看到一篇不错的 Python 抽象基类的文章,遂摘录。

更详细的关于抽象基类的内容,请参考 Python 文档:abc – 抽象基类

原始文章:接口与抽象基类(知乎)

前言

抽象基类(abstract base class, ABC),提到这个概念应该会马上联想到面向对象、继承。作为继承的一种,它拥有继承中代码共享、提高代码的重用性等优点。例如下面示例:

class Animal(object):
    def eat(self, kind):
        print("{} eat food....".format(kind))
​
class Dog(Animal):
    pass
​
class Cat(Animal):
    pass
    
dog = Dog()
cat = Cat()
dog.eat("dog")
cat.eat("cat")
​
# 输出
# >dog eat food....
# >cat eat food....

 

狗(Dog)和猫(Cat)都属于动物(Animal),它们有很多类似的属性和动作,我们可以在父类中实现这些方法,在子类中直接继承或者重载父类中的方法,这样减少了代码的重复性,提高了代码的共享能力。

作为继承的一种,抽象基类有用继承的上述这些优点,但是它与普通继承也有不同之处:

  • 抽象基类不能实例化
  • 子类需要实现基类指定的抽象方法

看到这里应该会意识到,抽象基类有一种接口的感觉,没错,抽象基类的出现主要是功能就是类似于 Java 等编程语言中的接口。但是需要明确一点,Python 语言中没有 interface 这个概念,只是这是一种约定俗成的编程规范,就如同 Python 也没有真实意义上的私有变量,我们在编程中可以规范的使用下划线来表示某个变量为私有变量。

尽管 Python 中没有接口这个关键字,但是抽象基类实现的功能主要围绕接口在展开,因此,首先类比 Java 来阐述一下编程语言中接口的概念,然后介绍一下 Python 中如何实现抽象基类。

接口

接口(Interface)是对象公开方法的一种集合,在 Java 中通常以 interface 关键字来定义,接口虽然实现过程中和类相似,但是却具有不同的概念。具体而言,类与接口主要有以下几点不同之处:

  • 类实现了对象的属性和方法,而接口指定了使用该接口需要实现哪些方法
  • 类可以实例化,而接口不可以被实例化
  • 类中的方法可以是实现,接口中的方法都是抽象方法

抽象方法:抽象方法的概念是父类中只负责声明该方法,但不具体实现这个方法,实现部分由继承该类的子类负责实现。

如果觉得上述描述有点云里雾里、对接口的概念依然不是非常清楚,不妨来试想一个场景:当你开发一个项目或者服务,你需要给上下游的组件提供接口,让别人来调用你的程序接口(Application Programming Interface, API),上下游组件该怎么样才能达到想要的目的和你的组件无缝衔接?需要通过按照你接口中规定的抽象方法来实现,例如,你提供一个访问网络请求的接口,你不会去实现 host、username、password 的注册和发送请求,这些需要调用的用户去实现,你只需要规定:“调用者必须实现指定方法才能实现调用”即可。

抽象基类

虽然Python中抽象基类和接口概念非常相近,但是它们还是有一些不同之处,例如,

  • 接口需要被实现的子类完成接口中指定的所有方法,而抽象基类不是,抽象基类则没有这么严格的要求
  • 接口需要所有方法都是抽象方法,而抽象基类中有抽象方法,也有自己实现的方法
  • 正是因为抽象基类和接口的不同之处使得接口之所以称为接口、抽象基类之所以称为抽象基类。

为什么使用抽象基类?

前面铺垫了这么多,话说回来,为什么需要抽象基类?

存在的既是合理的,抽象基类的存在自然有它的价值。当你学会一种编程语言的语法时,你可以轻松地完成一项功能的开发,但是如果希望把代码完成得更加优美高效,那么就需要在设计模式等方面下一些功夫,抽象基类就是其中的一个选择,抽象基类具有以下优点:

  • 处理继承问题方面更加规范、系统
  • 明确调用之间的相互关系
  • 使得继承层次更加清晰
  • 限定子类实现的方法

什么是抽象基类?

前面已经介绍了很多有关接口的概念,抽象基类和接口有很多相似之处,例如需要包含抽象方法,不能被实例化,如果更加确切的定义抽象基类:必须包含一个抽象函数(纯虚函数),它是一个不完整的类,它有已经被实现的方法,也有需要子类重写的方法。

抽象基类使用场景

一项功能只有具有应用场景才能体现出它的价值,如果仅仅是为了看上去高逼格,那么倒不如使用最简单的条件、循环语句,没必要花里胡哨,让代码变得难以维护、晦涩难懂。

