Python 抽象基类 ABC ：从实践到优雅

今天我们来聊聊 Python 中的抽象基类（Abstract Base Class，简称 ABC）。虽然这个概念在 Python 中已经存在很久了，但在日常开发中，很多人可能用得并不多，或者用得不够优雅。

让我们从一个实际场景开始：假设你正在开发一个文件处理系统，需要支持不同格式的文件读写，比如 JSON、CSV、XML 等。

初始版本：简单但不够严谨

我们先来看看最简单的实现方式：

class FileHandler:
    def read(self, filename):
        pass
    
    def write(self, filename, data):
        pass

class JsonHandler(FileHandler):
    def read(self, filename):
        import json
        with open(filename, 'r') as f:
            return json.load(f)
    
    def write(self, filename, data):
        import json
        with open(filename, 'w') as f:
            json.dump(data, f)

class CsvHandler(FileHandler):
    def read(self, filename):
        import csv
        with open(filename, 'r') as f:
            return list(csv.reader(f))

这个实现看起来没什么问题，但实际上存在几个隐患：

  1. 无法强制子类实现所有必要的方法
  2. 基类方法的签名（参数列表）可能与子类不一致
  3. 没有明确的接口契约

改进版本：使用抽象基类

让我们引入 abc.ABC 来改进这个设计：

from abc import ABC, abstractmethod

class FileHandler(ABC):
    @abstractmethod
    def read(self, filename: str):
        """读取文件内容"""
        pass
    
    @abstractmethod
    def write(self, filename: str, data: any):
        """写入文件内容"""
        pass

class JsonHandler(FileHandler):
    def read(self, filename: str):
        import json
        with open(filename, 'r') as f:
            return json.load(f)
    
    def write(self, filename: str, data: any):
        import json
        with open(filename, 'w') as f:
            json.dump(data, f)

这个版本引入了两个重要的改进：

  1. 使用 ABC 将 FileHandler 声明为抽象基类
  2. 使用 @abstractmethod 装饰器标记抽象方法

现在，如果我们尝试实例化一个没有实现所有抽象方法的子类，Python 会抛出异常：

# 这个类缺少 write 方法的实现
class BrokenHandler(FileHandler):
    def read(self, filename: str):
        return "some data"

# 这行代码会抛出 TypeError
handler = BrokenHandler()  # TypeError: Can't instantiate abstract class BrokenHandler with abstract method write

进一步优化：添加类型提示和接口约束

让我们再进一步，添加类型提示和更严格的接口约束：

from abc import ABC, abstractmethod
from typing import Any, List, Dict, Union

class FileHandler(ABC):
    @abstractmethod
    def read(self, filename: str) -> Union[Dict, List]:
        """读取文件内容并返回解析后的数据结构"""
        pass
    
    @abstractmethod
    def write(self, filename: str, data: Union[Dict, List]) -> None:
        """将数据结构写入文件"""
        pass
    
    @property
    @abstractmethod
    def supported_extensions(self) -> List[str]:
        """返回支持的文件扩展名列表"""
        pass

class JsonHandler(FileHandler):
    def read(self, filename: str) -> Dict:
        import json
        with open(filename, 'r') as f:
            return json.load(f)
    
    def write(self, filename: str, data: Dict) -> None:
        import json
        with open(filename, 'w') as f:
            json.dump(data, f)
    
    @property
    def supported_extensions(self) -> List[str]:
        return ['.json']

# 使用示例
def process_file(handler: FileHandler, filename: str) -> None:
    if any(filename.endswith(ext) for ext in handler.supported_extensions):
        data = handler.read(filename)
        # 处理数据...
        handler.write(f'processed_{filename}', data)
    else:
        raise ValueError(f"Unsupported file extension for {filename}")

这个最终版本的改进包括：

  1. 添加了类型提示，提高代码的可读性和可维护性
  2. 引入了抽象属性（supported_extensions），使接口更完整
  3. 通过 Union 类型提供了更灵活的数据类型支持
  4. 提供了清晰的文档字符串

使用抽象基类的好处

  1. 接口契约：抽象基类提供了明确的接口定义，任何违反契约的实现都会在运行前被发现。

  2. 代码可读性：通过抽象方法清晰地表明了子类需要实现的功能。

  3. 类型安全：结合类型提示，我们可以在开发时就发现潜在的类型错误。

  4. 设计模式支持：抽象基类非常适合实现诸如工厂模式、策略模式等设计模式。

NotImplementedError 还是 ABC？

很多 Python 开发者会使用 NotImplementedError 来标记需要子类实现的方法：

