小编典典

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

python

有没有办法在模块内部设置全局变量?当我尝试以最明显的方式进行操作(如下所示)时,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:赋值之前引用了本地变量’ DBNAME


阅读 253

收藏
2020-12-20

共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;
在这种情况下,您应该明确测试None使用该is运算符。我修改了示例以添加显式None测试。显式测试None永远不会出错,因此我默认使用它。

最后,正如其他人在此页面上所指出的那样,两个前导下划线向Python发出信号,表示您希望变量是模块的“私有”变量。如果您执行过import * from mymodule,Python不会将带有两个前划线的名称导入名称空间。但是,如果您只是简单地import mymodule说一遍,然后说dir(mymodule)您将在列表中看到“私有”变量,并且如果您显式引用mymodule.__DBNAME__Python无关紧要,那么它将只允许您引用它。下划线的双下划线是您模块用户的主要线索,您不希望他们将该名称重新绑定到自己的名称上。

在Python中,最好不要这样做import *,而是使用mymodule.something或通过显式执行like来最大程度地减少耦合并最大限度地提高显式性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解决方案也可以正常工作。

使用adict可以将任何可散列的值用作键,但是当您对有效标识符的名称感到满意时,可以像Box上面一样使用平凡的类。

2020-12-20