通过使用模块名称(字符串)来调用模块的功能


1734

在Python程序中,给定带有函数名称的字符串的最佳方法是什么?例如,假设我有一个模块foo,我有一个内容为的字符串"bar"。最好的通话方式是foo.bar()什么?

我需要获取函数的返回值,这就是为什么我不只是使用eval。我想出了如何通过eval定义一个临时函数来返回该函数调用的结果的方法,但是我希望有一种更优雅的方法。

Answers:


2078

假设模块foo与方法bar

import foo
method_to_call = getattr(foo, 'bar')
result = method_to_call()

您可以将第2行和第3行缩短为:

result = getattr(foo, 'bar')()

如果这对您的用例更有意义。

您可以通过getattr这种方式在类实例绑定的方法,模块级方法,类方法...上使用清单。


9
hasattr或getattr可用于确定是否定义了函数。我有一个数据库映射(eventType和处理functionName),我想确保自己永远不会“忘记”在我的python中定义事件处理程序
Shaun

9
如果您已经知道模块名称,则此方法有效。但是,如果您希望用户以字符串形式提供模块名称,则将无法使用。
Blairg23

7
如果需要避免NoneType不是可调用的异常,则还可以采用getattr的三参数形式:getattr(foo,'bar',lambda:None)。我为格式表示歉意;stackexchange android应用程序显然很糟糕。
geekofalltrades

3
如果仅关心例如本地/当前模块的功能,也请参阅@sastanin提供的答案。
NuSkooler 2015年

6
@akki是的,如果你是foo模块,您可以使用globals()要做到这一点:methodToCall = globals()['bar']
本·霍伊特

543
locals()["myfunction"]()

要么

globals()["myfunction"]()

locals返回带有当前本地符号表的字典。globals返回带有全局符号表的字典。


53
如果您要调用的方法是在您从中调用的同一模块中定义的,则此方法具有globals / locals很好。
Joelmob 2014年

@Joelmob还有其他方法可以通过字符串从根名称空间中获取对象吗?
尼克T

@NickT我只知道这些方法,我认为没有其他方法可以实现与这些方法相同的功能,至少我不认为应该有更多方法。
Joelmob 2015年

我有一个理由给您(实际上是什么导致了我):模块A有一个函数F,需要按名称调用函数。模块B导入模块A,然后调用函数F并调用调用模块B中定义的函数G的请求。此调用失败,因为显然,函数F仅与模块F中定义的全局变量一起运行-因此globals() ['G'] =无。
大卫·斯坦

336

帕特里克(Patrick)的解决方案可能是最干净的。如果您还需要动态提取模块,则可以按以下方式导入它:

module = __import__('foo')
func = getattr(module, 'bar')
func()

93
我不明白那最后的评论。__import__拥有自己的权利,提到的文档中的下一个句子说:“很少使用__import __(),除非要导入仅在运行时知道其名称的模块”。因此:给定答案+1。
hoffmaje 2012年

50
使用importlib.import_module。官方文档说__import__:“这是日常Python编程中不需要的高级功能,与importlib.import_module()不同。” docs.python.org/2/library/functions.html#__import__
glarrain

8
@glarrain只要您认为仅支持2.7及更高版本就可以。
熊加米奥夫

1
@Xiong Chaimiov importlib.import_module在3.6中受支持。参见docs.python.org/3.6/library/…–
cowlinator

7
@cowlinator是的,在严格的版本控制语义和发布日期(大约在六年后)中,3.6是“ 2.7及更高版本”的一部分。在我发表评论后的三年里,它也不存在。;)在3.x分支中,该模块自3.1起就存在。2.7和3.1现在相当古老。您仍然会发现服务器仅支持2.6,但现在值得将importlib用作标准建议。
熊加米奥夫

113

只是一个简单的贡献。如果我们需要实例化的类在同一文件中,则可以使用类似以下内容的东西:

# Get class from globals and create an instance
m = globals()['our_class']()

# Get the function (from the instance) that we need to call
func = getattr(m, 'function_name')

# Call it
func()

例如:

class A:
    def __init__(self):
        pass

    def sampleFunc(self, arg):
        print('you called sampleFunc({})'.format(arg))

m = globals()['A']()
func = getattr(m, 'sampleFunc')
func('sample arg')

# Sample, all on one line
getattr(globals()['A'](), 'sampleFunc')('sample arg')

而且,如果不是课程:

def sampleFunc(arg):
    print('you called sampleFunc({})'.format(arg))

globals()['sampleFunc']('sample arg')

100

给定一个字符串,带有指向函数的完整python路径,这就是我如何获取所述函数的结果:

import importlib
function_string = 'mypackage.mymodule.myfunc'
mod_name, func_name = function_string.rsplit('.',1)
mod = importlib.import_module(mod_name)
func = getattr(mod, func_name)
result = func()

