Python类字段能否添加类似Go的字符串注解实现带点字段名输出？

问题说明 #

Python的TypedDict不允许直接定义带点的字段名（比如network.client.ip），你想通过给合法的字段名添加注解（类似Go结构体的标签语法），让最终输出时使用带点的字段名，而非把注解当成字段值。你期望的写法示例如下：

class MyNetworkClass(TypedDict):
    network_client_ip: str "network.client.ip"
    network_client_port: int "network.client.port"

解决方案 #

Python确实支持给TypedDict字段添加字符串注解，但这种注解只是存储在类的__annotations__属性中的元信息，不会自动替换输出的字段名。你需要自己实现字段映射逻辑，以下是两种可行的方式：

方式一：基于TypedDict的字符串注解实现映射

利用TypedDict类的__annotations__属性提取注解中的带点字段名，再将实例转换为目标格式的字典：

from typing import TypedDict

class MyNetworkClass(TypedDict):
    network_client_ip: str "network.client.ip"
    network_client_port: int "network.client.port"

def convert_to_dot_fields(td_instance: MyNetworkClass) -> dict:
    # 构建合法字段名到带点字段名的映射
    field_map = {}
    for field, anno in MyNetworkClass.__annotations__.items():
        # 只处理值为字符串的注解（即带点字段名）
        if isinstance(anno, str):
            field_map[field] = anno
    # 转换实例的键
    return {
        field_map.get(key, key): value
        for key, value in td_instance.items()
    }

# 使用示例
my_net = MyNetworkClass(network_client_ip="192.168.1.1", network_client_port=8080)
print(convert_to_dot_fields(my_net))
# 输出结果: {'network.client.ip': '192.168.1.1', 'network.client.port': 8080}

方式二：用dataclasses的元数据实现更规范的映射

如果需要更结构化的元信息管理，可以用dataclasses配合字段元数据，比单纯的字符串注解更清晰：

from dataclasses import dataclass, fields, field

@dataclass
class MyNetworkClass:
    network_client_ip: str = field(metadata={"dot_name": "network.client.ip"})
    network_client_port: int = field(metadata={"dot_name": "network.client.port"})

def convert_dataclass_to_dot_fields(obj: MyNetworkClass) -> dict:
    return {
        f.metadata["dot_name"]: getattr(obj, f.name)
        for f in fields(obj)
        if "dot_name" in f.metadata
    }

# 使用示例
my_net = MyNetworkClass(network_client_ip="192.168.1.1", network_client_port=8080)
print(convert_dataclass_to_dot_fields(my_net))
# 输出结果: {'network.client.ip': '192.168.1.1', 'network.client.port': 8080}

补充说明 #

Python没有内置机制让这类注解自动替换输出的字段名，必须手动实现映射逻辑。如果只是简单的字段名转换，用TypedDict加字符串注解的方式足够；如果需要更复杂的元信息管理（比如额外的字段校验规则），用dataclasses的元数据会更合适。

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