Вызов функции модуля по его имени (строке)

2060

Как лучше всего вызвать функцию с учетом строки с именем функции в программе Python. Например, предположим, что у меня есть модуль foo, и у меня есть строка, содержимое которой "bar". Как лучше всего позвонить foo.bar()?

Мне нужно получить возвращаемое значение функции, поэтому я просто не использую eval. Я понял, как это сделать, используя evalдля определения временной функции, которая возвращает результат вызова этой функции, но я надеюсь, что есть более элегантный способ сделать это.

2468

Предполагая модуль fooс методом bar:

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

Вы можете сократить строки 2 и 3 до:

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

если это имеет больше смысла для вашего варианта использования.

Вы можете использовать getattrэто в методах, связанных с экземпляром класса, методах уровня модуля, методах класса ... список можно продолжить.

16
  • 14
    hasattr или getattr могут использоваться, чтобы определить, определена ли функция. У меня было отображение базы данных (eventType и обработка functionName), и я хотел убедиться, что никогда не «забыл» определить обработчик событий в моем питонеShaun 03 июн.
  • 12
    Это работает, если вы уже знаете имя модуля. Однако, если вы хотите, чтобы пользователь указал имя модуля в виде строки, это не сработает. Blairg23 21 июня '14 в 7:39
  • 9
    Если вам нужно избежать исключения NoneType is not callable, вы также можете использовать форму с тремя аргументами getattr: getattr (foo, 'bar', lambda: None). Прошу прощения за форматирование; приложение для Android stackexchange, по-видимому, ужасно. geekofalltrades 16 авг.
  • 4
    См. Также ответ @sastanin, если вас интересуют только, например, функции вашего локального / текущего модуля. NuSkooler 19 июня '15 в 22: 192015-06-19 22:19
  • 11
    @akki Да, если вы в в fooмодуле вы можете использовать , globals()чтобы сделать это:methodToCall = globals()['bar']Ben Hoyt 20 дек.
638
locals()["myfunction"]()

или

globals()["myfunction"]()

locals возвращает словарь с текущей локальной таблицей символов. globals возвращает словарь с глобальной таблицей символов.

4
  • 74
    Этот метод с globals / locals хорош, если метод, который вам нужно вызвать, определен в том же модуле, из которого вы вызываете. Joelmob 9 окт.
  • @Joelmob есть ли другой способ получить объект по строке из корневого пространства имен? Nick T 26 янв.
  • @NickT Мне известны только эти методы, я не думаю, что есть другие, которые выполняют ту же функцию, что и эти, по крайней мере, я не могу придумать причину, по которой их должно быть больше. Joelmob 27 янв.
  • 1
    У меня для вас есть причина (на самом деле то, что привело меня сюда): в модуле A есть функция F, которая должна вызывать функцию по имени. Модуль B импортирует модуль A и вызывает функцию F с запросом на вызов функции G, которая определена в модуле B. Этот вызов завершается неудачно, потому что, по-видимому, функция F работает только с глобальными объектами, которые определены в модуле F, поэтому globals () ['G'] = Нет. David Stein 30 янв.
392

Решение Патрика, наверное, самое чистое. Если вам также нужно динамически подобрать модуль, вы можете импортировать его, например:

module = __import__('foo')
func = getattr(module, 'bar')
func()
5
  • 98
    Я не понимаю этого последнего комментария. __import__ имеет собственное право, и следующее предложение в упомянутых документах говорит: «Прямое использование __import __ () редко, за исключением случаев, когда вы хотите импортировать модуль, имя которого известно только во время выполнения». Итак: +1 за данный ответ. hoffmaje 5 мая '12 в 9:33
  • 55
    Используйте importlib.import_module. В официальных документах говорится __import__: «Это расширенная функция, которая не нужна в повседневном программировании на Python, в отличие от importlib.import_module ()». docs.python.org/2/library/functions.html#__import__glarrain 05 авг.
  • 9
    @glarrain Если у вас все в порядке, только с поддержкой 2.7 и выше. Xiong Chiamiov 14 сен '13 в 16:54
  • 2
    @Xiong Chaimiov, importlib.import_moduleподдерживается в версии 3.6. См. Docs.python.org/3.6/library/…cowlinator 5 окт.
  • 8
    @cowlinator Да, 3.6 является частью "2.7 и выше", как в строгой семантике управления версиями, так и в датах выпуска (это произошло примерно шесть лет спустя). Его также не существовало в течение трех лет после моего комментария. ;) В ветке 3.x модуль существует с 3.1. 2.7 и 3.1 теперь довольно древние; вы по-прежнему найдете серверы, поддерживающие только 2.6, но, вероятно, в настоящее время стандартным советом будет importlib. Xiong Chiamiov 05 окт.
