概述
打包与发布python项目主要包含三个过程,第一配置打包信息,主要通过setuptools工具实现;第二步打包生成wheel或者sdist(source distribution)文件,主要使用build工具;第三步将打包好的wheel、或者sdist文件发布到PYPI,使用twine工具。
pip install setuptools>=42 build twine
?
配置打包信息
配置打包信息涉及的知识很多,这里仅记录以下几部分,更多信息请看参考资料。 ?
在打包项目之前,首先了解下Python中module与package的概念及区别。module的官方定义为**“A module is a file containing Python definitions and statements. ”,可以理解为后缀为py 的脚本。在module中定义的函数、变量等对象,可以使用import语句导入到其它mudule中使用,注意在import语句中,被导入的函数、变量及其它对象只会在第一次导入时执行,后续重复导入不会执行**。因此如果“先导入module, 然后修改module中的对象定义,然后再导入module,被修改的内容不会生效——可以通过重启python interpreter, 或者importlib.reload方式解决。”
“Note For efficiency reasons, each module is only imported once per interpreter session. Therefore, if you change your modules, you must restart the interpreter – or, if it’s just one module you want to test interactively, use importlib.reload(), e.g. import importlib; importlib.reload(modulename).”
当使用import导入module时,python对module的搜索路径为“内置库–>>sys.path”, 其中sys.path的值由以下三部分决定: - 当前所在目录。 - python环境变量PYTHONPATH, python环境变量可以通过os.environ 查看。 - 包安装的目录site-package。
package的官方定义“Packages are a way of structuring Python’s module namespace by using “dotted module names”. ”, 可以理解为package为module的集合,再加上一个__init__.py, package的目的是通过一个命名空间方便的管理module。“The__init__.py files are required to make Python treat directories containing the file as packages. ”。__init__.py一般为空,也可以包含一个__all__变量,该变量的值是一个列表,列表值为需在from package import * 中导入的module名称。
需注意,import有两种导入形式,一种是绝对路径,另一种是相对路径。在相对import中, 前置的一个句点表示current package,前置的两个句点表示parent package。 ?
setuptools包含三种依赖,第一种是系统层级的,打包python项目所必须的,一般依赖为setuptools与wheel,并且需要写入pyproject.toml文件中;第二种依赖为module正常运行所需的依赖,这种依赖在setup.py或者setup.cfg中用install_requires关键字指明,install_requires值为一个列表,列表中的值为需要安装的包及版本标识,还可以为每个包加上平台依赖条件。setuptools会自动到pypi中下载指定条件的包。如果依赖的包不在pypi,可以指定dependency_links,到指定的url去下载包。最后一种依赖是在特定条件下才需要的依赖,比如test模块中可能需要的依赖,当需要时才安装。 ?
打包时添加数据文件,或者其它格式的文件,主要有三种方式,第一种方式为在setup.py中指定include_package_data=True ,以及编写MANIFEST.in文件;第二种方式为指定关键字package_data,其值是一个字典,键为“包名称”,若为空,则匹配所有package,值为模式列表。第三种方式为exclude_package_data,语法与package_data,只是将file打包,但不安装。 ?
打包
如果是纯python项目,建议使用以下命令:python -m build --wheel 。 ?
上传至PYPI
执行上述命令后,会生成一个dist目录,该目录中包含生成的wheel文件,将该文件上传到PYPI即可, twine upload dist\*
?
参考资料
Packaging Python Projects Packaging and distributing projects Building and Distributing Packages with Setuptools Including files in source distributions with MANIFEST.in setuptools:从下载链接安装pytorch:403禁止
|