lsst.pipe.base  21.0.0+544a109665
Functions
lsst.pipe.base.testUtils Namespace Reference

Functions

def makeQuantum (task, butler, dataId, ioDataIds)
 
def runTestQuantum (task, butler, quantum, mockRun=True)
 
def assertValidOutput (task, result)
 

Function Documentation

◆ assertValidOutput()

def lsst.pipe.base.testUtils.assertValidOutput (   task,
  result 
)
Test that the output of a call to ``run`` conforms to its own
connections.

Parameters
----------
task : `lsst.pipe.base.PipelineTask`
    The task whose connections need validation. This is a fully-configured
    task object to support features such as optional outputs.
result : `lsst.pipe.base.Struct`
    A result object produced by calling ``task.run``.

Raises
-------
AssertionError:
    Raised if ``result`` does not match what's expected from ``task's``
    connections.

Definition at line 245 of file testUtils.py.

◆ makeQuantum()

def lsst.pipe.base.testUtils.makeQuantum (   task,
  butler,
  dataId,
  ioDataIds 
)
Create a Quantum for a particular data ID(s).

Parameters
----------
task : `lsst.pipe.base.PipelineTask`
    The task whose processing the quantum represents.
butler : `lsst.daf.butler.Butler`
    The collection the quantum refers to.
dataId: any data ID type
    The data ID of the quantum. Must have the same dimensions as
    ``task``'s connections class.
ioDataIds : `collections.abc.Mapping` [`str`]
    A mapping keyed by input/output names. Values must be data IDs for
    single connections and sequences of data IDs for multiple connections.

Returns
-------
quantum : `lsst.daf.butler.Quantum`
    A quantum for ``task``, when called with ``dataIds``.

Definition at line 35 of file testUtils.py.

◆ runTestQuantum()

def lsst.pipe.base.testUtils.runTestQuantum (   task,
  butler,
  quantum,
  mockRun = True 
)
Run a PipelineTask on a Quantum.

Parameters
----------
task : `lsst.pipe.base.PipelineTask`
    The task to run on the quantum.
butler : `lsst.daf.butler.Butler`
    The collection to run on.
quantum : `lsst.daf.butler.Quantum`
    The quantum to run.
mockRun : `bool`
    Whether or not to replace ``task``'s ``run`` method. The default of
    `True` is recommended unless ``run`` needs to do real work (e.g.,
    because the test needs real output datasets).

Returns
-------
run : `unittest.mock.Mock` or `None`
    If ``mockRun`` is set, the mock that replaced ``run``. This object can
    be queried for the arguments ``runQuantum`` passed to ``run``.

Definition at line 209 of file testUtils.py.