Skip to main content
 首页 » 编程设计

Python 在主代码中调用本地函数会破坏测试中的导入

2024年12月31日9birdshome

我已经受够了 Python 的导入系统……以为我终于得到了一些可靠的东西,然后莫名其妙的事情发生了!

这是我的应用程序的目录结构:

/ 
- my-application/ 
 - subpackage/ 
  - __init__.py 
  - my_module.py 
 - __init__.py 
- tests/ 
 - subpackage/ 
  - __init__.py 
  - test_my_module.py 
 - __init__.py 
 - conftest.py 
 - run.py 
 - spark.py 

我通过 tests/run.py 运行所有测试,如下所示(试图解决所有导入问题):

import os 
import pytest 
import sys 
 
rootdir = os.path.abspath(os.path.join(os.path.dirname(__file__), "..")) 
 
sys.path.insert(0, os.path.abspath(os.path.join(rootdir, "my-application"))) 
 
sys.exit(pytest.main([os.path.join(rootdir, "tests")])) 

这就像一个绝对的魅力,直到我对文件 /my-application/subpackage/my-module.py 进行了修改 - 我添加了一个本地函数调用。所以例如我的模块.py:

def foo(): 
  pass 
 
def run_my_module(): 
  def bar(): 
    foo()          <---- Added this line 
 
  bar() 
  print("Ran") 

更新:这工作正常:

def foo(): 
  pass 
 
def run_my_module(): 
  def bar(): 
    pass 
 
  foo() 
  bar() 
  print("Ran") 

我一添加本地函数调用,测试就停止工作,并出现错误 No module named "subpackage"。

test_my_module.py 看起来像这样(基本上):

from subpackage.my_module import run_my_module 
 
def basic_test(): 
    run_my_module() 

请注意,在 test_my_module.py 中,我使用 subpackage 作为导入语句的第一部分,因为我使用的是 run.py 将 my-application 设置为系统路径的文件。如果我将导入更改为以 my_application 开头,我会在引用 my_application.py 时遇到相同的错误。

我仍在学习 python,所以建议对我的应用程序结构进行任何你喜欢的更改。我无法相信这个导入系统的麻烦 - 我确实觉得我在这里缺少一些基本的东西......

提前致谢!

请您参考如下方法:

手动管理导入路径很困难。
setup.py 是管理 python 包的最佳方式。

按照约定,包名应该使用 _ 而不是 -。

在 my_application/ 旁边创建一个包含此内容的 setup.py

from setuptools import find_packages, setup 
 
setup( 
    name='my_application', 
    version='0.0.1', 
    packages=find_packages(), 
) 

我推荐如下的应用程序结构:

$ tree 
 
├── my_application 
│   ├── __init__.py 
│   ├── spark.py 
│   └── subpackage 
│       ├── __init__.py 
│       └── my_module.py 
├── setup.py 
└── tests 
    ├── conftest.py 
    └── subpackage 
        ├── __init__.py 
        └── test_my_module.py 

本地安装包

python setup.py 开发 这将符号链接(symbolic link)(神奇地)将您的包安装到 python 包路径
现在,在任何脚本中,您都可以按预期使用路径,例如

from my_application.subpackage.my_module import run_my_module 

还建议您使用 virtualenv

更多关于 setup.py here