如何使用 pip 和 PyPI 安装 Python 模块单个文件？

Posted 2023-02-23

【中文标题】如何使用 pip 和 PyPI 安装 Python 模块单个文件？

【英文标题】：How can a Python module single file be installed using pip and PyPI?

【发布时间】：2022-01-10 18:08:21

【问题描述】：

我正在尝试学习如何通过 PyPI 上的 pip 使 Python 模块可用。为了做到这一点，我正在使用 PyPI 测试站点 (https://testpypi.python.org/pypi) 进行测试，并尝试为模块创建一个 setup.py。我的模块是根目录中的一个文件，我无法成功安装它。我想知道如何做到这一点。

下面，我详细介绍了我正在采取的步骤。我怀疑问题出在我写setup.py的方式上。

存储库的解剖结构如下：

.
├── examples_1.py
├── LICENSE
├── MANIFEST.in
├── README.rst
├── setup.py
└── supermodule.py

请注意，模块只是目录根目录下的文件supermodule.py。另请注意，文件examples_1.py不包含在模块包的安装中。

setup.py的内容如下：

#!/usr/bin/python
# -*- coding: utf-8 -*-

import os
import setuptools

def read(*paths):

    with open(os.path.join(*paths), "r") as filename:
        return filename.read()

def main():

    setuptools.setup(
        name             = "supermodule",
        version          = "2015.10.30.0820",
        description      = "super utilities",
        long_description = (read("README.rst")),
        url              = "https://github.com/johndrake1/junk",
        author           = "John Drake",
        author_email     = "[e-mail]",
        license          = "GPLv3",
        package_data     = 
            "": [
                "*.txt",
                "*.md",
                "*.rst",
                "*.py"
            ]
        
    )

if __name__ == "__main__":
    main()

我通过以下程序注册、上传和安装包：

python setup.py register -r https://testpypi.python.org/pypi
python setup.py sdist upload -r https://testpypi.python.org/pypi
sudo pip install -i https://testpypi.python.org/pypi supermodule

在源代码分发中，supermodule-2015.10.30.0820.tar.gz，我可以看到以下目录结构：

.
└── supermodule-2015.10.30.0820
    ├── LICENSE
    ├── MANIFEST.in
    ├── PKG-INFO
    ├── README.rst
    ├── setup.cfg
    ├── setup.py
    ├── supermodule.egg-info
    │   ├── dependency_links.txt
    │   ├── PKG-INFO
    │   ├── SOURCES.txt
    │   └── top_level.txt
    └── supermodule.py

因此，打包和上传似乎工作正常，并且包含位于根目录的模块文件supermodule.py。但是，当我安装软件包时，我会在本地安装以下文件：

/usr/local/lib/python2.7/dist-packages/supermodule-2015.10.30.0820.dist-info
/usr/local/lib/python2.7/dist-packages/supermodule-2015.10.30.0820.dist-info/DESCRIPTION.rst
/usr/local/lib/python2.7/dist-packages/supermodule-2015.10.30.0820.dist-info/METADATA
/usr/local/lib/python2.7/dist-packages/supermodule-2015.10.30.0820.dist-info/RECORD
/usr/local/lib/python2.7/dist-packages/supermodule-2015.10.30.0820.dist-info/WHEEL
/usr/local/lib/python2.7/dist-packages/supermodule-2015.10.30.0820.dist-info/metadata.json
/usr/local/lib/python2.7/dist-packages/supermodule-2015.10.30.0820.dist-info/top_level.txt

您可以看到文件supermodule.py 不存在并且无法在Python 实例中导入。我应该怎么做才能将此文件包含在安装中，以便它可以在 Python 中导入？

---

编辑：根据@DeanFenster 的建议，我将文件supermodule.py 移动到supermodule/__init__.py 并将setup.py 更改为以下内容：

#!/usr/bin/python
# -*- coding: utf-8 -*-

import os
import setuptools

def read(*paths):
    with open(os.path.join(*paths), "r") as filename:
        return filename.read()

def main():

    setuptools.setup(
        name             = "supermodule",
        version          = "2015.10.30.0902",
        description      = "super utilities",
        long_description = (read("README.rst")),
        url              = "https://github.com/johndrake1/junk",
        author           = "John Drake",
        author_email     = "[e-mail]",
        license          = "GPLv3",
        packages         = ["supermodule"]
    )

if __name__ == "__main__":
    main()

在注册、上传和安装之后，这导致安装使模块可导入，并在本地安装以下文件：

/usr/local/lib/python2.7/dist-packages/supermodule
/usr/local/lib/python2.7/dist-packages/supermodule-2015.10.30.0902.dist-info
/usr/local/lib/python2.7/dist-packages/supermodule/__init__.py
/usr/local/lib/python2.7/dist-packages/supermodule/__init__.pyc
/usr/local/lib/python2.7/dist-packages/supermodule-2015.10.30.0902.dist-info/DESCRIPTION.rst
/usr/local/lib/python2.7/dist-packages/supermodule-2015.10.30.0902.dist-info/METADATA
/usr/local/lib/python2.7/dist-packages/supermodule-2015.10.30.0902.dist-info/RECORD
/usr/local/lib/python2.7/dist-packages/supermodule-2015.10.30.0902.dist-info/WHEEL
/usr/local/lib/python2.7/dist-packages/supermodule-2015.10.30.0902.dist-info/metadata.json
/usr/local/lib/python2.7/dist-packages/supermodule-2015.10.30.0902.dist-info/top_level.txt

这种方法很好用，但我还是想知道当模块是单个文件的形式时如何安装。

---

编辑：根据@Xk0nSid 的建议，我将setup.py 更改为以下内容：

#!/usr/bin/python
# -*- coding: utf-8 -*-

import os
import setuptools

def read(*paths):
    with open(os.path.join(*paths), "r") as filename:
        return filename.read()

def main():

    setuptools.setup(
        name             = "supermodule",
        version          = "2015.10.30.1001",
        description      = "super utilities",
        long_description = (read("README.rst")),
        url              = "https://github.com/johndrake1/junk",
        author           = "John Drake",
        author_email     = "[e-mail]",
        license          = "GPLv3",
        py_modules       = ["supermodule"],
        entry_points     = """
            [console_scripts]
            supermodule = supermodule:supermodule
        """
    )

if __name__ == "__main__":
    main()

在注册、上传和安装之后，这导致安装使模块可导入，并在本地安装以下文件：

/usr/local/bin/supermodule
/usr/local/lib/python2.7/dist-packages/supermodule-2015.10.30.1001.dist-info
/usr/local/lib/python2.7/dist-packages/supermodule.py
/usr/local/lib/python2.7/dist-packages/supermodule.pyc
/usr/local/lib/python2.7/dist-packages/supermodule-2015.10.30.1001.dist-info/DESCRIPTION.rst
/usr/local/lib/python2.7/dist-packages/supermodule-2015.10.30.1001.dist-info/METADATA
/usr/local/lib/python2.7/dist-packages/supermodule-2015.10.30.1001.dist-info/RECORD
/usr/local/lib/python2.7/dist-packages/supermodule-2015.10.30.1001.dist-info/WHEEL
/usr/local/lib/python2.7/dist-packages/supermodule-2015.10.30.1001.dist-info/entry_points.txt
/usr/local/lib/python2.7/dist-packages/supermodule-2015.10.30.1001.dist-info/metadata.json
/usr/local/lib/python2.7/dist-packages/supermodule-2015.10.30.1001.dist-info/top_level.txt

这种方法成功地处理了模块的单个文件形式。

【问题讨论】：

模块是否存在于site_packages目录下？

@DeanFenster 嘿，感谢您的评论。不，安装后该模块在目录/usr/local/lib/python2.7/dist-packages 中不存在。我的问题中列出的目录是 supermodule 似乎存在的唯一目录。

试着把你的脚本放在一个包里怎么样？ （带有项目名称和__init__ 文件中代码的文件夹）

@DeanFenster 感谢您的建议。我刚刚尝试了您的方法，并添加了该方法的详细信息来编辑问题。使用这种方法，包可以成功安装并且可以在 Python 中导入。所以，很高兴知道这是有效的。我仍然想知道如何安装单个文件形式的模块。

【参考方案1】：

尝试对单个文件使用类似的内容。以下是目录结构：

.
├── example.py
├── LICENSE
├── README.md
└── setup.py

0 directories, 4 files

setup.py

from setuptools import setup

setup(
    name='example',
    version='0.1.0',
    py_modules=['example'],
    install_requires=[
        'exampledep',
    ],
    entry_points='''
        [console_scripts]
        example=example:example
    ''',
)

以上对我有用。这就是示例文件的样子。

def example():
    # Note: You can use sys.argv here
    print "Hi! I'm a command written in python."

也可以这样导入：

import example
example.example()
# or
from example import example
example()

希望这会有所帮助。

安装要求

install_requires 用于为您的模块/应用程序定义dependencies。例如，在这种情况下，example 模块依赖于exampledep。因此，当有人执行pip install example 时，pip 也会安装 exampledep，因为它在依赖项中列出。

入口点

这通常是包的最终用户可能想要使用的可调用对象。这通常是可调用的，用于命令行。您可以查看this question 或this doc 了解更多详情。

【讨论】：

太好了，感谢您的帮助。这似乎工作成功。您认为您可以在选项install_requires 和entry_points 上添加一些小细节吗？我对此很陌生。 pythonhosted.org/setuptools/…>

当然。我已经用一些解释更新了答案，提供了几个链接供参考。

谢谢，这行对我帮助很大 py_modules=['example']