Чи можуть модулі мати властивості так само, як і об’єкти?

За допомогою властивостей 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