Python에서 setup.py 파일을 사용하는 방법은 무엇입니까?

1. 프로젝트를 배포하고 패키징해야 하는 이유는 무엇인가요?

보통 우리는 일부 타사 모듈을 설치하기 위해 pip를 사용하는 데 익숙합니다. 이 설치 과정이 간단한 이유는 모듈 개발자가 모든 복잡한 작업을 자동으로 수행하기 때문입니다. 그리고 이 과정이 포장입니다.

패키징이란 소스 코드를 더욱 캡슐화하고 모든 배포 작업을 미리 정리하여 사용자가 배포 방법에 대해 걱정할 필요 없이(비교를 원하지 않는 경우) 배포 방법을 걱정할 필요 없이 받은 후 즉시 설치하고 사용할 수 있도록 하는 것입니다. 문서를 수동으로 배포하는 경우).

Python은 수년간 개발되어 왔으며 프로젝트 패키징 도구도 매우 성숙해졌습니다. 그것들은 무엇인가요?

disutils, distutils, distutils2, setuptools 등에 대해 들어보셨을 것입니다. 익숙하면서도 이상하기도 합니다. 이들 사이의 관계는 무엇인가요?

2. 패키지 배포의 조상: distutils

Python의 표준 라이브러리입니다. 이름만 보면 배포 도구(utlis)임을 쉽게 알 수 있습니다. Python에서 공식적으로 개발한 배포 및 패키징 도구입니다.

distutils의 핵심은 모듈 배포 및 설치 안내 파일인 setup.py를 작성하는 데 있습니다.

그럼 setup.py는 어떻게 작성하나요? 내용이 많아서 나중에 자세히 분석해보겠습니다.

setup.py를 작성하지 않았을 수도 있지만 모듈을 설치하는 데 자주 사용하는 다음 명령과 같은 작업을 수행하기 위해 setup.py를 사용한 것은 분명합니다.

$ python setup.py install

이 설치 방법을 소스 코드 설치라고 하는데, 이는 나중에 소개할 바이너리 소프트웨어 패키지를 통한 설치에 해당합니다.

3. 배포 도구 업그레이드: setuptools

setuptools는 distutils의 향상된 버전이며 표준 라이브러리에 포함되어 있지 않습니다. 개발자가 Python 패키지를 더 잘 생성하고 배포할 수 있도록 많은 기능을 확장합니다. 대부분의 Python 사용자는 고급 setuptools 모듈을 사용합니다.

배포, 아마도 다른 곳에서 보셨을 수도 있으니 여기서 언급하겠습니다.

distribute는 setuptools에 브랜치 버전이 있다는 것입니다. 브랜치의 이유는 일부 개발자가 setuptools 개발이 너무 느리다고 생각하기 때문일 수 있습니다. 그러나 이제 배포는 setuptools로 다시 병합됩니다. 그러므로 우리는 그것들을 동일한 것으로 간주할 수 있다.

distutils2라는 대규모 패키지 배포 도구도 있는데, 이 도구는 distutils, detuptools를 최대한 활용하고 배포하여 Python 표준 라이브러리의 표준 도구가 되도록 시도합니다. 그러나 이 계획은 의도한 목적을 달성하지 못했고, 폐기된 프로젝트다.

따라서 setuptools는 우수하고 안정적인 Python 패키지 설치 및 배포 도구입니다.

pycharm을 통해 가상 환경을 생성하면 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

요약하자면: setuptools는 패키지 배포를 위해 공식적으로 제공하는 전문 도구입니다. 설치 측면에서 볼 때 그 기능은 정말 간단합니다. 더 큰 의미는 패키지 배포에 매우 유용하다는 것입니다. 사용자 정의 프로그램은 여전히 ​​버전 패키지를 출시하는 데 사용됩니다.

5. 소스 코드 패키지와 바이너리 패키지의 차이점은 무엇인가요?

Python 패키지 배포는 두 가지 유형으로 나눌 수 있습니다.

소스 코드 패키지로 게시

바이너리 패키지로 게시

소스 코드 패키지

설치 패키지를 소스 코드 패키지로 게시하는 과정은 먼저 압축을 푼 다음 컴파일하고 마지막으로 설치(위에서 언급한 python setup.py 설치)하는 것이므로 각 설치는 크로스 플랫폼이어야 합니다. 패키지 설치 방법에 비해 설치 속도가 상대적으로 느립니다.

소스 코드 패키지의 본질은 압축된 패키지입니다. 일반적인 형식은 다음과 같습니다.

바이너리 패키지 형태로 출시됨

바이너리 패키지의 설치 과정은 컴파일 과정을 생략하고 직접 압축을 풀고 설치합니다. 따라서 소스 코드 패키지의 설치 속도가 더 빠릅니다.

다양한 플랫폼용으로 컴파일된 패키지는 보편적으로 사용할 수 없기 때문에 퍼블리싱할 때 미리 여러 ​​플랫폼용으로 패키지를 컴파일해야 합니다.

바이너리 패키지의 일반적인 형식은 다음과 같습니다.

계란과 바퀴의 차이점은 무엇인가요?

Egg 형식은 2004년 setuptools에 의해 도입된 반면 Wheel 형식은 2012년 PEP427에 의해 정의되었습니다. Wheel은 Egg를 대체하기 위해 등장했습니다. 그 핵심은 현재 Python 바이너리 패키지의 표준 형식으로 간주되는 zip 패키지입니다.

다음은 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

下面进入正题：setup.py

1. 超详细讲解 setup.py 的编写

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

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

from setuptools import setup, find_packages
  setup(            
     name="mytest",     
     version="1.0",     
     author="name",     
     author_email="name@163.com",    
     # 项目地址 
     url="https://github.com/test/mytest",
     description="Learn to Pack Python Module",             
     # 你要安装的包，通过 setuptools.find_packages 自动发现当前目录下有哪些包     
     packages=find_packages()
)

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

 关于安装环境的限制

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

这可以使用 python_requires 来实现。

setup(     
    ...     
    python_requires=&#39;>=2.7, <=3&#39;, 
)

 关于依赖包下载安装

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"],    
     } 
)

 关于文件的分发

from setuptools import setup, find_packages   
setup(     
    name="mytest",    
    version="1.0",    
    author="name",    
    author_email="name@163.com",     
    description="Learn to Pack Python Module",     
    url="https://github.com/test/mytest",  
    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']                
    } 
)

关于程序分类信息

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',     
    ] 
)

2.生成可执行文件的分发

from setuptools import setup, find_packages   
setup(     
    ...   
    # 用来支持自动生成脚本，安装后会自动生成 /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  中，并添加可执行权限。

指定release

setup.py 里只能指定 version，而不能指定 release，如果你需要变更版本号，可以使用 --release 参数进行指定

python setup.py bdist_rpm --release=20200617

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

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

a、构建源码发布包。

用于发布一个 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

b、构建二进制分发包。

在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

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

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

但在编写 setup.py 的过程中，可能不能一步到位，需要多次调试，这时候如何测试自己写的 setup.py 文件是可用的呢?

这时候你可以使用python setup.py install命令，它会将你的模块安装至系统全局环境中.

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

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

$ python setup.py develop

5. 如何发布包到 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

위 내용은 Python에서 setup.py 파일을 사용하는 방법은 무엇입니까?의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!