136

Просто простой вклад. Если класс, который нам нужно создать, находится в том же файле, мы можем использовать что-то вроде этого:

# 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')
0
130

Учитывая строку с полным путем 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()
2
  • 3
    Это мне помогло. Это облегченная версия __import__функции. Pankaj Bhambhani 16 дек.
  • 2
    Думаю, это был лучший ответ. SdSaati 22 янв.
73

Лучшим ответом в соответствии с FAQ по программированию на Python будет:

functions = {'myfoo': foo.bar}

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

The primary advantage of this technique is that the strings do not need to match the names of the functions. This is also the primary technique used to emulate a case construct

60

Ответ (надеюсь) никто никогда не хотел

Эвал подобное поведение

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")()
2
  • 14
    это можно улучшить путем рекурсивного сканирования дерева каталогов и автоматического монтирования USB-накопителейwilks 21 мая '20 в 0:43
  • Это определенно тот ответ, который я хотел. Идеально. SaladHead 27 фев в 20:13
34

Как бы то ни было, если вам нужно передать имя функции (или класса) и имя приложения в виде строки, вы можете сделать это:

myFnName  = "MyFn"
myAppName = "MyApp"
app = sys.modules[myAppName]
fn  = getattr(app,myFnName)
1
  • Просто немного более общийhandler = getattr(sys.modules[__name__], myFnName)lony 06 окт.
31

Попробуй это. Хотя он все еще использует eval, он использует его только для вызова функции из текущего контекста . Тогда у вас есть настоящая функция, которую вы можете использовать по своему усмотрению.

Основное преимущество для меня в том, что вы получите любые ошибки, связанные с 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)
4
  • 2
    Это было бы рискованно. Строка может иметь что угодно, и eval в конечном итоге вычислит ее безо всяких соображений. iankit 30 дек.
  • 5
    Конечно, вы должны помнить о контексте, в котором вы его используете, независимо от того, будет ли это уместно с учетом этих рисков. tvt173 06 янв.
  • 3
    Функция не должна отвечать за проверку своих параметров - это задача другой функции. Сказать, что использовать eval со строкой рискованно, значит, что использование каждой функции рискованно. red777 14 авг.
  • 2
    Никогда не используйте без evalкрайней необходимости. getattr(__module__, method_name)- гораздо лучший выбор в этом контексте. moi 14 янв.
16

ничего из предложенного мне не помогло. Я все же обнаружил это.

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

Я использую Python 2.66

Надеюсь это поможет

4
  • 21 год
    В чем это лучше, чем getattr ()? V13 29 июл.
  • 1
    Именно то, что я хотел. Работает как шарм! Идеально!! self.__getattribute__('title')равноself.titleioaniatr 06 авг.
  • self.__getattribute__('title')не работает ни в каких случаях (не знаю почему) в конце концов, но func = getattr(self, 'title'); func();работает. Так что, может быть, лучше использовать getattr()вместо этогоioaniatr 16 авг.
  • 16
    Могут ли люди, которые не знают python, перестать голосовать за этот хлам? Используйте getattrвместо этого. Aran-Fey 23 окт.
12

В качестве этого вопроса Как динамически вызывать методы в классе с использованием присвоения имени метода переменной [дубликат], помеченной как дубликат, как этот, я отправляю связанный ответ здесь:

Сценарий заключается в том, что метод в классе хочет динамически вызывать другой метод в том же классе, я добавил некоторые детали в исходный пример, который предлагает более широкий сценарий и ясность:

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()

Output (Python 3.7.x)

function1: 12

function2: 12

9

