Skip to content

Running Black on *_pb2 files #13930

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 5, 2025
Merged

Running Black on *_pb2 files #13930

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,6 @@ requires-python = ">=3.9" # Minimum version to run tests, used by uv run
line-length = 130
target-version = ["py310"]
skip-magic-trailing-comma = true
# Exclude protobuf files because they have long line lengths
# that can't be autofixed. Like docstrings and import aliases.
# Ideally, we could configure Black to allow longer line lengths
# for just these files, but doesn't seem possible yet.
force-exclude = ".*_pb2.pyi"

[tool.ruff]
line-length = 130
Expand Down
7 changes: 1 addition & 6 deletions stubs/protobuf/google/protobuf/any_pb2.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,12 +166,7 @@ class Any(google.protobuf.message.Message, google.protobuf.internal.well_known_t
"""
value: builtins.bytes
"""Must be a valid serialized protocol buffer of the above specified type."""
def __init__(
self,
*,
type_url: builtins.str | None = ...,
value: builtins.bytes | None = ...,
) -> None: ...
def __init__(self, *, type_url: builtins.str | None = ..., value: builtins.bytes | None = ...) -> None: ...
def ClearField(self, field_name: typing.Literal["type_url", b"type_url", "value", b"value"]) -> None: ...

global___Any = Any
47 changes: 39 additions & 8 deletions stubs/protobuf/google/protobuf/api_pb2.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,25 @@ class Api(google.protobuf.message.Message):
syntax: google.protobuf.type_pb2.Syntax.ValueType | None = ...,
) -> None: ...
def HasField(self, field_name: typing.Literal["source_context", b"source_context"]) -> builtins.bool: ...
def ClearField(self, field_name: typing.Literal["methods", b"methods", "mixins", b"mixins", "name", b"name", "options", b"options", "source_context", b"source_context", "syntax", b"syntax", "version", b"version"]) -> None: ...
def ClearField(
self,
field_name: typing.Literal[
"methods",
b"methods",
"mixins",
b"mixins",
"name",
b"name",
"options",
b"options",
"source_context",
b"source_context",
"syntax",
b"syntax",
"version",
b"version",
],
) -> None: ...

global___Api = Api

Expand Down Expand Up @@ -167,7 +185,25 @@ class Method(google.protobuf.message.Message):
options: collections.abc.Iterable[google.protobuf.type_pb2.Option] | None = ...,
syntax: google.protobuf.type_pb2.Syntax.ValueType | None = ...,
) -> None: ...
def ClearField(self, field_name: typing.Literal["name", b"name", "options", b"options", "request_streaming", b"request_streaming", "request_type_url", b"request_type_url", "response_streaming", b"response_streaming", "response_type_url", b"response_type_url", "syntax", b"syntax"]) -> None: ...
def ClearField(
self,
field_name: typing.Literal[
"name",
b"name",
"options",
b"options",
"request_streaming",
b"request_streaming",
"request_type_url",
b"request_type_url",
"response_streaming",
b"response_streaming",
"response_type_url",
b"response_type_url",
"syntax",
b"syntax",
],
) -> None: ...

global___Method = Method

Expand Down Expand Up @@ -263,12 +299,7 @@ class Mixin(google.protobuf.message.Message):
"""If non-empty specifies a path under which inherited HTTP paths
are rooted.
"""
def __init__(
self,
*,
name: builtins.str | None = ...,
root: builtins.str | None = ...,
) -> None: ...
def __init__(self, *, name: builtins.str | None = ..., root: builtins.str | None = ...) -> None: ...
def ClearField(self, field_name: typing.Literal["name", b"name", "root", b"root"]) -> None: ...

global___Mixin = Mixin
102 changes: 90 additions & 12 deletions stubs/protobuf/google/protobuf/compiler/plugin_pb2.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,12 @@ class Version(google.protobuf.message.Message):
patch: builtins.int | None = ...,
suffix: builtins.str | None = ...,
) -> None: ...
def HasField(self, field_name: typing.Literal["major", b"major", "minor", b"minor", "patch", b"patch", "suffix", b"suffix"]) -> builtins.bool: ...
def ClearField(self, field_name: typing.Literal["major", b"major", "minor", b"minor", "patch", b"patch", "suffix", b"suffix"]) -> None: ...
def HasField(
self, field_name: typing.Literal["major", b"major", "minor", b"minor", "patch", b"patch", "suffix", b"suffix"]
) -> builtins.bool: ...
def ClearField(
self, field_name: typing.Literal["major", b"major", "minor", b"minor", "patch", b"patch", "suffix", b"suffix"]
) -> None: ...

global___Version = Version

Expand All @@ -84,7 +88,9 @@ class CodeGeneratorRequest(google.protobuf.message.Message):
"""

@property
def proto_file(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[google.protobuf.descriptor_pb2.FileDescriptorProto]:
def proto_file(
self,
) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[google.protobuf.descriptor_pb2.FileDescriptorProto]:
"""FileDescriptorProtos for all files in files_to_generate and everything
they import. The files will appear in topological order, so each file
appears before any file that imports it.
Expand All @@ -107,7 +113,9 @@ class CodeGeneratorRequest(google.protobuf.message.Message):
"""

@property
def source_file_descriptors(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[google.protobuf.descriptor_pb2.FileDescriptorProto]:
def source_file_descriptors(
self,
) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[google.protobuf.descriptor_pb2.FileDescriptorProto]:
"""File descriptors with all options, including source-retention options.
These descriptors are only provided for the files listed in
files_to_generate.
Expand All @@ -126,8 +134,24 @@ class CodeGeneratorRequest(google.protobuf.message.Message):
source_file_descriptors: collections.abc.Iterable[google.protobuf.descriptor_pb2.FileDescriptorProto] | None = ...,
compiler_version: global___Version | None = ...,
) -> None: ...
def HasField(self, field_name: typing.Literal["compiler_version", b"compiler_version", "parameter", b"parameter"]) -> builtins.bool: ...
def ClearField(self, field_name: typing.Literal["compiler_version", b"compiler_version", "file_to_generate", b"file_to_generate", "parameter", b"parameter", "proto_file", b"proto_file", "source_file_descriptors", b"source_file_descriptors"]) -> None: ...
def HasField(
self, field_name: typing.Literal["compiler_version", b"compiler_version", "parameter", b"parameter"]
) -> builtins.bool: ...
def ClearField(
self,
field_name: typing.Literal[
"compiler_version",
b"compiler_version",
"file_to_generate",
b"file_to_generate",
"parameter",
b"parameter",
"proto_file",
b"proto_file",
"source_file_descriptors",
b"source_file_descriptors",
],
) -> None: ...

global___CodeGeneratorRequest = CodeGeneratorRequest

Expand All @@ -141,7 +165,9 @@ class CodeGeneratorResponse(google.protobuf.message.Message):
ValueType = typing.NewType("ValueType", builtins.int)
V: typing_extensions.TypeAlias = ValueType

class _FeatureEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[CodeGeneratorResponse._Feature.ValueType], builtins.type):
class _FeatureEnumTypeWrapper(
google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[CodeGeneratorResponse._Feature.ValueType], builtins.type
):
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
FEATURE_NONE: CodeGeneratorResponse._Feature.ValueType # 0
FEATURE_PROTO3_OPTIONAL: CodeGeneratorResponse._Feature.ValueType # 1
Expand Down Expand Up @@ -233,8 +259,32 @@ class CodeGeneratorResponse(google.protobuf.message.Message):
content: builtins.str | None = ...,
generated_code_info: google.protobuf.descriptor_pb2.GeneratedCodeInfo | None = ...,
) -> None: ...
def HasField(self, field_name: typing.Literal["content", b"content", "generated_code_info", b"generated_code_info", "insertion_point", b"insertion_point", "name", b"name"]) -> builtins.bool: ...
def ClearField(self, field_name: typing.Literal["content", b"content", "generated_code_info", b"generated_code_info", "insertion_point", b"insertion_point", "name", b"name"]) -> None: ...
def HasField(
self,
field_name: typing.Literal[
"content",
b"content",
"generated_code_info",
b"generated_code_info",
"insertion_point",
b"insertion_point",
"name",
b"name",
],
) -> builtins.bool: ...
def ClearField(
self,
field_name: typing.Literal[
"content",
b"content",
"generated_code_info",
b"generated_code_info",
"insertion_point",
b"insertion_point",
"name",
b"name",
],
) -> None: ...

ERROR_FIELD_NUMBER: builtins.int
SUPPORTED_FEATURES_FIELD_NUMBER: builtins.int
Expand Down Expand Up @@ -268,7 +318,9 @@ class CodeGeneratorResponse(google.protobuf.message.Message):
effect for plugins that have FEATURE_SUPPORTS_EDITIONS set.
"""
@property
def file(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___CodeGeneratorResponse.File]: ...
def file(
self,
) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___CodeGeneratorResponse.File]: ...
def __init__(
self,
*,
Expand All @@ -278,7 +330,33 @@ class CodeGeneratorResponse(google.protobuf.message.Message):
maximum_edition: builtins.int | None = ...,
file: collections.abc.Iterable[global___CodeGeneratorResponse.File] | None = ...,
) -> None: ...
def HasField(self, field_name: typing.Literal["error", b"error", "maximum_edition", b"maximum_edition", "minimum_edition", b"minimum_edition", "supported_features", b"supported_features"]) -> builtins.bool: ...
def ClearField(self, field_name: typing.Literal["error", b"error", "file", b"file", "maximum_edition", b"maximum_edition", "minimum_edition", b"minimum_edition", "supported_features", b"supported_features"]) -> None: ...
def HasField(
self,
field_name: typing.Literal[
"error",
b"error",
"maximum_edition",
b"maximum_edition",
"minimum_edition",
b"minimum_edition",
"supported_features",
b"supported_features",
],
) -> builtins.bool: ...
def ClearField(
self,
field_name: typing.Literal[
"error",
b"error",
"file",
b"file",
"maximum_edition",
b"maximum_edition",
"minimum_edition",
b"minimum_edition",
"supported_features",
b"supported_features",
],
) -> None: ...

global___CodeGeneratorResponse = CodeGeneratorResponse
Loading