Các mô-đun có thể có các thuộc tính giống như các đối tượng không?

Với các thuộc tính của python, tôi có thể làm cho nó như vậy

obj.y 

gọi một hàm thay vì chỉ trả về một giá trị.

Có cách nào để làm điều này với các mô-đun? Tôi có một trường hợp mà tôi muốn

module.y 

để gọi một hàm, thay vì chỉ trả về giá trị được lưu trữ ở đó.

Chỉ các trường hợp của lớp kiểu mới mới có thể có thuộc tính. Bạn có thể làm cho Python tin rằng một ví dụ như vậy là một mô-đun bằng cách lưu trữ nó vào sys.modules[thename] = theinstance. Vì vậy, ví dụ: tệp mô-đun m.py của bạn có thể là:

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

Tôi sẽ làm điều này để kế thừa đúng tất cả các thuộc tính của một mô-đun và được xác định chính xác bởi isinstance ()

import types

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


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

Và sau đó bạn có thể chèn cái này vào sys.modules:

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

Vì PEP 562 đã được triển khai bằng Python> = 3.7, bây giờ chúng ta có thể làm điều này

tệp: module.py

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

other = 4

sử dụng:

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

Lưu ý rằng nếu bạn bỏ qua hàm raise AttributeErrortrong __getattr__hàm, điều đó có nghĩa là hàm kết thúc bằng return None, sau đó module.nosuchsẽ nhận giá trị là None.

Dựa trên câu trả lời của 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

Cách sử dụng (lưu ý dấu gạch dưới ở đầu), trong the_module.py:

@module_property
def _thing():
    return 'hello'

Sau đó:

import the_module

print(the_module.thing)  # prints 'hello'

Dấu gạch dưới hàng đầu là cần thiết để phân biệt hàm thuộc tính ized với hàm gốc. Tôi không nghĩ ra cách nào để gán lại số nhận dạng, vì trong thời gian thực thi decorator, nó vẫn chưa được gán.

Lưu ý rằng IDE sẽ không biết rằng thuộc tính tồn tại và sẽ hiển thị wavies màu đỏ.

Một trường hợp sử dụng điển hình là: làm phong phú thêm một (rất lớn) mô-đun hiện có bằng một số (vài) thuộc tính động - mà không biến tất cả nội dung mô-đun thành một bố cục lớp. Thật không may, một bản vá lớp mô-đun đơn giản nhất như sys.modules[__name__].__class__ = MyPropertyModulekhông thành công với TypeError: __class__ assignment: only for heap types. Vì vậy việc tạo mô-đun cần phải được tua lại.

Cách tiếp cận này thực hiện điều đó mà không cần đến các móc nhập Python, chỉ bằng cách có một số đoạn mở đầu trên đầu mã mô-đun:

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

Sử dụng:

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

Lưu ý: Tất nhiên, một cái gì đó giống như from propertymodule import dynvalsẽ tạo ra một bản sao cố định - tương ứng vớidynval = someobject.dynval

Một câu trả lời ngắn gọn: sử dụng proxy_tools

Các proxy_toolsgói nỗ lực để cung cấp @module_propertychức năng.

Nó cài đặt với

pip install proxy_tools

Sử dụng một chút sửa đổi ví dụ của @ Marein, the_module.pychúng tôi đưa

from proxy_tools import module_property

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

Bây giờ từ một tập lệnh khác, tôi có thể làm

import the_module

print(the_module.thing)
# . hello

Hành vi không mong muốn

Giải pháp này không phải là không có cảnh báo. Cụ thể, the_module.thinglà không phải là một chuỗi ! Nó là một proxy_tools.Proxyđối tượng có các phương thức đặc biệt đã được ghi đè để nó bắt chước một chuỗi. Dưới đây là một số bài kiểm tra cơ bản minh họa quan điểm:

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

Trong nội bộ, chức năng gốc được lưu trữ để the_module.thing._Proxy__local:

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

Suy nghĩ thêm

Thành thật mà nói, tôi bối rối về lý do tại sao các mô-đun không được tích hợp sẵn chức năng này. Tôi nghĩ mấu chốt của vấn đề là đó the_modulelà một phiên bản của types.ModuleTypelớp. Đặt một "thuộc tính mô-đun" tương đương với việc đặt một thuộc tính trên một thể hiện của lớp này, chứ không phải trên types.ModuleTypechính lớp đó. Để biết thêm chi tiết, hãy xem câu trả lời này .

Chúng tôi thực sự có thể triển khai các thuộc tính trên types.ModuleTypenhư sau, mặc dù kết quả không lớn. Chúng tôi không thể sửa đổi trực tiếp các loại tích hợp sẵn, nhưng chúng tôi có thể nguyền rủa chúng:

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

Điều này cung cấp cho chúng tôi một thuộc tính tồn tại trên tất cả các mô-đun. Nó hơi khó sử dụng, vì chúng tôi phá vỡ hành vi cài đặt trên tất cả các mô-đun:

import sys

print(sys.thing2)
# hi from sys

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