Псевдонимы метода и свойства с пользовательской строкой документации в Python - PullRequest
Новая
       21

Псевдонимы метода и свойства с пользовательской строкой документации в Python

0 голосов
/ 12 января 2019

Я реализовал следующие декораторы: 

class alias(object):

    """
    A decorator for implementing method aliases.
    """

    def __init__(self, *aliases):

        self.aliases = set(aliases)

    def __call__(self, obj):

        if type(obj) == property:
            obj.fget._aliases = self.aliases
        else:
            obj._aliases = self.aliases

        return obj

def aliased(aliased_class):

    """
    A decorator for enabling method aliases.
    """

    aliased_class_dict = aliased_class.__dict__.copy()
    aliased_class_set = set(aliased_class_dict)

    for name, method in aliased_class_dict.items():

        aliases = None

        if (type(method) == property) and hasattr(method.fget, '_aliases'):
            aliases = method.fget._aliases
        elif hasattr(method, '_aliases'):
            aliases = method._aliases

        if aliases:

            for a in aliases - aliased_class_set:
                setattr(aliased_class, a, method)

    return aliased_class

Ниже приведен пример того, как я их использую для создания вызываемых псевдонимов свойств и методов: 

@aliased
class MyClass(object):

    @alias('a')
    @property
    def alpha(self) -> float:

        """
        Returns the value of alpha.
        """

        return 2.5

    @alias('agt')
    def alpha_greater_than(value) -> bool:

        """
        Checks whether alpha is greater than the given value.
        """

        return self.alpha > value

mc = MyClass()
result = mc.agt(3.0)
# ...

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

Этот метод / свойство является псевдонимом X.

1 Ответ

0 голосов
/ 12 января 2019

Вы можете напрямую манипулировать X.__doc__, например: 

if aliases:

    for a in aliases - aliased_class_set:
        method.__doc__ = "This function is an alias of %s." % a
        setattr(aliased_class, a, method)

Но проблема в том, что исходная ссылка X также будет подвержена влиянию. Поэтому вам лучше использовать оболочку: 

def aliased(aliased_class):

    """
    A decorator for enabling method aliases.
    """
    def wrapper(func):
        @functools.wraps(func)
        def inner(*args, **kwargs):
            return func(*args, **kwargs)
        return inner

    aliased_class_dict = aliased_class.__dict__.copy()
    aliased_class_set = set(aliased_class_dict)

    for name, method in aliased_class_dict.items():

        aliases = None

        if (type(method) == property) and hasattr(method.fget, '_aliases'):
            aliases = method.fget._aliases
        elif hasattr(method, '_aliases'):
            aliases = method._aliases

        if aliases:

            for a in aliases - aliased_class_set:
                wrapped_method = wrapper(method)
                wrapped_method.__doc__ = "This function is an alias of %s." % a
                setattr(aliased_class, a, wrapped_method)

    return aliased_class

И тест: 

print(mc.alpha_greater_than.__doc__)
print(mc.agt.__doc__)

Выход: 

        Checks whether alpha is greater than the given value.

This function is an alias of agt.
...