ICode9

精准搜索请尝试: 精确搜索
首页 > 编程语言> 文章详细

打包&发布Python项目

2022-09-02 12:04:08  阅读:257  来源: 互联网

标签:依赖 package Python module python 发布 import 打包


概述
打包与发布python项目主要包含三个过程,第一配置打包信息,主要通过setuptools工具实现;第二步打包生成wheel或者sdist(source distribution)文件,主要使用build工具;第三步将打包好的wheel、或者sdist文件发布到PYPI,使用twine工具。

pip install setuptools>=42 build twine
1

配置打包信息
配置打包信息涉及的知识很多,这里仅记录以下几部分,更多信息请看参考资料。

module与package的区别
在打包项目之前,首先了解下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中的依赖管理
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\*

标签:依赖,package,Python,module,python,发布,import,打包
来源: https://www.cnblogs.com/clark1990/p/16649321.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有