TheFuzz 项目技术文档

1. 安装指南

使用 pip 安装

你可以通过 pip 从 PyPI 安装 thefuzz：

pip install thefuzz

从 GitHub 安装

你也可以通过 pip 从 GitHub 安装最新版本的 thefuzz：

pip install git+git://github.com/seatgeek/thefuzz.git@0.19.0#egg=thefuzz

手动安装

如果你更喜欢手动安装，可以按照以下步骤操作：

1. 克隆仓库：

   git clone git://github.com/seatgeek/thefuzz.git
   

2. 进入项目目录：

   cd thefuzz
   

3. 安装项目：

   python setup.py install
   

2. 项目使用说明

TheFuzz 是一个用于模糊字符串匹配的 Python 库，它基于 Levenshtein 距离来计算字符串之间的差异。以下是一些基本的使用示例：

简单比率

from thefuzz import fuzz

# 计算两个字符串的相似度
ratio = fuzz.ratio("this is a test", "this is a test!")
print(ratio)  # 输出: 97

部分比率

# 计算部分字符串的相似度
partial_ratio = fuzz.partial_ratio("this is a test", "this is a test!")
print(partial_ratio)  # 输出: 100

令牌排序比率

# 计算令牌排序后的相似度
token_sort_ratio = fuzz.token_sort_ratio("fuzzy wuzzy was a bear", "wuzzy fuzzy was a bear")
print(token_sort_ratio)  # 输出: 100

令牌集比率

# 计算令牌集的相似度
token_set_ratio = fuzz.token_set_ratio("fuzzy was a bear", "fuzzy fuzzy was a bear")
print(token_set_ratio)  # 输出: 100

处理提取

from thefuzz import process

choices = ["Atlanta Falcons", "New York Jets", "New York Giants", "Dallas Cowboys"]

# 提取最匹配的选项
result = process.extract("new york jets", choices, limit=2)
print(result)  # 输出: [('New York Jets', 100), ('New York Giants', 78)]

3. 项目 API 使用文档

fuzz 模块

• fuzz.ratio(s1, s2): 计算两个字符串的相似度，返回一个 0 到 100 的整数。
• fuzz.partial_ratio(s1, s2): 计算部分字符串的相似度。
• fuzz.token_sort_ratio(s1, s2): 计算令牌排序后的相似度。
• fuzz.token_set_ratio(s1, s2): 计算令牌集的相似度。
• fuzz.partial_token_sort_ratio(s1, s2): 计算部分令牌排序后的相似度。

process 模块

• process.extract(query, choices, limit=None): 从 choices 中提取与 query 最匹配的选项，返回一个列表，每个元素是一个元组，包含匹配的字符串和相似度。
• process.extractOne(query, choices, scorer=None): 提取与 query 最匹配的单个选项，返回一个元组，包含匹配的字符串和相似度。

4. 项目安装方式

TheFuzz 可以通过以下几种方式安装：

1. 通过 pip 从 PyPI 安装：

   pip install thefuzz
   

2. 通过 pip 从 GitHub 安装：

   pip install git+git://github.com/seatgeek/thefuzz.git@0.19.0#egg=thefuzz
   

3. 手动安装：

   • 克隆仓库：

     git clone git://github.com/seatgeek/thefuzz.git
     

   • 进入项目目录：

     cd thefuzz
     

   • 安装项目：

     python setup.py install
     

通过以上步骤，你可以轻松安装并使用 TheFuzz 进行模糊字符串匹配。