Русский
Русский
English
Статистика
Реклама

Перевод Functools Инструменты для работы с функциями

Для будущих студентов курса "Python Developer. Basic" подготовили перевод полезной статьи.


Модуль functools предоставляет инструменты для работы с функциями и другими вызываемыми объектами, чтобы адаптировать или расширить их для других целей, не переписывая полностью.

Декораторы

Основным инструментом, который предоставляет модуль functools является класс partial, который можно использовать для оборачивания вызываемых объектов аргументами по умолчанию. Объект, полученный в результате, также можно вызвать или рассматривать его как исходную функцию. Он принимает те же аргументы, что и исходная функция, и может быть вызван с дополнительными позиционными или именованными аргументами.

partial

В этом примере показаны два простых partial объекта для функции myfunc(). Обратите внимание, что функция show_details() выводит атрибуты func, args и ключевые слова partial объекта.

import functoolsdef myfunc(a, b=2):    """Docstring for myfunc()."""    print '\tcalled myfunc with:', (a, b)    returndef show_details(name, f, is_partial=False):    """Show details of a callable object."""    print '%s:' % name    print '\tobject:', f    if not is_partial:        print '\t__name__:', f.__name__    print '\t__doc__', repr(f.__doc__)    if is_partial:        print '\tfunc:', f.func        print '\targs:', f.args        print '\tkeywords:', f.keywords    returnshow_details('myfunc', myfunc)myfunc('a', 3)printp1 = functools.partial(myfunc, b=4)show_details('partial with named default', p1, True)p1('default a')p1('override b', b=5)printp2 = functools.partial(myfunc, 'default a', b=99)show_details('partial with defaults', p2, True)p2()p2(b='override b')printprint 'Insufficient arguments:'p1()

В конце примера первый созданный partial вызывается без передачи значения в a, вызывая исключение.

$ python functools_partial.pymyfunc:        object: <function myfunc at 0x100468c08>        __name__: myfunc        __doc__ 'Docstring for myfunc().'        called myfunc with: ('a', 3)partial with named default:        object: <functools.partial object at 0x10046b050>        __doc__ 'partial(func, *args, **keywords) - new function with partial application\n    of the given arguments and keywords.\n'        func: <function myfunc at 0x100468c08>        args: ()        keywords: {'b': 4}        called myfunc with: ('default a', 4)        called myfunc with: ('override b', 5)partial with defaults:        object: <functools.partial object at 0x10046b0a8>        __doc__ 'partial(func, *args, **keywords) - new function with partial application\n    of the given arguments and keywords.\n'        func: <function myfunc at 0x100468c08>        args: ('default a',)        keywords: {'b': 99}        called myfunc with: ('default a', 99)        called myfunc with: ('default a', 'override b')Insufficient arguments:Traceback (most recent call last):  File "functools_partial.py", line 49, in <module>    p1()TypeError: myfunc() takes at least 1 argument (1 given)

update_wrapper

У partial объекта нет атрибутов _name_ или _doc_ по умолчанию, без этих атрибутов декорированные функции сложнее отлаживать. С помощью update_wrapper() можно скопировать и добавить атрибуты из исходной функции в partial объект.

import functoolsdef myfunc(a, b=2):    """Docstring for myfunc()."""    print '\tcalled myfunc with:', (a, b)    returndef show_details(name, f):    """Show details of a callable object."""    print '%s:' % name    print '\tobject:', f    print '\t__name__:',     try:        print f.__name__    except AttributeError:        print '(no __name__)'    print '\t__doc__', repr(f.__doc__)    print    returnshow_details('myfunc', myfunc)p1 = functools.partial(myfunc, b=4)show_details('raw wrapper', p1)print 'Updating wrapper:'print '\tassign:', functools.WRAPPER_ASSIGNMENTSprint '\tupdate:', functools.WRAPPER_UPDATESprintfunctools.update_wrapper(p1, myfunc)show_details('updated wrapper', p1)

Атрибуты, добавленные в wrapper определены в functools.WRAPPER_ASSIGNMENTS, тогда как functools.WRAPPER_UPDATES перечисляет значения, подлежащие изменению.

$ python functools_update_wrapper.pymyfunc:        object: <function myfunc at 0x100468c80>        __name__: myfunc        __doc__ 'Docstring for myfunc().'raw wrapper:        object: <functools.partial object at 0x10046c0a8>        __name__: (no __name__)        __doc__ 'partial(func, *args, **keywords) - new function with partial application\n    of the given arguments and keywords.\n'Updating wrapper:        assign: ('__module__', '__name__', '__doc__')        update: ('__dict__',)updated wrapper:        object: <functools.partial object at 0x10046c0a8>        __name__: myfunc        __doc__ 'Docstring for myfunc().'

Другие вызываемые объекты

Partial работают с любым объектом, который можно вызвать, а не только с отдельными функциями.

