tldextract 项目技术文档

1. 安装指南

安装最新发布版本

你可以通过 pip 安装 tldextract 的最新发布版本：

pip install tldextract

安装开发版本

如果你想安装最新的开发版本，可以使用以下命令：

pip install -e 'git://github.com/john-kurkowski/tldextract.git#egg=tldextract'

命令行使用

安装完成后，你可以通过命令行直接使用 tldextract 来解析 URL：

tldextract http://forums.bbc.co.uk
# 输出: forums bbc co.uk

2. 项目的使用说明

tldextract 是一个用于准确分离 URL 的子域、域名和公共后缀的 Python 库。它使用 Public Suffix List (PSL) 来实现这一功能。

基本用法

以下是一个简单的使用示例：

import tldextract

# 提取 URL 的各个部分
result = tldextract.extract('http://forums.news.cnn.com/')
print(result)
# 输出: ExtractResult(subdomain='forums.news', domain='cnn', suffix='com', is_private=False)

处理不同类型的 URL

tldextract 可以处理各种类型的 URL，包括没有子域或无效后缀的 URL：

# 没有子域的 URL
result = tldextract.extract('google.com')
print(result)
# 输出: ExtractResult(subdomain='', domain='google', suffix='com', is_private=False)

# 无效后缀的 URL
result = tldextract.extract('google.notavalidsuffix')
print(result)
# 输出: ExtractResult(subdomain='google', domain='notavalidsuffix', suffix='', is_private=False)

# IP 地址的 URL
result = tldextract.extract('http://127.0.0.1:8080/deployed/')
print(result)
# 输出: ExtractResult(subdomain='', domain='127.0.0.1', suffix='', is_private=False)

重新组合原始主机名

你可以通过 registered_domain 和 fqdn 属性重新组合原始主机名：

ext = tldextract.extract('http://forums.bbc.co.uk')
print(ext.registered_domain)  # 输出: bbc.co.uk
print(ext.fqdn)  # 输出: forums.bbc.co.uk

3. 项目API使用文档

tldextract.extract(url)

• 功能: 提取 URL 的子域、域名和公共后缀。
• 参数:
  • url (str): 要解析的 URL。
• 返回值: 返回一个 ExtractResult 对象，包含以下属性：
  • subdomain (str): 子域部分。
  • domain (str): 域名部分。
  • suffix (str): 公共后缀部分。
  • is_private (bool): 是否为私有域名。

tldextract.TLDExtract(suffix_list_urls=None, cache_dir=None, include_psl_private_domains=False, fallback_to_snapshot=True, extra_suffixes=None)

• 功能: 创建一个自定义的 TLDExtract 实例，用于提取 URL 的各个部分。
• 参数:
  • suffix_list_urls (list): 自定义的公共后缀列表 URL。
  • cache_dir (str): 缓存目录路径。
  • include_psl_private_domains (bool): 是否包含私有域名。
  • fallback_to_snapshot (bool): 是否在无法获取公共后缀列表时回退到内置快照。
  • extra_suffixes (list): 额外的后缀列表。

示例

# 不使用缓存的提取器
no_cache_extract = tldextract.TLDExtract(cache_dir=None)
result = no_cache_extract('http://www.google.com')
print(result)

4. 项目安装方式

通过 pip 安装

你可以通过 pip 安装 tldextract 的最新发布版本：

pip install tldextract

通过 GitHub 安装开发版本

如果你想安装最新的开发版本，可以使用以下命令：

pip install -e 'git://github.com/john-kurkowski/tldextract.git#egg=tldextract'

命令行使用

安装完成后，你可以通过命令行直接使用 tldextract 来解析 URL：

tldextract http://forums.bbc.co.uk
# 输出: forums bbc co.uk

缓存管理

tldextract 默认会在 $HOME/.cache/python-tldextract 目录下缓存公共后缀列表。你可以通过设置 TLDEXTRACT_CACHE 环境变量或使用 cache_dir 参数来控制缓存位置。

# 自定义缓存路径
custom_cache_extract = tldextract.TLDExtract(cache_dir='/path/to/your/cache/')
custom_cache_extract('http://www.google.com')

如果你想更新缓存，可以运行以下命令：

tldextract --update

或者：

env TLDEXTRACT_CACHE="~/tldextract.cache" tldextract --update

建议在升级库后删除缓存文件以确保使用最新的公共后缀列表。