Могут ли модули иметь свойства так же, как объекты?

С помощью свойств Python я могу сделать так, чтобы

obj.y 

вызывает функцию, а не просто возвращает значение.

Есть ли способ сделать это с помощью модулей? У меня есть случай где я хочу

module.y 

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

Только экземпляры классов нового стиля могут иметь свойства. Вы можете заставить Python поверить, что такой экземпляр является модулем, спрятав его в sys.modules[thename] = theinstance. Так, например, ваш файл модуля m.py может быть:

import sys

class _M(object):
    def __init__(self):
        self.c = 0
    def afunction(self):
        self.c += 1
        return self.c
    y = property(afunction)

sys.modules[__name__] = _M()

Я бы сделал это, чтобы правильно унаследовать все атрибуты модуля и правильно идентифицировать isinstance ()

import types

class MyModule(types.ModuleType):
    @property
    def y(self):
        return 5


>>> a=MyModule("test")
>>> a
<module 'test' (built-in)>
>>> a.y
5

А затем вы можете вставить это в sys.modules:

sys.modules[__name__] = MyModule(__name__)  # remember to instantiate the class

Поскольку PEP 562 был реализован в Python> = 3.7, теперь мы можем это сделать

файл: module.py

def __getattr__(name):
    if name == 'y':
        return 3
    raise AttributeError(f"module '{__name__}' has no attribute '{name}'")

other = 4

использование:

>>> import module
>>> module.y
3
>>> module.other
4
>>> module.nosuch
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "module.py", line 4, in __getattr__
    raise AttributeError(f"module '{__name__}' has no attribute '{name}'")
AttributeError: module 'module' has no attribute 'nosuch'

Обратите внимание: если вы опустите raise AttributeErrorв __getattr__функции, это означает, что функция заканчивается на return None, тогда module.nosuchбудет получено значение None.

На основе ответа Джона Линя :

def module_property(func):
    """Decorator to turn module functions into properties.
    Function names must be prefixed with an underscore."""
    module = sys.modules[func.__module__]

    def base_getattr(name):
        raise AttributeError(
            f"module '{module.__name__}' has no attribute '{name}'")

    old_getattr = getattr(module, '__getattr__', base_getattr)

    def new_getattr(name):
        if f'_{name}' == func.__name__:
            return func()
        else:
            return old_getattr(name)

    module.__getattr__ = new_getattr
    return func

Использование (обратите внимание на подчеркивание в начале) в the_module.py:

@module_property
def _thing():
    return 'hello'

Затем:

import the_module

print(the_module.thing)  # prints 'hello'

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

Обратите внимание, что IDE не будут знать, что свойство существует, и будут отображать красные волны.

Типичный вариант использования: обогащение (огромного) существующего модуля некоторыми (небольшими) динамическими атрибутами - без превращения всего модуля в макет класса. К сожалению , самый простой модуль класса патч , как sys.modules[__name__].__class__ = MyPropertyModuleтерпит неудачу с TypeError: __class__ assignment: only for heap types. Так что создание модуля нужно переделать.

Этот подход делает это без перехватчиков импорта Python, просто имея некоторый пролог поверх кода модуля:

# propertymodule.py
""" Module property example """

if '__orgmod__' not in globals():

    # constant prolog for having module properties / supports reload()

    print "PropertyModule stub execution", __name__
    import sys, types
    class PropertyModule(types.ModuleType):
        def __str__(self):
            return "<PropertyModule %r from %r>" % (self.__name__, self.__file__)
    modnew = PropertyModule(__name__, __doc__)
    modnew.__modclass__ = PropertyModule        
    modnew.__file__ = __file__
    modnew.__orgmod__ = sys.modules[__name__]
    sys.modules[__name__] = modnew
    exec sys._getframe().f_code in modnew.__dict__

else:

    # normal module code (usually vast) ..

    print "regular module execution"
    a = 7

    def get_dynval(module):
        return "property function returns %s in module %r" % (a * 4, module.__name__)    
    __modclass__.dynval = property(get_dynval)

Использование:

>>> import propertymodule
PropertyModule stub execution propertymodule
regular module execution
>>> propertymodule.dynval
"property function returns 28 in module 'propertymodule'"
>>> reload(propertymodule)   # AFTER EDITS
regular module execution
<module 'propertymodule' from 'propertymodule.pyc'>
>>> propertymodule.dynval
"property function returns 36 in module 'propertymodule'"

Примечание: что-то вроде from propertymodule import dynval, конечно, создаст замороженную копию - соответствующуюdynval = someobject.dynval

Короткий ответ: используйте proxy_tools

proxy_toolsПакет пытается обеспечить @module_propertyфункциональные возможности .

Он устанавливается с

pip install proxy_tools

Используя небольшую модификацию примера @Marein, the_module.pyмы помещаем

from proxy_tools import module_property

@module_property
def thing():
    print(". ", end='')  # Prints ". " on each invocation
    return 'hello'

Теперь из другого сценария я могу сделать

import the_module

print(the_module.thing)
# . hello

Неожиданное поведение

Это решение не лишено недостатков. А именно the_module.thingэто не строка ! Это proxy_tools.Proxyобъект, специальные методы которого были переопределены, чтобы имитировать строку. Вот несколько основных тестов, которые иллюстрируют это:

res = the_module.thing
# [No output!!! Evaluation doesn't occur yet.]

print(type(res))
# <class 'proxy_tools.Proxy'>

print(isinstance(res, str))
# False

print(res)
# . hello

print(res + " there")
# . hello there

print(isinstance(res + "", str))
# . True

print(res.split('e'))
# . ['h', 'llo']

Внутри исходная функция сохраняется в the_module.thing._Proxy__local:

print(res._Proxy__local)
# <function thing at 0x7f729c3bf680>

Дальнейшие мысли

Честно говоря, я сбит с толку, почему в модули не встроена эта функциональность. Я думаю, что суть вопроса в том, что the_moduleэто экземпляр types.ModuleTypeкласса. Установка «свойства модуля» сводится к установке свойства на экземпляре этого класса, а не на самом types.ModuleTypeклассе. Подробнее см. В этом ответе .

Фактически мы можем реализовать свойства types.ModuleTypeследующим образом, хотя результаты невелики. Мы не можем напрямую изменять встроенные типы, но можем проклинать их:

# python -m pip install forbiddenfruit
from forbiddenfruit import curse
from types import ModuleType
# curse has the same signature as setattr.
curse(ModuleType, "thing2", property(lambda module: f'hi from {module.__name__}'))

Это дает нам свойство, которое существует для всех модулей. Это немного громоздко, так как мы нарушаем поведение настроек для всех модулей:

import sys

print(sys.thing2)
# hi from sys

sys.thing2 = 5
# AttributeError: can't set attribute