6

Python Cookbook为“典型的库包”建议了以下树结构：

projectname/
    README.txt
    Doc/
        documentation.txt
    projectname/
        __init__.py
        foo.py
        bar.py
        utils/
            __init__.py
            spam.py
            grok.py
    examples/
        helloworld.py

您会注意到examples/不是实际包的一部分，它位于下面projectname/projectname/（您可以在其中找到包的顶层__init__.py）。

嗯，examples/helloworld.py显然需要导入projectname包。

我知道 StackOverflow 中至少有 2-3 个相关问题。我不认为这是重复的，因为其他问题要么涉及包内导入，要么涉及从另一个 python 模块导入一个 python 模块的一般情况，当它们不位于同一目录中时。我在打包库时特别要求建议的方法来执行此操作。

有没有办法在不修改路径的情况下实现这一点？如果修改路径是唯一的方法，有没有办法以优雅的方式完成？

让我详细说明最后一点。在Kenneth Reitz 的Repository Structure and Pythontests/中，出现了类似的结构，用examples/. 这是完全相同的问题。他建议使用“简单（但明确）的路径修改来正确解析包”。好的，但这是实际代码：

import os
import sys
sys.path.insert(0, os.path.abspath('..'))

我真的不喜欢这个..部分。我希望有一个更通用的解决方案，希望可以从我选择运行示例（或测试）的任何目录中工作。

4

1 回答 1

3

虽然文件夹树看起来不错，但我认为从开发人员的角度和用户的角度来看，隐含地假设模块可用于导入是错误的。

确实，您可以在技术上使用sys.path.insert(0, os.path.abspath('..'))为 python 添加任何路径以允许从中导入，但这意味着您，开发人员，必须确保添加的路径始终位于正确的位置。

用户安装软件包以使用它们是很常见的。开发人员有一个清晰的工作流程：

  1. 安装了 pip 和 virtualenv（甚至更好的是 virtualenvwrapper）
  2. 使用 pip 的-e标志以可编辑模式安装包，这意味着您对代码所做的任何更改都将直接影响执行。每次更改代码时都不必重新安装。
  3. 由于您的代码始终被安装（特别是在site-packages作为用户但在您开发时处于可编辑模式），您始终可以使用任何示例或测试中的显式名称导入您的包。

一个常见的工作流程：

$ pip install virtualenv
...
$ virtualenv distro
New python executable in /home/nir0s/work/distro/bin/python3
Also creating executable in /home/nir0s/work/distro/bin/python
Installing setuptools, pip, wheel...done.

$ source distro/bin/activate

# install in editable mode
$ pip install -e ~/repos/nir0s/distro/
Obtaining file:///home/nir0s/repos/nir0s/distro
Installing collected packages: distro
  Running setup.py develop for distro
Successfully installed distro

(distro) $ pip freeze
appdirs==1.4.3
-e git+git@github.com:nir0s/distro@e8a182f9d1dbe6391f25...#egg=distro
packaging==16.8
pyparsing==2.2.0
six==1.10.0

以可编辑模式安装的包意味着有一个指向包目录的 egg-link 文件：

$ cat distro/lib/python3.6/site-packages/distro.egg-link 
/home/nir0s/repos/nir0s/distro

用户将在不处理可编辑模式的情况下做同样的事情。只需创建虚拟环境并在其中安装软件包。然后，当他们完成工作时，他们将删除这些虚拟环境。十分简单。

于 2017-03-14T18:16:56.103 回答