1
这对我有帮助。它是__import__功能的轻量级版本。
Pankaj Bhambhani 2015年

我认为这是最好的答案。
赛义德

55

根据Python编程常见问题解答,最佳答案是:

functions = {'myfoo': foo.bar}

mystring = 'myfoo'
if mystring in functions:
    functions[mystring]()

该技术的主要优点是字符串不需要与函数名称匹配。这也是用于模拟案例构造的主要技术


43

答案(我希望)没有人想要

评估行为

getattr(locals().get("foo") or globals().get("foo"), "bar")()

为什么不添加自动导入

getattr(
    locals().get("foo") or 
    globals().get("foo") or
    __import__("foo"), 
"bar")()

如果我们有额外的字典,我们要检查

getattr(next((x for x in (f("foo") for f in 
                          [locals().get, globals().get, 
                           self.__dict__.get, __import__]) 
              if x)),
"bar")()

我们需要更深入

getattr(next((x for x in (f("foo") for f in 
              ([locals().get, globals().get, self.__dict__.get] +
               [d.get for d in (list(dd.values()) for dd in 
                                [locals(),globals(),self.__dict__]
                                if isinstance(dd,dict))
                if isinstance(d,dict)] + 
               [__import__])) 
        if x)),
"bar")()

可以通过递归扫描目录树并自动安装USB驱动器来改善这一点
wilks,

27

对于它的价值,如果您需要将函数(或类)名称和应用名称作为字符串传递,则可以执行以下操作:

myFnName  = "MyFn"
myAppName = "MyApp"
app = sys.modules[myAppName]
fn  = getattr(app,myFnName)

更通用的是handler = getattr(sys.modules[__name__], myFnName)
lony

21

尝试这个。尽管此方法仍使用eval,但仅使用它从当前上下文中调用函数。这样,您便可以根据需要使用实际功能。

这对我的主要好处是,在调用该函数时,您将得到与评估有关的所有错误。这样,您在调用时将获得与功能相关的错误。

def say_hello(name):
    print 'Hello {}!'.format(name)

# get the function by name
method_name = 'say_hello'
method = eval(method_name)

# call it like a regular function later
args = ['friend']
kwargs = {}
method(*args, **kwargs)

1
这是有风险的。字符串可以有任何东西,而eval最终会在没有任何考虑的情况下对它进行评估。
iankit '16

4
当然,考虑到这些风险,您必须谨记所使用的上下文,是否合适。
tvt173

1
一个函数不应该负责验证其参数-这是另一个函数的工作。说将eval与字符串一起使用是有风险的,就是说使用每个函数都是有风险的。
red777 '18

eval除非绝对必要,否则切勿使用。getattr(__module__, method_name)在这种情况下是一个更好的选择。
moi

14

建议的内容都没有帮助我。我确实发现了这一点。

<object>.__getattribute__(<string name>)(<params>)

我正在使用python 2.66

希望这可以帮助


13
在哪方面比getattr()更好?
V13

1
正是我想要的。奇迹般有效!完善!! self.__getattribute__('title')等于self.title
ioaniatr '18

self.__getattribute__('title')毕竟在任何情况下都不起作用(不知道为什么),但是func = getattr(self, 'title'); func();可以。所以,也许是更好地使用getattr(),而不是
ioaniatr

10
不懂python的人可以停止批评这个垃圾吗?使用getattr代替。
阿兰·菲

6

就像这个问题一样,如何使用方法名称分配给变量[duplicate]来动态调用类中的方法,这个变量被标记为重复变量,我在这里发布了一个相关的答案:

场景是,一个类中的一个方法想动态调用同一类上的另一个方法,我在原始示例中添加了一些细节,从而提供了更广泛的场景和清晰度:

class MyClass:
    def __init__(self, i):
        self.i = i

    def get(self):
        func = getattr(MyClass, 'function{}'.format(self.i))
        func(self, 12)   # This one will work
        # self.func(12)    # But this does NOT work.


    def function1(self, p1):
        print('function1: {}'.format(p1))
        # do other stuff

    def function2(self, p1):
        print('function2: {}'.format(p1))
        # do other stuff


if __name__ == "__main__":
    class1 = MyClass(1)
    class1.get()
    class2 = MyClass(2)
    class2.get()

输出(Python 3.7.x)

功能1:12

功能2:12


-7

这是一个简单的答案,例如,这将使您可以清除屏幕。下面有两个示例,分别是eval和exec,它们在清理后将在顶部显示0(如果使用Windows,请更改clearcls,例如Linux和Mac用户将按原样离开)或仅执行它。

eval("os.system(\"clear\")")
exec("os.system(\"clear\")")

3
这不是op要求的。
TuncayGöncüoğlu的
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.