Python3中构建模块异常的最佳实践

这是我想出的解决方案。

其基本思想是将所有异常放在一个文件中,从中可以导入它们,然后将它们全部导入 main.py . 为了使一切都清晰明了,我们最终定义 __all__ 模块的属性。

这是新的文件结构

/project
    __init__.py
    main.py
    /__helpers
        __init__.py
        exceptions.py
        helpers.py
        ...

这是 exceptions.py 文件

# /project/__helpers/exceptions.py

class MainException(Exception):
    pass

# Note that this also allows us to inherit between exceptions
class HelperException(MainException):
    pass

然后,我们可以从该文件导入异常,而不存在循环依赖的风险。

最后我们定义 __全部__ 在里面 主要的py公司 明确要导入异常。

# /projects/main.py

from project.__helpers.helpers import some_function_that_raises
from project.__helpers.exceptions import MainException, HelperException

__all__ = ['MainException', 'HelperException', ...]

只是提醒一下 __全部__ 属性定义了要执行的操作将导入的内容 from project import * . 因此,这将期望的行为扩展到 import star 并明确表示我们希望从该文件导入异常。

还请注意,一些IDE甚至会 'HelperException' 正在加入 __全部__ 作为参考 HelperException 并且不会因为有一个未使用的导入而困扰您。这就是为什么我认为这是正确的方法。