Python unittest实践：调用foo.test()运行测试时避免暴露内部测试类

问题根源 #

你遇到的命名空间污染，本质是__init__.py里的from .test import *写法，会把test.py内所有非下划线开头的公开标识符（包括FooTest测试类）全部提升到foo模块的顶层作用域，外部使用者导入foo模块后，自然可以直接访问到原本只属于test模块内部的测试类，破坏了模块的封装性。

可落地的调整方案 #

• 方案1：移除冗余的全量导入，在测试入口函数内动态加载用例
  这是最符合封装原则的做法——你根本不需要把test模块的任何内容提前导入到foo的顶层命名空间，只需要在执行测试的函数内部，让unittest框架自行定位并加载test模块内的测试用例即可。
  改造后的__init__.py代码如下：

  import unittest
  
  def test():
      # 直接指定测试模块的完整路径，由unittest自动加载模块内所有符合规则的测试类
      test_suite = unittest.TestLoader().loadTestsFromName("foo.test")
      test_runner = unittest.TextTestRunner()
      test_runner.run(test_suite)
  

  这种写法完全不影响原有两种测试运行方式的兼容性：

  • 直接执行test.py文件时，靠文件内部if __name__ == '__main__'的逻辑正常触发测试
  • 外部调用foo.test()时，靠函数内的动态加载逻辑执行全部测试
    改造后foo模块的顶层命名空间不会出现FooTest，外部尝试访问foo.FooTest会直接抛出AttributeError，完全实现封装要求。

• 方案2：在test.py中用__all__限制模块导出范围
  如果因为业务逻辑需要，test.py模块确实需要被其他业务模块导入交互，可以在test.py的开头定义模块级的__all__列表，明确声明模块允许对外导出的标识符范围。这样就算在__init__.py中保留了from .test import *的写法，也只会导出__all__列表中声明的内容，不会把内部测试类带出来。
  改造示例（test.py内新增定义）：

  import unittest
  
  # 仅声明需要对外提供的接口，测试类不纳入导出范围
  __all__ = []
  
  class FooTest(unittest.TestCase):
      # 测试逻辑实现
      pass
  
  if __name__ == '__main__':
      unittest.main()
  

避坑提醒 #

不要为了规避命名污染，随意把测试类名改成单下划线开头的形式（比如改成_FooTest）。虽然这种写法确实会让全量导入自动过滤掉该类，但会降低测试代码的可读性，也会增加unittest用例发现逻辑的排查成本，远不如上面两种方案稳妥。

内容的提问来源于stack exchange，提问作者Peter