### setup.cfg 文件的用途与配置方法 `setup.cfg` 是 Python 的 `setuptools` 提供的一种用于简化项目构建过程的配置文件[^1]。它主要用于存储项目的元数据以及构建选项，从而减少在 `setup.py` 中编写复杂逻辑的需求。 #### 1. **setup.cfg 的主要功能** 该文件的主要作用是定义项目的元数据和构建参数，例如名称、版本号、依赖项等。通过这种方式可以实现更清晰的分离关注点，使代码更加简洁明了。 #### 2. **基本结构与常见字段** 以下是常见的 `setup.cfg` 配置示例及其解释： ```ini [metadata] name = my_package_name version = attr: my_module.__version__ description = A sample Python project using setup.cfg long_description = file: README.md long_description_content_type = text/markdown url = https://github.com/username/my-package author = Your Name author_email = your.email@example.com license = MIT classifiers = Programming Language :: Python :: 3 License :: OSI Approved :: MIT License Operating System :: OS Independent [options] packages = find: include_package_data = True python_requires = >=3.7, <4 install_requires = requests>=2.0,<3.0 numpy>=1.18 [options.packages.find] exclude = tests* docs* [bdist_wheel] universal = False ``` - `[metadata]`: 定义项目的元数据，如名称 (`name`) 和描述 (`description`)。 - `[options]`: 设置打包选项，包括要包含的包 (`packages`) 及其依赖关系 (`install_requires`)。 - `[options.packages.find]`: 自动查找并排除某些特定路径下的模块。 - `[bdist_wheel]`: 控制 wheel 构建行为，比如是否支持 Python 2 和 Python 3 的通用二进制分发。 #### 3. **动态获取版本号** 如果希望从源码中提取版本号而不是硬编码到配置文件里，则可以通过如下方式指定： ```ini version = attr: package_name.__version__ ``` 这表示会读取 `package_name/__init__.py` 文件中的 `__version__` 属性作为当前软件包的版本号。 #### 4. **安装依赖管理** 当使用 pip 进行安装时，可以直接解析 `setup.cfg` 来处理所有的依赖声明而无需额外脚本干预。只需运行命令即可完成环境搭建： ```bash pip install . ``` #### 5. **高级特性——扩展插件支持** 除了基础设置外，还可以利用其他工具（如 flit 或 poetry）进一步增强开发体验；或者借助 entry_points 实现 CLI 工具注册等功能: ```ini [options.entry_points] console_scripts = cli-tool=my_module.cli:main_function ``` 上述例子展示了如何创建名为 `cli-tool` 的命令行应用程序入口点。 --- ### 示例代码展示 下面是一个完整的最小化样例来演示如何组织一个简单的Python库工程目录结构及对应的配置文件内容: 假设我们的项目根目录下有以下布局: ``` my_project/ ├── src/ │ └── my_module/ │ ├── __init__.py │ └── core.py ├── pyproject.toml └── setup.cfg ``` 其中 `setup.cfg` 如此写入: ```ini [metadata] name = my-module version = attr: my_module.__version__ description = An example of a minimalistic Python library. long_description = file: README.md long_description_content_type = text/markdown url = https://example.org/my-repo author = John Doe author_email = john.doe@example.org license = Apache Software License 2.0 classifiers = Development Status :: 4 - Beta Intended Audience :: Developers Topic :: Software Development :: Libraries License :: OSI Approved :: Apache Software License Programming Language :: Python :: 3 Programming Language :: Python :: 3.9 Programming Language :: Python :: 3.10 [options] package_dir = =src packages = find: python_requires = >=3.9 install_requires = click==8.* [options.package_data] * = *.txt, *.rst [build_sphinx] source-dir = doc/source build-dir = doc/build all_files = true ``` ---