python包中的脚本

Question

我开发了 python 应用程序，我决定将其转换为软件包，以便稍后通过 easy_install 或 pip 安装。我使用搜索找到了一些有关 python 包目录结构的好资料请参阅 这个答案或这篇文章。

我创建了以下结构（我省略了列表中的几个文件以使结构更清晰）

Project/
|-- bin/
|-- my_package/
|   |-- test/
|   |   |-- __init__.py
|   |   |-- test_server.py
|   |-- __init__.py
|   |-- server.py
|   |-- util.py
|-- doc/
|   |-- index.rst
|-- README.txt
|-- LICENSE.txt
|-- setup.py           

之后我创建了可执行脚本 server-run

#!/usr/bin/env python
from my_package import server
    
server.main()

并将其放入 bin 目录中。如果我使用 python setup.py install 或通过 pip/easy_install 安装我的包，一切正常，我可以运行 server-run 和我的服务器开始处理传入的请求。

但我的问题是如何测试 server-run 在开发环境中工作（没有事先安装 my_package）？另外，我想使用此脚本来运行最新的服务器代码以用于开发目的。

开发发生在 Project 目录中，因此如果我运行 ./bin/server-run ，我会收到 ImportError

user@host:~/dev/Project/$ ./bin/server-run
Traceback (most recent call last):
  File "./bin/server-run", line 2, in <module>
    import my_package
ImportError: No module named my_package

是否可以修改 bin /server-run 脚本，因此如果我从文件系统中的另一个文件夹（不一定是从 Project 目录）运行它，它会起作用吗？另请注意，我想使用（如果可以实现）相同的脚本在生产环境中运行服务器。

Answer 1

您需要相对导入。尝试

from .. import mypackage

或

from ..mypackage import server

文档在这里

http://docs.python.org/tutorial /modules.html#intra-package-references

这些适用于 Python 2.5 或更高版本。

要仅在开发版本中执行此操作，请尝试：

try:
    from my_package import server
except ImportError:
    from ..my_package import server

Answer 2

您可以使用 virtualenv 在开发过程中测试 Python 代码，就像它一样被释放

Answer 3

最简单的方法是配置正确的 Python 路径，以便 Python 知道在当前目录中查找 my_package。

在 Linux 上（使用 Bash）：

export PYTHONPATH=.
bin/server-run

在 Windows 上：

set PYTHONPATH=.
python bin/server-run

Answer 4

现在有 console_scripts 方法。请参阅

entry_points={
      'console_scripts': [
        'wikibackup = wikibot.wikipush:mainBackup',   
        'wikiedit = wikibot.wikipush:mainEdit',
        'wikinuke = wikibot.wikipush:mainNuke',
        'wikipush = wikibot.wikipush:mainPush',
        'wikiupload = wikibot.wikipush:mainUpload',
        'wikiuser = wikibot.wikiuser:main',
      ],
    },

https://pypi.org/project/py-3rdparty-mediawiki/ （我是提交者）。

如果您对该软件包进行 pip 安装，上述脚本将作为安装过程的一部分进行安装。

请参阅 https://github.com/WolfgangFahl/py-3rdparty -mediawiki/blob/master/setup.py 获取安装脚本的完整源代码。