import functoolsclass MyClass(object):    """Demonstration class for functools"""        def meth1(self, a, b=2):        """Docstring for meth1()."""        print '\tcalled meth1 with:', (self, a, b)        return        def meth2(self, c, d=5):        """Docstring for meth2"""        print '\tcalled meth2 with:', (self, c, d)        return    wrapped_meth2 = functools.partial(meth2, 'wrapped c')    functools.update_wrapper(wrapped_meth2, meth2)        def __call__(self, e, f=6):        """Docstring for MyClass.__call__"""        print '\tcalled object with:', (self, e, f)        returndef show_details(name, f):    """Show details of a callable object."""    print '%s:' % name    print '\tobject:', f    print '\t__name__:',     try:        print f.__name__    except AttributeError:        print '(no __name__)'    print '\t__doc__', repr(f.__doc__)    return    o = MyClass()show_details('meth1 straight', o.meth1)o.meth1('no default for a', b=3)printp1 = functools.partial(o.meth1, b=4)functools.update_wrapper(p1, o.meth1)show_details('meth1 wrapper', p1)p1('a goes here')printshow_details('meth2', o.meth2)o.meth2('no default for c', d=6)printshow_details('wrapped meth2', o.wrapped_meth2)o.wrapped_meth2('no default for c', d=6)printshow_details('instance', o)o('no default for e')printp2 = functools.partial(o, f=7)show_details('instance wrapper', p2)p2('e goes here')

Этот пример создает partial из экземпляра и методы экземпляра.

$ python functools_method.pymeth1 straight:        object: <bound method MyClass.meth1 of <__main__.MyClass object at0x10046a3d0>>        __name__: meth1        __doc__ 'Docstring for meth1().'        called meth1 with: (<__main__.MyClass object at 0x10046a3d0>, 'no default for a', 3)meth1 wrapper:        object: <functools.partial object at 0x10046c158>        __name__: meth1        __doc__ 'Docstring for meth1().'        called meth1 with: (<__main__.MyClass object at 0x10046a3d0>, 'a goes here', 4)meth2:        object: <bound method MyClass.meth2 of <__main__.MyClass object at0x10046a3d0>>        __name__: meth2        __doc__ 'Docstring for meth2'        called meth2 with: (<__main__.MyClass object at 0x10046a3d0>, 'no default for c', 6)wrapped meth2:        object: <functools.partial object at 0x10046c0a8>        __name__: meth2        __doc__ 'Docstring for meth2'        called meth2 with: ('wrapped c', 'no default for c', 6)instance:        object: <__main__.MyClass object at 0x10046a3d0>        __name__: (no __name__)        __doc__ 'Demonstration class for functools'        called object with: (<__main__.MyClass object at 0x10046a3d0>, 'nodefault for e', 6)instance wrapper:        object: <functools.partial object at 0x10046c1b0>        __name__: (no __name__)        __doc__ 'partial(func, *args, **keywords) - new function with partial application\n    of the given arguments and keywords.\n'        called object with: (<__main__.MyClass object at 0x10046a3d0>, 'e goes here', 7)

wraps

Обновление свойств обернутого вызываемого объекта особенно полезно при использовании в декораторе, поскольку преобразованная функция заканчивается свойствами исходной голой функции.

import functoolsdef show_details(name, f):    """Show details of a callable object."""    print '%s:' % name    print '\tobject:', f    print '\t__name__:',     try:        print f.__name__    except AttributeError:        print '(no __name__)'    print '\t__doc__', repr(f.__doc__)    print    returndef simple_decorator(f):    @functools.wraps(f)    def decorated(a='decorated defaults', b=1):        print '\tdecorated:', (a, b)        print '\t',        f(a, b=b)        return    return decorateddef myfunc(a, b=2):    print '\tmyfunc:', (a,b)    returnshow_details('myfunc', myfunc)myfunc('unwrapped, default b')myfunc('unwrapped, passing b', 3)printwrapped_myfunc = simple_decorator(myfunc)show_details('wrapped_myfunc', wrapped_myfunc)wrapped_myfunc()wrapped_myfunc('args to decorated', 4)

Functools предоставляет декоратор wraps(), который применяет update_wrapper() к декорированной функции.

Сравнение

До Python 2 классы содержали метод _cmp_(), который возвращал -1, 0 или 1 в зависимости от того меньше, равен или больше объект, чем тот, с которым происходит сравнение. В Python 2.1 появляется более богатый интерфейс методов сравнения, _lt_(), _le_(), _eq_(), _ne_(), _gt_() и _ge_(), каждый из которых выполняет одну операцию сравнения и возвращает логическое значение. В Python 3 убран cmp() в пользу этих новых методов, поэтому functools предоставляет инструменты, облегчающие написание классов на Python 2, которые соответствуют новым требованиям сравнения в Python 3.

Богатое сравнение

