学习Python包的构建与分发

时间  2020-05-15
标签 学习 python 构建 分发 栏目 Python 繁體版
原文   原文链接

首发于公众号：Python编程时光html

1. 为何须要对项目分发打包？

日常咱们习惯了使用 pip 来安装一些第三方模块，这个安装过程之因此简单，是由于模块开发者为咱们默默地为咱们作了全部繁杂的工做，而这个过程就是 打包。python

打包，就是将你的源代码进一步封装，而且将全部的项目部署工做都事先安排好，这样使用者拿到后即装即用，不用再操心如何部署的问题（若是你不想对照着一堆部署文档手工操做的话）。git

无论你是在工做中，仍是业余准备本身写一个能够上传到 PyPI 的项目，你都要学会如何打包你的项目。shell

Python 发展了这么些年了，项目打包工具也已经很成熟了。他们都有哪些呢？编程

你可能听过 disutils、 distutils 、distutils2、setuptools等等，好像很熟悉，却又很陌生，他们都是什么关系呢？windows

2. 包分发的始祖：distutils

distutils 是 Python 的一个标准库，从命名上很容易看出它是一个分发（distribute）工具（utlis），它是 Python 官方开发的一个分发打包工具，全部后续的打包工具，所有都是基于它进行开发的。api

distutils 的精髓在于编写 setup.py，它是模块分发与安装的指导文件。函数

那么如何编写 setup.py 呢？这里面的内容很是多，我会在后面进行详细的解析，请你耐心往下看。工具

你有可能没写过 setup.py ，但你绝对使用过 setup.py 来作一些事情，好比下面这条命令，咱们常常用它来进行模块的安装。学习

$ python setup.py install

这样的安装方法是经过源码安装，与之对应的是经过二进制软件包的安装，一样我也会在后面进行介绍。

3. 分发工具升级：setuptools

setuptools 是 distutils 加强版，不包括在标准库中。其扩展了不少功能，可以帮助开发者更好的建立和分发 Python 包。大部分 Python 用户都会使用更先进的 setuptools 模块。

distribute，或许你在其余地方也见过它，这里也提一下。

distribute 是 setuptools 有一个分支版本，分支的缘由多是有一部分开发者认为 setuptools 开发太慢了。但如今，distribute 又合并回了 setuptools 中。所以，咱们能够认为它们是同一个东西。

还有一个大包分发工具是 distutils2，其试图尝试充分利用distutils，detuptools 和 distribute 并成为 Python 标准库中的标准工具。但该计划并无达到预期的目的，且已是一个废弃的项目。

所以，setuptools 是一个优秀的，可靠的 Python 包安装与分发工具。

那么如何在一个干净的环境中安装 setuptools 呢？

主要有两种方法：

  • 源码安装：在 https://pypi.org/project/setuptools/#files 中下载 zip 包 解压执行 python setup.py install 安装
  • 经过引导程序安装：下载引导程序，它能够用来下载或者更新最新版本的 setuptools
$ wget http://peak.telecommunity.com/dist/ez_setup.py

# 安装
$ python ez_setup.py

# 更新，如下两种任选
$ python ez_setup.py –U setuptools
$ pip install -U setuptools

4. easy_install 使用指南

当你安装完 setuptools 后，就拥有了一个叫作 easy_install 的第三方管理工具，这也是它区分于 distutils 的一大改进。

这里简单介绍一下它的用法，虽然它已经用得很是少了。

先是包的安装

# 经过包名，从PyPI寻找最新版本，自动下载、编译、安装
$ easy_install pkg_name

# 经过包名从指定下载页寻找连接来安装或升级包
$ easy_install -f http://pythonpaste.org/package_index.html 

# 指定线上的包地址安装
$ easy_install http://example.com/path/to/MyPackage-1.2.3.tgz

# 从本地的 .egg 文件安装
$ easy_install xxx.egg

# 在安装时你能够添加额外的参数
指定安装目录：--install-dir=DIR, -d DIR
指定用户安装：--user

再者是包的升级

# 从 pypi 中搜索并升级包
$ easy_install --upgrade pkg_name

# 指定版本进行升级
$ easy_install "SomePackage==2.0"

