Python中创建同时作为类型和值的单例哨兵对象-Python教程-PHP中文网

Python中创建同时作为类型和值的单例哨兵对象

本文探讨在Python中创建一种特殊的单例哨兵对象，使其既能作为函数参数的默认值表示“未设置”，又能用于类型提示，以区分None。文章分析了多种方法，包括使用None、Ellipsis、自定义单例以及高级的元类技巧，并提供了最佳实践建议，旨在实现代码的清晰性、类型安全性和可维护性。

在python编程中，我们经常需要一个特殊的默认值来表示某个参数“未提供”或“未设置”，尤其是在实现如partial_update这类部分更新的函数时。这种“哨兵值”必须与none（可能表示“明确设置为无”）或其他有效值区分开来。理想情况下，这个哨兵值应该是一个单例，并且能够同时作为类型提示和实际值使用，类似于python内置的none。

哨兵值需求场景示例

考虑一个Client类，其partial_update方法允许更新对象的特定字段。如果某个字段未在调用中明确指定，则不应更新它。如果字段可以被明确设置为None，那么None就不能作为“未设置”的哨兵值。

class Client:
    def partial_update(
            self,
            obj_id: int,
            obj_field: int | None | NotSet = NotSet, # 期望 NotSet 既是类型也是值
            another_field: str | None | NotSet = NotSet,
    ):
        # 如果 obj_field 未明确指定，则不更新
        if obj_field is NotSet:
            print(f"obj_field for obj_id {obj_id} was not specified, skipping update.")
        else:
            print(f"Updating obj_field for obj_id {obj_id} to {obj_field}.")
            # 实际更新逻辑

        if another_field is NotSet:
            print(f"another_field for obj_id {obj_id} was not specified, skipping update.")
        else:
            print(f"Updating another_field for obj_id {obj_id} to {another_field}.")

登录后复制

为了实现上述功能，我们需要一个NotSet对象。接下来，我们将探讨几种实现方法及其优缺点。

常见尝试与局限性

1. 使用 None 作为哨兵值

问题： None在业务逻辑中通常表示“空”或“无”，并且字段可能允许为None。如果将None用作“未设置”的哨兵，则无法区分用户明确传入的None和未传入的参数。

# 假设 obj_field: int | None，如果使用 None 作为哨兵，
# 那么 partial_update(obj_id=1, obj_field=None) 
# 将无法区分是用户想把 obj_field 设置为 None 
# 还是用户根本没传 obj_field。

登录后复制

2. 使用内置的 Ellipsis (...)

Python提供了Ellipsis对象，它是一个单例，并且在某些场景下可以作为哨兵值。

立即学习“Python免费学习笔记（深入）”；

from types import EllipsisType

def partial_update(
   obj_field: int | None | EllipsisType = ...,
):
   if obj_field is ...:
       print("obj_field was not specified.")
   else:
       print(f"Updating to {obj_field}.")

# 示例调用
partial_update() # obj_field was not specified.
partial_update(obj_field=None) # Updating to None.
partial_update(obj_field=10) # Updating to 10.

登录后复制

局限性：

语义不明确： Ellipsis通常用于切片或表示省略，将其用于“未设置”的语义不够直观和明确。
类型提示限制： 虽然可以使用EllipsisType进行类型提示，但在某些Python版本或特定语境下，直接在联合类型中使用...作为类型提示可能会遇到问题，例如obj_field: int | None | ... = ...可能不被静态类型检查器接受。

推荐的实践：自定义单例类

最Pythonic、最明确且易于理解的方法是创建一个自定义的单例类。

class NotSetType:
    """
    表示参数未设置的哨兵类型。
    """
    _instance = None

    def __new__(cls, *args, **kwargs):
        if cls._instance is None:
            cls._instance = super().__new__(cls, *args, **kwargs)
        return cls._instance

    def __repr__(self):
        return "NotSet"

    def __str__(self):
        return "NotSet"

# 创建 NotSet 单例实例
NotSet = NotSetType()

# 使用示例
class Client:
    def partial_update(
            self,
            obj_id: int,
            obj_field: int | None | NotSetType = NotSet, # 类型提示使用 NotSetType
    ):
        if obj_field is NotSet:
            print(f"obj_field for obj_id {obj_id} was not specified.")
        else:
            print(f"Updating obj_field for obj_id {obj_id} to {obj_field}.")

# 调用示例
client = Client()
client.partial_update(obj_id=1) # obj_field for obj_id 1 was not specified.
client.partial_update(obj_id=2, obj_field=100) # Updating obj_field for obj_id 2 to 100.
client.partial_update(obj_id=3, obj_field=None) # Updating obj_field for obj_id 3 to None.

登录后复制

优点：

明确性： NotSet的名称清晰地表达了其语义。
单例保证： 通过__new__方法确保NotSet始终是同一个对象。
类型安全： NotSetType可以作为联合类型的一部分进行类型提示。

局限性：

类型提示与值的不一致： 在类型提示中，我们使用NotSetType（类本身），而在实际参数默认值中，我们使用NotSet（类的实例）。这虽然可以工作，但可能不完全符合最初“像None一样，既是类型又是值”的理想。None的类型是NoneType，但我们通常直接写None作为类型提示，这是Python类型系统为None做的特殊处理。

进阶探索：使类成为自身的实例（实验性）

