nebius.base.protos.pythonic

module documentation

(source)

Utilities for deriving Python-friendly names from protobuf identifiers.

Exception	`NameError`	Raised when a name cannot be converted into a valid Python identifier.
Function	`enum`	Return a Python enum name from a protobuf enum name.
Function	`enum_value`	Return a Python constant name for an enum value.
Function	`field`	Return a Python attribute name for a message field.
Function	`first_non_underscore`	Return the first non-underscore character or an empty string.
Function	`is_reserved_name`	Return True if `s` is a Python keyword or soft keyword.
Function	`message`	Return a Python message name from a protobuf message name.
Function	`method`	Return a Python method name for a service method.
Function	`one_of`	Return a Python attribute name for a oneof declaration.
Function	`pascal_to_snake_case`	Convert a PascalCase string to snake_case.
Function	`service`	Return a Python service class name from a protobuf service name.
Variable	`logger`	Undocumented
Variable	`pep8_attr_re`	Undocumented
Variable	`pep8_class_re`	Undocumented
Variable	`pep8_const_re`	Undocumented
Variable	`pep8_method_re`	Undocumented
Function	`_class_name`	Resolve a Python class name from a protobuf full name.
Function	`_modify_name`	Adjust a proposed name to avoid reserved words and conflicts.

def enum(full_enum_name: str, annotated_name: str = '', full_proto_name: str = '') -> str: (source) ¶

Return a Python enum name from a protobuf enum name.

Parameters
full_enum_name:`str`	Fully qualified proto enum name.
annotated_name:`str`	Optional explicit name from annotations.
full_proto_name:`str`	Fully qualified proto name for warnings.
Returns
`str`	Valid Python enum class name.
Raises
`NameError`	If the annotated name is invalid.

def enum_value(value_name: str, enum_name: str, annotated_name: str = '', full_proto_name: str = '') -> str: (source) ¶

Return a Python constant name for an enum value.

Parameters
value_name:`str`	Enum value name in proto.
enum_name:`str`	Containing enum name.
annotated_name:`str`	Optional explicit name from annotations.
full_proto_name:`str`	Fully qualified proto name for warnings.
Returns
`str`	Valid Python constant name.
Raises
`NameError`	If the annotated name is invalid.

def field(field_name: str, message_name: str, annotated_name: str = '', full_proto_name: str = '') -> str: (source) ¶

Return a Python attribute name for a message field.

Parameters
field_name:`str`	Field name in proto.
message_name:`str`	Containing message name.
annotated_name:`str`	Optional explicit name from annotations.
full_proto_name:`str`	Fully qualified proto name for warnings.
Returns
`str`	Valid Python attribute name.
Raises
`NameError`	If the annotated name is invalid.

def first_non_underscore(s: str) -> str: (source) ¶

Return the first non-underscore character or an empty string.

Parameters
s:`str`	Input string.
Returns
`str`	First non-underscore character or `""`.

def is_reserved_name(s: str) -> bool: (source) ¶

Return True if s is a Python keyword or soft keyword.

Parameters
s:`str`	Name to test.
Returns
`bool`	`True` if reserved.

def message(full_enum_name: str, annotated_name: str = '') -> str: (source) ¶

Return a Python message name from a protobuf message name.

Parameters
full_enum_name:`str`	Fully qualified proto message name.
annotated_name:`str`	Optional explicit name from annotations.
Returns
`str`	Valid Python message class name.
Raises
`NameError`	If the annotated name is invalid.

def method(method_name: str, service_name: str, annotated_name: str = '', full_proto_name: str = '') -> str: (source) ¶

Return a Python method name for a service method.

Parameters
method_name:`str`	Proto method name.
service_name:`str`	Containing service name.
annotated_name:`str`	Optional explicit name from annotations.
full_proto_name:`str`	Fully qualified proto name for warnings.
Returns
`str`	Valid Python method name.
Raises
`NameError`	If the annotated name is invalid.

def one_of(field_name: str, message_name: str, annotated_name: str = '', full_proto_name: str = '') -> str: (source) ¶

Return a Python attribute name for a oneof declaration.

Parameters
field_name:`str`	Oneof field name.
message_name:`str`	Containing message name.
annotated_name:`str`	Optional explicit name from annotations.
full_proto_name:`str`	Fully qualified proto name for warnings.
Returns
`str`	Valid Python attribute name.
Raises
`NameError`	If the annotated name is invalid.

def pascal_to_snake_case(name: str) -> str: (source) ¶

Convert a PascalCase string to snake_case.

This conversion preserves leading underscores and splits abbreviations.

Parameters
name:`str`	PascalCase name.
Returns
`str`	snake_case representation.

def service(full_service_name: str, annotated_name: str = '') -> str: (source) ¶

Return a Python service class name from a protobuf service name.

Parameters
full_service_name:`str`	Fully qualified proto service name.
annotated_name:`str`	Optional explicit name from annotations.
Returns
`str`	Valid Python service class name.
Raises
`NameError`	If the annotated name is invalid.

logger = (source) ¶

Undocumented

pep8_attr_re = (source) ¶

Undocumented

pep8_class_re = (source) ¶

Undocumented

pep8_const_re = (source) ¶

Undocumented

pep8_method_re = (source) ¶

Undocumented

def _class_name(full_name: str, annotated_name: str = '') -> str: (source) ¶

Resolve a Python class name from a protobuf full name.

Parameters
full_name:`str`	Fully qualified proto name.
annotated_name:`str`	Optional explicit name from annotations.
Returns
`str`	Valid Python class name.
Raises
`NameError`	If the annotated name is invalid.

def _modify_name(suggested_name: str, container_name: str, *, lower: bool = True, full_proto_name: str = '') -> str: (source) ¶

Adjust a proposed name to avoid reserved words and conflicts.

Parameters
suggested_name:`str`	Initial candidate name.
container_name:`str`	Enclosing scope name used for conflict prefixes.
lower:`bool`	Whether to lower the prefix letter.
full_proto_name:`str`	Fully qualified proto name for warnings.
Returns
`str`	Adjusted name.

nebius.base.protos.pythonic_names

`nebius.base.protos.pythonic_names`