class FileHandler:
    def read(self, filename: str) -> Dict:
        raise NotImplementedError("Subclass must implement read method")
    
    def write(self, filename: str, data: Dict) -> None:
        raise NotImplementedError("Subclass must implement write method")

这种方式看起来也能达到目的，但与 ABC 相比有几个明显的劣势：

  1. 延迟检查：使用 NotImplementedError 只能在运行时发现问题，而 ABC 在实例化时就会检查。
# 使用 NotImplementedError 的情况
class BadHandler(FileHandler):
    pass

handler = BadHandler()  # 这行代码可以执行
handler.read("test.txt")  # 直到这里才会报错

# 使用 ABC 的情况
class BadHandler(FileHandler):  # FileHandler 是 ABC
    pass

handler = BadHandler()  # 直接在这里就会报错

  1. 缺乏语义：NotImplementedError 本质上是一个异常，而不是一个接口契约。

  2. IDE 支持：现代 IDE 对 ABC 的支持更好，能提供更准确的代码提示和检查。

不过，NotImplementedError 在某些场景下仍然有其价值：

  1. 当你想在基类中提供部分实现，但某些方法必须由子类覆盖时：
from abc import ABC, abstractmethod

class FileHandler(ABC):
    @abstractmethod
    def read(self, filename: str) -> Dict:
        pass
    
    def process(self, filename: str) -> Dict:
        data = self.read(filename)
        if not self._validate(data):
            raise ValueError("Invalid data format")
        return self._transform(data)
    
    def _validate(self, data: Dict) -> bool:
        raise NotImplementedError("Subclass should implement validation")
    
    def _transform(self, data: Dict) -> Dict:
        # 默认实现
        return data

这里，_validate 使用 NotImplementedError 而不是 @abstractmethod，表明它是一个可选的扩展点，而不是必须实现的接口。

代码检查工具的配合

主流的 Python 代码检查工具（pylint、flake8）都对抽象基类提供了良好的支持。

Pylint

Pylint 可以检测到未实现的抽象方法：

# pylint: disable=missing-module-docstring
from abc import ABC, abstractmethod

class Base(ABC):
    @abstractmethod
    def foo(self):
        pass

class Derived(Base):  # pylint: error: Abstract method 'foo' not implemented
    pass

你可以在 .pylintrc 中配置相关规则：

[MESSAGES CONTROL]
# 启用抽象类检查
enable=abstract-method

Flake8

Flake8 本身不直接检查抽象方法实现，但可以通过插件增强这个能力：

pip install flake8-abstract-base-class

配置 .flake8：

[flake8]
max-complexity = 10
extend-ignore = ABC001

metaclass=ABCMeta vs ABC

在 Python 中，有两种方式定义抽象基类：

# 方式 1：直接继承 ABC
from abc import ABC, abstractmethod

class FileHandler(ABC):
    @abstractmethod
    def read(self):
        pass

# 方式 2：使用 metaclass
from abc import ABCMeta, abstractmethod

class FileHandler(metaclass=ABCMeta):
    @abstractmethod
    def read(self):
        pass

这两种方式在功能上是等价的，因为 ABC 类本身就是用 ABCMeta 作为元类定义的：

class ABC(metaclass=ABCMeta):
    """Helper class that provides a standard way to create an ABC using
    inheritance.
    """
    pass

选择建议：

  1. 推荐使用 ABC：

    • 代码更简洁
    • 更符合 Python 的简单直观原则
    • 是 Python 3.4+ 后推荐的方式

  2. 使用 metaclass=ABCMeta 的场景：

    • 当你的类已经有其他元类时
    • 需要自定义元类行为时

例如，当你需要组合多个元类的功能时：

class MyMeta(type):
    def __new__(cls, name, bases, namespace):
        # 自定义的元类行为
        return super().__new__(cls, name, bases, namespace)

class CombinedMeta(ABCMeta, MyMeta):
    pass

class MyHandler(metaclass=CombinedMeta):
    @abstractmethod
    def handle(self):
        pass

实践建议

  1. 当你需要确保一组类遵循相同的接口时，使用抽象基类。

  2. 优先使用类型提示，它们能帮助开发者更好地理解代码。

  3. 适当使用抽象属性（@property + @abstractmethod），它们也是接口的重要组成部分。

  4. 在文档字符串中清晰地说明方法的预期行为和返回值。

通过这个实例，我们可以看到抽象基类如何帮助我们写出更加健壮和优雅的 Python 代码。它不仅能够捕获接口违规，还能提供更好的代码提示和文档支持。在下一个项目中，不妨试试用抽象基类来设计你的接口！

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：/a/942480.html

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

Redis-十大数据类型

Redis-十大数据类型

