Inheritance diagram for lsst.afw.typehandling.testUtils.MutableGenericMapTestBaseClass:

Public Member Functions
	checkInsertItem (self, mapFactory, contents, msg="")

	checkSetdefault (self, mapFactory, contents, msg="")

	checkUpdateMapping (self, mapFactory, contents, msg="")

	checkUpdatePairs (self, mapFactory, contents, msg="")

	checkUpdateKwargs (self, mapFactory, contents, msg="")

	checkReplaceItem (self, genericMap, msg="")

	checkRemoveItem (self, mapFactory, contents, msg="")

	checkPop (self, mapFactory, contents, msg="")

	checkPopitem (self, mapFactory, contents, msg="")

	checkClear (self, mapFactory, contents, msg="")

	checkMutableViews (self, mapFactory, contents, msg="")

	getTestData (cls, keyClass)

	setUp (self)

	checkInitMapping (self, mapClass, contents, msg="")

	checkInitPairs (self, mapClass, contents, msg="")

	checkInitKwargs (self, mapClass, contents, msg="")

	checkFromKeysDefault (self, mapClass, keys, msg="")

	checkFromKeys (self, mapClass, keys, value, msg="")

	checkContains (self, genericMap, contents, msg="")

	checkContents (self, genericMap, contents, msg="")

	checkGet (self, genericMap, contents, msg="")

	checkIteration (self, genericMap, contents, msg="")

	checkViews (self, genericMap, contents, msg="")

Static Public Member Functions
	getValidKeys (mapClass)

Public Attributes
bool	longMessage = True

Protected Member Functions
	_fillMap (cls, mapFactory, contents)

	_fillPartialMap (cls, mapFactory, contents, numElements)

Static Protected Attributes
	_testData

Detailed Description

Base class for unit tests of GenericMap that allow insertion/deletion.

Subclasses must call `MutableGenericMapTestBaseClass.setUp(self)`
if they provide their own version.

Definition at line 367 of file testUtils.py.

Member Function Documentation

◆ _fillMap()

lsst.afw.typehandling.testUtils.MutableGenericMapTestBaseClass._fillMap	(	cls,
		mapFactory,
		contents )

protected

Create a new GenericMap with particular contents.

Parameters
----------
mapFactory : callable
    A zero-argument callable that creates an empty
    `lsst.afw.typehandling.GenericMap` object
contents : `Mapping`
    The key-value pairs that should be present in the new map.

Returns
-------
map : `lsst.afw.typehandling.GenericMap`
    a GenericMap equivalent to ``contents``

Definition at line 375 of file testUtils.py.

◆ _fillPartialMap()

lsst.afw.typehandling.testUtils.MutableGenericMapTestBaseClass._fillPartialMap	(	cls,
		mapFactory,
		contents,
		numElements )

protected

Create a new GenericMap with particular contents.

Parameters
----------
mapFactory : callable
    A zero-argument callable that creates an empty
    `lsst.afw.typehandling.GenericMap` object
contents : `Mapping`
    The key-value pairs that should be present in the new map.
numElements : `int`
    The number of elements from ``contents`` to be inserted.

Returns
-------
map : `lsst.afw.typehandling.GenericMap`
    a GenericMap containing ``numElements`` of ``contents`` or all of
    ``contents``, whichever is smaller

Definition at line 394 of file testUtils.py.

◆ checkClear()

lsst.afw.typehandling.testUtils.MutableGenericMapTestBaseClass.checkClear	(	self,
		mapFactory,
		contents,
		msg = "" )

Check erasing a GenericMap.

Parameters
----------
mapFactory : callable
    A zero-argument callable that creates an empty
    `lsst.afw.typehandling.GenericMap` object of the type to be tested
contents : `Mapping`
    The key-value pairs initially occupying the map
msg : `str`
    Error message suffix describing test parameters

Definition at line 705 of file testUtils.py.

◆ checkContains()

lsst.afw.typehandling.testUtils.GenericMapTestBaseClass.checkContains	(	self,
		genericMap,
		contents,
		msg = "" )

inherited

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.

◆ checkContents()

lsst.afw.typehandling.testUtils.GenericMapTestBaseClass.checkContents	(	self,
		genericMap,
		contents,
		msg = "" )

inherited

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.

◆ checkFromKeys()

