def testSaveSettingWithoutFilePath(self):
filePath = self._saveSettingFile()
paramReader = ParamReader(filePath=filePath)
paramReader.saveSetting()
self.assertEqual(paramReader.getFilePath(), filePath)
# Check the values are saved actually
self.assertEqual(paramReader.getSetting("znmax"), 22)
keysInContent = paramReader.getContent().keys()
self.assertTrue("dofIdx" in keysInContent)
self.assertTrue("zn3Idx" in keysInContent)
self.assertEqual(paramReader.getSetting("zn3Idx"), [1] * 19)
def testGetContentWithDefaultSetting(self):
paramReader = ParamReader()
content = paramReader.getContent()
self.assertTrue(isinstance(content, dict))
class TestParamReader(unittest.TestCase):
"""Test the ParamReaderYaml class."""
def setUp(self):
testDir = os.path.join(getModulePath(), "tests")
self.configDir = os.path.join(testDir, "testData")
self.fileName = "testConfigFile.yaml"
filePath = os.path.join(self.configDir, self.fileName)
self.paramReader = ParamReader(filePath=filePath)
self.testTempDir = tempfile.TemporaryDirectory(dir=testDir)
def tearDown(self):
self.testTempDir.cleanup()
def testGetSetting(self):
znmax = self.paramReader.getSetting("znmax")
self.assertEqual(znmax, 22)
def testGetSettingWithWrongParam(self):
self.assertRaises(ValueError, self.paramReader.getSetting, "wrongParam")
def testGetFilePath(self):
ansFilePath = os.path.join(self.configDir, self.fileName)
self.assertEqual(self.paramReader.getFilePath(), ansFilePath)
def testSetFilePath(self):
fileName = "test.yaml"
filePath = os.path.join(self.configDir, fileName)
with self.assertWarns(UserWarning):
self.paramReader.setFilePath(filePath)
self.assertEqual(self.paramReader.getFilePath(), filePath)
def testGetContent(self):
content = self.paramReader.getContent()
self.assertTrue(isinstance(content, dict))
def testGetContentWithDefaultSetting(self):
paramReader = ParamReader()
content = paramReader.getContent()
self.assertTrue(isinstance(content, dict))
def testWriteMatToFile(self):
self._writeMatToFile()
numOfFile = self._getNumOfFileInFolder(self.testTempDir.name)
self.assertEqual(numOfFile, 1)
def _writeMatToFile(self):
mat = np.random.rand(3, 4, 5)
filePath = os.path.join(self.testTempDir.name, "temp.yaml")
ParamReader.writeMatToFile(mat, filePath)
return mat, filePath
def _getNumOfFileInFolder(self, folder):
return len(
[
name
for name in os.listdir(folder)
if os.path.isfile(os.path.join(folder, name))
]
)
def testWriteMatToFileWithWrongFileFormat(self):
wrongFilePath = os.path.join(self.testTempDir.name, "temp.txt")
self.assertRaises(
ValueError, ParamReader.writeMatToFile, np.ones(4), wrongFilePath
)
def testGetMatContent(self):
mat, filePath = self._writeMatToFile()
self.paramReader.setFilePath(filePath)
matInYamlFile = self.paramReader.getMatContent()
delta = np.sum(np.abs(matInYamlFile - mat))
self.assertLess(delta, 1e-10)
def testGetMatContentWithDefaultSetting(self):
paramReader = ParamReader()
matInYamlFile = paramReader.getMatContent()
self.assertTrue(isinstance(matInYamlFile, np.ndarray))
self.assertEqual(len(matInYamlFile), 0)
def testUpdateSettingSeries(self):
znmaxValue = 20
zn3IdxValue = [1, 2, 3]
settingSeries = {"znmax": znmaxValue, "zn3Idx": zn3IdxValue}
self.paramReader.updateSettingSeries(settingSeries)
self.assertEqual(self.paramReader.getSetting("znmax"), znmaxValue)
self.assertEqual(self.paramReader.getSetting("zn3Idx"), zn3IdxValue)
def testUpdateSetting(self):
value = 10
param = "znmax"
self.paramReader.updateSetting(param, value)
self.assertEqual(self.paramReader.getSetting(param), value)
def testUpdateSettingWithWrongParam(self):
self.assertRaises(ValueError, self.paramReader.updateSetting, "wrongParam", -1)
def testSaveSettingWithFilePath(self):
filePath = self._saveSettingFile()
self.assertTrue(os.path.exists(filePath))
self.assertEqual(self.paramReader.getFilePath(), filePath)
def _saveSettingFile(self):
filePath = os.path.join(self.testTempDir.name, "newConfigFile.yaml")
self.paramReader.saveSetting(filePath=filePath)
return filePath
def testSaveSettingWithoutFilePath(self):
filePath = self._saveSettingFile()
paramReader = ParamReader(filePath=filePath)
paramReader.saveSetting()
self.assertEqual(paramReader.getFilePath(), filePath)
# Check the values are saved actually
self.assertEqual(paramReader.getSetting("znmax"), 22)
keysInContent = paramReader.getContent().keys()
self.assertTrue("dofIdx" in keysInContent)
self.assertTrue("zn3Idx" in keysInContent)
self.assertEqual(paramReader.getSetting("zn3Idx"), [1] * 19)
def testGetAbsPathNotExist(self):
self.assertRaises(
ValueError, self.paramReader.getAbsPath, "testFile.txt", getModulePath()
)
def testGetAbsPath(self):
filePath = "README.md"
self.assertFalse(os.path.isabs(filePath))
filePathAbs = ParamReader.getAbsPath(filePath, getModulePath())
self.assertTrue(os.path.isabs(filePathAbs))
def testNonexistentFile(self):
with self.assertWarns(UserWarning):
paramReader = ParamReader(filePath="thisFileDoesntExists")
self.assertEqual(len(paramReader.getContent().keys()), 0)
def testNonexistentFile(self):
with self.assertWarns(UserWarning):
paramReader = ParamReader(filePath="thisFileDoesntExists")
self.assertEqual(len(paramReader.getContent().keys()), 0)
class MapSensorNameAndId(object):
def __init__(self, sensorNameToIdFileName="sensorNameToId.yaml"):
"""Construct a MapSensorNameAndId object.
Parameters
----------
sensorNameToIdFileName : str, optional
Configuration file name to map sensor name and Id. (the default is
"sensorNameToId.yaml".)
"""
sensorNameToIdFilePath = os.path.join(getConfigDir(),
sensorNameToIdFileName)
self._sensorNameToIdFile = ParamReader(filePath=sensorNameToIdFilePath)
def mapSensorNameToId(self, sensorName):
"""Map the sensor name to sensor Id.
Parameters
----------
sensorName : list[str] or str
List or string of abbreviated sensor names.
Returns
-------
list[int]
List of sensor Id.
"""
sensorNameList = self._changeToListIfNeed(sensorName)
sensorIdList = []
for sensor in sensorNameList:
sensorId = self._sensorNameToIdFile.getSetting(sensor)
sensorIdList.append(sensorId)
return sensorIdList
def _changeToListIfNeed(self, inputArg):
"""Change the input argument to list type if needed.
Parameters
----------
inputArg : obj
Input argument.
Returns
-------
list
Input argument as the list type.
"""
if (not isinstance(inputArg, list)):
inputArg = [inputArg]
return inputArg
def mapSensorIdToName(self, sensorId):
"""Map the sensor Id to sensor name.
If no sensor name is found for a specific Id, there will be no returned
value.
Parameters
----------
sensorId : list[int] or int
List or integer of sensor Id.
Returns
-------
list
List of abbreviated sensor names.
int
Number of sensors.
"""
sensorIdList = self._changeToListIfNeed(sensorId)
sensorNameList = []
content = self._sensorNameToIdFile.getContent()
for sensor in sensorIdList:
try:
sensorName = self._getKeyFromValueInDict(content, sensor)
sensorNameList.append(sensorName)
except ValueError:
pass
return sensorNameList, len(sensorNameList)
def _getKeyFromValueInDict(self, aDict, value):
"""Get the key from value in a dictionary object.
Parameters
----------
aDict : dict
Dictionary object.
value : str or int
Value in the dictionary.
Returns
-------
str
Dictionary key.
"""
return list(aDict.keys())[list(aDict.values()).index(value)]
class MapSensorNameAndId(object):
def __init__(self, sensorNameToIdFileName="sensorNameToId.yaml"):
"""Construct a MapSensorNameAndId object.
Parameters
----------
sensorNameToIdFileName : str, optional
Configuration file name to map sensor name and Id. (the default is
"sensorNameToId.yaml".)
"""
sensorNameToIdFilePath = os.path.join(getConfigDir(),
sensorNameToIdFileName)
self._sensorNameToIdFile = ParamReader(filePath=sensorNameToIdFilePath)
def mapSensorNameToId(self, sensorName):
"""Map the sensor name to sensor Id.
Parameters
----------
sensorName : list[str] or str
List or string of abbreviated sensor names.
Returns
-------
list[int]
List of sensor Id.
"""
sensorNameList = self._changeToListIfNeed(sensorName)
sensorIdList = []
for sensor in sensorNameList:
sensorId = self._sensorNameToIdFile.getSetting(sensor)
sensorIdList.append(sensorId)
return sensorIdList
def _changeToListIfNeed(self, inputArg):
"""Change the input argument to list type if needed.
Parameters
----------
inputArg : obj
Input argument.
Returns
-------
list
Input argument as the list type.
"""
if not isinstance(inputArg, list):
inputArg = [inputArg]
return inputArg
def mapSensorIdToName(self, sensorId):
"""Map the sensor Id to sensor name.
If no sensor name is found for a specific Id, there will be no returned
value.
Parameters
----------
sensorId : list[int] or int
List or integer of sensor Id.
Returns
-------
list
List of abbreviated sensor names.
int
Number of sensors.
"""
sensorIdList = self._changeToListIfNeed(sensorId)
sensorNameList = []
content = self._sensorNameToIdFile.getContent()
for sensor in sensorIdList:
try:
sensorName = self._getKeyFromValueInDict(content, sensor)
sensorNameList.append(sensorName)
except ValueError:
pass
return sensorNameList, len(sensorNameList)
def _getKeyFromValueInDict(self, aDict, value):
"""Get the key from value in a dictionary object.
Parameters
----------
aDict : dict
Dictionary object.
value : str or int
Value in the dictionary.
Returns
-------
str
Dictionary key.
"""
return list(aDict.keys())[list(aDict.values()).index(value)]
class TestParamReader(unittest.TestCase):
"""Test the ParamReaderYaml class."""
def setUp(self):
testDir = os.path.join(getModulePath(), "tests")
self.configDir = os.path.join(testDir, "testData")
self.fileName = "testConfigFile.yaml"
filePath = os.path.join(self.configDir, self.fileName)
self.paramReader = ParamReader(filePath=filePath)
self.testTempDir = os.path.join(testDir, "tmp")
self._makeDir(self.testTempDir)
def _makeDir(self, directory):
if (not os.path.exists(directory)):
os.makedirs(directory)
def tearDown(self):
shutil.rmtree(self.testTempDir)
def testGetSetting(self):
znmax = self.paramReader.getSetting("znmax")
self.assertEqual(znmax, 22)
def testGetFilePath(self):
ansFilePath = os.path.join(self.configDir, self.fileName)
self.assertEqual(self.paramReader.getFilePath(), ansFilePath)
def testSetFilePath(self):
fileName = "test.yaml"
filePath = os.path.join(self.configDir, fileName)
self.paramReader.setFilePath(filePath)
self.assertEqual(self.paramReader.getFilePath(), filePath)
def testGetContent(self):
content = self.paramReader.getContent()
self.assertTrue(isinstance(content, dict))
def testGetContentWithDefaultSetting(self):
paramReader = ParamReader()
content = paramReader.getContent()
self.assertTrue(isinstance(content, dict))
def testWriteMatToFile(self):
self._writeMatToFile()
numOfFile = self._getNumOfFileInFolder(self.testTempDir)
self.assertEqual(numOfFile, 1)
def _writeMatToFile(self):
mat = np.random.rand(3, 4, 5)
filePath = os.path.join(self.testTempDir, "temp.yaml")
ParamReader.writeMatToFile(mat, filePath)
return mat, filePath
def _getNumOfFileInFolder(self, folder):
return len([name for name in os.listdir(folder)
if os.path.isfile(os.path.join(folder, name))])
def testWriteMatToFileWithWrongFileFormat(self):
wrongFilePath = os.path.join(self.testTempDir, "temp.txt")
self.assertRaises(ValueError, ParamReader.writeMatToFile,
np.ones(4), wrongFilePath)
def testGetMatContent(self):
mat, filePath = self._writeMatToFile()
self.paramReader.setFilePath(filePath)
matInYamlFile = self.paramReader.getMatContent()
delta = np.sum(np.abs(matInYamlFile - mat))
self.assertLess(delta, 1e-10)
def testGetMatContentWithDefaultSetting(self):
paramReader = ParamReader()
matInYamlFile = paramReader.getMatContent()
self.assertTrue(isinstance(matInYamlFile, np.ndarray))
self.assertEqual(len(matInYamlFile), 0)
def testGetContentWithDefaultSetting(self):
paramReader = ParamReader()
content = paramReader.getContent()
self.assertTrue(isinstance(content, dict))