使用`import __main__`是一个好习惯吗？

Question

我正在开发一个相对较大的Python应用程序，因此我希望保留几种资源，因为可以在多个不同模块中访问全局变量。这些值包括版本号，版本日期，全局配置以及一些指向资源的静态路径。我还包括了一个DEBUG由命令行选项设置的标志，以便我可以在调试模式下运行应用程序而无需整个环境。

我一直在谨慎地确保要导入的值在程序运行过程中不会发生变化，并且我已将它们记录为不应被触及的全局常量变量。我的代码本质上看起来像

# Main.py
import wx
from gui import Gui

DEBUG = False
GLOBAL_CONFIG = None
VERSION = '1.0'
ICON_PATH = 'some/path/to/the/app.ico'

def main():
    global DEBUG, GLOBAL_CONFIG

    # Simplified
    import sys
    DEBUG = '--debug' in sys.argv

    GLOBAL_CONFIG = load_global_config()
    # Other set-up for the application, e.g. setting up logging, configs, etc

    app = wx.App()
    gui = Gui()
    app.MainLoop()

if __name__ == '__main__':
    main()

# gui.py
import wx
from __main__ import DEBUG, GLOBAL_CONFIG, ICON_PATH

import controller


class Gui(wx.Frame):
    def __init__(self):
        wx.Frame.__init__(self, None)

        icon = wx.Icon(ICON_PATH, wx.BITMAP_TYPE_ICO)
        self.SetIcon(icon)

        # Always make a copy so we don't accidentally modify it
        conf = GLOBAL_CONFIG.copy()
        self.controller = controller.Controller(conf)

        # More setup, building the layout, etc

# controller.py
from __main__ import DEBUG

import logging
log = logging.getLogger('controller')

class Controller(object):
    def __init__(self, conf):
        if DEBUG:
            log.info("Initializing controller in DEBUG mode")
        self.conf = conf
        # Other setup ...

显然，这与我的应用程序实际上是相去甚远的，并且忽略了错误处理，文档以及基本上所有的实现细节。

现在，我看到它说这是个坏主意，但没有解释原因。由于在搜索“ python import main”的变体时，大多数结果都是关于什么的问题if __name__ == '__main__'，因此很难找到有关此主题的可靠信息。到目前为止，我还没有遇到任何问题，实际上非常方便。

那么，这被认为是良好的Python做法，还是有理由我应该避免这种设计？

Answer 1

我认为可能有两个主要原因（哈哈），一个可能规定避免这种模式。

• 它混淆了您要导入的变量的来源。
• 如果您的程序有多个入口点，它将中断（或至少很难维护）。想象一下，如果有人（很可能是您）想要将功能的某些子集提取到一个独立的库中，他们将不得不删除或重新定义这些孤立的引用中的每个引用，以使其在您的应用程序之外可用。

如果您完全控制该应用程序，并且永远不会再有其他入口点或功能的其他用途，并且您确定自己不介意模棱两可，那么我认为模式错误是没有 客观 原因的from __main__ import foo。我个人不喜欢它，但是再次，基本上是出于上述两个原因。

我认为，更健壮/对开发人员友好的解决方案可能是这样的，它创建了一个专门用于保存这些超全局变量的特殊模块。然后，您可以导入模块并module.VAR在需要设置时参考。本质上，只需创建一个特殊的模块命名空间即可在其中存储超全局运行时配置。

# conf.py (for example)
# This module holds all the "super-global" stuff.
def init(args):
    global DEBUG
    DEBUG = '--debug' in args
    # set up other global vars here.

然后，您将更像这样使用它：

# main.py
import conf
import app

if __name__ == '__main__':
    import sys
    conf.init(sys.argv[1:])

    app.run()

# app.py
import conf

def run():
    if conf.DEBUG:
        print('debug is on')

请注意使用conf.DEBUG而不是from conf import DEBUG。这种构造意味着您 可以
在程序的生命周期内更改变量，并将更改反映到其他地方（显然，假设单个线程/进程）。

另一个好处是，这是一种相当普遍的模式，因此其他开发人员将很容易认识到它。尽管我避免使用该特定名称，因为它通常是一堆静态对象，而不是运行时参数的命名空间，但它很容易与settings.py各种流行应用程序（例如django）使用的文件进行比较settings.py。例如，上述配置名称空间模块的其他好名字可能是runtime或params。