Dapatkah modul memiliki properti dengan cara yang sama seperti objek?

Dengan properti python, saya bisa membuatnya seperti itu

obj.y 

memanggil fungsi, bukan hanya mengembalikan nilai.

Apakah ada cara untuk melakukan ini dengan modul? Saya memiliki kasus yang saya inginkan

module.y 

untuk memanggil fungsi, bukan hanya mengembalikan nilai yang disimpan di sana.

Hanya instance dari kelas gaya baru yang dapat memiliki properti. Anda dapat membuat Python percaya bahwa instance seperti itu adalah modul dengan menyimpannya sys.modules[thename] = theinstance. Jadi, misalnya, file modul m.py Anda bisa jadi:

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

Saya akan melakukan ini untuk mewarisi semua atribut modul dengan benar, dan diidentifikasi dengan benar oleh isinstance ()

import types

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


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

Dan kemudian Anda dapat memasukkan ini ke dalam sys.modules:

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

Karena PEP 562 telah diimplementasikan dengan Python> = 3.7, sekarang kita bisa melakukan ini

file: module.py

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

other = 4

pemakaian:

>>> 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'

Perhatikan bahwa jika Anda menghilangkan raise AttributeErrorin the __getattr__function, itu berarti fungsi diakhiri dengan return None, maka module.nosuchakan mendapatkan nilai None.

Berdasarkan jawaban John Lin :

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

Penggunaan (perhatikan garis bawah di depan), di the_module.py:

@module_property
def _thing():
    return 'hello'

Kemudian:

import the_module

print(the_module.thing)  # prints 'hello'

Garis bawah di depan diperlukan untuk membedakan fungsi yang di-properti-kan dari fungsi aslinya. Saya tidak dapat memikirkan cara untuk menetapkan ulang pengenal, karena selama waktu eksekusi dekorator, pengenal tersebut belum ditetapkan.

Perhatikan bahwa IDE tidak akan mengetahui bahwa properti itu ada dan akan menampilkan gelombang merah.

Kasus penggunaan tipikal adalah: memperkaya modul (besar) yang ada dengan beberapa (beberapa) atribut dinamis - tanpa mengubah semua materi modul menjadi tata letak kelas. Sayangnya patch kelas modul yang paling sederhana seperti sys.modules[__name__].__class__ = MyPropertyModulegagal dengan TypeError: __class__ assignment: only for heap types. Jadi pembuatan modul perlu kabel.

Pendekatan ini melakukannya tanpa kait impor Python, hanya dengan memiliki beberapa prolog di atas kode modul:

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

Pemakaian:

>>> 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'"

Catatan: Sesuatu seperti from propertymodule import dynvalakan menghasilkan salinan beku tentu saja - sesuai dengandynval = someobject.dynval

Jawaban singkatnya: gunakan proxy_tools

The proxy_toolspaket mencoba untuk memberikan @module_propertyfungsionalitas.

Ini menginstal dengan

pip install proxy_tools

Menggunakan sedikit modifikasi dari contoh @ Marein, the_module.pykami masukkan

from proxy_tools import module_property

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

Sekarang dari skrip lain, saya bisa melakukannya

import the_module

print(the_module.thing)
# . hello

Perilaku tidak terduga

Solusi ini bukannya tanpa peringatan. Yaitu, the_module.thingadalah tidak string ! Ini adalah proxy_tools.Proxyobjek yang metode khususnya telah diganti sehingga meniru string. Berikut adalah beberapa tes dasar yang menggambarkan hal tersebut:

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']

Secara internal, fungsi asli disimpan ke the_module.thing._Proxy__local:

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

Pikiran lebih lanjut

Sejujurnya, saya bingung tentang mengapa modul tidak memiliki fungsi bawaan ini. Saya pikir inti masalahnya adalah itu the_moduleadalah turunan dari types.ModuleTypekelas. Menyetel "properti modul" berarti menyetel properti pada instance kelas ini, bukan pada types.ModuleTypekelas itu sendiri. Untuk lebih jelasnya, lihat jawaban ini .

Kami sebenarnya dapat mengimplementasikan properti pada types.ModuleTypesebagai berikut, meskipun hasilnya tidak bagus. Kami tidak dapat langsung mengubah tipe bawaan, tetapi kami dapat mengutuknya :

# 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__}'))

Ini memberi kita properti yang ada di semua modul. Ini agak sulit, karena kami merusak perilaku pengaturan di semua modul:

import sys

print(sys.thing2)
# hi from sys

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