Python中的setup.py和setup.cfg使用详解

Python中的setup.py和setup.cfg使用详解

在Python开发中，我们经常会使用到setup.py和setup.cfg这两个文件来配置我们的项目。setup.py是一个Python脚本，用于定义项目的元数据和设置项目的安装过程，而setup.cfg是一个配置文件，用于存储项目的一些设置信息。在本文中，我将详细介绍如何使用这两个文件来配置和管理Python项目。

什么是setup.py

setup.py是一个Python脚本，用于描述和定义Python项目的元数据，比如项目名称、版本号、作者、许可证等信息。它是distutils/setuptools的入口点，通过运行python setup.py命令可以完成项目的构建、安装、打包等操作。

下面是一个简单的setup.py的示例代码：

from setuptools import setup, find_packages

setup(
    name='my_project',
    version='0.1',
    author='geek-docs.com',
    packages=find_packages(),
)

运行python setup.py sdist命令之后，会在当前目录下生成一个dist目录，并在该目录下生成一个名为my_project-0.1.tar.gz的压缩包。该压缩包包含了项目的源代码和setup.py文件。

setup.py中的元数据定义

setup.py中可以定义很多元数据信息，比如项目的名称、版本号、作者、许可证、依赖等。下面是一个完整的setup.py的示例代码：

from setuptools import setup, find_packages

setup(
    name='my_project',
    version='0.1',
    author='geek-docs.com',
    description='A simple Python project',
    long_description='This is a simple Python project created for demonstration.',
    url='https://geek-docs.com',
    packages=find_packages(),
    classifiers=[
        'Development Status :: 3 - Alpha',
        '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',
        'Topic :: Software Development :: Libraries',
    ],
    install_requires=[
        'requests',
    ],
)

在上面的示例代码中，我们定义了项目的名称为my_project，版本号为0.1，作者为geek-docs.com，依赖于requests库，以及一些其他的元数据信息。在classifiers中，我们定义了项目的一些分类信息，比如开发状态、适用于的Python版本等。

setup.cfg配置文件

除了使用setup.py来定义项目的元数据，我们还可以使用setup.cfg文件来配置项目的一些设置信息。setup.cfg是一个INI格式的配置文件，它可以存储项目的元数据、依赖、版本等信息，让我们的setup.py文件更加简洁清晰。

下面是一个简单的setup.cfg的示例代码：

[metadata]
name = my_project
version = 0.1
author = geek-docs.com

[options]
packages = find:
install_requires =
    requests

通过上面的配置文件，我们可以看到name、version、author等元数据信息已经定义在metadata段中，install_requires等依赖信息定义在options段中。这样可以使我们的setup.py文件更加简洁清晰，只需要留下一行代码from setuptools import setup即可。

示例：使用setup.cfg配置依赖

下面是一个示例代码，演示了如何通过setup.cfg文件来配置项目的依赖：

[metadata]
name = my_project
version = 0.1
author = geek-docs.com

[options]
packages = find:
install_requires =
    requests

如上所示，我们在setup.cfg文件中定义了项目的名称、版本号、作者以及依赖项（requests），然后可以在setup.py文件中通过如下方式引用这些信息：

from setuptools import setup

setup()

示例：使用setup.cfg配置包含数据文件的项目

有时候我们的Python项目中会包含一些静态资源文件，比如配置文件、模板文件等。我们可以通过setup.cfg文件将这些文件包含到项目中。

下面是一个示例代码，演示了如何使用setup.cfg配置包含数据文件的项目：

[metadata]
name = my_project
version = 0.1
author = geek-docs.com

[options]
packages = find:
package_data =
    conf = *.conf

在上面的示例中，我们定义了一个conf包含有.conf后缀的文件。当我们运行python setup.py build命令时，这些文件就会被包含到项目的构建结果中。

结语

通过本文的介绍，相信大家对setup.py和setup.cfg的使用有了更深入的了解。这两个文件是Python项目开发中不可或缺的一部分，能够帮助我们更好地管理和配置项目。