__getattr__ в модуле

Как можно реализовать эквивалент __getattr__класса в модуле?

пример

При вызове функции, которая не существует в статически определенных атрибутах модуля, я хочу создать экземпляр класса в этом модуле и вызвать в нем метод с тем же именем, что и при поиске атрибутов в модуле.

class A(object):
    def salutation(self, accusative):
        print "hello", accusative

# note this function is intentionally on the module, and not the class above
def __getattr__(mod, name):
    return getattr(A(), name)

if __name__ == "__main__":
    # i hope here to have my __getattr__ function above invoked, since
    # salutation does not exist in the current namespace
    salutation("world")

Который дает:

matt@stanley:~/Desktop$ python getattrmod.py 
Traceback (most recent call last):
  File "getattrmod.py", line 9, in <module>
    salutation("world")
NameError: name 'salutation' is not defined

Некоторое время назад Гвидо объявил, что все специальные методы поиска в классах нового стиля обходят __getattr__и__getattribute__ . Раньше методы Dunder работали с модулями - вы могли, например, использовать модуль в качестве диспетчера контекста, просто определяя __enter__и __exit__, до того, как эти уловки сломаются .

Недавно были возвращены некоторые исторические особенности, в том __getattr__числе и модуль , поэтому существующий хак (модуль, заменяющий себя классом во sys.modulesвремя импорта) больше не нужен.

В Python 3.7+ вы просто используете один очевидный способ. Чтобы настроить доступ к атрибутам в модуле, определите __getattr__функцию на уровне модуля, которая должна принимать один аргумент (имя атрибута) и возвращать вычисленное значение или вызывать AttributeError:

# my_module.py

def __getattr__(name: str) -> Any:
    ...

Это также позволит подключаться к импорту "из", т.е. вы можете возвращать динамически сгенерированные объекты для таких операторов, как from my_module import whatever.

В связи с этим, вместе с модулем getattr вы также можете определить __dir__функцию на уровне модуля, на которую нужно реагировать dir(my_module). Подробности см. В PEP 562 .

Здесь вы столкнетесь с двумя основными проблемами:

1. __xxx__ методы ищутся только в классе
2. TypeError: can't set attributes of built-in/extension type 'module'

(1) означает, что любое решение должно также отслеживать, какой модуль исследуется, иначе каждый модуль будет иметь поведение подстановки экземпляра; и (2) означает, что (1) даже невозможно ... по крайней мере, не напрямую.

