Python `__init__.py` 和代码中对象的初始化

Question

我已经阅读了有关 __init__.py 文件的文档以及此处关于 SO 的一些很好的问题，但我仍然对其正确用法感到困惑。

上下文

我有一个包含许多包和子包的代码。我已经定义了很多类，其中一些我需要为整个用户 session 创建一个(并且只有一个)实例。然后，这些新对象将用于代码的不同部分，以便我(或用户)随时更新此对象中的数据/信息，它将在所有代码中使用，而无需更改任何其他内容。为了更清楚，让我向您展示我正在谈论的内容的基本方案。

代码有一个过度简化的结构，如:

root/
    __init__.py
    tools/
        __init__.py
        ... (some modules)
        aliases.py (which defines the class Aliases)
    physics/
        __init__.py
        ... (some modules)
        constants/
            ... (some modules)
            constants.py (which defines the class Ctes)
        units.py (which defines the class Units)

在代码中，我需要管理别名、单位和常量。我发现处理这个问题的方法是为每个创建一个实例，并在所有代码中使用它。用这种方法，例如，我敢肯定，如果在代码仍在运行时添加别名，则可以在代码中的任何地方使用它，因为只有一个共享的别名实例。这就是我所需要的(顺便说一下，这同样适用于单位和常量)。

现状

就目前而言，我认为我这样做的方式并不是最好的。事实上，我在声明类后直接在同一个文件中创建实例，比方说别名:

在 root/tools/aliases.py

import ... (stuff

class Aliases(object):
    """The Aliases manager"""
    ...

ALIASES = Aliases()

然后，在我需要使用别名的任何文件中，我会:

在 any_file.py 中(代码中的任意位置)

from root.tools.aliases import ALIASES

ALIASES.method1() # possibly in functions or other classes
ALIASES.method2() # ... etc

对于其他一些类，我什至在代码的根部使用了 __init__.py 文件:

在 root/__init__.py

# CTES is the instance of Ctes() created in root/physics/constants/constants.py
from root.physics.constants.constants import CTES
CTES.add(...) # add a new constant that needs to be known

(当然，CTES 不只是存储一些常量，我定义了一些方法来利用它们，所以将它们放在这个类中而不是仅仅将它们定义为常规 python 是有意义的模块中的常量)

问题

我想知道我是否做对了(可能不对)。也许最好使用文件 __init__.py 并在其中启动共享实例。但是这会带来一些问题吗(比如依赖循环，或者增加内存使用量……)？另外，如何在代码的其他地方使用创建的实例？像这样吗？:

在 root/tools/__init__.py

import root.tools.aliases as Al
ALIASES = Al.Aliases()
# should I delete the imported module: del Al ??

然后在 any_file.py

from root.tools import ALIASES
ALIASES.method(...)

或者最好将所有这些实例都包含在我导入到 root/__init__.py 中的文件中(例如 root/shared.py)，这样我我确定它已启动？

我读过很多次最好将 __init__.py 文件保持为空(我的代码中现在就是这种情况，当然 root/__init__.py)。你怎么看？

我有点迷茫(你可能从我不太清楚的事实中看出这一点)。任何帮助/建议都非常受欢迎。我想避免任何非 pythonic 解决方案，或可能会使用户感到困惑或使事情变得不安全的解决方案。

Answer 1

您在模块中内联创建单个实例时所做的事情很好。使用全局变量没有错(除非它们不合适，但适用于任何语言特性)。唯一的潜在缺点是如果您导入该模块而不使用它并浪费资源来初始化该类。除非你的类(class)在创作时做了一些非常繁重的事情，我非常怀疑，否则这种影响可以忽略不计。我唯一建议的是你调整你的命名。您的类可能应该以下划线开头，这样模块的用户就知道不要碰它，并且您的实例应该是小写的。您使用的方法不会造成任何不良副作用。

没有人说您必须将所有类放在它们自己的文件中，或者您根本必须使用类。也许一个带有函数的别名模块和模块全局变量中的“私有(private)”状态对你来说更有意义。由于您没有使用对象系统来获得具有独立状态的多个实例，因此创建类的唯一原因是您是否喜欢这样组织代码和 API。这里最重要的是您对代码的组织方式和模块的使用方式感到满意。与使用太少 imo 相比，过多地使用面向对象技术更容易使用户感到困惑。只要确保在您确实需要时开设类(class)即可。

还有很多其他的单例方法。这是我第一次听说“博格模式”，听起来很浪费很傻，但我猜它至少在技术上是可行的，而且浪费至少可以忽略不计。您可以编写一个函数，在第一次调用时实例化一个类，将其存储在全局中，并在后续调用中返回全局(但是您必须担心线程，这不是您已经在做的问题它)。您可以创建一个其 __init__ 方法引发 TypeError 的类，以便它根本无法实例化，并使用类方法或静态方法执行所有操作，将您需要的所有状态保留在类本身上。甚至可以创建一个每次都返回相同实例的类。所有这些的结果是，您从模块中获取了一个对象，然后在您的代码中使用它，之后使用它的方式看起来也一样。

我认为您应该在您的一个模块中内联实例化您的类，就像在您发布的代码中一样，因为它有效，它是一种常见的模式，它是明智的，并且对您有意义。

没有理由删除您导入的模块。它不会为您节省任何东西。模块一旦导入就永远存在(除非你主动做一些奇怪的事情来摆脱它)，全局变量不是你需要保存的宝贵资源。

只要您在内部使用相对名称(即别名而不是 root.tools.aliases)引用您的模块，您就不会通过在 __init__.py 中导入您的模块来引入循环依赖.循环依赖是一个真正的问题，所以要小心。只要你的模块只导入树中更深层次的东西，并且你认为是“较低级别”(意味着那些较低级别的模块不会导入可能使用它们的较高级别的东西)，你应该没事。我会警告不要在 __init__.py, 中放置任何大量代码，但我认为如果您希望实例存在于此，那么实例化您的类就可以了。