4. 创建源代码分发

如简单示例部分所示，您可以使用 sdist 命令创建源分发。在最简单的情况下，

python setup.py sdist

（假设您没有在安装脚本或配置文件中指定任何 sdist 选项），sdist 会为当前平台创建默认格式的存档。默认格式在 Unix 上是 gzip 压缩的 tar 文件 (.tar.gz)，在 Windows 上是 ZIP 文件。

您可以使用 --formats 选项指定任意数量的格式，例如：

python setup.py sdist --formats=gztar,zip

创建一个 gzip 压缩包和一个 zip 文件。可用的格式有：

格式	说明	笔记
`zip`	压缩文件 (`.zip`)	(1),(3)
`gztar`	gzip 压缩的 tar 文件 (`.tar.gz`)	(2)
`bztar`	bzip2'ed tar 文件 (`.tar.bz2`)
`ztar`	压缩的 tar 文件 (`.tar.Z`)	(4)
`tar`	tar 文件 (`.tar`)

注意事项：

Windows 上的默认设置
Unix 上的默认值
需要外部 zip 实用程序或 zipfile 模块（自 Python 1.6 起成为标准 Python 库的一部分）
需要 compress 程序。

在 Unix 下使用任何 tar 格式（gztar、bztar、ztar 或 tar）时，您可以指定 [ X115X] 和 group 将为存档的每个成员设置的名称。

例如，如果您希望存档的所有文件都归根用户所有：

python setup.py sdist --owner=root --group=root

4.1. 指定要分发的文件

如果您不提供明确的文件列表（或有关如何生成文件的说明），则 sdist 命令会将最小的默认设置放入源代码分发版中：

py_modules 和 packages 选项隐含的所有 Python 源文件
ext_modules 或 libraries 选项中提到的所有 C 源文件
由 scripts 选项标识的脚本请参阅安装脚本。
任何看起来像测试脚本的东西：test/test*.py（目前，Distutils 不对测试脚本做任何事情，除了将它们包含在源代码发行版中，但将来会有一个用于测试 Python 模块发行版的标准）
README.txt（或 README）、setup.py（或任何您调用的安装脚本）和 setup.cfg
与 package_data 元数据匹配的所有文件。请参阅安装包数据。
与 data_files 元数据匹配的所有文件。请参阅安装附加文件。

有时这已经足够了，但通常您需要指定要分发的其他文件。这样做的典型方法是编写一个 清单模板 ，默认情况下称为 MANIFEST.in。清单模板只是关于如何生成清单文件 MANIFEST 的说明列表，这是要包含在源代码分发中的确切文件列表。 sdist 命令处理这个模板并根据它的指令和它在文件系统中找到的内容生成一个清单。

如果您更喜欢滚动自己的清单文件，格式很简单：每行一个文件名，只有常规文件（或指向它们的符号链接）。如果您确实提供自己的 MANIFEST，则必须指定所有内容：上述默认文件集不适用于这种情况。

在 2.7 版更改：将重新生成现有生成的 MANIFEST，而无需 sdist 将其修改时间与 MANIFEST.in 或 [ X171X]。

在 2.7.1 版更改：MANIFEST 文件以注释开头，表明它们是生成的。没有此注释的文件不会被覆盖或删除。

2.7.3 版更改： sdist 将读取 MANIFEST 文件，如果 MANIFEST.in 不存在，就像 2.7 之前一样。

有关语法参考，请参阅 MANIFEST.in 模板部分。

4.2. 清单相关选项

sdist命令的正常操作过程如下：

如果清单文件（默认情况下为 MANIFEST）存在并且第一行没有注释表明它是从 MANIFEST.in 生成的，则按原样使用，未更改
如果清单文件不存在或之前已自动生成，请阅读 MANIFEST.in 并创建清单
如果 MANIFEST 和 MANIFEST.in 都不存在，则创建一个仅包含默认文件集的清单
现在使用 MANIFEST 中的文件列表（刚刚生成或读入）来创建源分发存档

有几个选项可以修改此行为。首先，使用 --no-defaults 和 --no-prune 禁用标准的“包含”和“排除”集。

其次，您可能只想（重新）生成清单，而不是创建源分发：

