重用数据类类型提示

如何解决重用数据类类型提示

我正在尝试在我的函数签名中重用来自数据类的类型提示 - 也就是说，无需再次输入签名。

解决这个问题的最佳方式是什么？

from dataclasses import dataclass
from typing import Set,Tuple,Type

@dataclass
class MyDataClass:
    force: Set[Tuple[str,float,bool]]

# I've had to write the same type annotation in the dataclass and the
# function signature - yuck
def do_something(force: Set[Tuple[str,bool]]):
    print(force)

# I want to do something like this,where I reference the type annotation from
# the dataclass. But,doing it this way,pycharm thinks `force` is type `Any`
def do_something_2(force: Type["MyDataClass.force"]):
    print(force)

解决方法

解决这个问题的最佳方式是什么？

PEP 484 为这种情况提供了一个明确的选择

Type aliases

类型别名由简单的变量赋值定义： （……） 类型别名可能和注解中的类型提示一样复杂——任何可以作为类型提示接受的东西在类型别名中都是可以接受的：

应用于您的示例，这相当于（Mypy 确认这是正确的）

from dataclasses import dataclass

Your_Type = set[tuple[str,float,bool]]


@dataclass
class MyDataClass:
    force: Your_Type


def do_something(force: Your_Type):
    print(force)

以上是使用 Python 3.9 以后编写的 Generic Alias Type。由于 typing.Set 和 typing.Tuple 已被弃用，因此语法更加简洁和现代。

---

---

现在，从 Python Data Model 的角度完全理解这一点比看起来要复杂得多：

3.1. Objects,values and types

每个对象都有一个身份、一个类型和一个值。

您第一次尝试使用 Type 会得到惊人的结果

>>> type(MyDataClass.force)

AttributeError: type object 'MyDataClass' has no attribute 'force'

这是因为内置函数 type 返回一个类型（它本身是一个对象），但 MyDataClass 是“类”（声明）和“类属性”force是在类上，而不是在 type() 寻找它的类的类型对象上。仔细注意数据模型的差异：

• 课程

  这些对象通常充当它们自己的新实例的工厂

• 类实例

  任意类的实例

如果改为检查实例的类型，则会得到以下结果

>>> init_values: set = {(True,"the_str",1.2)}

>>> a_var = MyDataClass(init_values)

>>> type(a_var)
<class '__main__.MyDataClass'>

>>> type(a_var.force)
<class 'set'>

现在让我们通过将 force 应用到类声明对象上的 __anotations__ 来恢复 type() 上的类型对象（不是类型提示）（这里我们看到 Generic Alias type之前提到）。 （这里我们确实在检查类属性 force 上的类型对象）。

>>> type(MyDataClass.__annotations__['force'])
<class 'typing._GenericAlias'>

或者我们可以检查 Class 实例上的注解，并恢复我们习惯看到的类型提示。

>>> init_values: set = {(True,1.2)}
>>> a_var = MyDataClass(init_values)
>>> a_var.__annotations__

{'force': set[tuple[str,bool]]}

我不得不在数据类和函数签名中编写相同的类型注释 -

对于元组注释往往会变成长文字，这证明创建一个目的变量是为了简洁。但总的来说，显式签名更具描述性，这也是大多数 API 的目标。

The typing Module

基本构建块：

元组，用于列出元素类型，例如 Tuple[int,int,str]。空元组可以输入为 Tuple[()]。任意长度的同构元组可以使用一种类型和省略号来表示，例如 Tuple[int,...]。 （... 这里是语法的一部分，字面省略号。）