最后是包的删除

$ easy_install -m pkg_name

须要注意的是，这样的删除，仅是在 easy-install.pth 文件中删除，使其不能在 python 中使用 这个模块，但实际的包还在你的电脑中，若要删除完全，须要你手动删除相关的 .egg 及 其余文件。

默认状况下，easy_install 只会从 pypi 上下载相关软件包，因为这个源在国外，下载包的速度并不理想，使用过pip的朋友天然会想，easy_install 是否能指定源进行安装呢？

答案是，能够的。

编辑配置文件 /root/.pydistutils.cfg

[easy_install]
index-url=http://mirrors.aliyun.com/pypi/simple/
find-links=http://mirrors.aliyun.com/pypi/simple/

以上仅介绍了 easy_install 的一些经常使用的方法，想要了解更多，你能够点击官方文档：https://setuptools.readthedocs.io/en/latest/easy_install.html

总结一句：setuptools 是官方提供的一个专业用于包分发的工具，若只从安装的角度来看，它的功能确实简单。它更大的意义是对包的分发颇有用，定制化程序很是高，咱们如今也还在用它进行版本包的发布。

5. 源码包与二进制包什么区别？

Python 包的分发能够分为两种：

  1. 以源码包的方式发布

源码包安装的过程，是先解压，再编译，最后才安装，因此它是跨平台的，因为每次安装都要进行编译，相对二进包安装方式来讲安装速度较慢。

源码包的本质是一个压缩包，其常见的格式有：

  1. 以二进制包形式发布

二进制包的安装过程省去了编译的过程，直接进行解压安装，因此安装速度较源码包来讲更快。

因为不一样平台的编译出来的包没法通用，因此在发布时，需事先编译好多个平台的包。

二进制包的常见格式有：

6. eggs 与 wheels 有什么区别？

Egg 格式是由 setuptools 在 2004 年引入，而 Wheel 格式是由 PEP427 在 2012 年定义。Wheel 的出现是为了替代 Egg，它的本质是一个zip包，其如今被认为是 Python 的二进制包的标准格式。

如下是 Wheel 和 Egg 的主要区别：

  • Wheel 有一个官方的 PEP427 来定义，而 Egg 没有 PEP 定义
  • Wheel 是一种分发格式，即打包格式。而 Egg 既是一种分发格式，也是一种运行时安装的格式，而且是能够被直接 import
  • Wheel 文件不会包含 .pyc 文件
  • Wheel 使用和 PEP376 兼容的 .dist-info 目录，而 Egg 使用 .egg-info 目录
  • Wheel 有着更丰富的命名规则。
  • Wheel 是有版本的。每一个 Wheel 文件都包含 wheel 规范的版本和打包的实现
  • Wheel 在内部被 sysconfig path type 管理，所以转向其余格式也更容易

wheel 包能够经过 pip 来安装，只不过须要先安装 wheel 模块，而后再使用 pip 的命令。

$ pip install wheel
$ pip wheel --wheel-dir=/local/wheels pkg

7. 超详细讲解 setup.py 的编写？

打包分发最关键的一步是编写 setup.py 文件。

如下是一个 setup.py 简单的使用示例

from setuptools import setup, find_packages

setup(
    name="mytest",
    version="1.0",
    author="wangbm",
    author_email="wongbingming@163.com",
    description="Learn to Pack Python Module  -->公众号：Python编程时光",
    
    # 项目主页
    url="http://python-online.cn/", 
    
    # 你要安装的包，经过 setuptools.find_packages 找到当前目录下有哪些包
    packages=find_packages()
)

接下来，我将慢慢扩充这个setup函数，增长更多的参数，以便你能理解setup函数能作哪些事情。

程序分类信息

classifiers 参数说明包的分类信息。全部支持的分类列表见：https://pypi.org/pypi?%3Aaction=list_classifiers

示例：

from setuptools import setup, find_packages

