如何在类型化签名（Python > 3.9）中指定一个需要更新方法的通用 MutableSet？

发布于 2025-01-20 09:37:59 字数 866 浏览 3 评论 0原文

我写了一个库。它的一些函数和方法在 Hashable 集合上运行，例如：

def some_function(my_set: set[Hashable]) -> None:
    ...
    my_set.update(...)
    ...

如何定义像 UpdatableSet 这样的东西（并使用它而不是 some_function 签名中的“set”），要求是否存在更新方法，但允许使用 set 以外的其他类（来自外部库），在函数调用中提供所有必要的方法？

def some_function(my_set: UpdatableSet[Hashable]) -> None:
    ...
    my_set.update(...)
    ...

from intbitset import intbitset  # see PyPI
some_set = intbitset(rhs=100)
some_function(some_set)

MutableSet[Hashable] 还不够，因为它不保证有更新方法。

我使用 MyPy 进行类型检查。

我想到了类似下面的东西，但没有找到注册方法。我不知道这是否是正确的方法。也许定义一些通用协议是正确的方法。

class UpdatableSet(MutableSet[_T], Generic[_T], ABC):
    def update(self, other) -> None:
        pass

UpdatableSet.register(set)
UpdatableSet.register(intbitset)

原文

I have written a library. Some of its functions and methods operate on sets of Hashables, e.g.:

def some_function(my_set: set[Hashable]) -> None:
    ...
    my_set.update(...)
    ...

How can I define something like an UpdatableSet (and use it instead of "set" in the signature of some_function), that demands existence of an update method, but allows for using some other class (from an external library) than set, that provides all necessary methods, in function calls?

def some_function(my_set: UpdatableSet[Hashable]) -> None:
    ...
    my_set.update(...)
    ...

from intbitset import intbitset  # see PyPI
some_set = intbitset(rhs=100)
some_function(some_set)

MutableSet[Hashable] is not enough, since it does not guarantee that there is an update method.

I use MyPy for type checking.

I thought of something like the following, but the register method is not found. And I do not know, if this is the right approach. Maybe defining some generic protocol would be the right way.

class UpdatableSet(MutableSet[_T], Generic[_T], ABC):
    def update(self, other) -> None:
        pass

UpdatableSet.register(set)
UpdatableSet.register(intbitset)

分享到QQ

分享到微博