lsst.afw.typehandling.testUtils.GenericMapTestBaseClass.checkFromKeys	(	self,
		mapClass,
		keys,
		value,
		msg = "" )

inherited

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.

◆ checkFromKeysDefault()

lsst.afw.typehandling.testUtils.GenericMapTestBaseClass.checkFromKeysDefault	(	self,
		mapClass,
		keys,
		msg = "" )

inherited

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.

◆ checkGet()

lsst.afw.typehandling.testUtils.GenericMapTestBaseClass.checkGet	(	self,
		genericMap,
		contents,
		msg = "" )

inherited

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.

◆ checkInitKwargs()

lsst.afw.typehandling.testUtils.GenericMapTestBaseClass.checkInitKwargs	(	self,
		mapClass,
		contents,
		msg = "" )

inherited

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.

◆ checkInitMapping()

lsst.afw.typehandling.testUtils.GenericMapTestBaseClass.checkInitMapping	(	self,
		mapClass,
		contents,
		msg = "" )

inherited

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.

◆ checkInitPairs()

lsst.afw.typehandling.testUtils.GenericMapTestBaseClass.checkInitPairs	(	self,
		mapClass,
		contents,
		msg = "" )

inherited

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.

◆ checkInsertItem()

lsst.afw.typehandling.testUtils.MutableGenericMapTestBaseClass.checkInsertItem	(	self,
		mapFactory,
		contents,
		msg = "" )

Check element insertion in a GenericMap.

Parameters
----------
mapFactory : callable
    A zero-argument callable that creates an empty
    `lsst.afw.typehandling.GenericMap` object of the type to be tested
contents : `Mapping`
    The key-value pairs to insert into the map
msg : `str`
    Error message suffix describing test parameters

Definition at line 430 of file testUtils.py.

◆ checkIteration()

lsst.afw.typehandling.testUtils.GenericMapTestBaseClass.checkIteration	(	self,
		genericMap,
		contents,
		msg = "" )

inherited

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.

◆ checkMutableViews()

lsst.afw.typehandling.testUtils.MutableGenericMapTestBaseClass.checkMutableViews	(	self,
		mapFactory,
		contents,
		msg = "" )

Check that the views of a GenericMap update automatically.

This test supersedes `GenericMapTestBaseClass.checkViews`.

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 727 of file testUtils.py.

◆ checkPop()

lsst.afw.typehandling.testUtils.MutableGenericMapTestBaseClass.checkPop	(	self,
		mapFactory,
		contents,
		msg = "" )

Check that GenericMap.pop works correctly.

Parameters
----------
mapFactory : callable
    A zero-argument callable that creates an empty
    `lsst.afw.typehandling.GenericMap` object of the type to be tested
contents : `Mapping`
    The key-value pairs initially occupying the map
msg : `str`
    Error message suffix describing test parameters

Definition at line 642 of file testUtils.py.

◆ checkPopitem()

lsst.afw.typehandling.testUtils.MutableGenericMapTestBaseClass.checkPopitem	(	self,
		mapFactory,
		contents,
		msg = "" )

Check that GenericMap.popitem works correctly.

Parameters
----------
mapFactory : callable
    A zero-argument callable that creates an empty
    `lsst.afw.typehandling.GenericMap` object of the type to be tested
contents : `Mapping`
    The key-value pairs initially occupying the map
msg : `str`
    Error message suffix describing test parameters

Definition at line 680 of file testUtils.py.

◆ checkRemoveItem()

lsst.afw.typehandling.testUtils.MutableGenericMapTestBaseClass.checkRemoveItem	(	self,
		mapFactory,
		contents,
		msg = "" )

Check element removal from a GenericMap.

Parameters
----------
mapFactory : callable
    A zero-argument callable that creates an empty
    `lsst.afw.typehandling.GenericMap` object of the type to be tested
contents : `Mapping`
    The key-value pairs initially occupying the map
msg : `str`
    Error message suffix describing test parameters

Definition at line 610 of file testUtils.py.

◆ checkReplaceItem()

lsst.afw.typehandling.testUtils.MutableGenericMapTestBaseClass.checkReplaceItem	(	self,
		genericMap,
		msg = "" )

Check element replacement in a GenericMap.

Parameters
----------
genericMap : `lsst.afw.typehandling.GenericMap`
    The map to test. Must be empty.
