Python: PEP8自动格式化代码

简介

PEP8 是 Python 的代码风格指南。在跨平台开发时,代码格式(如缩进、换行符等)可能导致问题。本文介绍如何使用工具自动格式化代码。

使用 autopep8

安装autopep8

# 普通安装
pip install --upgrade autopep8

# 使用国内源安装
pip install --upgrade autopep8 --trusted-host mirrors.aliyun.com

基本用法

autopep8 提供了多种格式化选项:

# 临时查看格式化效果，不覆盖原有的代码
autopep8 --aggressive --aggressive code.py

# 覆盖原有的代码格式化
autopep8 --in-place --aggressive --aggressive code.py

# 格式化目录下所有 Python 文件
autopep8 --in-place --aggressive --recursive .

配置文件

可以创建 setup.cfg 或 tox.ini 配置文件，这些文件通常存放在项目的根目录下。例如，如果你的项目结构如下所示：

my_project/
    setup.cfg
    my_module/
        __init__.py
        my_file.py
    tests/
        test_my_file.py
    tox.ini

在 setup.cfg 或 tox.ini 文件中，可以添加以下配置：

[pycodestyle]
max_line_length = 120
ignore = E226,E302,E41

编码格式转换

使用 Vim 转换文件格式:

# 在 Vim 中执行
:set ff=unix  # 转换为 Unix 格式
:set ff=dos   # 转换为 Windows 格式
:wq          # 保存并退出

最佳实践

格式化建议
- 使用版本控制
- 在提交前格式化
- 团队统一配置
编码建议
- 统一使用 UTF-8
- 注意换行符
- 保持一致的缩进

注意：
备份重要文件
检查格式化结果
遵循项目规范