Skip to main content
 首页 » 编程设计

python之从父目录导入测试子目录而不使用打包,Python 2.7

2025年04月02日16exmyth

长话短说

对于像这样的固定且不可更改的非包目录结构:

some_dir/ 
    mod.py 
    test/ 
        test_mod.py 
        example_data.txt 

启用test_mod.py 从mod.py 导入的非封装方式是什么?

在这种情况下,我只能使用 Python 2.7。

我想为 mod.py 中的函数编写一些测试。我想创建一个新目录 test 与 mod.py 并排,里面有一个测试文件 test/test_mod.py 应该从 mod.py 导入函数并测试它们。

由于相对导入的众所周知的局限性,它依赖于基于包的命名,您不能以直接的方式执行此操作。然而,关于该主题的所有建议都建议将脚本构建为一个包,然后使用相对导入,这对我的用例来说是不可能的。

在我的例子中,不允许将 mod.py 构建为一个包,我不能要求 mod.py 的用户安装它。相反,他们可以自由地从版本控制中 checkout 文件,然后随心所欲地开始使用它,我无法改变这种情况。

鉴于此,有什么方法可以提供简单、直接的测试 目录?

注意:不只是一个位于 mod.py 旁边的测试文件,而是一个实际的测试目录,因为它会附带其他 Assets ,如测试数据,子目录组织很关键。

如果这是重复的,我深表歉意,但在发布之前我在研究中看到的这个问题的十几个排列中,我还没有看到一个解决如何做到这一点的问题。他们都说要使用包装,这对我来说是不允许的选择。

请您参考如下方法:

根据@mgilson 的评论,我在测试目录中添加了一个文件import_helper.py。

some_dir/ 
    mod.py 
    test/ 
        test_mod.py 
        import_helper.py 
        example_data.txt 

import_helper.py 的内容如下:

import sys as _sys 
import os.path as _ospath  
import inspect as _inspect 
from contextlib import contextmanager as _contextmanager 
 
@_contextmanager 
def enable_parent_import(): 
    path_appended = False 
    try: 
        current_file      = _inspect.getfile(_inspect.currentframe()) 
        current_directory = _ospath.dirname(_ospath.abspath(current_file)) 
        parent_directory  = _ospath.dirname(current_directory) 
        _sys.path.insert(0, parent_directory) 
        path_appended = True 
        yield 
    finally: 
        if path_appended: 
            _sys.path.pop(0) 

然后在 test_mod.py 的导入部分,在尝试导入 mod.py 之前,我添加了:

import unittest 
from import_helper import enable_parent_import 
 
with enable_parent_import(): 
    from mod import some_mod_function_to_test 

不幸的是需要手动修改 PYTHONPATH,但是将其编写为上下文管理器会有所帮助,并且可以将 sys.path 恢复到父目录修改之前的原始状态。

为了让这个解决方案能够跨越这个问题的多个实例(假设明天我被要求为一些不相关的任务编写一个 widget.py 模块并且它也不能作为一个包分发) ,我必须复制我的辅助函数并确保它的副本与任何测试一起分发,或者我必须将那个小实用程序编写为一个包,确保它在我的用户群中全局安装,然后继续维护它。

当您在公司内部管理大量 Python 代码时,通常会发生一种功能失调的代码分发模式,即“安装”一些 Python 代码等同于从版本控制中 checkout 新版本。

由于代码通常是高度本地化的并且特定于较大团队的一小部分任务的一小部分任务,因此维护通过打包共享代码的开销(即使它通常是一个更好的主意)根本不会发生.

因此,我觉得我上面描述的用例对于现实世界的 Python 来说非常常见,如果一些导入工具添加这个修改 PYTHONPATH 的功能就好了,其中一些合理的默认选择(比如添加父目录) ) 非常简单。

这样一来,您至少可以依赖它作为标准库的一部分,而无需滚动您自己的代码并确保它随您的测试一起提供或安装在您的用户群中。