从混乱到清晰：用NotImplementedError重构你的Python代码，NotImplementedError如何助你打造更健壮的API

长风清留扬

于 2024-09-26 16:10:04 发布

阅读量654

点赞数 21

分类专栏： Python 文章标签：重构 python 服务器 API 异常处理

本文链接：https://blog.csdn.net/qq_51431069/article/details/142555952

版权

Python 专栏收录该内容

14 篇文章 0 订阅

订阅专栏

NotImplementedError

NotImplementedError 是 Python 中的一个标准异常类，它通常用于指示某个方法或功能尚未实现。这个异常是内置的，位于 Python 的 exceptions 模块中，但通常你不需要直接从这个模块导入它，因为 Python 已经自动将其包含在全局命名空间中

使用场景

NotImplementedError 异常的主要用途是：

标记未完成的代码：在开发过程中，你可能会先定义一些函数或方法的签名，但暂时不打算实现它们。这时，你可以在这些方法体内抛出 NotImplementedError 异常，以清楚地表明这些方法尚未实现。
抽象基类中的方法：在定义抽象基类（ABC）时，你可能会声明一些必须被子类实现的方法。如果某个子类没有实现这些方法，Python 不会自动抛出错误。但是，通过在这些抽象方法的基类中抛出 NotImplementedError，你可以强制子类实现这些方法，否则在尝试调用这些未实现的方法时将引发异常。
未来可能实现的功能：有时候，你可能会在设计阶段就预见到某些功能在未来可能会被添加，但目前还没有实现它们。使用 NotImplementedError 可以清楚地标记这些未来的功能点。

异常层次结构

Python 的异常是通过一个继承自 BaseException 的类层次结构来组织的。NotImplementedError 是从这个层次结构中的一个类继承而来的，具体来说，它是从 Exception 类继承而来的，表示一个已经发生但尚未被处理的异常情况。

与其他异常的比较

与 NotImplemented 的比较：NotImplemented 是一个特殊的值，用于在二元操作中表示某个操作对于该类型的对象是不适用的。当在特殊方法（如 add、eq 等）中返回 NotImplemented 时，Python 会尝试调用另一个操作数的相应特殊方法。而 NotImplementedError 是一个异常，用于表示某个功能尚未实现。
与 RuntimeError 的比较：RuntimeError 是一个更通用的异常，用于表示程序中的运行时错误。NotImplementedError 是 RuntimeError 的一个更具体的子类，专门用于表示未实现的功能。

抛出和捕获

抛出：你可以通过在函数或方法体中使用 raise NotImplementedError(“具体信息”) 来抛出 NotImplementedError 异常。
捕获：使用 try…except 块可以捕获并处理 NotImplementedError 异常。这允许你在遇到未实现的功能时，执行一些额外的操作，比如记录日志、回退到默认行为或向用户报告错误。

代码案例

案例1：使用NotImplementedError在抽象基类中

假设我们有一个Shape基类，它定义了一个area方法，但这个方法的具体实现应该由子类来完成。

from abc import ABC, abstractmethod  
  
class Shape(ABC):  # 定义一个抽象基类  
    @abstractmethod  
    def area(self):  
        # 抛出NotImplementedError，强制子类实现这个方法  
        raise NotImplementedError("Subclasses must implement abstract method 'area'")  
  
# 尝试直接实例化Shape会失败，因为它是一个抽象基类  
# shape = Shape()  # 这会抛出TypeError  
  
class Circle(Shape):  
    def __init__(self, radius):  
        self.radius = radius  
  
    def area(self):  
        # 实现area方法  
        return 3.14159 * self.radius ** 2  
  
# 使用Circle类  
circle = Circle(5)  
print(circle.area())  # 输出圆的面积  
# 运行结果: 78.53975

案例2：在类中预留方法接口

有时候，我们可能在设计类时就知道某些方法将来会被实现，但目前还没有具体的实现逻辑。这时，可以使用NotImplementedError来标记这些方法。

class Database:  
    def connect(self):  
        # 假设连接数据库的逻辑  
        print("Connected to the database")  
  
    def execute_query(self, query):  
        # 预留方法接口，尚未实现  
        raise NotImplementedError("execute_query method is not implemented yet")  
  
# 尝试使用execute_query方法  
db = Database()  
db.connect()  # 输出: Connected to the database  
  
try:  
    db.execute_query("SELECT * FROM users")  
except NotImplementedError as e:  
    print(e)  # 输出: execute_query method is not implemented yet

案例3：在接口类中使用NotImplementedError

虽然Python没有像Java那样的接口关键字，但我们可以通过定义只包含NotImplementedError的方法的类来模拟接口。

class IPrintable:  
    def print_info(self):  
        raise NotImplementedError("print_info method must be implemented")  
  
class Employee(IPrintable):  
    def __init__(self, name, role):  
        self.name = name  
        self.role = role  
  
    def print_info(self):  
        # 实现print_info方法  
        print(f"Name: {self.name}, Role: {self.role}")  
  
# 使用Employee类  
emp = Employee("John Doe", "Developer")  
emp.print_info()  # 输出: Name: John Doe, Role: Developer