setup(
    classifiers = [
        # 发展时期,常见的以下
        #   3 - Alpha
        #   4 - Beta
        #   5 - Production/Stable
        'Development Status :: 3 - Alpha',

        # 开发的目标用户
        'Intended Audience :: Developers',

        # 属于什么类型
        'Topic :: Software Development :: Build Tools',

        # 许可证信息
        'License :: OSI Approved :: MIT License',

        # 目标 Python 版本
        'Programming Language :: Python :: 2',
        'Programming Language :: Python :: 2.7',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.3',
        'Programming Language :: Python :: 3.4',
        'Programming Language :: Python :: 3.5',
    ]
)

关于文件的分发

from setuptools import setup, find_packages


setup(
    name="mytest",
    version="1.0",
    author="wangbm",
    author_email="wongbingming@163.com",
    description="Learn to Pack Python Module",
    url="http://python-online.cn/", 
    packages=find_packages(),
    
    # 安装过程当中，须要安装的静态文件，如配置文件、service文件、图片等
    data_files=[
        ('', ['conf/*.conf']),
        ('/usr/lib/systemd/system/', ['bin/*.service']),
               ],
    
    # 但愿被打包的文件
    package_data={
        '':['*.txt'],
        'bandwidth_reporter':['*.txt']
               },
    # 不打包某些文件
    exclude_package_data={
        'bandwidth_reporter':['*.txt']
               }
)

除了以上的参数配置以外，还可使用一个叫作 MANIFEST.in 的文件，来控制文件的分发。

以下这是一个 MANIFEST.in 的样例：

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

这些配置，规定了以下几点

  • 全部根目录下的以 txt 为后缀名的文件，都会分发
  • 根目录下的 examples 目录 和 txt、py文件都会分发
  • 路径匹配上 examples/sample?/build 不会分发

MANIFEST.in 须要放在和 setup.py 同级的顶级目录下，setuptools 会自动读取该文件。

关于依赖包下载安装

from setuptools import setup, find_packages


setup(
	...
    
    # 代表当前模块依赖哪些包，若环境中没有，则会从pypi中下载安装
    install_requires=['docutils>=0.3'],
    
    # setup.py 自己要依赖的包，这一般是为一些setuptools的插件准备的配置
    # 这里列出的包，不会自动安装。
    setup_requires=['pbr'],
    
    # 仅在测试时须要使用的依赖，在正常发布的代码中是没有用的。
    # 在执行python setup.py test时，能够自动安装这三个库，确保测试的正常运行。
    tests_require=[
        'pytest>=3.3.1',
        'pytest-cov>=2.5.1',
    ],
    
    # 用于安装setup_requires或tests_require里的软件包
    # 这些信息会写入egg的 metadata 信息中
    dependency_links=[
        "http://example2.com/p/foobar-1.0.tar.gz",
    ],
    
    # install_requires 在安装模块时会自动安装依赖包
    # 而 extras_require 不会，这里仅表示该模块会依赖这些包
    # 可是这些包一般不会使用到，只有当你深度使用模块时，才会用到，这里须要你手动安装
    extras_require={
        'PDF':  ["ReportLab>=1.2", "RXP"],
        'reST': ["docutils>=0.3"],
    }
)

关于 install_requires， 有如下五种经常使用的表示方法：

  1. 'argparse'，只包含包名。 这种形式只检查包的存在性，不检查版本。 方便，但不利于控制风险。
  2. 'setuptools==38.2.4'，指定版本。 这种形式把风险降到了最低，确保了开发、测试与部署的版本一致，不会出现意外。 缺点是不利于更新，每次更新都须要改动代码。
  3. 'docutils >= 0.3'，这是比较经常使用的形式。 当对某个库比较信任时，这种形式能够自动保持版本为最新。
  4. 'Django >= 1.11, != 1.11.1, <= 2'，这是比较复杂的形式。 如这个例子，保证了Django的大版本在1.11和2之间，也即1.11.x；而且，排除了已知有问题的版本1.11.1（仅举例）。 对于一些大型、复杂的库，这种形式是最合适的。
  5. 'requests[security, socks] >= 2.18.4'，这是包含了额外的可选依赖的形式。 正常安装requests会自动安装它的install_requires中指定的依赖，而不会安装security和socks这两组依赖。 这两组依赖是定义在它的extras_require中。 这种形式，用在深度使用某些库时。

关于安装环境的限制

