|
lsst.afw g712618294e+4813a5392e
|
Classes | |
| class | ComplexStorable |
| class | NotAStorable |
| class | SimpleStorable |
Public Member Functions | |
| def | getTestData (cls, keyClass) |
| def | setUp (self) |
| def | checkInitMapping (self, mapClass, contents, msg="") |
| def | checkInitPairs (self, mapClass, contents, msg="") |
| def | checkInitKwargs (self, mapClass, contents, msg="") |
| def | checkFromKeysDefault (self, mapClass, keys, msg="") |
| def | checkFromKeys (self, mapClass, keys, value, msg="") |
| def | checkContains (self, genericMap, contents, msg="") |
| def | checkContents (self, genericMap, contents, msg="") |
| def | checkGet (self, genericMap, contents, msg="") |
| def | checkIteration (self, genericMap, contents, msg="") |
| def | checkViews (self, genericMap, contents, msg="") |
Static Public Member Functions | |
| def | getValidKeys (mapClass) |
Public Attributes | |
| longMessage | |
Base class for unit tests of GenericMap. Subclasses must call `GenericMapTestBaseClass.setUp(self)` if they provide their own version. This class is not *quite* a generic Mapping testbed, because it assumes that the map being tested only accepts keys of a particular type, stored as the `dtype` member.
Definition at line 33 of file testUtils.py.
| def lsst.afw.typehandling.testUtils.GenericMapTestBaseClass.checkContains | ( | self, | |
| genericMap, | |||
| contents, | |||
msg = "" |
|||
| ) |
Check the contents of a GenericMap.
Parameters
----------
genericMap : `lsst.afw.typehandling.GenericMap`
The map to test.
contents : `Mapping`
The key-value pairs that should be present in ``genericMap``
msg : `str`
Error message suffix describing test parameters
Definition at line 262 of file testUtils.py.
| def lsst.afw.typehandling.testUtils.GenericMapTestBaseClass.checkContents | ( | self, | |
| genericMap, | |||
| contents, | |||
msg = "" |
|||
| ) |
Check the contents of a GenericMap.
Parameters
----------
genericMap : `lsst.afw.typehandling.GenericMap`
The map to test.
contents : `Mapping`
The key-value pairs that should be present in ``genericMap``
msg : `str`
Error message suffix describing test parameters
Definition at line 286 of file testUtils.py.
| def lsst.afw.typehandling.testUtils.GenericMapTestBaseClass.checkFromKeys | ( | self, | |
| mapClass, | |||
| keys, | |||
| value, | |||
msg = "" |
|||
| ) |
Check initialization using the ``fromkeys`` factory.
Parameters
----------
mapClass: `lsst.afw.typehandling.GenericMap`-type
The class whose ``fromkeys`` method will be tested.
keys : `iterable`
The keys to insert into the map.
value
A legal value for a GenericMap.
msg : `str`
Error message suffix describing test parameters
Definition at line 244 of file testUtils.py.
| def lsst.afw.typehandling.testUtils.GenericMapTestBaseClass.checkFromKeysDefault | ( | self, | |
| mapClass, | |||
| keys, | |||
msg = "" |
|||
| ) |
Check initialization using the ``fromkeys`` factory.
Unlike `checkFromKeys`, this method lets ``fromkeys`` use its default
value (which may give different behavior, in nonconforming
implementations, from explicitly passing `None`).
Parameters
----------
mapClass: `lsst.afw.typehandling.GenericMap`-type
The class whose ``fromkeys`` method will be tested.
keys : `iterable`
The keys to insert into the map.
msg : `str`
Error message suffix describing test parameters
Definition at line 224 of file testUtils.py.
| def lsst.afw.typehandling.testUtils.GenericMapTestBaseClass.checkGet | ( | self, | |
| genericMap, | |||
| contents, | |||
msg = "" |
|||
| ) |
Check that GenericMap.get works correctly.
Parameters
----------
genericMap : `lsst.afw.typehandling.GenericMap`
The map to test.
contents : `Mapping`
The key-value pairs that should be present in ``genericMap``
msg : `str`
Error message suffix describing test parameters
Definition at line 310 of file testUtils.py.
| def lsst.afw.typehandling.testUtils.GenericMapTestBaseClass.checkInitKwargs | ( | self, | |
| mapClass, | |||
| contents, | |||
msg = "" |
|||
| ) |
Check bulk insertion from keywords into a GenericMap.
Parameters
----------
mapClass: `lsst.afw.typehandling.GenericMapS`-type
The class whose ``__init__`` method will be tested.
Must allow string keys.
contents : `Mapping`
The key-value pairs to insert into the map
msg : `str`
Error message suffix describing test parameters
Definition at line 205 of file testUtils.py.
| def lsst.afw.typehandling.testUtils.GenericMapTestBaseClass.checkInitMapping | ( | self, | |
| mapClass, | |||
| contents, | |||
msg = "" |
|||
| ) |
Check initialization from a mapping.
Parameters
----------
mapClass : `lsst.afw.typehandling.GenericMap`-type
The class whose ``__init__`` method will be tested.
contents : `Mapping`
The key-value pairs to insert into the map
msg : `str`
Error message suffix describing test parameters
Definition at line 153 of file testUtils.py.
| def lsst.afw.typehandling.testUtils.GenericMapTestBaseClass.checkInitPairs | ( | self, | |
| mapClass, | |||
| contents, | |||
msg = "" |
|||
| ) |
Check initialization from an iterable of pairs.
Parameters
----------
mapClass: `lsst.afw.typehandling.GenericMap`-type
The class whose ``__init__`` method will be tested.
contents : `Mapping`
The key-value pairs to insert into the map
msg : `str`
Error message suffix describing test parameters
Definition at line 179 of file testUtils.py.
| def lsst.afw.typehandling.testUtils.GenericMapTestBaseClass.checkIteration | ( | self, | |
| genericMap, | |||
| contents, | |||
msg = "" |
|||
| ) |
Check the result of iterating over a GenericMap.
Parameters
----------
genericMap : `lsst.afw.typehandling.GenericMap`
The map to test.
contents : `Mapping`
The key-value pairs that should be present in ``genericMap``
msg : `str`
Error message suffix describing test parameters
Definition at line 336 of file testUtils.py.
| def lsst.afw.typehandling.testUtils.GenericMapTestBaseClass.checkViews | ( | self, | |
| genericMap, | |||
| contents, | |||
msg = "" |
|||
| ) |
Check the views provided by a GenericMap.
Parameters
----------
genericMap : `lsst.afw.typehandling.GenericMap`
The map to test.
contents : `Mapping`
The key-value pairs that should be present in ``genericMap``
msg : `str`
Error message suffix describing test parameters
Definition at line 350 of file testUtils.py.
| def lsst.afw.typehandling.testUtils.GenericMapTestBaseClass.getTestData | ( | cls, | |
| keyClass | |||
| ) |
Generic dataset for testing GenericMap classes that can handle it.
Parameters
----------
keyClass : `type`
The type of key expected by the GenericMap.
Definition at line 96 of file testUtils.py.
|
static |
Return all keys suitable for a GenericMap.
Parameters
----------
mapClass : `type`
A type object for a subclass of either `GenericMap` or a
key-specific specialization.
Returns
-------
keyTypes: `set` [`type`]
The types that can be used as keys. If ``mapClass`` is a
key-specific specialization, this set will contain exactly
one type.
Definition at line 107 of file testUtils.py.
| def lsst.afw.typehandling.testUtils.GenericMapTestBaseClass.setUp | ( | self | ) |
Set up a test Subclasses must call this method if they override setUp.
Definition at line 128 of file testUtils.py.
| lsst.afw.typehandling.testUtils.GenericMapTestBaseClass.longMessage |
Definition at line 136 of file testUtils.py.