Реалізація інтерфейсів з абстрактними базовими класами набагато простіше в сучасному 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 .)