Menerapkan antarmuka dengan kelas dasar abstrak jauh lebih sederhana di Python modern 3 dan mereka melayani tujuan sebagai kontrak antarmuka untuk ekstensi plug-in.
Buat antarmuka / kelas dasar abstrak:
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)
Buat subkelas normal dan timpa semua metode abstrak:
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)
Anda dapat secara opsional memiliki implementasi umum dalam metode abstrak seperti pada create_sale_invoice()
, memanggilnya super()
secara eksplisit dalam subkelas seperti di atas.
Instansiasi dari subkelas yang tidak menerapkan semua metode abstrak gagal:
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
Anda juga dapat memiliki properti abstrak, metode statis, dan kelas dengan menggabungkan anotasi yang sesuai dengannya @abstractmethod
.
Kelas dasar abstrak sangat bagus untuk menerapkan sistem berbasis plugin. Semua subclass yang diimpor dari suatu kelas dapat diakses melalui __subclasses__()
, jadi jika Anda memuat semua kelas dari direktori plugin dengan importlib.import_module()
dan jika mereka mensubclass kelas dasar, Anda memiliki akses langsung ke mereka melalui__subclasses__()
dan Anda dapat yakin bahwa kontrak antarmuka diberlakukan untuk semua mereka selama instantiasi.
Berikut implementasi plugin loading untuk AccountingSystem
contoh di atas:
...
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
Kemudian Anda dapat mengakses objek plugin sistem akuntansi melalui AccountingSystem
kelas:
>>> accountingsystem = AccountingSystem.instance()
(Terinspirasi oleh pos PyMOTW-3 ini .)