导入模块中全局变量的可见性

Visibility of global variables in imported modules

提问人:Nubarke 提问时间:4/12/2013 最后编辑:codeforesterNubarke 更新时间:4/30/2022 访问量:228060

问:

我在 Python 脚本中导入模块时遇到了一些障碍。我将尽我所能描述这个错误,为什么我会遇到它,以及为什么我要用这种特殊的方法来解决我的问题(我将在一秒钟内描述):

假设我有一个模块,其中我定义了一些实用函数/类,这些函数/类引用在命名空间中定义的实体,该辅助模块将被导入其中(让“a”成为这样的实体):

模块 1:

def f():
    print a

然后我有一个主程序,其中定义了“a”,我想将这些实用程序导入其中:

import module1
a=3
module1.f()

执行程序将触发以下错误:

Traceback (most recent call last):
  File "Z:\Python\main.py", line 10, in <module>
    module1.f()
  File "Z:\Python\module1.py", line 3, in f
    print a
NameError: global name 'a' is not defined

过去(两天前,呃)也问过类似的问题,并提出了几种解决方案,但我真的认为这些不符合我的要求。这是我的特殊背景:

我正在尝试制作一个 Python 程序,该程序连接到 MySQL 数据库服务器并使用 GUI 显示/修改数据。为了清洁起见,我在单独的文件中定义了一堆与MySQL相关的辅助/实用程序函数。但是,它们都有一个共同的变量,我最初在 utilities 模块定义了这个变量,它是 MySQLdb 模块中的光标对象。 后来我意识到,游标对象(用于与数据库服务器通信)应该在主模块中定义,以便主模块和导入其中的任何内容都可以访问该对象。

最终结果如下所示:

utilities_module.py:

def utility_1(args):
    code which references a variable named "cur"
def utility_n(args):
    etcetera

而我的主要模块:

program.py:

