From 6d733c76acb14324565a6f5b1941b7d9561f1f54 Mon Sep 17 00:00:00 2001
From: fspreck <f.spreckelsen@indiscale.com>
Date: Mon, 11 Oct 2021 14:09:31 +0200
Subject: [PATCH] API: Rename enum_converter to string_in_list
---
CHANGELOG.md | 2 +-
src/caosadvancedtools/table_importer.py | 2 +-
unittests/test_table_importer.py | 17 +++++++++--------
3 files changed, 11 insertions(+), 10 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 799d4ba1..04a51711 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -29,7 +29,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Proof-of-concept integration with Bloxberg.
- Introduce a cfood that can create a Record structure based on the contents of a hdf5 file
h5py is now an optional dependency
-- enum_converter for table imports
+- string-in-list check for table imports
### Changed ###
diff --git a/src/caosadvancedtools/table_importer.py b/src/caosadvancedtools/table_importer.py
index 15fb89af..dded9edf 100755
--- a/src/caosadvancedtools/table_importer.py
+++ b/src/caosadvancedtools/table_importer.py
@@ -145,7 +145,7 @@ def win_path_converter(val):
return path.as_posix()
-def enum_converter(val, options, ignore_case=True):
+def string_in_list(val, options, ignore_case=True):
"""Return the given value if it is contained in options, raise an
error otherwise.
diff --git a/unittests/test_table_importer.py b/unittests/test_table_importer.py
index 671fcec6..a3604673 100644
--- a/unittests/test_table_importer.py
+++ b/unittests/test_table_importer.py
@@ -33,7 +33,7 @@ from caosadvancedtools.table_importer import (XLSImporter, assure_name_format,
incomplete_date_converter,
win_path_converter,
win_path_list_converter,
- enum_converter,
+ string_in_list,
yes_no_converter)
@@ -50,14 +50,15 @@ class ConverterTest(unittest.TestCase):
self.assertRaises(ValueError, yes_no_converter, "True")
self.assertRaises(ValueError, yes_no_converter, "true")
- def test_enum(self):
- self.assertEqual("false", enum_converter("false",
+ def test_string_in_list(self):
+ self.assertEqual("false", string_in_list("false",
["FALSE", "TRUE"]))
- self.assertEqual("FALSE", enum_converter("FALSE",
+ self.assertEqual("FALSE", string_in_list("FALSE",
["FALSE", "TRUE"], False))
- self.assertRaises(ValueError, enum_converter, "FALSE", [])
- self.assertRaises(ValueError, enum_converter, "FALSE", ["fals"])
- self.assertRaises(ValueError, enum_converter, "FALSE", ["false"], False)
+ self.assertRaises(ValueError, string_in_list, "FALSE", [])
+ self.assertRaises(ValueError, string_in_list, "FALSE", ["fals"])
+ self.assertRaises(ValueError, string_in_list,
+ "FALSE", ["false"], False)
def test_assure_name_format(self):
self.assertEqual(assure_name_format("Müstermann, Max"),
@@ -72,7 +73,7 @@ class ConverterTest(unittest.TestCase):
["/this/computer"])
self.assertEqual(win_path_list_converter(
r"\this\computer,\this\computer"),
- ["/this/computer", "/this/computer"])
+ ["/this/computer", "/this/computer"])
def test_datetime(self):
test_file = os.path.join(os.path.dirname(__file__), "date.xlsx")
--
GitLab