msg : `str`
    Error message suffix describing test parameters

Definition at line 585 of file testUtils.py.

◆ checkSetdefault()

lsst.afw.typehandling.testUtils.MutableGenericMapTestBaseClass.checkSetdefault	(	self,
		mapFactory,
		contents,
		msg = "" )

Check that GenericMap.setdefault works correctly.

Parameters
----------
mapFactory : callable
    A zero-argument callable that creates an empty
    `lsst.afw.typehandling.GenericMap` object of the type to be tested
contents : `Mapping`
    The key-value pairs to insert into the map
msg : `str`
    Error message suffix describing test parameters

Definition at line 461 of file testUtils.py.

◆ checkUpdateKwargs()

lsst.afw.typehandling.testUtils.MutableGenericMapTestBaseClass.checkUpdateKwargs	(	self,
		mapFactory,
		contents,
		msg = "" )

Check bulk insertion from keywords into a GenericMap.

Parameters
----------
mapFactory : callable
    A zero-argument callable that creates an empty
    `lsst.afw.typehandling.GenericMap` object of the type to 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 562 of file testUtils.py.

◆ checkUpdateMapping()

lsst.afw.typehandling.testUtils.MutableGenericMapTestBaseClass.checkUpdateMapping	(	self,
		mapFactory,
		contents,
		msg = "" )

Check bulk insertion from a mapping into a GenericMap.

Parameters
----------
mapFactory : callable
    A zero-argument callable that creates an empty
    `lsst.afw.typehandling.GenericMap` object of the type to be tested
contents : `Mapping`
    The key-value pairs to insert into the map
msg : `str`
    Error message suffix describing test parameters

Definition at line 508 of file testUtils.py.

◆ checkUpdatePairs()

lsst.afw.typehandling.testUtils.MutableGenericMapTestBaseClass.checkUpdatePairs	(	self,
		mapFactory,
		contents,
		msg = "" )

Check bulk insertion from an iterable of pairs into a GenericMap.

Parameters
----------
mapFactory : callable
    A zero-argument callable that creates an empty
    `lsst.afw.typehandling.GenericMap` object of the type to be tested
contents : `Mapping`
    The key-value pairs to insert into the map
msg : `str`
    Error message suffix describing test parameters

Definition at line 535 of file testUtils.py.

◆ checkViews()

lsst.afw.typehandling.testUtils.GenericMapTestBaseClass.checkViews	(	self,
		genericMap,
		contents,
		msg = "" )

inherited

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.

◆ getTestData()

lsst.afw.typehandling.testUtils.GenericMapTestBaseClass.getTestData	(		cls,
			keyClass )

inherited

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.

◆ getValidKeys()

lsst.afw.typehandling.testUtils.GenericMapTestBaseClass.getValidKeys ( mapClass )

staticinherited

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.

◆ setUp()

lsst.afw.typehandling.testUtils.GenericMapTestBaseClass.setUp ( self )

inherited

Set up a test

Subclasses must call this method if they override setUp.

Definition at line 128 of file testUtils.py.

Member Data Documentation

◆ _testData

lsst.afw.typehandling.testUtils.GenericMapTestBaseClass._testData

staticprotectedinherited

Definition at line 85 of file testUtils.py.

◆ longMessage

bool lsst.afw.typehandling.testUtils.GenericMapTestBaseClass.longMessage = True

inherited

Definition at line 136 of file testUtils.py.

The documentation for this class was generated from the following file:

python/lsst/afw/typehandling/testUtils.py

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ _fillMap()

◆ _fillPartialMap()

◆ checkClear()

◆ checkContains()

◆ checkContents()

◆ checkFromKeys()

◆ checkFromKeysDefault()

◆ checkGet()

◆ checkInitKwargs()

◆ checkInitMapping()

◆ checkInitPairs()

◆ checkInsertItem()

◆ checkIteration()

◆ checkMutableViews()

◆ checkPop()

◆ checkPopitem()

◆ checkRemoveItem()

◆ checkReplaceItem()

◆ checkSetdefault()

◆ checkUpdateKwargs()

◆ checkUpdateMapping()

◆ checkUpdatePairs()

◆ checkViews()

◆ getTestData()

◆ getValidKeys()

◆ setUp()

Member Data Documentation

◆ _testData

◆ longMessage