Better error message when on non-string values

For augur curate titlecase
nextstrain · Jul 14, 2023 · 72e6c95 · 72e6c95
1 parent ef00aa0
commit 72e6c95
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/augur/curate/titlecase.py b/augur/curate/titlecase.py
@@ -98,7 +98,7 @@ def run(args, records):
 
             titlecased_string = titlecase(record[field], articles, abbreviations)
 
-            failure_message = f"Failed to titlecase {field!r}:{record.get(field)!r} in record {record_id!r}"
+            failure_message = f"Failed to titlecase {field!r}:{record.get(field)!r} in record {record_id!r} because the value is a {type(record.get(field))!r} and is not a string."
             if titlecased_string is None:
                 if failure_reporting is DataErrorMethod.ERROR_FIRST:
                     raise AugurError(failure_message)

diff --git a/tests/functional/curate/cram/titlecase.t b/tests/functional/curate/cram/titlecase.t
@@ -51,7 +51,14 @@ Test case that fails on a non-string int
 
   $ echo '{"bare_int": 2021}' \
   >   | ${AUGUR} curate titlecase --titlecase-fields "bare_int"
-  ERROR: Failed to titlecase 'bare_int':2021 in record 0
+  ERROR: Failed to titlecase 'bare_int':2021 in record 0 because the value is a <class 'int'> and is not a string.
+  [2]
+
+Test case that fails on complext types (e.g. arrays)
+
+  $ echo '{"an_array": ["hello", "world"]}' \
+  >   | ${AUGUR} curate titlecase --titlecase-fields "an_array"
+  ERROR: Failed to titlecase 'an_array':['hello', 'world'] in record 0 because the value is a <class 'list'> and is not a string.
   [2]
 
 Test cases when fields do not exist, decide if this should error out and may affect ingest pipelines