lsst.pipe.base.graph._loadHelpers Namespace Reference

Classes
class	RegistryDict
class	DefaultLoadHelper
class	S3LoadHelper
class	FileLoadHelper
class	OpenFileHandleHelper
class	LoadHelper

Functions
def	register_helper (Union[Type[ButlerURI], Type[io.IO[bytes]]] URICLass)

Variables
	HELPER_REGISTRY = RegistryDict()

Function Documentation

register_helper()

def lsst.pipe.base.graph._loadHelpers.register_helper

(

Union[Type[ButlerURI], Type[io.IO[bytes]]]

URICLass

)

Used to register classes as Load helpers

When decorating a class the parameter is the class of "handle type", i.e.
a ButlerURI type or open file handle that will be used to do the loading.
This is then associated with the decorated class such that when the
parameter type is used to load data, the appropriate helper to work with
that data type can be returned.

A decorator is used so that in theory someone could define another handler
in a different module and register it for use.

Parameters
----------
URIClass : Type of `~lsst.daf.butler.ButlerURI` or `~io.IO` of bytes
    type for which the decorated class should be mapped to

Definition at line 56 of file _loadHelpers.py.

def register_helper(URICLass: Union[Type[ButlerURI], Type[io.IO[bytes]]]):
    """Used to register classes as Load helpers
 
    When decorating a class the parameter is the class of "handle type", i.e.
    a ButlerURI type or open file handle that will be used to do the loading.
    This is then associated with the decorated class such that when the
    parameter type is used to load data, the appropriate helper to work with
    that data type can be returned.
 
    A decorator is used so that in theory someone could define another handler
    in a different module and register it for use.
 
    Parameters
    ----------
    URIClass : Type of `~lsst.daf.butler.ButlerURI` or `~io.IO` of bytes
        type for which the decorated class should be mapped to
    """
    def wrapper(class_):
        HELPER_REGISTRY[URICLass] = class_
        return class_
    return wrapper
 
 

Variable Documentation

HELPER_REGISTRY

lsst.pipe.base.graph._loadHelpers.HELPER_REGISTRY = RegistryDict()

Definition at line 53 of file _loadHelpers.py.