Reids数据类型指的是value的类型，key都是字符串 redis-server:启动redis服务 redis-cli:进入redis交互式终端 常用的key的操作 redis的命令和参数不区分大小写 ，key和value区分 1、查看当前库所有的key keys * 2、判断某个key是否存在 exists key 3、查…
阅读更多...
IIC驱动EEPROM

IIC驱动EEPROM

代码参考正点原子 i2c_dri:主要是三段式状态机的编写 module iic_dri#(parameter SLAVE_ADDR 7b1010000 , //EEPROM从机地址parameter CLK_FREQ 26d50_000_000, //模块输入的时钟频率parameter I2C_FREQ 18d250_000 //IIC_SCL的时钟频率)( …
阅读更多...
webrtc获取IceCandidate流程

webrtc获取IceCandidate流程

在WebRTC（Web Real-Time Communication）中，ICECandidate是一个关键概念，它用于描述在建立点对点（P2P）连接时可以考虑的潜在通信端点。以下是关于WebRTC中ICECandidate的详细解释： 一、ICECandidate的定义 ICECandidate对象通常包含以下关键属性： foundation：用于唯一…
阅读更多...
一文彻底拿捏DevEco Studio的使用小技巧

一文彻底拿捏DevEco Studio的使用小技巧

程序员Feri一名12年的程序员,做过开发带过团队创过业,擅长Java相关开发、鸿蒙开发、人工智能等,专注于程序员搞钱那点儿事,希望在搞钱的路上有你相伴！君志所向,一往无前！ 0.安装DevEco Studio DevEco Studio面向HarmonyOS应用及元服务开发者提供的集成开…
阅读更多...
基于openEuler22.09部署OpenStack Yoga云平台（一）

基于openEuler22.09部署OpenStack Yoga云平台（一）

OpenStack Yoga部署 安装OpenStack 一、基础准备 基于OpenStack经典的三节点环境进行部署，三个节点分别是控制节点（controller）、计算节点（compute）、存储节点（storage），其中存储…
阅读更多...
新服务器ubuntu系统相关操作

新服务器ubuntu系统相关操作

1、查看驱动：驱动版本535.216.01能够支持cuda12.2，下面直接使用默认安装的cuda。 2、赋予用户管理员权限。 首先有超级用户（root）权限来编辑 /etc/sudoers 文件，visudo 是一个命令，用于安全地编辑 /etc/sudoers 文件。运行： sudo visudo 在 visudo 编辑器中，找到类似…
阅读更多...
微机接口课设——基于Proteus和8086的打地鼠设计（8255、8253、8259）

微机接口课设——基于Proteus和8086的打地鼠设计（8255、8253、8259）

原理图设计 汇编代码 ; I/O 端口地址定义 IOY0 EQU 0600H IOY1 EQU 0640H IOY2 EQU 0680HMY8255_A EQU IOY000H*2 ; 8255 A 口端口地址 MY8255_B EQU IOY001H*2 ; 8255 B 口端口地址 MY8255_C EQU IOY002H*2 ; 8255 C 口端口地址 MY8255_MODE EQU IOY003H*2 ; …
阅读更多...
【C++数据结构——树】二叉树的遍历算法（头歌教学实验平台习题） 【合集】

【C++数据结构——树】二叉树的遍历算法（头歌教学实验平台习题） 【合集】

目录😋 任务描述 相关知识 1. 二叉树的基本概念与结构定义 2. 建立二叉树 3. 先序遍历 4. 中序遍历 5. 后序遍历 6. 层次遍历 测试说明 通关代码 测试结果 任务描述 本关任务：实现二叉树的遍历 相关知识 为了完成本关任务，你需要掌…
阅读更多...
简单园区网拓扑实验

简单园区网拓扑实验

1.实验拓扑 2.实验要求 1、按照图示的VLAN及IP地址需求，完成相关配置 2、要求SW1为VLAN 2/3的主根及主网关 SW2为vlan 20/30的主根及主网关 SW1和SW2互为备份 3、可以使用super vlan 4、上层通过静态路由协议完成数据通信过程 5、AR1为企业出口路由器 6、要求全网可…
阅读更多...
USB接口实现CDC（usb转串口功能）

USB接口实现CDC（usb转串口功能）

主控：stm32f429 PHY芯片：usb3320 Cubemx System Core-RCC connectivity-USB_OTG_HS Middleware and Software Packs-USB_DEVICE 时钟配置：根据自己使用的MCU工作频率设置 Generate Code Keil5 打开工程 usbd_cdc_if.c这个文件&…
阅读更多...
C++---------动态内存管理

C++---------动态内存管理