import MySQLdb, Tkinter
db=MySQLdb.connect(#blahblah) ; cur=db.cursor()  #cur is defined!
from utilities_module import *

然后,一旦我尝试调用任何实用程序函数,它就会触发上述“未定义全局名称”错误。

一个特别的建议是在实用程序文件中有一个“from program import cur”语句,如下所示:

utilities_module.py:

from program import cur
#rest of function definitions

program.py:

import Tkinter, MySQLdb
db=MySQLdb.connect(#blahblah) ; cur=db.cursor()  #cur is defined!
from utilities_module import *

但这是循环导入或类似的东西,最重要的是,它也会崩溃。所以我的问题是:

我怎样才能使主模块中定义的“cur”对象对导入其中的辅助函数可见?

感谢您抽出宝贵时间,如果解决方案已在其他地方发布,我深表歉意。我只是自己找不到答案,我的书里也没有更多的技巧了。

命名空间 mysql-python python-2.6 python-import

评论

1赞 abarnert 4/12/2013
根据您的更新:无论如何,您可能都不需要单个共享光标。一个共享连接,是的,但是游标很便宜,而且通常有充分的理由同时让多个游标处于活动状态(例如,这样你就可以同步迭代其中两个游标,而不必遍历两个列表,或者只是为了让两个不同的线程/greenlets/回调链/任何东西使用数据库而不会发生冲突)。fetch_all
1赞 abarnert 4/12/2013
无论如何,无论您想分享什么,我认为这里的答案是将(并且,如果您坚持)移动到一个单独的模块中,然后从中导入它。这样你就不会得到循环依赖关系(从程序导入的模块导入程序)以及随之而来的混乱。dbcurprogramutilities_module

答:

6赞 kindall 4/12/2013 #1

函数使用定义它的模块的全局变量。例如,您应该设置 .因此,如果您希望作为全局变量可用,请设置 .a = 3module1.a = 3curutilities_moduleutilities_module.cur

更好的解决方案:不要使用全局变量。将您需要的变量传递到需要它的函数中,或者创建一个类将所有数据捆绑在一起,并在初始化实例时传递它。

评论

0赞 variable 10/17/2019
如果用户编写了“from module1 import f”,而不是编写“import module1”,那么 f 将出现在 main.py 的全局命名空间中。现在在 main.py 如果我们使用 f(),那么由于 a=3 和 f(函数定义)都在 main 的 globalnamespace 中。这是一个解决方案吗?如果我错了,那么请您指导我阅读有关此主题的任何文章
0赞 rimetnac 11/6/2019
我使用了上面的方法,并在实例化使用全局变量的类时将全局变量作为参数传递。这没问题,但过了一段时间,我们激活了代码的 Sonarqube 代码检查,这抱怨函数有太多参数。因此,我们不得不寻找另一种解决方案。现在,我们使用由每个需要它们的模块读取的环境变量。它并不真正符合 OOP 标准,但仅此而已。仅当全局变量在代码执行期间未更改时,这才有效。
346赞 abarnert 4/12/2013 #2

Python 中的全局变量对模块是全局的,而不是跨所有模块的。(许多人对此感到困惑,因为在 C 语言中,全局在所有实现文件中都是相同的,除非您明确地将其设置为全局变量。static

有不同的方法可以解决这个问题,具体取决于您的实际用例。


在走上这条路之前,问问自己这是否真的需要全球化。也许你真的想要一个类,作为一个实例方法,而不仅仅是一个自由函数?然后你可以做这样的事情:f

import module1
thingy1 = module1.Thingy(a=3)
thingy1.f()

如果您确实想要一个全局,但它只是供 使用 ,请在该模块中设置它。module1

import module1
module1.a=3
module1.f()

另一方面,如果被一大堆模块共享,把它放在其他地方,让每个人都导入它:a

import shared_stuff
import module1
shared_stuff.a = 3
module1.f()

...并且,在 module1.py:

import shared_stuff
def f():
    print shared_stuff.a

除非变量旨在成为常量,否则不要使用 import。 将创建一个新变量,该变量初始化为导入时引用的任何内容,并且此新变量不会受到赋值 的影响。fromfrom shared_stuff import aashared_stuff.aashared_stuff.a


或者,在极少数情况下,您确实需要它像内置模块一样在任何地方都真正具有全局性,请将其添加到内置模块中。Python 2.x 和 3.x 之间的确切细节有所不同。 在 3.x 中,它的工作原理如下:

import builtins
import module1
builtins.a = 3
module1.f()

评论

0赞 Nubarke 4/12/2013
谢谢你的回答。我将尝试导入shared_stuff方法,尽管我无法克服主模块中定义的变量并不是真正全局的事实 - 难道没有办法让每个人都能真正访问一个名称,从程序中的任何地方?
2赞 Bi Rico 4/12/2013
让某些东西“每个人都可以从任何程序中访问”,这非常违背了 Python 的禅意,特别是“显式比隐式更好”。Python 有一个经过深思熟虑的 oo 设计,如果你使用得当,你可能会设法完成你的 Python 职业生涯的剩余时间,而不需要再次使用 global 关键字。
1赞 Nubarke 4/12/2013
更新:谢谢!shared_stuff方法效果很好,有了这个,我想我可以解决任何其他问题。
2赞 abarnert 4/12/2013
@DanielArmengod:我添加了内置答案,以防万一您真的需要它。(如果你需要更多细节,请搜索 SO;至少有两个关于如何正确地向内置添加内容的问题。但是,正如 Bi Rico 所说,你几乎可以肯定并不真正需要它,或者想要它。
1赞 abarnert 8/13/2013
@BiRico:进一步思考,与其说是“显式比隐式更好”,不如说是“命名空间是一个响亮的好主意”。每个模块都有自己的模块,这是喇叭式伟大想法的典范案例,其他一切都建立在它之上(至少在概念上;在细节上,新式类可能是最好的范式)。globals
7赞 user3336548 4/17/2015 #3

这篇文章只是对我遇到的 Python 行为的观察。也许你上面读到的建议对你不起作用,如果你做了我在下面做的同样的事情。

也就是说,我有一个包含全局/共享变量的模块(如上所述):

#sharedstuff.py

globaltimes_randomnode=[]
globalist_randomnode=[]

然后我有了主模块,它导入了共享的东西:

import sharedstuff as shared

以及实际填充这些数组的其他一些模块。这些由主模块调用。退出这些其他模块时,我可以清楚地看到数组已填充。但是当在主模块中读回它们时,它们是空的。这对我来说很奇怪(好吧,我是 Python 的新手)。但是,当我更改将主模块中的 sharedstuff.py 导入方式更改为:

from globals import *

它起作用了(数组已填充)。

只是说'

3赞 Chris Nasr 8/14/2015 #4

解决此特定问题的最简单方法是在模块中添加另一个函数,该函数将光标存储在模块的变量全局中。然后所有其他函数也可以使用它。

模块 1:

cursor = None

def setCursor(cur):
    global cursor
    cursor = cur

def method(some, args):
    global cursor
    do_stuff(cursor, some, args)

主程序:

import module1

cursor = get_a_cursor()
module1.setCursor(cursor)
module1.method()
3赞 user2589273 11/30/2015 #5

由于全局变量是特定于模块的,因此您可以将以下函数添加到所有导入的模块中,然后使用它来:

  • 添加单数变量(字典格式)作为全局变量
  • 模块全局变量传输到它 .

addglobals = lambda x:globals().update(x)

然后,您需要传递当前全局变量的只是:

导入模块

module.addglobals(全局())

18赞 Vishal 3/30/2016 #6

作为解决方法,您可以考虑在外层设置环境变量,如下所示。

main.py:

import os
os.environ['MYVAL'] = str(myintvariable)

mymodule.py:

import os

myval = None
if 'MYVAL' in os.environ:
    myval = os.environ['MYVAL']

作为额外的预防措施,当模块中未定义 MYVAL 时,请处理这种情况。

1赞 Toby Petty 10/16/2018 #7

由于我在上面的答案中没有看到它,我想我会添加我的简单解决方法,即为需要调用模块的全局变量的函数添加一个参数,然后在调用时将字典传递到函数中;例如:global_dict

# external_module
def imported_function(global_dict=None):
    print(global_dict["a"])


# calling_module
a = 12
from external_module import imported_function
imported_function(global_dict=globals())

>>> 12
0赞 coyot 4/13/2019 #8

OOP 的方法是使模块成为一个类,而不是一组未绑定的方法。然后,您可以使用 或 setter 方法来设置来自调用方的变量,以便在模块方法中使用。__init__

2赞 Orwellophile 9/2/2021 #9

更新

为了测试这个理论,我创建了一个模块并将其放在 pypi 上。一切都很完美。

pip install superglobals

简答

这在 Python 2 或 3 中工作正常:

import inspect

def superglobals():
    _globals = dict(inspect.getmembers(
                inspect.stack()[len(inspect.stack()) - 1][0]))["f_globals"]
    return _globals

另存为并在另一个模块中使用,如下所示:superglobals.py

from superglobals import *

superglobals()['var'] = value

扩展答案

您可以添加一些额外的功能,使事情更具吸引力。


def superglobals():
    _globals = dict(inspect.getmembers(
                inspect.stack()[len(inspect.stack()) - 1][0]))["f_globals"]
    return _globals

def getglobal(key, default=None):
    """
    getglobal(key[, default]) -> value
    
    Return the value for key if key is in the global dictionary, else default.
    """
    _globals = dict(inspect.getmembers(
                inspect.stack()[len(inspect.stack()) - 1][0]))["f_globals"]
    return _globals.get(key, default)

def setglobal(key, value):
    _globals = superglobals()
    _globals[key] = value

def defaultglobal(key, value):
    """
    defaultglobal(key, value)

    Set the value of global variable `key` if it is not otherwise st
    """
    _globals = superglobals()
    if key not in _globals:
        _globals[key] = value

然后这样使用:

from superglobals import *

setglobal('test', 123)
defaultglobal('test', 456)
assert(getglobal('test') == 123)

理由

散落在这个问题上的“python纯度联盟”答案是完全正确的,但是在某些环境(例如IDAPython)中,它基本上是单线程的,具有大型全局实例化的API,这并不重要

这仍然是一种糟糕的形式,也是一种不好的做法,但有时它更容易。尤其是当你编写的代码不会有很长的寿命时。

评论

0赞 Gabi 1/21/2022
嘿!这是一些很棒的东西,但我认为它不适用于 ipython,仅适用于 python。你有什么想法如何以强大的方式使它与ipython一起工作吗?谢谢!:)
1赞 Orwellophile 4/20/2022
ipython 是魔鬼。您可以尝试将第二行更改为 不过。_globals = globals()