Hyperlink 项目使用教程

Hyperlink 项目使用教程

hyperlink 🔗 Immutable, Pythonic, correct URLs. 项目地址: https://gitcode.com/gh_mirrors/hy/hyperlink

1. 项目目录结构及介绍

Hyperlink 项目是一个纯 Python 实现的不可变 URL 库。以下是项目的目录结构及其说明：

hyperlink/
├── .appveyor.yml          # Windows CI/CD 配置文件
├── .coveragerc            # 覆盖率配置文件
├── .gitignore             # Git 忽略文件列表
├── .github/               # GitHub 工作流程目录
│   └── workflows/         # 工作流程文件
├── CHANGELOG.md           # 更改日志
├── LICENSE                # 项目许可证文件
├── MANIFEST.in            # 打包文件列表
├── README.md              # 项目说明文件
├── TODO.md                # 待办事项列表
├── pyproject.toml         # Python 项目配置文件
├── pytest.ini             # pytest 配置文件
├── setup.cfg              # 打包配置文件
├── setup.py               # Python 包设置文件
├── src/                   # 源代码目录
│   └── hyperlink/         # Hyperlink 模块
└── tox.ini                # tox 配置文件

• .appveyor.yml: 用于在 Windows 系统上自动化测试和构建的配置文件。
• .coveragerc: 覆盖率测试的配置文件，用于测量测试覆盖率。
• .gitignore: 指定 Git 忽略的文件和目录，以避免将不必要的文件提交到版本控制中。
• .github/workflows: 包含 GitHub Actions 工作流文件，用于自动化各种任务，如测试、构建和发布。
• CHANGELOG.md: 记录了项目的更新、修改和改进历史。
• LICENSE: 项目遵循的许可证信息。
• MANIFEST.in: 指定打包时包含的文件。
• README.md: 项目的自述文件，提供项目的基本信息和使用方法。
• TODO.md: 列出了项目开发中待完成的事项。
• pyproject.toml: 包含项目的元数据和构建系统要求。
• pytest.ini: pytest 测试框架的配置文件。
• setup.cfg: 包含打包和分发 Python 包的配置信息。
• setup.py: 用于构建和安装 Python 包的脚本。
• src/hyperlink: 包含 Hyperlink 库的源代码。

2. 项目的启动文件介绍

Hyperlink 项目没有特定的启动文件。要使用这个库，你通常需要从 src/hyperlink 目录中导入 URL 类，并使用它来创建和处理 URL。以下是一个简单的示例：

from hyperlink import URL

# 创建 URL
url = URL.from_text('http://github.com/python-hyper/hyperlink?utm_source=README')

# 获取查询参数
utm_source = url.get('utm_source')

# 修改 URL
better_url = url.replace(scheme='https', port=443)

# 打印修改后的 URL
print(better_url)

3. 项目的配置文件介绍

Hyperlink 项目的配置文件主要用于 CI/CD 流程、测试和打包。以下是一些主要配置文件的简要说明：

• .appveyor.yml: 配置在 Windows 系统上的持续集成服务。它指定了构建环境、依赖项、测试命令等。
• .coveragerc: 配置测试覆盖率工具。它指定了要包括和排除的文件，以及覆盖率报告的生成方式。
• pytest.ini: 配置 pytest 测试框架。它允许你自定义测试行为，例如添加自定义插件或配置测试发现规则。
• setup.cfg: 配置 Python 包的构建和分发。它指定了包的元数据、依赖项和构建选项。

以上文件通常不需要用户手动修改，除非你需要自定义项目的工作流程或测试设置。

hyperlink 🔗 Immutable, Pythonic, correct URLs. 项目地址: https://gitcode.com/gh_mirrors/hy/hyperlink