Богатый интерфейс сравнения реализован так, чтобы классы со сложными сравнениями могли пройти каждый из тестов наиболее эффективно. Однако для классов, где сравнение является относительно простым, нет смысла вручную создавать каждый из методов расширенного набора. Декоратор класса total_ordering() принимает класс, предоставляющий некоторые из методов, и добавляет недостающие.

import functoolsimport inspectfrom pprint import pprint@functools.total_orderingclass MyObject(object):    def __init__(self, val):        self.val = val    def __eq__(self, other):        print '  testing __eq__(%s, %s)' % (self.val, other.val)        return self.val == other.val    def __gt__(self, other):        print '  testing __gt__(%s, %s)' % (self.val, other.val)        return self.val > other.valprint 'Methods:\n'pprint(inspect.getmembers(MyObject, inspect.ismethod))a = MyObject(1)b = MyObject(2)print '\nComparisons:'for expr in [ 'a < b', 'a <= b', 'a == b', 'a >= b', 'a > b' ]:    print '\n%-6s:' % expr    result = eval(expr)    print '  result of %s: %s' % (expr, result)

Класс должен обеспечивать реализацию _eq_() и любого другого метода сравнения из расширенного набора. Декоратор добавляет реализации других методов, которые работают с использованием предоставленных сравнений.

$ python functools_total_ordering.pyMethods:[('__eq__', <unbound method MyObject.__eq__>), ('__ge__', <unbound method MyObject.__ge__>), ('__gt__', <unbound method MyObject.__gt__>), ('__init__', <unbound method MyObject.__init__>), ('__le__', <unbound method MyObject.__le__>), ('__lt__', <unbound method MyObject.__lt__>)]Comparisons:a < b :  testing __gt__(1, 2)  testing __eq__(1, 2)  result of a < b: Truea <= b:  testing __gt__(1, 2)  result of a <= b: Truea == b:  testing __eq__(1, 2)  result of a == b: Falsea >= b:  testing __gt__(1, 2)  testing __eq__(1, 2)  result of a >= b: Falsea > b :  testing __gt__(1, 2)  result of a > b: False

Порядок сортировки

Поскольку старая функция сравнения больше не используется в Python 3, то и аргумент cmp больше не поддерживается такими функциями как sort(). Программы на Python 2, использующие функции сравнения, могут использовать cmp_to_key() для преобразования их в функцию, возвращающую ключ сортировки, который используется для определения позиции в конечной последовательности.

import functoolsclass MyObject(object):    def __init__(self, val):        self.val = val    def __str__(self):        return 'MyObject(%s)' % self.valdef compare_obj(a, b):    """Old-style comparison function.    """    print 'comparing %s and %s' % (a, b)    return cmp(a.val, b.val)# Make a key function using cmp_to_key()get_key = functools.cmp_to_key(compare_obj)def get_key_wrapper(o):    """Wrapper function for get_key to allow for print statements.    """    new_key = get_key(o)    print 'key_wrapper(%s) -> %s' % (o, new_key)    return new_keyobjs = [ MyObject(x) for x in xrange(5, 0, -1) ]for o in sorted(objs, key=get_key_wrapper):    print o

Примечание: как правило, cmp_to_key() используется напрямую, но в этом примере дополнительная обертка функции нужна для того, чтобы вывести более подробную информацию о том, как вызывается ключевая функция.

Выходные данные показывают, что sorted() начинается с вызова get_key_wrapper() для каждого элемента в последовательности для получения ключа. Ключи, возвращаемые cmp_to_key(), являются экземплярами класса, определенного в functools, который реализует расширенный интерфейс сравнения на основе возвращаемого значения функции сравнения старого стиля. После того, как все ключи получены последовательность сортируется путем сравнения ключей.

$ python functools_cmp_to_key.pykey_wrapper(MyObject(5)) -> <functools.K object at 0x100466558>key_wrapper(MyObject(4)) -> <functools.K object at 0x100466590>key_wrapper(MyObject(3)) -> <functools.K object at 0x1004665c8>key_wrapper(MyObject(2)) -> <functools.K object at 0x100466600>key_wrapper(MyObject(1)) -> <functools.K object at 0x100466638>comparing MyObject(4) and MyObject(5)comparing MyObject(3) and MyObject(4)comparing MyObject(2) and MyObject(3)comparing MyObject(1) and MyObject(2)MyObject(1)MyObject(2)MyObject(3)MyObject(4)MyObject(5)

Подробнее о курсе "Python Developer. Basic". Посмотреть открытый урок по теме "Pytest: введение в автотесты" можно здесь.

Источник: habr.com
К списку статей
Опубликовано: 20.11.2020 16:08:20
0

Сейчас читают

Комментариев (0)
Имя
Электронная почта

Блог компании otus. онлайн-образование

Python

Программирование

Functions

Functools

Категории

Последние комментарии

© 2006-2020, personeltest.ru