lsst.scarlet.lite.io.migration Namespace Reference

Classes
class	MigrationError
class	MigrationRegistry

Functions
Callable[[Migrator], Migrator]	migration (str type_name, str from_version)

Variables
	Migrator = Callable[[dict], dict]
str	PRE_SCHEMA = "0.0.0"

Function Documentation

migration()

Callable[[Migrator], Migrator] lsst.scarlet.lite.io.migration.migration	(	str	type_name,
		str	from_version )

Decorator to register a migration step.

Parameters
----------
type_name :
    The type of data being migrated.
from_version :
    The version the migrator converts from.

Returns
-------
result :
    The decorator that registers the migration function.

Definition at line 77 of file migration.py.

def migration(type_name: str, from_version: str) -> Callable[[Migrator], Migrator]:
    """Decorator to register a migration step.
 
    Parameters
    ----------
    type_name :
        The type of data being migrated.
    from_version :
        The version the migrator converts from.
 
    Returns
    -------
    result :
        The decorator that registers the migration function.
    """
 
    def decorator(func: Migrator) -> Migrator:
        MigrationRegistry.register(type_name, from_version, func)
        return func
 
    return decorator

Variable Documentation

Migrator

lsst.scarlet.lite.io.migration.Migrator = Callable[[dict], dict]

Definition at line 7 of file migration.py.

PRE_SCHEMA

str lsst.scarlet.lite.io.migration.PRE_SCHEMA = "0.0.0"

Definition at line 9 of file migration.py.