为了实现“类本身就是其自身的实例，并用作类型提示和值”这一更严格的要求，可以通过元类（metaclass）进行一些高级操作。

class Meta(type):
    """
    自定义元类，在类创建时使其成为自身的实例。
    """
    def __new__(cls, name, bases, dct):
        # 正常创建类对象
        class_obj = super().__new__(cls, name, bases, dct)
        # 将创建的类对象包装成其自身的实例
        # 这里的 class_obj(name, bases, dct) 实际上是调用了 NotSet 的 __new__ 方法
        # 但由于 NotSet 没有自定义 __new__，它会调用 type.__new__，
        # 最终导致 class_obj 成为 class_obj 的实例
        return class_obj() # 直接返回实例，而不是类本身

class NotSet(metaclass=Meta):
    """
    一个特殊的单例，其类本身就是其唯一的实例。
    """
    def __repr__(self):
        return "<NotSet>"

    def __str__(self):
        return "NotSet"

# 此时，NotSet 既是类，也是其自身的实例
print(NotSet)
print(type(NotSet))
print(NotSet is type(NotSet)) # True，证明 NotSet 是其自身的类型

# 使用示例
class Client:
    def partial_update(
            self,
            obj_id: int,
            obj_field: int | None | NotSet = NotSet, # 类型提示和默认值都使用 NotSet
    ):
        if obj_field is NotSet:
            print(f"obj_field for obj_id {obj_id} was not specified.")
        else:
            print(f"Updating obj_field for obj_id {obj_id} to {obj_field}.")

# 调用示例
client = Client()
client.partial_update(obj_id=1) # obj_field for obj_id 1 was not specified.
client.partial_update(obj_id=2, obj_field=100) # Updating obj_field for obj_id 2 to 100.
client.partial_update(obj_id=3, obj_field=None) # Updating obj_field for obj_id 3 to None.

登录后复制

优点：

完美符合需求： NotSet既可以作为类型提示，也可以作为值，且它们是同一个对象。

局限性：

复杂性高： 使用元类增加了代码的复杂性和理解难度，不适合初学者或对元类不熟悉的团队。
静态类型检查器兼容性问题： 这种模式虽然在运行时有效，但大多数静态类型检查器（如Mypy）可能无法正确理解这种自引用的类型结构，从而可能报告错误或发出警告。这会损害类型提示的实际作用。
非标准模式： 这种模式非常规，可能导致维护困难。

替代方案：使用 **kwargs

在某些场景下，如果partial_update函数需要处理大量可选字段，并且对类型提示的要求不那么严格，可以考虑使用**kwargs。

class Client:
    def partial_update(self, obj_id: int, **kwargs):
        print(f"Processing update for obj_id {obj_id}:")
        for field_name, value in kwargs.items():
            print(f"  Updating {field_name} to {value}.")
            # setattr(obj, field_name, value) # 实际更新逻辑

# 调用示例
client = Client()
client.partial_update(obj_id=1, obj_field=10, another_field="test")
client.partial_update(obj_id=2) # 没有提供任何字段，也不会更新

登录后复制

局限性：

丢失类型提示： **kwargs参数无法提供具体的字段名和类型提示，降低了代码的可读性和类型安全性。
参数名称不明确： 调用者需要知道所有可能的字段名称。

总结与最佳实践

在Python中创建同时作为类型和值的单例哨兵对象，以区分None并表示“未设置”，是一个常见的需求。

避免使用 None： 除非您的业务逻辑明确规定None不能作为有效输入。
谨慎使用 Ellipsis： 尽管它是单例，但其语义不明确，且在类型提示方面可能存在兼容性问题。
推荐使用自定义单例类（如 NotSetType 和 NotSet）： 这是最平衡、最Pythonic且易于维护的方法。尽管类型提示需要使用类名NotSetType，而默认值使用实例NotSet，但这通常是可接受的折衷方案，并且能很好地与静态类型检查器配合。
避免使用元类实现自引用类型（如 Meta 和 NotSet）： 尽管它能完美实现“类即实例”的需求，但其复杂性高，且与静态类型检查器兼容性差，不建议在生产环境中使用。
`kwargs作为备选：** 如果函数参数众多且对类型提示要求不高，**kwargs`可以简化函数签名，但会牺牲类型安全性和明确性。

综上所述，为了代码的清晰性、可维护性和与静态类型检查器的良好协作，强烈推荐使用自定义单例类的方式来创建您的“未设置”哨兵值。

# 最终推荐的实现方式
class NotSetType:
    _instance = None

    def __new__(cls, *args, **kwargs):
        if cls._instance is None:
            cls._instance = super().__new__(cls, *args, **kwargs)
        return cls._instance

    def __repr__(self):
        return "NotSet"

    def __str__(self):
        return "NotSet"

NotSet = NotSetType()

# 使用示例
def example_function(
    param_a: int | None | NotSetType = NotSet,
    param_b: str | NotSetType = NotSet
):
    if param_a is NotSet:
        print("param_a was not provided.")
    elif param_a is None:
        print("param_a was explicitly set to None.")
    else:
        print(f"param_a was set to {param_a}.")

    if param_b is NotSet:
        print("param_b was not provided.")
    else:
        print(f"param_b was set to {param_b}.")

example_function()
example_function(param_a=10)
example_function(param_a=None, param_b="hello")

登录后复制

以上就是Python中创建同时作为类型和值的单例哨兵对象的详细内容，更多请关注php中文网其它相关文章！