Python 制作、发布与安装模块

悠悠 2022-10-16 11:29 170阅读 0赞

### 文章目录 ###

*  1. 按
 *  2. 设置模块（.py文件）和包（文件夹）
 *   *  2.1. 创建目录和文件
     *  2.2. 设置setup.py文件的内容
     *  2.3. 设置test.py文件的内容
     *  2.4. 设置\\\_\_init\_\_文件的内容
 *  3. 本地使用
 *   *  3.1. 构建模块
     *  3.2. 安装模块
     *  3.3. 卸载模块
 *  4. 联机使用
 *   *  4.1. 生成requirements.txt
     *  4.2. 打包成wheel文件
     *  4.3. 上传到\[PyPI\](https://pypi.org/)
     *  4.4. 安装模块
     *  4.5. 卸载
 *  5. 参考

# 1. 按 #

本文包含使用Python制作、发布及安装模块的所有内容说明：首先在**2. 设置模块（.py文件）和包（文件夹）中介绍了我所使用的测试包里.py文件的架构及其内容，其次在3. 本地使用**中介绍了如何在本地构建及安装卸载自定义的模块，最后在**4. 联机使用**中介绍了如何将自定义的模块发布成`.whl`文件并上传至PyPI网站以供他人使用自己所发布的模块。

# 2. 设置模块（.py文件）和包（文件夹） #

## 2.1. 创建目录和文件 ##

1.  新建`pacc`文件夹
2.  在`pacc`文件夹中新建一个`setup.py`文件和一个`pacc`文件夹
3.  在`pacc/pacc`文件夹中创建`test.py`和`__init__.py`文件

该目录的整体结构如下两种树形图所示：

└─pacc
        │  setup.py
        │
        └─pacc
                test.py
                __init__.py

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NPQ081Ng_size_16_color_FFFFFF_t_70]

获取此项目的完整源码请访问：[https://github.com/cocos56/pacc][https_github.com_cocos56_pacc]

## 2.2. 设置setup.py文件的内容 ##

`setup.py`是用来安装模块用的，里面需要设置一些与模块有关的信息，以下是我设置的内容：

from setuptools import setup, find_packages
    
    setup(
        name='pacc',  # 包名
        version='0.0.0',  # 版本
        packages=find_packages(),  # 目录下所有文件
        description='Python Android Cluster Control 为使用Python对安卓集群控制进行支持',  # 描述信息
        long_description='安卓集群控制系统模块，包含对ADB、数据库、图像识别、验证码破解等功能的封装',  # 完整的描述信息
        author='Coco',  # 作者
        author_email='zj175@139.com',  # 作者邮箱
        url='https://github.com/cocos56/pacc',  # 主页
    )

## 2.3. 设置test.py文件的内容 ##

def t():
        print('test.py')

## 2.4. 设置\_\_init\_\_文件的内容 ##

`__init__.py`是要想让一个文件夹成为包的必须的文件！这个文件可以为空，但是必须得有。我们可以把其他模块里的变量导入进来，代码如下：

from pacc.test import t

另外也可以使用`__all__`变量来指定自己所要导出的特定变量：

from pacc.test import t
    
    
    __all__ = ["t",
               ]

# 3. 本地使用 #

## 3.1. 构建模块 ##

在CMD或Power Shell中先将工作目录设为`cluster`文件夹所在的目录，然后运行：

python3 .\setup.py build

## 3.2. 安装模块 ##

python3 .\setup.py install

## 3.3. 卸载模块 ##

pip3 uninstall cluster -y

# 4. 联机使用 #

## 4.1. 生成requirements.txt ##

如果你的模块需要用到其他模块的话，则应生成requirements.txt文件，请参考：[如何使用PyCharm自动生成requirements.txt][PyCharm_requirements.txt]

## 4.2. 打包成wheel文件 ##

1.  需要先安装`wheel`，否则会提示：`error: invalid command 'bdist_wheel'`
    
        pip3 install wheel
2.  运行：
    
        python3 .\setup.py bdist_wheel
3.  在`dist`目录中你会发现多一个whl文件  
    ![在这里插入图片描述][20210601195038143.png]

## 4.3. 上传到[PyPI][] ##

1.  参考本文的**4.2. 打包成wheel文件**先打包成wheel文件
2.  安装`twine`
    
        pip3 install twine
3.  检查你想要使用的包名是否已经被别人注册，如我这里检测[`pacc`https://pypi.org/project/pacc/][pacc_https_pypi.org_project_pacc]时发现没有被人注册  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NPQ081Ng_size_16_color_FFFFFF_t_70 1]
4.  进入到`pacc`目录运行命令`twine upload dist/文件名`上传dist目录下的某个指定的文件，或者使用`twine upload dist/*`上传dist目录下的所有文件。输完上传命令后，需要再输入一下你在PyPI上的账号及其对应的密码：
    
        twine upload dist/*
    
    如果经常上传，且不想每次都输入账号和密码的话，则可以参考：[twine upload设置账号和密码，避免每次都输账号和密码][twine upload]
5.  上传成功会提示让你查看，如我的[https://pypi.org/project/pacc/0.0.0/][https_pypi.org_project_pacc_0.0.0]  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NPQ081Ng_size_16_color_FFFFFF_t_70 2]

## 4.4. 安装模块 ##

pip3 install pacc

## 4.5. 卸载 ##

pip3 uninstall pacc -y

# 5. 参考 #

*  [https://zhuanlan.zhihu.com/p/102265858][https_zhuanlan.zhihu.com_p_102265858]
 *  [https://www.cnblogs.com/zhangjialu2015/p/5173313.html][https_www.cnblogs.com_zhangjialu2015_p_5173313.html]
 *  [https://jingyan.baidu.com/article/ea24bc39d8497eda62b3313a.html][https_jingyan.baidu.com_article_ea24bc39d8497eda62b3313a.html]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NPQ081Ng_size_16_color_FFFFFF_t_70]: /images/20221014/613352e8c5fe4acb93396bd647e7f5bb.png
[https_github.com_cocos56_pacc]: https://github.com/cocos56/pacc
[PyCharm_requirements.txt]: https://coco56.blog.csdn.net/article/details/117452383
[20210601195038143.png]: /images/20221014/aa97b976438f49b0b4726a7b0b1567c5.png
[PyPI]: https://pypi.org/
[pacc_https_pypi.org_project_pacc]: https://pypi.org/project/pacc/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NPQ081Ng_size_16_color_FFFFFF_t_70 1]: /images/20221014/46531575f9c3469eaff3545e399dd3de.png
[twine upload]: https://coco56.blog.csdn.net/article/details/117450936
[https_pypi.org_project_pacc_0.0.0]: https://pypi.org/project/pacc/0.0.0/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NPQ081Ng_size_16_color_FFFFFF_t_70 2]: /images/20221014/2675d900b0c641458aaa6c283c4189b5.png
[https_zhuanlan.zhihu.com_p_102265858]: https://zhuanlan.zhihu.com/p/102265858
[https_www.cnblogs.com_zhangjialu2015_p_5173313.html]: https://www.cnblogs.com/zhangjialu2015/p/5173313.html
[https_jingyan.baidu.com_article_ea24bc39d8497eda62b3313a.html]: https://jingyan.baidu.com/article/ea24bc39d8497eda62b3313a.html