Хотя getattr () является элегантным (и примерно в 7 раз быстрее) методом, вы можете получить возвращаемое значение из функции (локального, метода класса, модуля) с eval, столь же элегантным, как x = eval('foo.bar')(). И когда вы реализуете некоторую обработку ошибок, то достаточно безопасно (тот же принцип можно использовать для getattr). Пример с импортом модуля и классом:

# import module, call module function, pass parameters and print retured value with eval():
import random
bar = 'random.randint'
randint = eval(bar)(0,100)
print(randint) # will print random int from <0;100)

# also class method returning (or not) value(s) can be used with eval: 
class Say:
    def say(something='nothing'):
        return something

bar = 'Say.say'
print(eval(bar)('nice to meet you too')) # will print 'nice to meet you' 

Когда модуль или класс не существует (опечатка или что-то лучше), возникает ошибка NameError. Когда функция не существует, возникает AttributeError. Это можно использовать для обработки ошибок:

# try/except block can be used to catch both errors
try:
    eval('Say.talk')() # raises AttributeError because function does not exist
    eval('Says.say')() # raises NameError because the class does not exist
    # or the same with getattr:
    getattr(Say, 'talk')() # raises AttributeError
    getattr(Says, 'say')() # raises NameError
except AttributeError:
    # do domething or just...
    print('Function does not exist')
except NameError:
    # do domething or just...
    print('Module does not exist')
4

getattrвызывает метод по имени из объекта. Но этот объект должен быть родительским для вызывающего класса. Родительский класс может быть полученsuper(self.__class__, self)

class Base:
    def call_base(func):
        """This does not work"""
        def new_func(self, *args, **kwargs):
            name = func.__name__
            getattr(super(self.__class__, self), name)(*args, **kwargs)
        return new_func

    def f(self, *args):
        print(f"BASE method invoked.")

    def g(self, *args):
        print(f"BASE method invoked.")

class Inherit(Base):
    @Base.call_base
    def f(self, *args):
        """function body will be ignored by the decorator."""
        pass

    @Base.call_base
    def g(self, *args):
        """function body will be ignored by the decorator."""
        pass

Inherit().f() # The goal is to print "BASE method invoked."
0

Раньше я сталкивался с аналогичной проблемой, которая заключается в преобразовании строки в функцию. но я не могу использовать eval()или ast.literal_eval(), потому что не хочу сразу выполнять этот код.

например, у меня есть строка "foo.bar", и я хочу назначить ее xкак имя функции вместо строки, что означает, что я могу вызвать функцию x() ПО ЗАПРОСУ .

вот мой код:

str_to_convert = "foo.bar"
exec(f"x = {str_to_convert}")
x()

Что касается вашего вопроса, вам нужно только добавить имя своего модуля fooи .до {}следующего:

str_to_convert = "bar"
exec(f"x = foo.{str_to_convert}")
x()

ПРЕДУПРЕЖДЕНИЕ!!! либо, eval()либо exec()является опасным методом, вы должны подтвердить безопасность. ПРЕДУПРЕЖДЕНИЕ!!! либо, eval()либо exec()является опасным методом, вы должны подтвердить безопасность. ПРЕДУПРЕЖДЕНИЕ!!! либо, eval()либо exec()является опасным методом, вы должны подтвердить безопасность.

0

В python3 вы можете использовать __getattribute__метод. См. Следующий пример со строкой имени метода списка:

func_name = 'reverse'

l = [1, 2, 3, 4]
print(l)
>> [1, 2, 3, 4]

l.__getattribute__(func_name)()
print(l)
>> [4, 3, 2, 1]
-13

Это простой ответ, это позволит вам, например, очистить экран. Ниже приведены два примера с eval и exec, которые будут выводить 0 вверху после очистки (если вы используете Windows, измените clearна cls, например, пользователи Linux и Mac оставят как есть) или просто выполните его, соответственно.

eval("os.system(\"clear\")")
exec("os.system(\"clear\")")
2
  • 5
    Это не то, о чем спрашивает op. Tuncay Göncüoğlu 14 ноя '19 в 7:30
  • 9
    этот фрагмент кода содержит 2 наихудших недостатка безопасности, вложенных друг в друга. Какая-то запись. Jean-François Fabre 17 июл.