functools.wraps возвращает __dict__ типа dict вместо типа mappingproxy

Question

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

Я пытаюсь создать декоративный декодер python для моего кода в Python 3. Цель состоит в том, чтобы правильно обернуть функцию или класс, выполнив две вещи: напечатать предупреждение об отказе и добавить __doc__ с информацией об устаревании (которая его можно обработать также sphinx). Я думаю, что я разобрал большую часть того, что хотел, я все еще боюсь с Sphinx, но я нашел кое-что любопытное о поведении functools.wraps. В принципе, __dict__ обернутого класса имеет тип dict, а в развернутом классе - тип mappingproxy.

Вот некоторые витрина код:

import functools 

class Deprecated(object): 
    def __call__(self, cls): 
     myassigns = functools.WRAPPER_ASSIGNMENTS 
     myassigns += ('__mro__',) 

     @functools.wraps(cls, assigned=myassigns) 
     def new_func(*args, **kwargs): 
      warnings.warn(message, category=DeprecationWarning, stacklevel=2) 
      return cls(*args, **kwargs) 

     return new_func 


@Deprecated() 
class SomeOldClass: 
    def some_method(self, x, y): 
     return x + y 

class SomeClass: 
    def some_method(self, x, y): 
     return x + y 

print(type(SomeOldClass.__dict__)) 
print(type(SomeClass.__dict__)) 

И выход:

<class 'dict'> 
<class 'mappingproxy'> 

ли functools.wraps или Сбой в я делаю что-то не так?

Answer 1

я настоятельно рекомендую сделать ваш класс обертка известно, поэтому он не завернуть сам класс:

class Deprecated(object): 
    def __init__(self, messagefmt='{wrapped} is deprecated'): 
     self.messagefmt = messagefmt 

    def __call__(self, wrapped): 
     message = self.messagefmt.format(wrapped=wrapped.__name__) 
     wrappingclass = isinstance(wrapped, type) 
     if wrappingclass: 
      wrappedfunc = wrapped.__init__ 
     else: 
      wrappedfunc = wrapped 

     @functools.wraps(wrappedfunc) 
     def new_func(*args, **kwargs): 
      warnings.warn(message, category=DeprecationWarning, stacklevel=2) 
      return wrappedfunc(*args, **kwargs) 
     wrapped.__doc__ = 'Deprecated\n\n' + message + '\n\n' + (wrapped.__doc__ or '') 

     if wrappingclass: 
      wrapped.__init__ = new_func 
      return wrapped 
     else: 
      return new_func 

Это позволяет использовать его с обоими классами:

@Deprecated() 
class SomeOldClass: 
    def some_method(self, x, y): 
     return x + y 

без затемнения поведение класса и с функциями (возможно, с пользовательским сообщением об отказе):

@Deprecated('foo is dead') 
def foo(): 
    pass 

Итак, когда вы используете их:

>>> import warnings 
>>> warnings.filterwarnings('always', category=DeprecationWarning) 
>>> SomeOldClass() 
/usr/local/bin/ipython3:1: DeprecationWarning: SomeOldClass is deprecated 
    #!/usr/bin/python3 
<__main__.SomeOldClass at 0x7fea8f744a20> 
>>> foo() 
/usr/local/bin/ipython3:1: DeprecationWarning: foo is dead 
    #!/usr/bin/python3 

И аналогично, __doc__ для обоего модифицируются предварять устаревание уведомления (вы можете настроить его, чтобы Sphinxify, я просто обеспечение основного примера).

Answer 2

functools.wrap не ошибается, и вы не совершаете что-то не так, вы вернули функцию, которая возвращает при вызове.

После упаковки, SomeOldClass функция new_func вы завернуты и вернулись:

>>> SomeOldClass 
<function __main__.SomeOldClass> 

не класс. Не оформленный SomeClass сохраняется как класс, который __dict__ является mappingproxy.