PyUpgrade 使用教程

PyUpgrade 使用教程

1. 项目目录结构及介绍

PyUpgrade 是一个自动化工具，用于将 Python 代码升级到新版本支持的语法。其源码仓库的目录结构大致如下：

.
├── README.md       # 主要的项目说明文件
├── pyproject.toml  # 项目的配置文件
├── setup.py        # 作为 Python 包的安装脚本
└── src             # 存放实际代码的目录
   └── pyupgrade     # 主要的 Python 模块
      ├── __init__.py
      └── main.py    # 启动文件

• README.md: 提供了项目的基本信息、安装指南和使用示例。
• pyproject.toml: 通常用来存储项目的构建和依赖配置。
• setup.py: 根据标准的 Python 包规范，负责安装 PyUpgrade。
• src/pyupgrade: 包含了工具的核心代码。
  • __init__.py: 使 pyupgrade 目录成为一个 Python 包。
  • main.py: 工具的主要入口点，执行代码升级任务。

2. 项目的启动文件介绍

main.py 文件是 PyUpgrade 的核心，它定义了如何处理输入的 Python 代码并进行语法升级。当运行 pyupgrade 命令时，这个文件会被调用。main.py 中的关键部分包括解析命令行参数、加载配置以及调用 do_upgrade() 函数来实际执行代码更新。

例如，你可以通过以下命令行来使用 main.py 进行代码升级：

python -m src.pyupgrade path/to/your/code/file.py

这将会把指定的 Python 文件中的语法自动升级到最新的 Python 版本支持的形式。

3. 项目的配置文件介绍

PyUpgrade 的配置主要通过 pyproject.toml 文件完成。虽然在默认情况下不需要额外配置，但你可以自定义一些行为，比如设置特定的最小 Python 版本或排除某些模式。

以下是一个简单的 pyproject.toml 示例，其中设置了最小的 Python 版本来限制升级的范围：

[tool.pyupgrade]
min_version = "3.7"

这意味着 PyUpgrade 只会应用对 Python 3.7 及以上版本有效的语法更改。

另外，如果你想要在项目范围内使用 PyUpgrade 作为预提交钩子，可以在 .pre-commit-config.yaml 文件中配置，如下所示：

repos:
  - repo: https://github.com/asottile/pyupgrade
    rev: v3.17.0  # 替换为最新版本号
    hooks:
      - id: pyupgrade

这将确保每次提交前都会检查并更新你的 Python 代码。

以上就是关于 PyUpgrade 项目的目录结构、启动文件和配置文件的简要介绍。为了开始使用，只需按照上述步骤进行操作，即可快速地将你的旧版 Python 代码升级到现代语法。