在python项目中设置sys.path.append有没有更好的方法？

Question

我有一个简单的python项目，其目录结构如下:

sample-project/
main/
    config/
        config.yaml
    docker/
        Dockerfile
    tests/
        __init__.py
        sometests.py
    config.py
    run.py
    __init__.py
requirements.txt
README.rst

在config.py文件中，我有:

import yaml


class Config:

def __init__(self):
    with open("config/config.yaml", 'r') as ymlfile:
        cfg = yaml.load(ymlfile)

        self.host = cfg["mysql"]["host"]
        self.database = cfg["mysql"]["database"]
        self.user = cfg["mysql"]["user"]
        self.password = cfg["mysql"]["password"]


my_config = Config()

在run.py文件中，我有一个导入语句，如下所示：

from main.config import my_config

当我使用命令行运行python3.5 run.py时，我得到错误:

从主要。配置导入my_config

ImportError:没有名为“main”的模块

但当我在运行中添加此项时。py导入它的工作原理：

import sys
sys.path.append('/home/tomas/sample-project/')

除了给出绝对路径或其他方式之外，还有其他更好的方法吗？请举例说明:)

Answer 1

虽然我同意AKX的观点，即编辑您的路径是要避免的，但我通常会建议以下方法：

import sys
from os.path import dirname
abs_dir = dirname(__file__)
sys.path.append(abs_dir)

__file__变量提供对访问它的文件位置的访问。这允许您获取项目中任何文件的绝对路径。

Answer 2

当下面提到从主.配置导入my_config

保持目录路径，例如：从示例项目/main。配置导入my_config

假设您在/home/tomas中执行

Answer 3

通常，永远不要触摸＜code＞系统。程序中的路径。

因为main/（不是最好的名称）包含__init__。py，我们将它视为一个包，因此让它作为一个包运行。这样，进口将被正确考虑。

添加主/__main__.py例如

from main.run import run

if __name__ == "__main__":
   run()

然后运行你的应用

python -m main

而不是

python main/main.py