Proto字段默认值设为5编译后仍为0？如何解决序列化问题？

Proto文件 #

message MyMessage
{
    optional uint32 field1 = 1 [default = 5];
}

编译命令 #

protoc -I=. --python_betterproto_out=. my_message.proto

生成的Python代码 #

@dataclass(eq=False, repr=False)
class MyMessage(betterproto.Message):
    field1: int = betterproto.uint32_field(1)

序列化代码及问题 #

执行以下代码时，field1未被序列化：

message = MyMessage()
message.field1 = 0
encoded = bytes(message)

原因是betterproto的序列化逻辑默认不序列化零值，仅当字段属于oneof或零值是用户显式设置时例外，但当前场景未触发例外逻辑。

1. 为何Proto文件中设置的默认值5未生效？ #

betterproto对proto2的[default]注解支持有限，编译时未将Proto定义的默认值5注入到生成的Python字段中。生成的代码里uint32_field(1)未指定default参数，因此Python类初始化时会使用int类型的默认值0，而非Proto定义的5。这是因为betterproto更偏向遵循proto3的设计规则——proto3中不允许显式设置默认值，字段默认值为对应类型的零值。

2. 不使用oneof，如何解决设置0后不被序列化的问题？ #

提供两种可行方案：

方案1：修改生成代码，指定字段默认值与序列化规则 #

手动修改生成的MyMessage类字段定义，添加default=5和serialize_default=True参数：

@dataclass(eq=False, repr=False)
class MyMessage(betterproto.Message):
    field1: int = betterproto.uint32_field(1, default=5, serialize_default=True)

• default=5：让类初始化时field1的默认值与Proto定义一致。
• serialize_default=True：强制序列化字段的默认值；当显式设置field1=0时，由于0不等于默认值5，会被视为非默认值正常序列化。

方案2：手动标记字段为已修改 #

利用betterproto内部的_modified_fields集合，标记字段为用户显式设置，强制序列化：

message = MyMessage()
message.field1 = 0
# 标记field1为主动设置，触发序列化
message._modified_fields.add("field1")
encoded = bytes(message)

这种方式无需修改生成的代码，通过操作内部状态告诉序列化逻辑：该字段值是用户主动设置的，即使为零值也需要序列化。

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