Python：利用不同级别模块之间共享的实用函数构建项目

Question

我有一个 python 3.10 项目，它结合使用了抓取网站、数据分析和其他 API。一些实用模块可以由抓取和数据分析模块使用。我从根本上误解了 Python 中导入的工作原理。 例如，在 sl_networking.py 中，我尝试从 result.py 导入 Result 类：

from ...util.result import Result

产生错误：

PS C:\Development\TradeAssist> & c:/Development/TradeAssist/.venv/Scripts/python.exe c:/Development/TradeAssist/libs/scrapers/sl/sl_networking.py
Traceback (most recent call last):
  File "c:\Development\TradeAssist\libs\scrapers\sl\sl_networking.py", line 1, in <module>
    from ...util.result import Result
ImportError: attempted relative import with no known parent package

项目结构 I'我当前使用的是：

TradeAssist
|__libs
|  |__broker_apis
|  |  |__ibapi
|  |__data_analysis
|  |  |__sl
|  |  |__ta
|  |__scrapers
|  |  |__sl
|  |  |  |  sl_auth.py
|  |  |  |__sl_networking.py
|  |  |__ta
|  |__util
|     |__result.py
|__tests
   |__test_sl.py
   |__test_ta.py

如果我有一个公共实用程序函数，我希望在 data_analysis 和 scraper 模块中使用，我应该如何构建我的项目并处理导入？

Answer 1

这不是一个Python问题，而是一个VSCode问题。 VSCode 默认运行 Python 文件的方式有点愚蠢。当您在 test_sl 上单击小三角形“运行 Python 文件”时，VSCode 将运行如下命令：

/usr/local/bin/python3 /path/to/TradeAssist/tests/test_ta.py

Python by defaultinitialises sys.path 包含正在运行的文件所在的目录，以及它自己的库，无论你里面有什么PYTHONPATH 变量。这意味着您的 sys.path 看起来像这样（... 是 Python 的库）

['/path/to/TradeAssist/tests', ...]

但是，这意味着 lib 中的代码无法访问; Python 只能正确找到 tests 内的文件。即开箱即用，VSCode 只能运行根源文件夹中的 Python 文件（例如 src 或直接位于根工作区文件夹中）。

有几种解决方案。

第一个最简单：确定您的 TradeAssist 是源根目录，并将您想要直接执行的任何文件放在那里。他们将能够导入其下的任何文件，并且其下的文件将能够正确使用相对和绝对导入。这有明显的缺点——你会自我限制在一个目录中。

第二种是通过定义 PYTHONPATH 来设置 VSCode 来告诉 Python 你的源根目录在哪里。这是相当复杂。

第三种是最简单的，也可能是正确的情况：使用 VSCode 的 测试 功能。 配置测试框架（大概使用unittest 和 test_*.py 测试文件模式），然后只需 运行测试。如果您认为 TradeAssist 是您的源根，它将正常工作（即 import libs.scrapers.sl.sl_networking 将在您的测试中正常工作，并且 from ...util.result import Result 将在您的 sl_networking.py 中正常工作）。测试功能将以正确的方式为您运行测试。

但是，如果您想将 libs 视为您的源根目录（即您希望import scrapers.sl.sl_networking），或者如果您希望能够运行任意文件，而不仅仅是测试，那么你必须回退到方法#2：搞乱PYTHONPATH。

tl;dr: 不要手动运行测试文件，让 VSCode 通过正确设置测试来为您完成此操作。

Answer 2

相对导入仅在从最外层父根执行代码时才起作用。目前场景下，只能执行libs目录及以上的代码。

python -m scrapers.sl.sl_networking

如果您在 libs 目录中运行

应该可以正常工作。一旦项目构建完成，就可以使用 -m 标志轻松地从顶级父目录运行各个脚本，因为不需要重构。如果必须从脚本父目录执行代码，则必须执行以下操作：

1. 使用绝对导入而不是相对导入。
2. 将目录添加到 python 搜索导入的路径中。这可以通过多种方式完成。将其添加到 PYTHONPATH 环境变量或使用任何 sys.path.append 或 sys.path.insert 黑客，这可以很容易成立。