lsst.pipe.base.connections Namespace Reference

Classes
class	DeferredDatasetRef
class	InputQuantizedConnection
class	OutputQuantizedConnection
class	PipelineTaskConnectionDict
class	PipelineTaskConnections
class	PipelineTaskConnectionsMetaclass
class	QuantizedConnection
class	ScalarError

Functions
typing.Generator[BaseConnection, None, None]	iterConnections (PipelineTaskConnections connections, Union[str, Iterable[str]] connectionType)

Function Documentation

iterConnections()

typing.Generator[BaseConnection, None, None] lsst.pipe.base.connections.iterConnections	(	PipelineTaskConnections	connections,
		Union[str, Iterable[str]]	connectionType
	)

Creates an iterator over the selected connections type which yields
all the defined connections of that type.

Parameters
----------
connections: `PipelineTaskConnections`
    An instance of a `PipelineTaskConnections` object that will be iterated
    over.
connectionType: `str`
    The type of connections to iterate over, valid values are inputs,
    outputs, prerequisiteInputs, initInputs, initOutputs.

Yields
-------
connection: `BaseConnection`
    A connection defined on the input connections object of the type
    supplied.  The yielded value Will be an derived type of
    `BaseConnection`.

Definition at line 501 of file connections.py.

def iterConnections(connections: PipelineTaskConnections,
                    connectionType: Union[str, Iterable[str]]
                    ) -> typing.Generator[BaseConnection, None, None]:
    """Creates an iterator over the selected connections type which yields
    all the defined connections of that type.
 
    Parameters
    ----------
    connections: `PipelineTaskConnections`
        An instance of a `PipelineTaskConnections` object that will be iterated
        over.
    connectionType: `str`
        The type of connections to iterate over, valid values are inputs,
        outputs, prerequisiteInputs, initInputs, initOutputs.
 
    Yields
    -------
    connection: `BaseConnection`
        A connection defined on the input connections object of the type
        supplied.  The yielded value Will be an derived type of
        `BaseConnection`.
    """
    if isinstance(connectionType, str):
        connectionType = (connectionType,)
    for name in itertools.chain.from_iterable(getattr(connections, ct) for ct in connectionType):
        yield getattr(connections, name)