hydra.python.names module

Python naming utilities: encoding Hydra names as Python names.

hydra.python.names.encode_constant_for_field_name(env: T0, tname: T1, fname: Name) → Name

Generate a constant name for a field definition.

hydra.python.names.encode_constant_for_type_name(env: T0, tname: T1) → Name

Generate a constant name for a type definition.

hydra.python.names.encode_enum_value(v1: PythonEnvironment, v2: Name) → Name

Encode a name as a Python enum value (UPPER_SNAKE case).

hydra.python.names.encode_field_name(env: PythonEnvironment, fname: Name) → Name

Encode a name as a Python field name (lower_snake case).

hydra.python.names.encode_name(is_qualified: bool, conv: CaseConvention, env: PythonEnvironment, name: Name) → Name

Encode a Hydra name as a Python name.

hydra.python.names.encode_name_qualified(env: PythonEnvironment, name: Name) → Name

Encode a name as a fully qualified Python name.

hydra.python.names.encode_namespace(ns_val: ModuleName) → DottedName

Encode a namespace as a Python dotted name.

hydra.python.names.encode_namespace_string_with_overrides(overlay_subs: Set[str], ns_val: ModuleName) → str

Convert a ModuleName to its Python dotted import string, routing overlay modules to hydra.overlay.python.*.

hydra.python.names.encode_namespace_with_overrides(overlay_subs: Set[str], ns_val: ModuleName) → DottedName

Encode a namespace as a Python dotted name, routing overlay modules to their hydra.overlay.python.* paths.

hydra.python.names.encode_type_variable(name: Name) → Name

Encode a type variable name (capitalized).

hydra.python.names.overlay_python_module_aliases() → Mapping[ModuleName, str]

Alias map routing DSL-declared module names to their hydra.overlay.python.* import strings.

hydra.python.names.sanitize_python_name(v1: str) → str

Sanitize a string to be a valid Python name.

hydra.python.names.term_variable_reference(v1: PythonEnvironment, v2: Name) → Expression

Reference a term variable as a Python expression.

hydra.python.names.type_variable_reference(v1: PythonEnvironment, v2: Name) → Expression

Reference a type variable as a Python expression.

hydra.python.names.variable_reference(conv: CaseConvention, quoted: bool, env: PythonEnvironment, name: Name) → Expression

Reference a variable as a Python expression.

hydra.python.names.variant_name(is_qualified: bool, env: PythonEnvironment, tname: Name, fname: Name) → Name

Generate a variant name from type name and field name.