Skip to content

Python: don't emit ClassVar for a file's top-level extensions #29222

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

Open
folded wants to merge 1 commit into
base: main
Choose a base branch
from
+14 −5
Open

Python: don't emit ClassVar for a file's top-level extensions #29222

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
16 changes: 12 additions & 4 deletions src/google/protobuf/compiler/python/pyi_generator.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -361,14 +361,22 @@ void PyiGenerator::PrintTopLevelEnums() const {
}

template <typename DescriptorT>
void PyiGenerator::PrintExtensions(const DescriptorT& descriptor) const {
void PyiGenerator::PrintExtensions(const DescriptorT& descriptor,
bool is_classvar) const {
for (int i = 0; i < descriptor.extension_count(); ++i) {
const FieldDescriptor* extension_field = descriptor.extension(i);
std::string constant_name =
absl::StrCat(extension_field->name(), "_FIELD_NUMBER");
absl::AsciiStrToUpper(&constant_name);
printer_->Print("$constant_name$: _ClassVar[int]\n",
"constant_name", constant_name);
// ClassVar is only a valid annotation inside a class body, so it is used for a message's
// nested extensions and not for a file's top-level ones.
if (is_classvar) {
printer_->Print("$constant_name$: _ClassVar[int]\n",
"constant_name", constant_name);
} else {
printer_->Print("$constant_name$: int\n",
"constant_name", constant_name);
}
Annotate("constant_name", extension_field);
printer_->Print("$name$: _descriptor.FieldDescriptor\n",
"name", extension_field->name());
Expand Down Expand Up @@ -478,7 +486,7 @@ void PyiGenerator::PrintMessage(const Descriptor& message_descriptor,
PrintMessage(*message_descriptor.nested_type(i), true);
}

PrintExtensions(message_descriptor);
PrintExtensions(message_descriptor, /* is_classvar = */ true);

// Prints field number
for (int i = 0; i < message_descriptor.field_count(); ++i) {
Expand Down
3 changes: 2 additions & 1 deletion src/google/protobuf/compiler/python/pyi_generator.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,8 @@ class PROTOC_EXPORT PyiGenerator : public google::protobuf::compiler::CodeGenera
void PrintEnumValues(const EnumDescriptor& enum_descriptor,
bool is_classvar = false) const;
template <typename DescriptorT>
void PrintExtensions(const DescriptorT& descriptor) const;
void PrintExtensions(const DescriptorT& descriptor,
bool is_classvar = false) const;
void PrintMessages() const;
void PrintMessage(const Descriptor& message_descriptor, bool is_nested) const;
void PrintServices() const;
Expand Down
Loading