Python使用setup.py打包成库供别的模块调用

曾经终败给现在 2021-10-29 07:10 385阅读 0赞

## 一、setup.py 文件的编写 ##

[http://blog.konghy.cn/2018/04/29/setup-dot-py/][http_blog.konghy.cn_2018_04_29_setup-dot-py]

## 二、实操过程 ##

1.创建python项目bricewulib

![在这里插入图片描述][20190819180122922.png]  
2.新建test\_package包并创建info1类以及print\_hello方法  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2_size_16_color_FFFFFF_t_70]  
3.为了让包的结构再复杂点，我们再在test\_package下面新建一个test\_package2包并创建Info2类以及print\_hello2方法（注意：这里是Info2，不是上面的Info1）  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2_size_16_color_FFFFFF_t_70 1]  
4.此时整个test\_package编写完成，目录结构（test\_package包包含test\_package2包以及info1类，test\_package2包中又包含info2类）  
![在这里插入图片描述][20190819180219851.png]  
5.编写:setup.py，注意：setup.py与test\_package包同在bricewulib根目录下，而setup.py中的内容如下图  
其中比较重要的几项是:`name,version,packages`

name:描述的是你打包的文件文件名。
    version描述的是文件的版本号。
    packages是所有要打包的包（package），这里需要打包的是test_package包以及test_package包下的test_package2。所以packages=[‘test_package’,‘test_package.test_package2’]。包与包之间用逗号“ ，”隔开

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2_size_16_color_FFFFFF_t_70 2]  
6.命令:`python setup.py sdist` 为模块创建一个源码包（linux下的命令，windows下自寻上网查询或见此博客的参考链接）  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2_size_16_color_FFFFFF_t_70 3]  
7.多了一个MANIFEST文件以及文件夹dist，而我们的源码包就在dist文件夹下面  
![在这里插入图片描述][20190819180328557.png]  
8.我们将其解压得到文件夹bricewulib-1.0，并进入文件夹bricewulib-1.0  
![在这里插入图片描述][20190819180334174.png]  
9.到bricewulib-1.0目录下执行:sudo python setup.py install进行库的安装  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2_size_16_color_FFFFFF_t_70 4]  
10.此时，我们的/usr/local/lib/python2.7/dist-packages/目录下会多出一个文件bricewulib-1.0.egg-info和文件夹test\_package，如图（从上面的安装信息也可以看出）：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2_size_16_color_FFFFFF_t_70 5]  
11.进入文件夹test\_package可以看到，这里的文件即是我们的源码：  
![在这里插入图片描述][2019081918042778.png]  
12.至此打包完成。  
13.新建mytest项目来调用test\_package包，依次通过 Info1.print\_hello()，Info2.print\_hello2()方法分别调用  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2_size_16_color_FFFFFF_t_70 6]

## 二、部分疑问： ##

**1、在setup.py文件中要对所用的包挨个写上么？**  
答：（1）在工程中包比较少的情况下可以对每个包，挨个写上，如果多的话，则使用`find_package()`例如：

setup(
        name='mmdet',
        version=get_version(),
        description='Open MMLab Detection Toolbox',
        long_description=readme(),
        keywords='computer vision, object detection',
        url='https://github.com/open-mmlab/mmdetection',
        packages=find_packages(exclude=('configs', 'tools', 'demo')),
        package_data={'mmdet.ops': ['*/*.so']},
        classifiers=[
            'Development Status :: 4 - Beta',
            'License :: OSI Approved :: Apache Software License',
            'Operating System :: OS Independent',
            'Programming Language :: Python :: 2',
            'Programming Language :: Python :: 2.7',
            'Programming Language :: Python :: 3',
            'Programming Language :: Python :: 3.4',
            'Programming Language :: Python :: 3.5',
            'Programming Language :: Python :: 3.6',
        ],
        license='GPLv3',
        setup_requires=['pytest-runner'],
        tests_require=['pytest'],
        install_requires=[
            'mmcv', 'numpy', 'matplotlib', 'six', 'terminaltables',
            'pycocotools'
        ],
        zip_safe=False)

其中`packages=find_packages(exclude=('configs', 'tools', 'demo')),` 的excluce表示，除了这几个文件之外，其他的与setup.py文件相同目录下的文件夹中包含\_\_init\_\_.py文件的均为包，自动打包，不必挨个写上。  
（2）、不论是上述例程中的包内之间的嵌套还是在同一级的关系上，必须均在`package`中写上，否则不能进行打包！

[http_blog.konghy.cn_2018_04_29_setup-dot-py]: http://blog.konghy.cn/2018/04/29/setup-dot-py/
[20190819180122922.png]: /images/20211029/93a62100a5134acc99b9800a496fd680.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2_size_16_color_FFFFFF_t_70]: /images/20211029/bbf56646b5e5419980f31dd3ff8b1abc.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2_size_16_color_FFFFFF_t_70 1]: /images/20211029/bb8dfae7c647424b964134ca6c78ff4f.png
[20190819180219851.png]: /images/20211029/596bc341c3d745899bb8733f722bc72a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2_size_16_color_FFFFFF_t_70 2]: /images/20211029/78c4cbb022df4639bdb1672d68e527df.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2_size_16_color_FFFFFF_t_70 3]: /images/20211029/1ef02f31882242aaa326aac55053fec3.png
[20190819180328557.png]: /images/20211029/1228c96f3b454718b45f8274d2991cc5.png
[20190819180334174.png]: /images/20211029/40460ad0afdc498ab94d0b512c9f18fb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2_size_16_color_FFFFFF_t_70 4]: /images/20211029/b4459e9b7d4e483c942a819d485a2b2d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2_size_16_color_FFFFFF_t_70 5]: /images/20211029/8964d1c3348e4d5196fece91ba30c2f4.png
[2019081918042778.png]: /images/20211029/039090e9e001420b893322352b16eea9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2_size_16_color_FFFFFF_t_70 6]: /images/20211029/2700f858940845d3912fc812ac419834.png