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	iterConnections (PipelineTaskConnections connections, str connectionType)

Function Documentation

iterConnections()

typing.Generator lsst.pipe.base.connections.iterConnections	(	PipelineTaskConnections	connections,
		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 494 of file connections.py.

def iterConnections(connections: PipelineTaskConnections, connectionType: str) -> typing.Generator:
    """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`.
    """
    for name in getattr(connections, connectionType):
        yield getattr(connections, name)