Python如何指定类方法仅接收自身类实例 解决注解类名未定义问题

Python解析类内部代码时，当前类尚未完成定义，直接在方法的类型注解里引用类名会触发NameError。
注意：Python原生类型注解仅用于静态类型检查，运行时不会自动校验参数类型，若需要运行时拦截非法传参，需手动添加判断逻辑。

方案1：延迟解析注解（Python 3.7+ 通用，最简便） #

在文件最开头加入from __future__ import annotations，这行代码会让当前文件内所有类型注解延迟到类、函数全部定义完成后再解析，不会出现类名找不到的问题。
修正后的完整可运行代码：

from __future__ import annotations
from dataclasses import dataclass, field
from random import uniform
from math import dist

@dataclass
class Atom():
    # 修正原代码类型标注错误：A、B默认值为浮点数，对应类型应为float
    A: float = 0.5
    B: float = 0.5
    position: list[float] = field(default_factory=list)
    

    def __post_init__(self) -> None:
        if not self.position:
            self.position = [uniform(0, 10),
                      uniform(0, 10),
                      uniform(0, 10)]  # x y z坐标

    def get_distance_to(self, atom: Atom) -> float:
        return dist(self.position,
                    atom.position)

    def get_energy_with(self, atom: Atom) -> float:
        A_general = self.A + atom.A
        B_general = self.B + atom.B
        r = self.get_distance_to(atom)

        U = (A_general / (r**12)) - (B_general / (r**6))
        return U

方案2：字符串字面量类型注解（兼容所有Python3版本） #

如果不想导入future特性，可以直接把类名用引号包裹作为类型注解，Python类型检查工具可正常识别该写法，也不会触发定义阶段的名称错误：

# 无需额外导入，直接使用字符串形式的类型名
def get_distance_to(self, atom: 'Atom') -> float:
    return dist(self.position, atom.position)

def get_energy_with(self, atom: 'Atom') -> float:
    A_general = self.A + atom.A
    B_general = self.B + atom.B
    r = self.get_distance_to(atom)
    U = (A_general / (r**12)) - (B_general / (r**6))
    return U

运行时强制参数校验（可选） #

如果需要程序运行时直接拦截非Atom类型的传参，可以在方法开头手动添加类型判断：

def get_distance_to(self, atom: Atom) -> float:
    if not isinstance(atom, Atom):
        raise TypeError(f"参数必须为Atom类实例，当前传入类型为{type(atom)}")
    return dist(self.position, atom.position)

两个需要限制参数类型的方法都可以加上这段判断，即可实现运行时的参数类型强校验。

内容的提问来源于stack exchange，提问作者Matvey_coder3