class documentation

not well scoped. This means that each of the feature enums below can clash with each other. The short names we've chosen maximize call-site readability, but leave us very open to this scenario. A future feature will be designed and implemented to handle this, hopefully before we ever hit a conflict here.

Class EnforceNamingStyle Undocumented
Class EnumType Undocumented
Class FieldPresence Undocumented
Class JsonFormat Undocumented
Class MessageEncoding Undocumented
Class RepeatedFieldEncoding Undocumented
Class Utf8Validation Undocumented
Class VisibilityFeature No class docstring; 1/1 method, 0/1 class documented
Method __init__ Create a message from a source message and field values.
Method default_symbol_visibility.setter Set or clear the generated default_symbol_visibility field.
Method enforce_naming_style.setter Set or clear the generated enforce_naming_style field.
Method enum_type.setter Set or clear the generated enum_type field.
Method field_presence.setter Set or clear the generated field_presence field.
Method json_format.setter Set or clear the generated json_format field.
Method message_encoding.setter Set or clear the generated message_encoding field.
Method repeated_field_encoding.setter Set or clear the generated repeated_field_encoding field.
Method utf8_validation.setter Set or clear the generated utf8_validation field.
Property default_symbol_visibility Undocumented
Property enforce_naming_style Undocumented
Property enum_type Undocumented
Property field_presence Undocumented
Property json_format Undocumented
Property message_encoding Undocumented
Property repeated_field_encoding Undocumented
Property utf8_validation Undocumented

Inherited from Message:

