如何在Python中创建模块范围的变量？

Question

是否有方法在模块内部设置全局变量？当我试图用下面所示的最明显的方法来实现它时，Python解释器说变量__DBNAME__不存在。

...
__DBNAME__ = None

def initDB(name):
    if not __DBNAME__:
        __DBNAME__ = name
    else:
        raise RuntimeError("Database name has already been set.")
...

在将模块导入到另一个文件中之后

...
import mymodule
mymodule.initDB('mydb.sqlite')
...

回溯是：

... UnboundLocalError: local variable 'DBNAME' referenced before assignment ...

有什么想法吗？我正试图根据this fellow's建议，通过使用模块来设置单例。

Answer 1

这是发生的事情。

首先，Python真正拥有的唯一全局变量是模块范围的变量。不能生成真正全局的变量；只能在特定范围内生成变量。（如果您在Python解释器中创建一个变量，然后导入其他模块，那么您的变量在Python会话的最外层范围中，因此是全局的。）

创建模块全局变量所需做的只是为名称赋值。

想象一下一个名为foo.py的文件，其中包含这一行：

X = 1

现在想象一下你导入它。

import foo
print(foo.X)  # prints 1

但是，假设您希望将模块范围变量之一用作函数中的全局变量，如您的示例所示。Python的默认设置是假设函数变量是局部的。您只需在函数中添加一个global声明，然后再尝试使用全局。

def initDB(name):
    global __DBNAME__  # add this line!
    if __DBNAME__ is None: # see notes below; explicit test for None
        __DBNAME__ = name
    else:
        raise RuntimeError("Database name has already been set.")

顺便说一下，对于本例，简单的if not __DBNAME__测试就足够了，因为除了空字符串之外的任何字符串值都将计算为true，因此任何实际的数据库名称都将计算为true。但是对于可能包含数字值0的变量，不能只说if not variablename；在这种情况下，应该使用is运算符显式测试None。我修改了示例以添加一个显式的None测试。对None的显式测试从来没有错，所以我默认使用它。

最后，正如其他人在本页中所指出的，前面的两个下划线向Python发出信号，表示您希望变量对模块是“私有的”。如果您做过import * from mymodule，Python将不会将带有两个前导下划线的名称导入到您的名称空间中。但是如果你只做一个简单的import mymodule，然后说dir(mymodule)，你会看到列表中的“private”变量，如果你显式地引用mymodule.__DBNAME__，Python不会在意，它只会让你引用它。双前导下划线是模块用户的一个重要线索，您不希望他们将该名称重新绑定到自己的某个值。

在Python中，最好不要做import *，而是通过使用mymodule.something或显式地执行类似from mymodule import something的导入来最小化耦合并最大化显式性。

编辑：如果出于某种原因，您需要在没有global关键字的非常旧的Python版本中执行类似的操作，那么有一个简单的解决方法。不要直接设置模块全局变量，而是在模块全局级别使用可变类型，并将值存储在其中。

在函数中，全局变量名将是只读的；您将无法重新绑定实际的全局变量名。（如果在函数内指定该变量名，则只会影响函数内的局部变量名。）但可以使用该局部变量名访问实际的全局对象，并在其中存储数据。

您可以使用list，但您的代码将很难看：

__DBNAME__ = [None] # use length-1 list as a mutable

# later, in code:  
if __DBNAME__[0] is None:
    __DBNAME__[0] = name

Adict更好。但最方便的是类实例，您只需使用一个简单的类：

class Box:
    pass

__m = Box()  # m will contain all module-level values
__m.dbname = None  # database name global in module

# later, in code:
if __m.dbname is None:
    __m.dbname = name

（实际上不需要将数据库名称变量大写。）

我喜欢使用__m.dbname而不是__m["DBNAME"]的语法糖；在我看来，这似乎是最方便的解决方案。但是dict溶液也可以工作。

使用dict可以使用任何可散列值作为键，但是如果您对作为有效标识符的名称感到满意，则可以使用上面的Box之类的小类。