Реализация интерфейсов с абстрактными базовыми классами намного проще в современном Python 3, и они служат в качестве контракта интерфейса для расширений плагинов.
Создание интерфейса / абстрактного базового класса:
from abc import ABC, abstractmethod
class AccountingSystem(ABC):
@abstractmethod
def create_purchase_invoice(self, purchase):
pass
@abstractmethod
def create_sale_invoice(self, sale):
log.debug('Creating sale invoice', sale)
Создайте нормальный подкласс и переопределите все абстрактные методы:
class GizmoAccountingSystem(AccountingSystem):
def create_purchase_invoice(self, purchase):
submit_to_gizmo_purchase_service(purchase)
def create_sale_invoice(self, sale):
super().create_sale_invoice(sale)
submit_to_gizmo_sale_service(sale)
При желании вы можете иметь общую реализацию в абстрактных методах, как в create_sale_invoice()
, вызывая ее явно с super()
в подклассе, как указано выше.
Ошибка создания подкласса, который не реализует все абстрактные методы:
class IncompleteAccountingSystem(AccountingSystem):
pass
>>> accounting = IncompleteAccountingSystem()
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TypeError: Can't instantiate abstract class IncompleteAccountingSystem with abstract methods
create_purchase_invoice, create_sale_invoice
Вы также можете иметь абстрактные свойства, статические и методы классов, комбинируя соответствующие аннотации с @abstractmethod
.
Абстрактные базовые классы отлично подходят для реализации систем на основе плагинов. Все импортированные подклассы класса доступны через __subclasses__()
, поэтому, если вы загружаете все классы из каталога плагинов с помощью importlib.import_module()
и если они подклассируют базовый класс, у вас есть прямой доступ к ним через __subclasses__()
и вы можете быть уверены что интерфейсный контракт применяется для всех из них во время реализации.
Вот реализация загрузки плагинов для AccountingSystem
примера выше:
...
from importlib import import_module
class AccountingSystem(ABC):
...
_instance = None
@classmethod
def instance(cls):
if not cls._instance:
module_name = settings.ACCOUNTING_SYSTEM_MODULE_NAME
import_module(module_name)
subclasses = cls.__subclasses__()
if len(subclasses) > 1:
raise InvalidAccountingSystemError('More than one '
f'accounting module: {subclasses}')
if not subclasses or module_name not in str(subclasses[0]):
raise InvalidAccountingSystemError('Accounting module '
f'{module_name} does not exist or does not '
'subclass AccountingSystem')
cls._instance = subclasses[0]()
return cls._instance
Затем вы можете получить доступ к объекту плагина системы учета через класс AccountingSystem
:
>>> accountingsystem = AccountingSystem.instance()
(Вдохновлено этим сообщением PyMOTW-3 .)