■ はじめに

https://dk521123.hatenablog.com/entry/2019/10/12/075251
https://dk521123.hatenablog.com/entry/2019/08/29/220537

の続き。

今更ながら、Pythonの抽象クラス（Abstract Class）
を知ったので、メモ。

【１】Pythonの抽象クラス - ABC (Abstract Base Classes)
【２】abc.ABC と abc.ABCMeta との違い
【３】使用上の注意
　１）abstractclassmethodは非推奨
【４】サンプル
　１）Hello world
　２）メソッドの引数に渡す
　３）応用編：メッセージ管理するクラス

【１】Pythonの抽象クラス - ABC (Abstract Base Classes)

cf. Abstract Base Class = 抽象基底クラス

https://docs.python.org/ja/3/library/abc.html#abc.ABC

* ABC クラスを継承して実装する
 => はじめ見た時に、テストで適当に作ったクラスかと思ってしまった、、、
 => Python には、 interface がないので、その代わりにもなる
　　（以下のサイトなどを参照）

https://www.lifewithpython.com/2017/11/python-interface.html
https://qiita.com/baikichiz/items/7c3fdb721bb72644f638

【２】abc.ABC と abc.ABCMeta との違い

https://docs.python.org/ja/3/whatsnew/3.4.html#abc

より抜粋
~~~~~~~~~~~~~~~~~
新規クラス ABC はそのメタクラスとして ABCMeta を持ちます。
この ABC を基底クラスとして使うことは 
metaclass=abc.ABCMeta を指定するのと本質的に同じ効果を持ちますが、
少ないタイプ数で単純に書ける上に読みやすいものになります。
~~~~~~~~~~~~~~~~~

要するに

* 書き方が違うだけでほとんど一緒。

【３】使用上の注意

１）abstractclassmethodは非推奨

from abc import ABC, abstractclassmethod

class DemoAbstract(ABC):
  # ★この部分
  @abstractclassmethod
  def initialize(self) -> bool:
    pass

【４】サンプル

１）Hello world

import abc

class SampleAbstract(metaclass=abc.ABCMeta):
  @abc.abstractmethod
  def initialize(self) -> bool:
    pass

class SampleExecutor(SampleAbstract):
  def initialize(self) -> bool:
    print("Hello world. This is from initialize.")
    return True

# 呼び出し
executor = SampleExecutor()
executor.initialize()
# Hello world. This is from initialize.

２）メソッドの引数に渡す

import abc

class BaseDemo(metaclass=abc.ABCMeta):
  @abc.abstractmethod
  def get_message(self, msg_params) -> str:
    pass

class Target(BaseDemo):
  def get_message(self, msg_params) -> str:
    return "Hello world. {0}".format(msg_params)

def print_hello_world(target_class: BaseDemo, msg_params):
  print(target_class. get_message(msg_params))

# 呼び出し
target = Target()
print_hello_world(target, "This is args...")
# Hello world. This is args...

３）応用編：メッセージ管理するクラス

import abc

class MessageBase(metaclass=abc.ABCMeta):
  def __init__(self, message_id: int, message_format: str):
    self.message_id = message_id
    self.message_format = message_format

  @abc.abstractmethod
  def get_message(self, message_params) -> str:
    pass

class Message(MessageBase):
  def get_message(self, message_params) -> str:
    return f"{str(self.message_id).zfill(5)} - {self.message_format.format(message_params)}"

class MessageProvider(object):
  NOT_FOUND = Message(1, "Not found... {0}.")

# 呼び出し
target = MessageProvider.NOT_FOUND
print(target.get_message("This is just test..."))
# 00001 - Not found... This is just test....