有些库并非在因此的 Python 版本中都适用的，若一个库安装在一个未兼容的 Python 环境中，理论上不该该在使用时才报错，而应该在安装过程就使其失败，提示禁止安装。

这样的功能，可使用 python_requires 来实现。

setup(
    ...
    python_requires='>=2.7, <=3',
)

生成可执行文件的分发

from setuptools import setup, find_packages


setup(
    name="mytest",
    version="1.0",
    author="wangbm",
    author_email="wongbingming@163.com",
    description="Learn to Pack Python Module",
    url="http://python-online.cn/", 
    packages=find_packages(),
   
    # 用来支持自动生成脚本，安装后会自动生成 /usr/bin/foo 的可执行文件
    # 该文件入口指向 foo/main.py 的main 函数
    entry_points={
        'console_scripts': [
            'foo = foo.main:main'
        ]
    },
    
    # 将 bin/foo.sh 和 bar.py 脚本，生成到系统 PATH中
    # 执行 python setup.py install 后
    # 会生成 如 /usr/bin/foo.sh 和 如 /usr/bin/bar.py
    scripts=['bin/foo.sh', 'bar.py']
)

上面的 scripts 里有的脚本中有 sh 和 py 后缀，那么安装后，setuptools 会原封不动的移动到 /usr/bin 中，并添加可执行权限。

若你想对这些文件再做一些更改，好比去掉多余的后缀，能够这样作

from setuptools.command.install_scripts import install_scripts

class InstallScripts(install_scripts):

    def run(self):
        setuptools.command.install_scripts.install_scripts.run(self)

        # Rename some script files
        for script in self.get_outputs():
            if basename.endswith(".py") or basename.endswith(".sh"):
                dest = script[:-3]
            else:
                continue
            print("moving %s to %s" % (script, dest))
            shutil.move(script, dest)

setup(
    ...
    scripts=['bin/foo.sh', 'bar.py'],
    
    cmdclass={
        "install_scripts": InstallScripts
    }
)

ext_modules

ext_modules 参数用于构建 C 和 C++ 扩展扩展包。其是 Extension 实例的列表，每个 Extension 实例描述了一个独立的扩展模块，扩展模块能够设置扩展包名，头文件、源文件、连接库及其路径、宏定义和编辑参数等。如：

setup(
    # other arguments here...
    ext_modules=[
        Extension('foo',
                  glob(path.join(here, 'src', '*.c')),
                  libraries = [ 'rt' ],
                  include_dirs=[numpy.get_include()])
    ]
)

详细了解可参考：https://docs.python.org/3.6/distutils/setupscript.html#preprocessor-options

setup.py 的参数很是多，可以不借助文档写好一个setup.py好像没那么简单。为了备忘，我整理了 setup 函数经常使用的一些参数：

更多参数可见：https://setuptools.readthedocs.io/en/latest/setuptools.html

8. 打包辅助神器PBR 是什么？

