全网最适合入门的面向对象编程教程：52 Python函数方法与接口-Protocol协议与接口

本文档主要介绍如何使用 Python 进行面向对象编程，需要读者对 Python 语法和单片机开发具有基本了解。相比其他讲解 Python 面向对象编程的博客或书籍而言，本文档更加详细、侧重于嵌入式上位机应用，以上位机和下位机的常见串口数据收发、数据处理、动态图绘制等为应用实例，同时使用 Sourcetrail 代码软件对代码进行可视化阅读便于读者理解。

相关示例代码获取链接如下：https://github.com/leezisheng/Python-OOP-Demo

正文

协议 protocol 在 python3.8 开始引入的，协议是抽象基类 (ABC) 的替代方案，作为在语言中定义结构类型或“鸭子类型”的一种方式。协议是对象必须具有的一组方法或属性，以便被认为与该协议兼容。协议使你能够定义接口，而无需显式创建类或从特定基类继承。

协议是使用 typing.Protocol 类或 typing.Protocol 装饰器定义的。

以下为示例代码，首先我们定义一个名为 Printable 的协议，该协议要求对象具有打印方法。 Protocol 类允许我们定义必须由符合协议的对象实现的抽象方法（在本例中为打印）。

from typing import Protocol

class Printable(Protocol):
    def print(self) -> None:
        pass

要实现协议，我们不需要显式声明它。相反，我们可以通过实现所需的方法来确保对象符合协议。这是一个例子：在此示例中，Book 类通过提供所需的打印方法来实现 Printable 协议。Book 类的任何实例都可以被视为 Printable 对象。

协议主要用于类型提示和静态类型检查。我们可以使用协议作为类型注释来指示参数或变量必须符合特定协议。这是一个例子：

def print_object(obj: Printable) -> None:
    obj.print()

在此示例中，print_object 函数采用 Printable 类型的参数 obj。这意味着传递给此函数的任何对象都必须实现 Printable 协议中定义的 print 方法。

接下来，我们定义一个没有 print 方法的类

_# 定义CD类，没有打印方法_
class CD:
    def __init__(self, title: str):
        self.title = title

    def play(self) -> None:
        print(f"play music Title: {self.title}")

接下来，实例化两个类，并且测试是否能使用 print_object 函数：

book_obj = Book("Piece and Love")
print_object(book_obj)
cd_obj = CD("Piece and Love")
print_object(cd_obj)

运行结果如下：

在 IDE 中实际上也会有相关提示：

实际上，协议的实质含义可以理解为“这个类只要有 xxxx 方法，那么它就会隐式地成为我的子类”，这个东西主要是给静态类型检查工具看的，性质上和 PEP 484 与 PEP 526 是一样的。我们也可以利用 @typing.runtime_checkable 装饰器将协议类标记为运行时协议，这种协议可以与 isinstance()和 issubclass()一起使用。当应用于非协议类时，这会引发 TypeError。

_# 导入协议Protocol_
from typing import Protocol
import typing
_# 定义Printable协议，需要具有打印方法_
@typing.runtime_checkable
class Printable(Protocol):
    def print(self) -> None:
        pass
... ...
_# 创建对象实例_
book_obj = Book("Piece and Love")
print_object(book_obj)
cd_obj = CD("Piece and Love")
_# 类型检查_
print(isinstance(Book,Printable))
assert isinstance(book_obj,Printable)
print(isinstance(CD,Printable))
assert isinstance(cd_obj,Printable)

运行结果如下：

我们也可以定义组合多个其他协议的协议。以下我们使用序列化方法定义了一个名为 Serialized 的协议。然后我们定义另一个名为 PrintableAndSerializing 的协议，它结合了 Printable 和 Serializing 协议。

class Serializable(Protocol):
    def serialize(self) -> str:
        pass

class PrintableAndSerializable(Printable, Serializable):
    pass

相比抽象基类等方式，协议提供了一种在 Python 中定义结构类型的方法，允许我们创建接口而无需显式继承。它们使类型检查器能够动态验证对象是否遵守定义的协议，从而增强代码的正确性和可维护性。

posted @ 2024-09-24 00:47 FreakStudio 阅读(60) 评论(0) 编辑收藏举报

刷新页面返回顶部

Freak嵌入式工作室

Freak Studio - From Zero To Hero

全网最适合入门的面向对象编程教程：52 Python函数方法与接口-Protocol协议与接口

全网最适合入门的面向对象编程教程：52 Python 函数方法与接口-Protocol 协议与接口

摘要：

原文链接：

往期推荐：

更多精彩内容可看：

文档和代码获取：

正文

公告