抽象基类首先它具备普通继承的功能,因此,在代码可以共用,或者需要获取额外属性的时候可以考虑使用抽象基类,例如,狗、猫、牛、羊这些动物有很多共有的属性和方法,我们可以通过实现一个基类,让每个特定的对象来继承它,这样不仅可以实现多态,还可以提高代码的复用能力。

当然,上述说的这些场景都偏重于普通继承的优势,而抽象基类的特别之处更加偏向于接口的特点,因此,它的使用场景和接口也有很多相通之处,例如我们开发一个系统,下面有若干个组件,每个组件都需要按照指定的规范来实现特定的方法,这时候我可以发挥抽象基类的限定功能的优势

下面就结合这个场景来介绍 Python 中抽象基类的实现方法。

Python 抽象基类

场景介绍

假如我们现在实现了一个数据中台的开发,我们对外提供一个接口让不同组件通过这个接口进行访问数据库,来读取数据,我们给数据接口主要有3个功能:

  • 登录数据库
  • 读取数据
  • 执行 SQL 语句

可以想象,登录数据库这个功能在不同组件之间可以共用,不同组件只需要提供 host、user、passwd 即可,至于读取数据这是每个组件都必须单独实现的,可以声明为抽象方法,执行 SQL 语句也是每个子类需要实现的,可以声明为抽象的静态方法。

实现

Python 标准库中有一个模块 abc 可以实现抽象基类和抽象方法,它们的实现方式如下:

  • 抽象基类:通过继承 abc 模块中的 ABC 类来实现抽象基类。
  • 抽象方法:通过装饰器的方法来调用 abc 模块中 abstractmethod 方法来注解抽象基类的方法。

abstractmethod注解除了可以实现抽象方法外,还可以注解类方法(@classmethod)、静态方法(@staticmethod)、属性(@property)。

下面就先实现抽象基类:

from abc import ABC
from abc import abstractmethod
​
​
class Database(ABC):
    def register(self, host, user, password):
        print("Host : {}".format(host))
        print("User : {}".format(user))
        print("Password : {}".format(password))
        print("Register Success!")
​
    @abstractmethod
    def query(self, *args):
        """
        传入查询数据的SQL语句并执行
        """
​
    @staticmethod
    @abstractmethod
    def execute(sql_string):
        """
        执行SQL语句
        """

 

从抽象基类 Database 的实现可以看出,它共包含3个方法,其中 register 是每个子类都需要的,直接实现在抽象基类里,是一个普通的类方法。query 和 execute 只是在基类中进行类声明,给出了描述,但并没有实现,它限定了继承 Database 的子类必须实现这两个方法。

下面就来实现两个组件(子类):

class Component1(Database):
    def __init__(self, host, user, password):
        self.register(host, user, password)
​
    @staticmethod
    def execute(sql_string):
        print(sql_string)
​
    def query(self, *args):
        sql_string = "SELECT ID FROM db_name"
        self.execute(sql_string)
​
​
class Component2(Database):
    def __init__(self, host, user, password):
        self.register(host, user, password)
​
    @staticmethod
    def execute(sql_string):
        print(sql_string)
​
    def query(self, *args):
        sql_string = "SELECT NAME FROM db_name"
        self.execute(sql_string)
​
comp1 = Component1("00.00.00.00", "abc", "000000")
comp2 = Component2("11.11.11.11", "ABC", "111111")
comp1.query()
comp2.query()
​
# 输出结果
# >Host : 00.00.00.00
# >User : abc
# >Password : 000000
# >Register Success!
# >Host : 11.11.11.11
# >User : ABC
# >Password : 111111
# >Register Success!
# >SELECT ID FROM db_name
# >SELECT NAME FROM db_name

 

上述是通过 Python 标准库中 abc 模块实现了抽象基类,其实在 Python 的 collections 中也实现了抽象基类,numbers 中也定义了有关数字对象的抽象基类,可见,抽象基类在 Python 中占据着至关重要的地位。

完整代码

本文所涉及的完整代码可以查看 github 项目 advance-python,也可以直接访问下方链接:

https://github.com/Jackpopc/advance-python/blob/master/5-abstract%20.ipynb


摘录于2022.2.7,原始链接:https://zhuanlan.zhihu.com/p/89549054


本文被阅读了:200次

作者头像
关于  Ailitonia

正因站在了巨人的肩膀上,才越发觉得自己渺小。不求成为巨人,但求与其同行。 把自己所见所闻,记录下来。

→查看所有由Ailitonia发布的文章