开源项目 `ast-pretty-print` 使用教程

1. 项目目录结构及介绍

ast-pretty-print/
├── .github/
│   └── workflows/
│       └── tests.yml
├── .gitignore
├── .pre-commit-config.yaml
├── LICENSE
├── README.md
├── astpretty.py
├── requirements-dev.txt
├── setup.cfg
├── setup.py
└── tox.ini

目录结构介绍

• .github/workflows/: 包含GitHub Actions的工作流配置文件，用于自动化测试和CI/CD流程。
• .gitignore: 指定Git版本控制系统忽略的文件和目录。
• .pre-commit-config.yaml: 配置pre-commit钩子，用于在提交代码前执行代码格式化和检查。
• LICENSE: 项目的开源许可证文件，通常为MIT许可证。
• README.md: 项目的介绍文档，包含项目的基本信息、安装和使用说明。
• astpretty.py: 项目的主要源代码文件，包含实现AST节点格式化打印的逻辑。
• requirements-dev.txt: 开发依赖的Python包列表。
• setup.cfg: 项目的配置文件，包含setuptools的配置选项。
• setup.py: 用于安装项目的Python脚本。
• tox.ini: 配置tox工具，用于自动化测试和环境管理。

2. 项目的启动文件介绍

项目的启动文件是 astpretty.py，该文件包含了项目的核心功能，即对Python标准库 ast.parse 生成的AST节点进行格式化打印。

主要功能

• astpretty.pprint(node, indent=FOUR_SPACE_INDENT, show_offsets=True): 打印AST节点的格式化表示。

  • node: 需要格式化打印的AST节点。
  • indent: 缩进字符串，默认为四个空格。
  • show_offsets: 是否显示行和列的偏移信息。

• astpretty.pformat(node, indent=FOUR_SPACE_INDENT, show_offsets=True): 返回AST节点的格式化字符串表示。

  • 参数与 pprint 相同。

3. 项目的配置文件介绍

setup.cfg

setup.cfg 是项目的配置文件，用于配置 setuptools 工具。以下是文件的主要内容：

[metadata]
name = astpretty
version = 1.0.0
description = Pretty print the output of python stdlib ast.parse
long_description = file: README.md
long_description_content_type = text/markdown
url = https://github.com/asottile/astpretty
author = Anthony Sottile
author_email = [e-mail]
license = MIT
classifiers =
    Development Status :: 5 - Production/Stable
    Intended Audience :: Developers
    License :: OSI Approved :: MIT License
    Programming Language :: Python :: 3
    Programming Language :: Python :: 3.6
    Programming Language :: Python :: 3.7
    Programming Language :: Python :: 3.8
    Programming Language :: Python :: 3.9

[options]
packages = find:
python_requires = >=3.6

[options.entry_points]
console_scripts =
    astpretty = astpretty:main

配置项介绍

• [metadata]: 包含项目的元数据，如项目名称、版本、描述、作者信息等。
• [options]: 配置 setuptools 的选项，如自动查找包、Python版本要求等。
• [options.entry_points]: 定义命令行脚本的入口点，astpretty 命令将调用 astpretty:main 函数。

tox.ini

tox.ini 是用于配置 tox 工具的文件，tox 用于自动化测试和环境管理。以下是文件的主要内容：

[tox]
envlist = py36, py37, py38, py39

[testenv]
deps =
    pytest
commands =
    pytest

配置项介绍

• [tox]: 定义测试环境列表，支持Python 3.6到3.9版本。
• [testenv]: 配置测试环境的依赖和命令，使用 pytest 进行测试。

通过以上配置文件，项目可以方便地进行安装、测试和发布。