lsst.afw g776a55d5bd+f790144ad9
Public Member Functions | 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="")
 

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.

◆ 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.

◆ 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.


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