Skip to content

Commit 3af9d03

Browse files
committed
Minor readme updates
Signed-off-by: Aidan Jensen <aidandj.github@gmail.com>
1 parent 7673bf3 commit 3af9d03

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -102,12 +102,18 @@ See [Changelog](CHANGELOG.md) for full listing
102102
* `mypy-protobuf` generates correctly typed `HasField`, `WhichOneof`, and `ClearField` methods.
103103
* There are differences in how `mypy-protobuf` and `pyi_out` generate enums. See [this issue](https://github.com/protocolbuffers/protobuf/issues/8175) for details
104104
* Type aliases exported for `HasField`, `WhichOneof` and `ClearField` arguments
105+
* Parses comments as docstrings
105106

106107
#### Examples
107108

108109
`mypy-protobuf`:
109110

110111
```python
112+
"""
113+
@generated by mypy-protobuf. Do not edit manually!
114+
isort:skip_file
115+
Edition version of proto2 file"""
116+
111117
import builtins
112118
import google.protobuf.descriptor
113119
import google.protobuf.message
@@ -132,8 +138,10 @@ class Editions2024SubMessage(google.protobuf.message.Message):
132138
*,
133139
thing: builtins.str | None = ...,
134140
) -> None: ...
135-
def HasField(self, field_name: typing.Literal["thing", b"thing"]) -> builtins.bool: ...
136-
def ClearField(self, field_name: typing.Literal["thing", b"thing"]) -> None: ...
141+
_HasFieldArgType: typing_extensions.TypeAlias = typing.Literal["thing", b"thing"]
142+
def HasField(self, field_name: _HasFieldArgType) -> builtins.bool: ...
143+
_ClearFieldArgType: typing_extensions.TypeAlias = typing.Literal["thing", b"thing"]
144+
def ClearField(self, field_name: _ClearFieldArgType) -> None: ...
137145

138146
Global___Editions2024SubMessage: typing_extensions.TypeAlias = Editions2024SubMessage
139147

@@ -167,10 +175,13 @@ class Editions2024Test(google.protobuf.message.Message):
167175
implicit_singular: builtins.str = ...,
168176
default_singular: builtins.str | None = ...,
169177
) -> None: ...
170-
def HasField(self, field_name: typing.Literal["default_singular", b"default_singular", "explicit_singular", b"explicit_singular", "legacy", b"legacy", "message_field", b"message_field"]) -> builtins.bool: ...
171-
def ClearField(self, field_name: typing.Literal["default_singular", b"default_singular", "explicit_singular", b"explicit_singular", "implicit_singular", b"implicit_singular", "legacy", b"legacy", "message_field", b"message_field"]) -> None: ...
178+
_HasFieldArgType: typing_extensions.TypeAlias = typing.Literal["default_singular", b"default_singular", "explicit_singular", b"explicit_singular", "legacy", b"legacy", "message_field", b"message_field"]
179+
def HasField(self, field_name: _HasFieldArgType) -> builtins.bool: ...
180+
_ClearFieldArgType: typing_extensions.TypeAlias = typing.Literal["default_singular", b"default_singular", "explicit_singular", b"explicit_singular", "implicit_singular", b"implicit_singular", "legacy", b"legacy", "message_field", b"message_field"]
181+
def ClearField(self, field_name: _ClearFieldArgType) -> None: ...
172182

173183
Global___Editions2024Test: typing_extensions.TypeAlias = Editions2024Test
184+
174185
```
175186

176187
Builtin pyi generator:

0 commit comments

Comments
 (0)