Pyink 项目使用教程

Pyink 项目使用教程

1. 项目目录结构及介绍

Pyink 是一个 Python 格式化工具，fork 自 Black，具有一些不同的格式化行为。以下是 Pyink 项目的目录结构及其介绍：

pyink/
├── CHANGES.md          # 项目变更日志
├── CONTRIBUTING.md     # 贡献指南
├── LICENSE             # 项目许可证
├── README.md           # 项目介绍和使用说明
├── pyproject.toml      # 项目配置文件
├── test_requirements.txt # 测试依赖
├── tox.ini             # Tox 配置文件
├── src/
│   └── pyink/          # Pyink 源代码目录
├── tests/              # 测试代码目录
└── github/
    └── workflows/      # GitHub Actions 工作流配置

主要目录和文件介绍

• CHANGES.md: 记录项目的变更历史。
• CONTRIBUTING.md: 提供给贡献者的指南，说明如何为项目做出贡献。
• LICENSE: 项目的开源许可证，Pyink 使用 MIT 许可证。
• README.md: 项目的主要介绍文档，包含项目的基本信息、使用方法和贡献指南。
• pyproject.toml: 项目的配置文件，定义了构建系统和工具的配置。
• test_requirements.txt: 测试所需的依赖包列表。
• tox.ini: Tox 配置文件，用于自动化测试和环境管理。
• src/pyink/: 包含 Pyink 的主要源代码。
• tests/: 包含项目的测试代码。
• github/workflows/: 包含 GitHub Actions 的工作流配置文件，用于持续集成和部署。

2. 项目启动文件介绍

Pyink 是一个命令行工具，没有传统的“启动文件”。用户通过命令行调用 Pyink 来格式化 Python 代码。以下是使用 Pyink 的基本命令：

pyink your_script.py

这个命令会自动格式化 your_script.py 文件中的代码。

3. 项目配置文件介绍

Pyink 的配置文件是 pyproject.toml，它定义了项目的构建系统和工具的配置。以下是一个示例配置文件的内容：

[tool.pyink]
line-length = 88
pyink = true
pyink-indentation = 2
pyink-use-majority-quotes = true

主要配置项介绍

• line-length: 设置代码行的最大长度，默认值为 88。
• pyink: 启用 Pyink 格式化模式，默认值为 true。
• pyink-indentation: 设置缩进大小，可以是 2 或 4，默认值为 4。
• pyink-use-majority-quotes: 根据文件中引号的多数来推断首选的引号样式，默认值为 true。

通过这些配置项，用户可以根据自己的需求定制 Pyink 的格式化行为。