Question

我有一个结构如下的项目：

project
├── api
│   ├── __init__.py
│   └── api.py
├── instance
│   ├── __init__.py
│   └── config.py
├── package
│   ├── __init__.py
│   └── app.py
├── requirements.txt
└── tests
    └── __init__.py

我正尝试从config.py调用package/app.py文件，如下所示：

# package/app.py
from instance import config

# I've also tried
import instance.config
import ..instance.config
from ..instance import config

但是我总是收到以下错误：

Traceback (most recent call last):
  File "/home/csymvoul/projects/project/package/app.py", line 1, in <module>
    from instance import config
ModuleNotFoundError: No module named 'instance'

修改sys.path不是我想要做的。我知道这个问题已经得到很好的回答，但是给出的答案对我没有用。

编辑：将app.py移动到根文件夹时，它可以正常工作。但是我需要将它放在package文件夹下。

Answer 1

您可以将父目录添加到PYTHONPATH，为了实现此目的，可以在sys.path中列出的“模块搜索路径”中使用OS依赖路径。因此，您可以轻松添加父目录，如下所示：

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

from instance import config

请注意，先前的代码使用相对路径，因此您必须在相同位置启动文件，否则可能无法正常工作。要从任何地方启动，可以使用pathlib模块。

from pathlib import Path
import sys
path = str(Path(Path(__file__).parent.absolute()).parent.absolute())
sys.path.insert(0, path)

from instance import config

但是，以前的方法比任何事情都更容易破解，为了正确执行操作，您首先需要根据此非常详细的博客文章python packaging重塑项目结构，并采用推荐的方法与src文件夹。

project
├── CHANGELOG.rst
├── README.rst
├── requirements.txt
├── setup.py
├── src
│   ├── api
│   │   ├── api.py
│   │   └── __init__.py
│   ├── instance
│   │   ├── config.py
│   │   └── __init__.py
│   └── package
│       ├── app.py
│       └── __init__.py
└── tests
    └── __init__.py

请注意，您实际上不需要requirements.txt，因为您可以在setup.py内声明依赖项。示例setup.py（改编自here）：

#!/usr/bin/env python
# -*- encoding: utf-8 -*-
from __future__ import absolute_import
from __future__ import print_function

import io
import re
from glob import glob
from os.path import basename
from os.path import dirname
from os.path import join
from os.path import splitext

from setuptools import find_packages
from setuptools import setup


def read(*names, **kwargs):
    with io.open(
        join(dirname(__file__), *names),
        encoding=kwargs.get('encoding', 'utf8')
    ) as fh:
        return fh.read()


setup(
    name='nameless',
    version='1.644.11',
    license='BSD-2-Clause',
    description='An example package. Generated with cookiecutter-pylibrary.',
    author='mpr',
    author_email='contact@ionelmc.ro',
    packages=find_packages('src'),
    package_dir={'': 'src'},
    include_package_data=True,
    zip_safe=False,
    classifiers=[
        # complete classifier list: http://pypi.python.org/pypi?%3Aaction=list_classifiers
        'Development Status :: 5 - Production/Stable',
        'Intended Audience :: Developers',
        'License :: OSI Approved :: BSD License',
        'Operating System :: Unix',
        'Operating System :: POSIX',
        'Operating System :: Microsoft :: Windows',
        'Programming Language :: Python',
        'Programming Language :: Python :: 2.7',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.5',
        'Programming Language :: Python :: 3.6',
        'Programming Language :: Python :: 3.7',
        'Programming Language :: Python :: 3.8',
        'Programming Language :: Python :: Implementation :: CPython',
        'Programming Language :: Python :: Implementation :: PyPy',
        # uncomment if you test on these interpreters:
        # 'Programming Language :: Python :: Implementation :: IronPython',
        # 'Programming Language :: Python :: Implementation :: Jython',
        # 'Programming Language :: Python :: Implementation :: Stackless',
        'Topic :: Utilities',
    ],
    keywords=[
        # eg: 'keyword1', 'keyword2', 'keyword3',
    ],
    python_requires='>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*',
    install_requires=[
        # eg: 'aspectlib==1.1.1', 'six>=1.7',
    ],
    extras_require={
        # eg:
        #   'rst': ['docutils>=0.11'],
        #   ':python_version=="2.6"': ['argparse'],
    },
    setup_requires=[
        # 'pytest-runner',
    ],
    entry_points={
        'console_scripts': [
            'api = api.api:main',
        ]
    },
)

我的api.py的内容：

from instance import config

def main():
    print("imported")
    config.config()

我的config.py的内容：

def config():
    print("config imported successfully")

您可以找到所有之前的here

可选，但建议使用：创建一个虚拟环境，为此我在项目的根目录内使用venv（Python 3.3 <=）：

python -m venv .

并激活：

source bin/activate

现在我可以安装软件包了：

在项目根目录内使用pip install -e .（带有点）命令

您的导入from instance import config现在可以正常运行，以确认您可以通过以下方式运行api.py：

python src/api/api.py

Answer 2

从Python 3.3开始，您不需要在子目录中使用__init__.py文件来进行导入。拥有它们实际上可能会引起误解，因为它会导致在每个包含初始化文件的文件夹中创建程序包名称空间，如here所述。

通过删除所有这些__init__.py文件，您将可以在运行package时将其导入命名空间app.py（包括子目录）中，但这仍然不是我们想要的。

Python解释器仍然不知道如何到达您的instance名称空间。为此，您可以使用PYTHONPATH环境变量，包括config.py父级的路径。您可以按照@RMPR的回答sys.path中的建议进行操作，也可以直接设置环境变量，例如：

PYTHONPATH=/home/csymvoul/projects/project python3 /home/csymvoul/projects/project/package/app.py

然后导入诸如from instance import config之类的依赖项。

如何从另一个目录导入python包？

2 个答案: