Блог

У меня есть класс, который предоставляет простой интерфейс к API. Я хочу определить метод в этом классе для каждого маршрута.

Поскольку большинство маршрутов одинаковы, большая часть функциональности может быть включена в более универсальную функцию, причем многие маршруты являются просто частично применяемой версией этой функции

 class MyAPIWrapper:

    def _get_results(self, route, **params):
        # Do the important stuff here
        results = ...
        return results

    def get_customers(self):
        return self._get_results(self, 'customers')

    def get_transactions(self):
        return self._get_results(self, 'transactions')

    # etc, etc, etc

  

Однако очевидно, что это все еще приводит к значительному количеству шаблонов в определении класса.

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

 import functools

class MyAPIWrapper:

    def __init__(self):
        self._init_route_methods()

    def _get_results(self, route, **params):
        # Do the important stuff here
        results = ...
        return results

    def _init_route_methods(self):
        for route in ['customers', 'transactions', ...]:
            route_fn = functools.partial(self. _get_results, route)
            setattr(self, f'get_{route}', route_fn)

  

Преимущество этого заключается в сокращении количества шаблонов и упрощении добавления / удаления маршрутов. Однако добавление методов при инициализации кажется мне несколько неэлегантным.

Есть ли лучший и / или более идиоматичный способ сделать это?

Вы можете быть удивлены, что это сработает:

 class MyAPIWrapper:
    def _get_results(self, route, **params):
        # Do the important stuff here
        return route

    for route in ['customers', 'transactions']:
        exec("""
    def get_{0}(self):
        return self._get_results('{0}')
    """.strip().format(route))
  

 MyAPIWrapper().get_customers()    # return customers
MyAPIWrapper().get_transactions() # return transactions
  

Плюсы

• Хорошая читаемость
• Минимальное изменение кода

Минусы

Пожалуйста, обратите внимание, что это exec требует немного больше накладных расходов, чем setattr(MyAPIWrapper,'get_%s'%route, ...) , что имеет значение только в том случае, если вы собираетесь создавать миллионы методов в цикле.

Если вы хотите сделать то же самое со многими различными классами APIWrapper, рассмотрите возможность использования вместо этого декоратора класса.