以下是对 C 中相关概念的详细说明及代码示例&#xff1a; 一、动态分配和堆 new 操作符&#xff1a; new 操作符用于在堆上动态分配内存。它会调用对象的构造函数&#xff08;如果是类对象&#xff09;并返回指向分配内存的指针。示例&#xff1a; #include <iostream&g…
阅读更多...
企业该如何进行合格文件外发管理

企业该如何进行合格文件外发管理

随着信息技术的迅猛发展&#xff0c;企业间的文件交换变得越来越频繁。但是&#xff0c;如何确保文件传输的安全性与效率&#xff0c;成为企业管理者面临的一个重大挑战。镭速&#xff08;Raysync&#xff09;文件外发管理方案以其独特的优势&#xff0c;成为众多企业的首选。本…
阅读更多...
Modbus数据网关在制造企业的应用与效果

Modbus数据网关在制造企业的应用与效果

Modbus是一种广泛应用于工业通信的协议&#xff0c;支持多种设备间的数据交换&#xff0c;如传感器、仪器仪表、PLC、工业机器人、数控机床等。Modbus数据网关则是一种网络通信转换设备&#xff0c;它能够将Modbus协议的数据转换为其他主流协议&#xff08;如MQTT、OPC UA、HTT…
阅读更多...
解决集群Elasticsearch 未授权访问漏洞

解决集群Elasticsearch 未授权访问漏洞

1、ES集群配置 首先至少是三个节点 2、生成证书&#xff08;后面要用&#xff09; cd /home/elasticsearch-7.4.2/bin ./elasticsearch-certutil cert 回车&#xff0c;空密码&#xff08;可以输入密码&#xff09;&#xff0c;回车 3、将elastic-certificates.p12 复制到三…
阅读更多...
mac启ssh服务用于快速文件传输

mac启ssh服务用于快速文件传输

x.1 在mac上启SSH服务 方法一&#xff1a;图形交互界面启ssh&#xff08;推荐&#xff09; 通过sharing - advanced - remote login来启动ssh&#xff1b;&#xff08;中文版mac应该是 “系统设置 → 通用 → 共享”里打开“远程登录”来启动&#xff09; 查看自己的用户名和…
阅读更多...
Jenkins 任意文件读取(CVE-2024-23897)修复及复现

Jenkins 任意文件读取(CVE-2024-23897)修复及复现

Jenkins任意文件读取漏洞CVE-2024-23897修复及复现 漏洞详情影响范围漏洞复现修复建议 Jenkins是一个开源软件项目&#xff0c;是基于Java开发的一种持续集成工具&#xff0c;用于监控持续重复的工作&#xff0c;旨在提供一个开放易用的软件平台&#xff0c;使软件项目可以进行…
阅读更多...
C语言数组查找

C语言数组查找

数组概念 就是一堆数的一个集合&#xff0c;包含于指针&#xff0c;但是与指针不同的是数组是开辟了空间的 char a[20] //开辟了20个空间 char *p //一个指针&#xff0c;并没有开辟空间 数组名作为指针&#xff1a; 在C语言中&#xff0c;数组名通常可以被看作是一…
阅读更多...
HarmonyOS NEXT 实战之元服务：静态案例效果---最近播放音乐

HarmonyOS NEXT 实战之元服务：静态案例效果---最近播放音乐

背景&#xff1a; 前几篇学习了元服务&#xff0c;后面几期就让我们开发简单的元服务吧&#xff0c;里面丰富的内容大家自己加&#xff0c;本期案例 仅供参考 先上本期效果图 &#xff0c;里面图片自行替换 效果图1完整代码案例如下&#xff1a; Index import { authentica…
阅读更多...
CVPR2024 | DiffAM：基于扩散模型的对抗性化妆迁移用于面部隐私保护

CVPR2024 | DiffAM：基于扩散模型的对抗性化妆迁移用于面部隐私保护

DiffAM: Diffusion-based Adversarial Makeup Transfer for Facial Privacy Protection 摘要-Abstract引言-Introduction相关工作-Related Works人脸识别中的对抗攻击化妆迁移扩散模型和风格迁移 方法-Method问题表述DiffAM文本引导的化妆去除图像引导的对抗性化妆转移 实验-Ex…
阅读更多...
ffmpeg之播放一个yuv视频

ffmpeg之播放一个yuv视频

播放YUV视频的步骤 初始化SDL库&#xff1a; 目的&#xff1a;确保SDL库正确初始化&#xff0c;以便可以使用其窗口、渲染和事件处理功能。操作&#xff1a;调用 SDL_Init(SDL_INIT_VIDEO) 来初始化SDL的视频子系统。 创建窗口用于显示YUV视频&#xff1a; 目的&#xff1a;…
阅读更多...
最新文章

Copyright @ 2022~2023