pbr 是 setuptools 的辅助工具，最初是为 OpenStack 开发(https://launchpad.net/pbr)，基于d2to1。

pbr 会读取和过滤setup.cfg中的数据，而后将解析后的数据提供给 setup.py 做为参数。包含以下功能：

  1. 从git中获取Version、AUTHORS and ChangeLog信息
  2. Sphinx Autodoc。pbr 会扫描project，找到全部模块，生成stub files
  3. Requirements。pbr会读取requirements.txt，生成setup函数须要的install_requires/tests_require/dependency_links

这里须要注意，在 requirements.txt 文件的头部可使用：--index https://pypi.python.org/simple/，这一行把一个抽象的依赖声明如 requests==1.2.0 转变为一个具体的依赖声明 requests 1.2.0 from pypi.python.org/simple/

  1. long_description。从README.rst, README.txt or README file中生成long_description参数

使用pbr很简单：

from setuptools import setup

setup(
    setup_requires=['pbr'],
    pbr=True,
)

使用pbr时，setup.cfg中有一些配置。在[files]中，有三个key： packages:指定须要包含的包，行为相似于setuptools.find_packages namespace_packages:指定namespace packages data_files: 指定目的目录和源文件路径，一个示例：

[files]
data_files =
    etc/pbr = etc/pbr/*
    etc/neutron =
        etc/api-paste.ini
        etc/dhcp-agent.ini
    etc/init.d = neutron.init

[entry_points] 段跟 setuptools 的方式相同。

到此，我讲了三种编写使用 setup.py 的方法

  • 使用命令行参数指定，一个一个将参数传递进去（极不推荐）
  • 在 setup.py 中的setup函数中指定（推荐使用）
  • 使用 pbr ，在 setup.cfg 中指定（易于管理，更推荐）

9. 如何使用 setup.py 构建包

一、构建源码发布包。

用于发布一个 Python 模块或项目，将源码打包成 tar.gz （用于 Linux 环境中）或者 zip 压缩包（用于 Windows 环境中）

$ python setup.py sdist

那这种包如何安装呢？

答案是，使用下一节即将介绍的 setuptools 中提供的 easy_install 工具。

$ easy_install xxx.tar.gz

使用 sdist 将根据当前平台建立默认格式的存档。在类 Unix 平台上，将建立后缀后为 .tar.gz 的 gzip 压缩的tar文件分发包，而在Windows上为 ZIP 文件。

固然，你也能够经过指定你要的发布包格式来打破这个默认行为

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

你能够指定的格式有哪些呢？

建立一个压缩的tarball和一个zip文件。可用格式为：

对以上的格式，有几点须要注意一下：

  • 在版本3.5中才添加了对 xztar 格式的支持
  • zip 格式须要你事先已安装相应的模块：zip程序或zipfile模块（已成为Python的标准库）
  • ztar 格式正在弃用，请尽可能不要使用

另外，若是您但愿归档文件的全部文件归root拥有，能够这样指定

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

二、构建二进制分发包。

在windows中咱们习惯了双击 exe 进行软件的安装，Python 模块的安装也一样支持 打包成 exe 这样的二进制软件包。

$ python setup.py bdist_wininst

而在 Linux 中，你们也习惯了使用 rpm 来安装包，对此你可使用这条命令实现 rpm 包的构建

$ python setup.py bdist_rpm

若你喜欢使用 easy_install 或者 pip 来安装离线包。你能够将其打包成 egg 包

$ python setup.py bdist_egg

若你的项目，须要安装多个平台下，既有 Windows 也有 Linux，按照上面的方法，多种格式咱们要执行屡次命令，为了方便，你能够一步到位，执行以下这条命令，便可生成多个格式的进制包

$ python setup.py bdist

10. 如何使用 setup.py 安装包

正常状况下，咱们都是经过以上构建的源码包或者二进制包进行模块的安装。

但在编写 setup.py 的过程当中，可能不能一步到位，须要屡次调试，这时候如何测试本身写的 setup.py 文件是可用的呢？

这时候你可使用这条命令，它会将你的模块安装至系统全局环境中

$ python setup.py install

如若你的项目还处于开发阶段，频繁的安装模块，也是一个麻烦事。

这时候你可使用这条命令安装，该方法不会真正的安装包，而是在系统环境中建立一个软连接指向包实际所在目录。这边在修改包以后不用再安装就能生效，便于调试。

$ python setup.py develop

11. 如何发布包到 PyPi？

经过上面的学习，你必定已经学会了如何打包本身的项目，若你以为本身开发的模块很是不错，想要 share 给其余人使用，你能够将其上传到 PyPi （Python Package Index）上，它是 Python 官方维护的第三方包仓库，用于统一存储和管理开发者发布的 Python 包。

若是要发布本身的包，须要先到 pypi 上注册帐号。而后建立 ~/.pypirc 文件，此文件中配置 PyPI 访问地址和帐号。如的.pypirc文件内容请根据本身的帐号来修改。

典型的 .pypirc 文件

[distutils]
index-servers = pypi

[pypi]
username:xxx
password:xxx

而后使用这条命令进行信息注册，完成后，你能够在 PyPi 上看到项目信息。

$ python setup.py register

注册完了后，你还要上传源码包，别人才使用下载安装

$ python setup.py upload

或者也可使用 twine 工具注册上传，它是一个专门用于与 pypi 进行交互的工具，详情能够参考官网：https://www.ctolib.com/twine.html，这里不详细讲了。

参考文章

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程