interrogate 项目教程

1. 项目目录结构及介绍

interrogate/
├── docs/
│   └── ...
├── src/
│   └── interrogate/
│       ├── __init__.py
│       ├── __main__.py
│       ├── badge_gen.py
│       ├── cli.py
│       ├── config.py
│       ├── coverage.py
│       ├── utils.py
│       └── visit.py
├── tests/
│   ├── functional/
│   │   ├── __init__.py
│   │   ├── test_cli.py
│   │   └── test_coverage.py
│   └── unit/
│       ├── __init__.py
│       ├── test_badge_gen.py
│       ├── test_config.py
│       └── test_utils.py
├── .gitignore
├── pre-commit-config.yaml
├── pre-commit-hooks.yaml
├── readthedocs.yaml
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── MANIFEST.in
├── README.rst
├── codecov.yml
├── pyproject.toml
├── setup.py
└── tox.ini

目录结构说明

• docs/: 项目文档目录，包含项目的详细文档。
• src/interrogate/: 项目源代码目录，包含主要的Python模块。
  • init.py: 初始化文件，用于定义包。
  • main.py: 项目的启动文件，包含主程序入口。
  • badge_gen.py: 生成覆盖率徽章的模块。
  • cli.py: 命令行接口模块。
  • config.py: 配置文件处理模块。
  • coverage.py: 覆盖率计算模块。
  • utils.py: 工具函数模块。
  • visit.py: 代码遍历模块。
• tests/: 测试代码目录，包含功能测试和单元测试。
  • functional/: 功能测试目录。
  • unit/: 单元测试目录。
• .gitignore: Git忽略文件配置。
• pre-commit-config.yaml: pre-commit配置文件。
• pre-commit-hooks.yaml: pre-commit钩子配置文件。
• readthedocs.yaml: ReadTheDocs配置文件。
• CODE_OF_CONDUCT.md: 行为准则文件。
• CONTRIBUTING.md: 贡献指南文件。
• LICENSE: 项目许可证文件。
• MANIFEST.in: 打包清单文件。
• README.rst: 项目说明文件。
• codecov.yml: Codecov配置文件。
• pyproject.toml: Python项目配置文件。
• setup.py: 项目安装脚本。
• tox.ini: tox配置文件。

2. 项目启动文件介绍

src/interrogate/__main__.py

该文件是项目的启动文件，包含了主程序的入口点。通过运行该文件，可以启动interrogate工具，检查代码库中的文档字符串覆盖率。

# src/interrogate/__main__.py

def main():
    # 主程序逻辑
    pass

if __name__ == "__main__":
    main()

启动方式

可以通过以下命令启动项目：

python -m src.interrogate

3. 项目配置文件介绍

pyproject.toml

pyproject.toml 是Python项目的配置文件，用于定义项目的构建系统和依赖项。

[tool.interrogate]
# interrogate 配置项

setup.py

setup.py 是Python项目的安装脚本，用于定义项目的元数据和依赖项。

from setuptools import setup, find_packages

setup(
    name="interrogate",
    version="1.0.0",
    packages=find_packages(),
    install_requires=[
        # 依赖项列表
    ],
)

tox.ini

tox.ini 是tox配置文件，用于定义项目的测试环境和测试命令。

[tox]
envlist = py38, py39

[testenv]
deps =
    # 测试依赖项
commands =
    # 测试命令

通过这些配置文件，可以方便地管理和配置interrogate项目。