python setup.py sdist --manifest-only

-o 是 --manifest-only 的快捷方式。

4.3. MANIFEST.in 模板

可以在项目中添加 MANIFEST.in 文件，以定义要包含在由 sdist 命令构建的分发中的文件列表。

当运行 sdist 时，它将查找 MANIFEST.in 文件并解释它以生成包含将包含在包中的文件列表的 MANIFEST 文件。

当默认文件列表不够用时，可以使用此机制。（请参阅指定要分发的文件）。

4.3.1. 原则

清单模板每行有一个命令，其中每个命令指定一组要在源分发中包含或排除的文件。例如，让我们看看 Distutils 自己的清单模板：

include *.txt
recursive-include examples *.txt *.py
prune examples/sample?/build

含义应该相当清楚：包括分发根目录中匹配 *.txt 的所有文件，examples 目录下匹配 *.txt 或 *.py 的所有文件，以及排除所有匹配 examples/sample?/build 的目录。所有这一切都在 标准包含集之后完成 ，因此您可以使用清单模板中的显式指令从标准集中排除文件。（或者，您可以使用 --no-defaults 选项完全禁用标准集。）

清单模板中的命令顺序很重要：最初，我们有如上所述的默认文件列表，模板中的每个命令都会添加到该文件列表中或从中删除。一旦我们完全处理了清单模板，我们就会删除不应包含在源代码分发中的文件：

Distutils“构建”树中的所有文件（默认 build/）
名为 RCS、CVS、.svn、.hg、.git、.bzr 或 _darcs

现在我们有了完整的文件列表，将其写入清单以供将来参考，然后用于构建源分发存档。

您可以使用 --no-defaults 选项禁用默认的包含文件集，也可以使用 --no-prune 禁用标准排除集。

遵循 Distutils 自己的清单模板，让我们跟踪 sdist 命令如何构建要包含在 Distutils 源代码分发中的文件列表：

包括 distutils 和 distutils/command 子目录中的所有 Python 源文件（因为在安装脚本的 packages 选项中提到了对应于这两个目录的包——请参阅部分）编写安装脚本)
包括 README.txt、setup.py 和 setup.cfg（标准文件）
包括 test/test*.py（标准文件）
在分布根目录中包含 *.txt（这将再次找到 README.txt，但此类冗余稍后会被淘汰）
在 examples 下的子树中包含与 *.txt 或 *.py 匹配的任何内容，
排除从匹配 examples/sample?/build 的目录开始的子树中的所有文件——这可能会排除前两个步骤中包含的文件，因此清单模板中的 prune 命令很重要，在 [ X223X] 命令
排除整个 build 树，以及任何 RCS、CVS、.svn、.hg、.git、.bzr 和 _darcs 目录

就像在安装脚本中一样，清单模板中的文件和目录名称应始终以斜杠分隔； Distutils 将负责将它们转换为您平台上的标准表示。这样，清单模板就可以跨操作系统移植。

4.3.2. 命令

清单模板命令是：

命令	说明
包括 pat1 pat2 ...	包括与任何列出的模式匹配的所有文件
排除 pat1 pat2 ...	排除与任何列出的模式匹配的所有文件
递归包含目录 pat1 pat2 ...	包括 dir 下与任何列出的模式匹配的所有文件
递归排除目录 pat1 pat2 ...	排除 dir 下与任何列出的模式匹配的所有文件
全局包含 pat1 pat2 ...	包含匹配源树中任何位置的所有文件 - 以及任何列出的模式
全局排除 pat1 pat2 ...	排除匹配源树中任何位置的所有文件 - 以及任何列出的模式
修剪目录	排除 dir 下的所有文件
移植目录	包含 dir 下的所有文件

这里的模式是 Unix 风格的“glob”模式：* 匹配任何常规文件名字符序列，? 匹配任何单个常规文件名字符，而 [range] 匹配任何一个范围中的字符（例如，a-z、a-zA-Z、a-f0-9_.）。 “常规文件名字符”的定义是特定于平台的：在 Unix 上它是除斜杠之外的任何东西；在 Windows 上，除反斜杠或冒号外的任何内容。