К счастью, sys.modules не разборчивы в том, что там происходит, поэтому оболочка будет работать, но только для доступа к модулю (т. Е. Для доступа import somemodule; somemodule.salutation('world')к тому же модулю вам в значительной степени придется выдернуть методы из класса подстановки и добавить их в globals()любой другой с помощью пользовательский метод в классе (мне нравится использовать .export()) или с общей функцией (например, те, которые уже указаны в качестве ответов). Одна вещь, о которой следует помнить: если оболочка создает новый экземпляр каждый раз, а глобальное решение - нет, вы в конечном итоге ведете слегка различающееся поведение О, и вы не можете использовать оба одновременно - это одно или другое.

Обновить

От Гвидо ван Россума :

На самом деле есть хак, который иногда используется и рекомендуется: модуль может определить класс с желаемой функциональностью, а затем в конце заменить себя в sys.modules экземпляром этого класса (или классом, если вы настаиваете , но это обычно менее полезно). Например:

# module foo.py

import sys

class Foo:
    def funct1(self, <args>): <code>
    def funct2(self, <args>): <code>

sys.modules[__name__] = Foo()

Это работает, потому что механизм импорта активно активирует этот взлом и на своем последнем шаге извлекает фактический модуль из sys.modules после его загрузки. (Это не случайно. Взлом был предложен давно, и мы решили, что нам достаточно, чтобы поддержать его в импортном оборудовании.)

Итак, установленный способ добиться того, что вы хотите, - это создать один класс в вашем модуле и в качестве последнего действия модуля заменить sys.modules[__name__]его экземпляром вашего класса - и теперь вы можете играть с __getattr__/ __setattr__/ по __getattribute__мере необходимости.

Примечание 1. Если вы используете эту функцию, тогда все остальное в модуле, например глобальные объекты, другие функции и т. Д., Будет потеряно при выполнении sys.modulesназначения - поэтому убедитесь, что все необходимое находится внутри класса замены.

Примечание 2 : Для поддержки from module import *вы должны __all__определить в классе; например:

class Foo:
    def funct1(self, <args>): <code>
    def funct2(self, <args>): <code>
    __all__ = list(set(vars().keys()) - {'__module__', '__qualname__'})

В зависимости от вашей версии Python могут быть другие имена, которые следует опустить __all__. set()Может быть опущена , если совместимость Python 2 не требуется.

Это хак, но вы можете обернуть модуль классом:

class Wrapper(object):
  def __init__(self, wrapped):
    self.wrapped = wrapped
  def __getattr__(self, name):
    # Perform custom logic here
    try:
      return getattr(self.wrapped, name)
    except AttributeError:
      return 'default' # Some sensible default

sys.modules[__name__] = Wrapper(sys.modules[__name__])

Обычно мы так не поступаем.

Вот что мы делаем.

class A(object):
....

# The implicit global instance
a= A()

def salutation( *arg, **kw ):
    a.salutation( *arg, **kw )

Зачем? Чтобы неявный глобальный экземпляр был виден.

В качестве примеров посмотрите на randomмодуль, который создает неявный глобальный экземпляр, чтобы немного упростить варианты использования, в которых вам нужен «простой» генератор случайных чисел.

Подобно тому, что предлагал @Håvard S, в случае, когда мне нужно было реализовать некоторую магию в модуле (например, __getattr__), я бы определил новый класс, который наследуется от types.ModuleTypeи вставил его sys.modules(вероятно, заменив модуль, в котором ModuleTypeбыл определен мой собственный ).

См. Основной __init__.pyфайл Werkzeug для довольно надежной реализации этого.

Это хакерство, но ...

import types

class A(object):
    def salutation(self, accusative):
        print "hello", accusative

    def farewell(self, greeting, accusative):
         print greeting, accusative

def AddGlobalAttribute(classname, methodname):
    print "Adding " + classname + "." + methodname + "()"
    def genericFunction(*args):
        return globals()[classname]().__getattribute__(methodname)(*args)
    globals()[methodname] = genericFunction

# set up the global namespace

x = 0   # X and Y are here to add them implicitly to globals, so
y = 0   # globals does not change as we iterate over it.

toAdd = []

def isCallableMethod(classname, methodname):
    someclass = globals()[classname]()
    something = someclass.__getattribute__(methodname)
    return callable(something)


for x in globals():
    print "Looking at", x
    if isinstance(globals()[x], (types.ClassType, type)):
        print "Found Class:", x
        for y in dir(globals()[x]):
            if y.find("__") == -1: # hack to ignore default methods
                if isCallableMethod(x,y):
                    if y not in globals(): # don't override existing global names
                        toAdd.append((x,y))


for x in toAdd:
    AddGlobalAttribute(*x)


if __name__ == "__main__":
    salutation("world")
    farewell("goodbye", "world")

Это работает путем перебора всех объектов в глобальном пространстве имен. Если элемент является классом, он выполняет итерацию по атрибутам класса. Если атрибут вызываемый, он добавляет его в глобальное пространство имен как функцию.

Он игнорирует все атрибуты, содержащие «__».

Я бы не стал использовать это в производственном коде, но он должен помочь вам начать.

Вот мой скромный вклад - небольшое приукрашивание высоко оцененного ответа @Håvard S, но немного более явного (так что он может быть приемлем для @ S.Lott, хотя, вероятно, недостаточно хорош для OP):

import sys

class A(object):
    def salutation(self, accusative):
        print "hello", accusative

class Wrapper(object):
    def __init__(self, wrapped):
        self.wrapped = wrapped

    def __getattr__(self, name):
        try:
            return getattr(self.wrapped, name)
        except AttributeError:
            return getattr(A(), name)

_globals = sys.modules[__name__] = Wrapper(sys.modules[__name__])

if __name__ == "__main__":
    _globals.salutation("world")

Создайте файл модуля с вашими классами. Импортируйте модуль. Запустите getattrтолько что импортированный модуль. Вы можете выполнить динамический импорт, используя __import__и извлечь модуль из sys.modules.

Вот ваш модуль some_module.py:

class Foo(object):
    pass

class Bar(object):
    pass

И в другом модуле:

import some_module

Foo = getattr(some_module, 'Foo')

Делаем это динамически:

import sys

__import__('some_module')
mod = sys.modules['some_module']
Foo = getattr(mod, 'Foo')