部署和分发

优质

小牛编辑

134浏览

2023-12-01

distribute 的前身是 setuptools ，是一个通常用于分发 Python 库和扩展程序的外部库。它依赖于随 Python 预装的 distutils 库，而后者则是一个基础的模块安装系统，这一安装系统也支持很多复杂的构造，使得大型应用更易于分发。

支持依赖关系管理: 一个库可以声明自己依赖哪些软件包，从而在安装这个模块的时候，自动将依赖的软件包也安装到您的计算机。
注册软件包: setuptools 将您的包注册到您的安装的 Python 环境中。这使得您可以使一个包中的代码查询另一个包所提供的信息。这一系统最知名的特性就是对接口机制的支持，也就是说一个包可以声明自己的一个接口，从而允许其他的包通过这个接口对自己进行扩展。
安装包管理器: easy_install 默认随 Python 安装，它可以用于为您安装其他的库。您也可以使用 pip 这个可能早晚会代替 easy_install 的包管理器，它能够完成安装软件包之外更多的任务。

而对于 Flask 自己，则所有您可以在 cheessshop 上找到的软件包，都随着 distribute 分发管理器，或者更古老的 setuptools 和 distutils 分发。

在这里，我们假定您的应用名为 yourapplication.py ，而您没使用模块而是使用 package 的结构来组织代码。分发带有标准模块的代码不被 distribute 支持，所以我们不去管它。如果您还没有将您的应用转化为包的形式，请参考前文 大型应用 的内容查找如何做到这件事。

利用 distribute 完成一个有效的部署进行更复杂和更自动化的部署方案的第一步，如果您使程序完全自动化，可以阅读 使用 Fabric 部署 这一章。

基础的安装脚本

因为你已经让 Flask 运行起来了，所以不管怎么说您的系统上应该会有 setuptools 或者d istribute，如果你没有这两样，不要害怕。这里帮你准备了一个脚本： distribute_setup.py 你只需要下载并用 Python 解释器运行它。

考虑这些操作可能会有风险，因此建议您参考 你最好使用 virtualenv 一文。

您的安装代码将总是保存在与您应用同目录下的 setup.py 文件中。为文件指定这一名称只是为了方便，不过一般来说每一个人自然而然的在程序目录下寻找这个文件，所以您最好别改变它。

同时，即使您在使用 distribute ，您也会导入一个名为 setuptools 的包。 distribute 完全向下兼容 setuptools ，所以我们也使用这个名字来导入它。

一个基本的 Flask 应用的 setup.py 文件看起来像如下这样:

from setuptools import setup

setup(
    name='Your Application',
    version='1.0',
    long_description=__doc__,
    packages=['yourapplication'],
    include_package_data=True,
    zip_safe=False,
    install_requires=['Flask']
)

切记，您必须详细地列出子代码包，如果您想要 distribute 自动为您寻找这些包，您可以使用 find_packages 函数:

from setuptools import setup, find_packages

setup(
    ...
    packages=find_packages()
)

大多数 setup 函数当中的参数的意义从字面意思就能看出来，然而 include_package_data 和 zip_safe 可能不在此列。 include_package_data 告诉 distribute 自动查找一个 MANIFEST.in 文件。解析此文件获得有效的包类型的数据，并安装所有这些包。我们使用这个特性来分发 Python 模块自带的静态文件和模板(参考 分发代码)。而 zip_safe 标志可以被用来强制阻止 ZIP 安装包的建立。通常情况下，您不希望您的包以 ZIP 压缩包的形式被安装，因为一些工具不支持这种方式，而且这样也会让调试代码异常麻烦。

分发代码

如果您视图安装您刚刚创建的包，您会发现诸如 static 和 templates 这样的文件夹没有安装进去。这是因为 distribute 不知道该把哪些文件添加进去。您只要在 setup.py 相同的文件夹下创建一个 MANIFEST.in 文件，并在此文件中列出所有应该被添加进去的文件:

recursive-include yourapplication/templates *
recursive-include yourapplication/static *

不要忘记，即使您已经将他们列在 MANIFEST.in 文件当中，也需要您将 setup 函数的 include_package_data 参数设置为 True ，否则他们仍然不会被安装。

声明依赖关系

您需要使用一个链表在 install_requires 参数中声明依赖关系。链表的每个元素是需要从 PyPI 下载并安装的包的名字，默认将总会下载安装最新的的版本。但是您也可以指定需要的最大和最小的版本区间。以下是一个例子:

install_requires=[
    'Flask>=0.2',
    'SQLAlchemy>=0.6',
    'BrokenPackage>=0.7,<=1.0'
]

前文曾经指出，这些依赖都从 PyPI 当中下载，如果您需要依赖一个不能在 PyPI 当中被下载的包，比如这个包是个内部的，您不想与别人分享。这时，您可以依然照原来那样将包列在列表里，但是同时提供一个包括所有可选下载地址的列表，以便于安装时从这些地点寻找分发的软件包:

dependency_links=['http://example.com/yourfiles']

请确认那个页面包含一个文件夹列表，且页面上的连接被指向实际需要下载的软件包。 distribute 通过扫描这个页面来寻找需要安装的文件，因此文件的名字必须是正确无误的。如您有一个内部服务器包含有这些包，将 URL 指向这个服务器。

安装 / 开发

安装您的应用(到一个 virtualenv)，只需使用 install 指令运行 setup.py 即可。这会将您的应用安装到一个 virtualenv 的 site-packages 文件夹下面，并且同时下载和安装所有的依赖包:

$ python setup.py install

如果您在进行基于这个包的开发，并且希望安装开发所依赖的工具或软件包，您可以使用 develop 命令代替 install

$ python setup.py develop

此时将不会把您的文件拷贝到 site-packages 文件夹，而仅仅是在那里创建指向这些文件的文件链接。您可以继续编辑和修改这些代码，而无需在每次修改之后运行 install 命令。