Class Method from_json Create a message from protobuf JSON mapping.
Class Method FromString Create a message by parsing protobuf wire-format bytes.
Class Method get_descriptor Return the message descriptor from the registry.
Class Method is_credentials Return True if a Python field contains credentials.
Class Method is_sensitive Return True if a Python field has the sensitive annotation.
Method __dir__ List generated fields, oneofs, and nested declarations.
Method __repr__ Render non-default fields without disclosing annotated secrets.
Method ByteSize Return the serialized protobuf wire size in bytes.
Method check_presence Check presence using a generated Python field name.
Method Clear Clear all fields, extensions, unknown fields, and the reset mask.
Method clear_extension Clear an extension value.
Method ClearField Clear a protobuf field or oneof and record it in the reset mask.
Method CopyFrom Replace this message with an independent copy of another message.
Method FindInitializationErrors Return paths of missing required fields.
Method get_extension Return an extension value.
Method get_full_update_reset_mask Create a reset mask from the current protobuf state.
Method get_mask Return the reset mask for field changes.
Method has_extension Return True if an extension has explicit presence.
Method HasField Return True if a protobuf field or oneof has explicit presence.
Method is_default Return True if a generated field has its default value.
Method IsInitialized Return True if every required field is initialized.
Method MergeFrom Merge fields from another message of the same generated type.
Method MergeFromString Merge protobuf wire-format bytes into this message.
Method ParseFromString Parse protobuf wire-format bytes and replace this message.
Method SerializeToString Serialize the message using protobuf wire format.
Method set_extension Set an extension value.
Method set_mask Set the reset mask for this message.
Method to_json Serialize this message using protobuf JSON mapping.
Method which_field_in_oneof Return the selected Python field name for a protobuf oneof.
Method WhichOneof Return the selected protobuf field name for a oneof.
Constant __DEPRECATION_DETAILS__ Undocumented
Constant __EXTENSION_REGISTRY__ Registry that decodes protobuf extensions.
Constant __FIELDS__ Runtime field data that the generator creates.
Constant __MAX_NESTING_DEPTH__ Maximum protobuf nesting depth for serialization, parsing, and initialization checks.
Constant __PB2_DESCRIPTOR__ Alias for code that expects a protobuf descriptor.
Constant __PROTO_DESCRIPTOR__ Message descriptor from the registry.
Constant __PY_TO_PB2__ Mapping from Python names to protobuf names.
Constant __REGISTRY__ Registry for the message and its descriptor.
Class Variable __PROTO_FULL_NAME__ Fully qualified protobuf message name.
Property Extensions Provide protobuf-compatible mapping access to extension values.
Class Method _fields_by_number Undocumented
Class Method _fields_by_proto_name Undocumented
Class Method _fields_by_python_name Undocumented
Class Method _from_string Deserialize internally without invoking generated user warnings.
Class Method _oneof_python_name Undocumented
Class Method _public_fields_by_proto_name Undocumented
Class Method _public_fields_by_python_name Undocumented
Static Method _format_map_key Undocumented
Static Method _repr_field Undocumented
Method _bind_child Undocumented
Method _bind_mutation Undocumented
Method _check_same_type Undocumented
Method _child_changed Undocumented
Method _clear_state Undocumented
Method _closed_enum_unknown Undocumented
Method _converted_view Undocumented
Method _decode_map_entry Undocumented
Method _detach_child Undocumented
Method _field_has_value Undocumented
Method _field_is_default Undocumented
Method _find_initialization_errors Undocumented
Method _get_field Undocumented
Method _initialize Initialize message state, optionally suppressing generated warnings.
Method _map Undocumented
Method _merge_from_string Undocumented
Method _nesting_limit Undocumented
Method _notify Undocumented
Method _record_reset Undocumented
Method _repeated Undocumented
Method _select Undocumented
Method _serialize_to_string Undocumented
Method _set_field Undocumented
Method _suspend_mutation Undocumented
Method _suspend_reset_mask Undocumented
Method _try_decode_field Undocumented
Method _write_field Undocumented
Instance Variable _extensions Undocumented
Instance Variable _mutation_suspended Undocumented
Instance Variable _on_mutation Undocumented
Instance Variable _oneofs Undocumented
Instance Variable _present Undocumented
Instance Variable _reset_mask Undocumented
Instance Variable _reset_mask_suspended Undocumented
Instance Variable _unknown_fields Undocumented
Instance Variable _values Undocumented
Instance Variable _views Undocumented
def __init__(self, initial_message: SerializableMessage | None = None, *, field_presence: FieldPresence | None | UnsetType = ..., enum_type: EnumType | None | UnsetType = ..., repeated_field_encoding: RepeatedFieldEncoding | None | UnsetType = ..., utf8_validation: Utf8Validation | None | UnsetType = ..., message_encoding: MessageEncoding | None | UnsetType = ..., json_format: JsonFormat | None | UnsetType = ..., enforce_naming_style: EnforceNamingStyle | None | UnsetType = ..., default_symbol_visibility: DefaultSymbolVisibility | None | UnsetType = ...): (source)

Create a message from a source message and field values.

@default_symbol_visibility.setter
def default_symbol_visibility(self, value: DefaultSymbolVisibility | None): (source)

Set or clear the generated default_symbol_visibility field.

@enforce_naming_style.setter
def enforce_naming_style(self, value: EnforceNamingStyle | None): (source)

Set or clear the generated enforce_naming_style field.

@enum_type.setter
def enum_type(self, value: EnumType | None): (source)

Set or clear the generated enum_type field.

@field_presence.setter
def field_presence(self, value: FieldPresence | None): (source)

Set or clear the generated field_presence field.

@json_format.setter
def json_format(self, value: JsonFormat | None): (source)

Set or clear the generated json_format field.

@message_encoding.setter
def message_encoding(self, value: MessageEncoding | None): (source)

Set or clear the generated message_encoding field.

@repeated_field_encoding.setter
def repeated_field_encoding(self, value: RepeatedFieldEncoding | None): (source)

Set or clear the generated repeated_field_encoding field.

@utf8_validation.setter
def utf8_validation(self, value: Utf8Validation | None): (source)

Set or clear the generated utf8_validation field.

@property
default_symbol_visibility: DefaultSymbolVisibility = (source)

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

@property
repeated_field_encoding: RepeatedFieldEncoding = (source)

Undocumented

Undocumented