Skip to content

tinker_cookbook.utils.make_deprecated_module_getattr

tinker_cookbook.utils.make_deprecated_module_getattr(module_name, attrs)

Create a __getattr__ function for deprecating module-level attributes.

Parameters:

  • module_name (str) – __name__ of the module defining __getattr__.
  • attrs (dict[str, tuple[str, str | None]]) – Mapping of {old_name: (dotted_path_to_new, removal_version)}. dotted_path_to_new is "package.module.NewName" and will be imported and returned. removal_version may be None.

Returns: A __getattr__ function.