Skip to navigation

nemo_gym.utils.compat

View as Markdown

Backward-compatibility helpers for symbols relocated during the CLI refactor.

It provides a lazy import mechanism for symbols that were moved to the nemo_gym.cli package and emits a DeprecationWarning pointing at the correct import path.

Note that an eager re-export from nemo_gym.cli.x import foo at the top of a core module would create a circular import.

Module Contents

Functions

NameDescription
moved_attr_getterBuild a module __getattr__ that re-exports relocated symbols with a deprecation warning.

API

nemo_gym.utils.compat.moved_attr_getter(
module_name: str,
moved: typing.Mapping[str, str]
) -> typing.Callable[[str], typing.Any]

Build a module __getattr__ that re-exports relocated symbols with a deprecation warning.

Parameters:

module_name
str

The __name__ of the module installing the shim (the old location).

moved
Mapping[str, str]

Maps each old attribute name to its new location. The value is either "package.module" (same attribute name) or "package.module:new_name" when the symbol was also renamed.

Returns: Callable[[str], Any]

A function suitable for assigning to a module’s __getattr__.