【问题标题】:Confusing behavior when using TypeVar with dataclass将 TypeVar 与数据类一起使用时的令人困惑的行为
【发布时间】:2022-10-02 02:28:17
【问题描述】:

如果我定义如下类型:

StringType = TypeVar(\'StringType\', str, None)

然后我可以在我的类或函数定义中使用它:

class StringClass:
    def __init__(self, s: StringType = None):
        self.s = s

def func(s: StringType = None):
    return s

我的类型检查器Pylance,效果很好!

但是如果我使用数据类定义我的类:

@dataclass
class StringClass:
    s: StringType = None

然后 Pylance 抱怨:Type variable \"StringType\" has no meaning in this context

我不明白为什么使用dataclass 的第二个定义不起作用。

有人可以向我解释一下,并希望解释如何让数据类与新类型一起工作吗?

  • 这似乎不是TypeVar 的使用场景,只是简单地使用typing.Optional[str] 或str | None。
  • 请记住,此处的类型只是一个示例。我使用的实际实词类型比这更复杂(例如str | None | QuerySet | ModelBase)
  • 我看不出类型是否复杂有什么影响,因为在我看来,这不是应该使用TypeVar 的场景。参考TypeVar,\"它们用作泛型类型以及泛型函数定义的参数。\"
  • 复习一下定义,看来你是对的。但这将我的问题改变为如何使用泛型类型来完成我的帖子中列出的类型检查。有任何想法吗?

标签: python python-3.x python-typing python-dataclasses


【解决方案1】:

首先,让我们看看你现在拥有什么。

StringType = TypeVar('StringType', str, None)

这是一个类型变量,即泛型。这是不是说StringType 是str | None 的别名。据说StringType 是一个变量可能稍后将其引入范围,如果是,则其可能值为str 或None。

现在,不幸的是,Python 在将类型变量引入作用域时很奇怪。在像 Java 这样的语言中,它总是显式的(即,任何时候你想引入一个类型变量,你显式地将它写在括号中为<T>)。但是 Python 的规则是不同的。

  • 如果函数(包括成员函数)中使用了类型变量(不在作用域内),则函数本身将变为泛型。
  • 如果在类的父类声明中使用类型变量,则整个类将变为泛型。

您的数据类不适合这两种情况。 dataclass 变量不是函数参数,也不是父类指示符,因此您的类型检查器会感到困惑。

所以你当前的构造函数代码

class StringClass:
    def __init__(self, s: StringType = None):
        self.s = s

类似于此 Java 代码(伪代码,因为我们无法在 Java 中准确表示约束 str | None)

public class StringClass {
    public Object s;
    public<T> StringClass(T s) {
        this.s = s;
    }
}

也就是说,类本身是不是通用的。就是构造函数,类上的实例变量s被推断为最小上限类型变量的有效类型。在 Java 中是 Object,在 Python(具有联合类型)中是 str | None。

正如 cmets 中所指出的,您可能想要的是联合类型。

class StringClass:
    def __init__(self, s: str | None = None):
        self.s = s

你可以像其他任何东西一样给它们起别名。

StringType = str | None

(注意:如果您使用的 Python 版本早于 3.10,则需要将该别名的右侧用引号引起来,因为在 Python 3.10 之前,运行时不允许使用 | syntax。类型检查器无论哪种方式都没有问题)

但是,如果您希望您的类是通用的,那么您需要所有的类是通用的,而不仅仅是构造函数。

class StringClass(Generic[StringType]):
    def __init__(self, s: StringType = None):
        self.s = s

typing.Generic 是一个专为引入类型变量而设计的超类。它什么也不做,也不向类添加任何方法(除了一些反射东西以允许[] 语法工作)。现在你的构造函数不是通用的,但你的整个类都是。在类型中,您引用StringClass,类型参数为StringClass[str] 或StringClass[None]。

这种方法可以很好地扩展到您的数据类。数据类可以有任意超类,包括Generic。

@dataclass
class StringClass(Generic[StringType]):
    s: StringType = None

现在类型变量在范围内,因为它是由类本身引入的,所以它可以在实例字段中使用就好了。

因此,根据您的用例,我建议(1)在类范围而不是构造函数范围内引入类型变量,或者(2)声明一个类型别名而不是类型变量,并使用它。使用哪一个的问题归结为,在您的情况下,跟踪实际的编译时参数的类型。使用第一种方法,您将能够编写 StringClass[None] 或 StringClass[str] 或类似的,以进一步限制您在特定情况下期望的 StringClass 的类型。这可能很有用,但如果您不经常需要知道这些信息,也会变得乏味。

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2011-11-09
    • 1970-01-01
    • 2014-02-04
    • 1970-01-01
    • 1970-01-01
    • 2012-08-20
    • 1970-01-01
    • 2015-10-22
    相关资源
    最近更新 更多