Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

Shorter optional fields

未关闭
  • 哪里不对？
#499 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
30/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
停滞
技术栈
python
领域
tooling

调研方向

首先跟踪为 proto3 optional 字段生成 Python 字段的生成器路径；该 issue 没有指定 repository 文件或测试。查看所引用的 cattrs/converters.py 示例，并在选择方案之前比较 Ideas A、B 和 C。完成的标准是：optional 字段生成更短的代码，同时保留正确的 Optional 类型和 presence tracking。

由索引模型根据 Issue 内容生成。

描述

enhancement medium

Optional fields generate very long and repetitive code.

The idea is to use shorter and simpler code, and internally consider it as a field having optional=True, group=f"_{field_name}".

Related to #459.

Proto file
syntax = "proto3";

message Foo {
    optional uint32 bar = 1;
};
Currently generated code
from dataclasses import dataclass

import betterproto

@dataclass(eq=False, repr=False)
class Foo(betterproto.Message):
    bar: Optional[int] = betterproto.uint32_field(
        1, optional=True, group="_bar"
    )
Idea A

Read the type-hint of the field, and if it's a union of a type with None, consider it an optional field.

This might be a bad idea if unions of a type + None are used for something other than optional fields.

An example implementation of detecting optional fields can be found here: cattrs/converters.py.

from dataclasses import dataclass
from typing import Union, Optional

import betterproto

@dataclass(eq=False, repr=False)
class Foo(betterproto.Message):
    bar: Optional[int] = betterproto.uint32_field(1)
Idea B

Use a custom type-hint that indicates a field is optional, and is correctly understood by type-checkers as Optional.

from dataclasses import dataclass

import betterproto

@dataclass(eq=False, repr=False)
class Foo(betterproto.Message):
    bar: betterproto.OptionalField[int] = betterproto.uint32_field(1)

It could possibly be implemented something like this:
Annotated

from typing import Optional, TypeVar
from typing_extensions import Annotated

T = TypeVar("T")

optional_metadata = object()  # or another sentinel

OptionalField = Annotated[Optional[T], optional_metadata]
Idea C

Automatically add group=f"_{field_name}" if optional=True and no group specified.

from dataclasses import dataclass

import betterproto


@dataclass(eq=False, repr=False)
class Foo(betterproto.Message):
    bar: Optional[int] = betterproto.uint32_field(1, optional=True)
主要语言
Python
星标
1.8k
派生
235
30 天内没有已合并 PR

环境准备

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

danielgtaylor/python-betterproto 的其他 Issue

查看 danielgtaylor/python-betterproto 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。