lsst.afw  22.0.1-41-g501672927+21a6849c81
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
lsst.afw.typehandling.testUtils.MutableGenericMapTestBaseClass Class Reference
Inheritance diagram for lsst.afw.typehandling.testUtils.MutableGenericMapTestBaseClass:
lsst.afw.typehandling.testUtils.GenericMapTestBaseClass

Public Member Functions

def checkInsertItem (self, mapFactory, contents, msg="")
 
def checkSetdefault (self, mapFactory, contents, msg="")
 
def checkUpdateMapping (self, mapFactory, contents, msg="")
 
def checkUpdatePairs (self, mapFactory, contents, msg="")
 
def checkUpdateKwargs (self, mapFactory, contents, msg="")
 
def checkReplaceItem (self, genericMap, msg="")
 
def checkRemoveItem (self, mapFactory, contents, msg="")
 
def checkPop (self, mapFactory, contents, msg="")
 
def checkPopitem (self, mapFactory, contents, msg="")
 
def checkClear (self, mapFactory, contents, msg="")
 
def checkMutableViews (self, mapFactory, contents, msg="")
 
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
 

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

◆ checkClear()

def 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()

def 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()

def 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()

def 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()

def 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()

def 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()

def 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()

def 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()

def 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()

def 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()

def 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()

def 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()

def 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()

def 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()

def 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()

def 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()

def 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()

def 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()

def 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()

def 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()

def 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()

def 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()

def 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()

def 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

◆ longMessage

lsst.afw.typehandling.testUtils.GenericMapTestBaseClass.longMessage
inherited

Definition at line 136 of file testUtils.py.


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