747: update identifier validation message now that leading colons aren't allowed

pyxform/errors.py

@@ -41,6 +41,54 @@ def format(self, **kwargs):
 
 
 class ErrorCode(Enum):
+    NAMES_001: Detail = Detail(
+        name="Invalid duplicate name in same context",
+        msg=(
+            "[row : {row}] On the 'survey' sheet, the 'name' value '{value}' is invalid. "
+            "Questions, groups, and repeats must be unique within their nearest parent group "
+            "or repeat, or the survey if not inside a group or repeat."
+        ),
+    )
+    NAMES_002: Detail = Detail(
+        name="Invalid duplicate name in context (case-insensitive)",
+        msg=(
+            "[row : {row}] On the 'survey' sheet, the 'name' value '{value}' is problematic. "
+            "The name is a case-insensitive match to another name. Questions, groups, and "
+            "repeats should be unique within the nearest parent group or repeat, or the survey "
+            "if not inside a group or repeat. Some data processing tools are not "
+            "case-sensitive, so the current names may make analysis difficult."
+        ),
+    )
+    NAMES_003: Detail = Detail(
+        name="Invalid repeat name same as survey",
+        msg=(
+            "[row : {row}] On the 'survey' sheet, the 'name' value '{value}' is invalid. "
+            "Repeat names must not be the same as the survey root (which defaults to 'data')."
+        ),
+    )
+    NAMES_004: Detail = Detail(
+        name="Invalid duplicate repeat name in the survey",
+        msg=(
+            "[row : {row}] On the 'survey' sheet, the 'name' value '{value}' is invalid. "
+            "Repeat names must unique anywhere in the survey, at all levels of group or "
+            "repeat nesting."
+        ),
+    )
+    NAMES_005: Detail = Detail(
+        name="Invalid duplicate meta name in the survey",
+        msg=(
+            "[row : {row}] On the 'survey' sheet, the 'name' value 'meta' is invalid. "
+            "The name 'meta' is reserved for form metadata."
+        ),
+    )
+    NAMES_006: Detail = Detail(
+        name="Invalid missing name in the choices sheet",
+        msg=(
+            "[row : {row}] On the 'choices' sheet, the 'name' value is invalid. "
+            "Choices must have a name. "
+            "Learn more: https://xlsform.org/en/#setting-up-your-worksheets"
+        ),
+    )
     PYREF_001: Detail = Detail(
         name="PyXForm Reference Parsing Failed",
         msg=(

pyxform/validators/pyxform/choices.py

@@ -1,11 +1,6 @@
 from pyxform import constants
-from pyxform.errors import PyXFormError
+from pyxform.errors import ErrorCode, PyXFormError
 
-INVALID_NAME = (
-    "[row : {row}] On the 'choices' sheet, the 'name' value is invalid. "
-    "Choices must have a name. "
-    "Learn more: https://xlsform.org/en/#setting-up-your-worksheets"
-)
 INVALID_LABEL = (
     "[row : {row}] On the 'choices' sheet, the 'label' value is invalid. "
     "Choices should have a label. "
@@ -44,7 +39,7 @@ def validate_choice_list(
     duplicate_errors = []
     for option in options:
         if constants.NAME not in option:
-            raise PyXFormError(INVALID_NAME.format(row=option["__row"]))
+            raise PyXFormError(ErrorCode.NAMES_006.value.format(row=option["__row"]))
         elif constants.LABEL not in option:
             warnings.append(INVALID_LABEL.format(row=option["__row"]))
 

pyxform/validators/pyxform/unique_names.py

@@ -1,46 +1,5 @@
 from pyxform import constants as const
-from pyxform.errors import Detail, PyXFormError
-
-NAMES001 = Detail(
-    name="Invalid duplicate name in same context",
-    msg=(
-        "[row : {row}] On the 'survey' sheet, the 'name' value '{value}' is invalid. "
-        "Questions, groups, and repeats must be unique within their nearest parent group "
-        "or repeat, or the survey if not inside a group or repeat."
-    ),
-)
-NAMES002 = Detail(
-    name="Invalid duplicate name in context (case-insensitive)",
-    msg=(
-        "[row : {row}] On the 'survey' sheet, the 'name' value '{value}' is problematic. "
-        "The name is a case-insensitive match to another name. Questions, groups, and "
-        "repeats should be unique within the nearest parent group or repeat, or the survey "
-        "if not inside a group or repeat. Some data processing tools are not "
-        "case-sensitive, so the current names may make analysis difficult."
-    ),
-)
-NAMES003 = Detail(
-    name="Invalid repeat name same as survey",
-    msg=(
-        "[row : {row}] On the 'survey' sheet, the 'name' value '{value}' is invalid. "
-        "Repeat names must not be the same as the survey root (which defaults to 'data')."
-    ),
-)
-NAMES004 = Detail(
-    name="Invalid duplicate repeat name in the survey",
-    msg=(
-        "[row : {row}] On the 'survey' sheet, the 'name' value '{value}' is invalid. "
-        "Repeat names must unique anywhere in the survey, at all levels of group or "
-        "repeat nesting."
-    ),
-)
-NAMES005 = Detail(
-    name="Invalid duplicate meta name in the survey",
-    msg=(
-        "[row : {row}] On the 'survey' sheet, the 'name' value 'meta' is invalid. "
-        "The name 'meta' is reserved for form metadata."
-    ),
-)
+from pyxform.errors import ErrorCode, PyXFormError
 
 
 def validate_question_group_repeat_name(
@@ -73,15 +32,17 @@ def validate_question_group_repeat_name(
 
     if name in seen_names:
         if name == const.META:
-            raise PyXFormError(NAMES005.format(row=row_number))
+            raise PyXFormError(ErrorCode.NAMES_005.value.format(row=row_number))
         else:
-            raise PyXFormError(NAMES001.format(row=row_number, value=name))
+            raise PyXFormError(
+                ErrorCode.NAMES_001.value.format(row=row_number, value=name)
+            )
     seen_names.add(name)
 
     question_name_lower = name.lower()
     if question_name_lower in seen_names_lower:
         # No case-insensitive warning for 'meta' since it's not an exported data table.
-        warnings.append(NAMES002.format(row=row_number, value=name))
+        warnings.append(ErrorCode.NAMES_002.value.format(row=row_number, value=name))
     seen_names_lower.add(question_name_lower)
 
 
@@ -107,7 +68,11 @@ def validate_repeat_name(
     """
     if control_type == const.REPEAT:
         if name == instance_element_name:
-            raise PyXFormError(NAMES003.format(row=row_number, value=name))
+            raise PyXFormError(
+                ErrorCode.NAMES_003.value.format(row=row_number, value=name)
+            )
         elif name in seen_names:
-            raise PyXFormError(NAMES004.format(row=row_number, value=name))
+            raise PyXFormError(
+                ErrorCode.NAMES_004.value.format(row=row_number, value=name)
+            )
         seen_names.add(name)

tests/test_choices_sheet.py

@@ -558,3 +558,20 @@ def test_reference_in_extra_columns__between_columns_of_interest(self):
                 """,
             ],
         )
+
+    def test_missing_name__error(self):
+        """Should raise an error if name is missing in the choices sheet."""
+        md = """
+        | survey |
+        | | type          | name | label |
+        | | select_one c1 | q1   | Q1    |
+
+        | choices |
+        | | list_name | name | label |
+        | | c1        |      | N1    |
+        """
+        self.assertPyxformXform(
+            md=md,
+            errored=True,
+            error__contains=[ErrorCode.NAMES_006.value.format(row=2)],
+        )

tests/test_external_instances.py

@@ -6,7 +6,7 @@
 
 from textwrap import dedent
 
-from pyxform.validators.pyxform import unique_names
+from pyxform.errors import ErrorCode
 
 from tests.pyxform_test_case import PyxformTestCase, PyxformTestError
 from tests.xpath_helpers.choices import xpc
@@ -50,7 +50,7 @@ def test_cannot__use_same_external_xml_id_in_same_section(self):
         self.assertPyxformXform(
             md=md,
             errored=True,
-            error__contains=[unique_names.NAMES001.format(row=3, value="mydata")],
+            error__contains=[ErrorCode.NAMES_001.value.format(row=3, value="mydata")],
         )
 
     def test_can__use_unique_external_xml_in_same_section(self):

tests/test_fields.py

@@ -3,7 +3,6 @@
 """
 
 from pyxform.errors import ErrorCode
-from pyxform.validators.pyxform import unique_names
 
 from tests.pyxform_test_case import PyxformTestCase
 
@@ -173,7 +172,7 @@ def test_names__question_same_as_question_in_same_context_in_survey__error(self)
         self.assertPyxformXform(
             md=md,
             errored=True,
-            error__contains=[unique_names.NAMES001.format(row=3, value="q1")],
+            error__contains=[ErrorCode.NAMES_001.value.format(row=3, value="q1")],
         )
 
     def test_names__question_same_as_group_in_same_context_in_survey__error(self):
@@ -189,7 +188,7 @@ def test_names__question_same_as_group_in_same_context_in_survey__error(self):
         self.assertPyxformXform(
             md=md,
             errored=True,
-            error__contains=[unique_names.NAMES001.format(row=3, value="q1")],
+            error__contains=[ErrorCode.NAMES_001.value.format(row=3, value="q1")],
         )
 
     def test_names__question_same_as_repeat_in_same_context_in_survey__error(self):
@@ -205,7 +204,7 @@ def test_names__question_same_as_repeat_in_same_context_in_survey__error(self):
         self.assertPyxformXform(
             md=md,
             errored=True,
-            error__contains=[unique_names.NAMES001.format(row=3, value="q1")],
+            error__contains=[ErrorCode.NAMES_001.value.format(row=3, value="q1")],
         )
 
     def test_names__question_same_as_question_in_same_context_in_group__error(self):
@@ -221,7 +220,7 @@ def test_names__question_same_as_question_in_same_context_in_group__error(self):
         self.assertPyxformXform(
             md=md,
             errored=True,
-            error__contains=[unique_names.NAMES001.format(row=4, value="q1")],
+            error__contains=[ErrorCode.NAMES_001.value.format(row=4, value="q1")],
         )
 
     def test_names__question_same_as_group_in_same_context_in_group__error(self):
@@ -239,7 +238,7 @@ def test_names__question_same_as_group_in_same_context_in_group__error(self):
         self.assertPyxformXform(
             md=md,
             errored=True,
-            error__contains=[unique_names.NAMES001.format(row=4, value="q1")],
+            error__contains=[ErrorCode.NAMES_001.value.format(row=4, value="q1")],
         )
 
     def test_names__question_same_as_repeat_in_same_context_in_group__error(self):
@@ -257,7 +256,7 @@ def test_names__question_same_as_repeat_in_same_context_in_group__error(self):
         self.assertPyxformXform(
             md=md,
             errored=True,
-            error__contains=[unique_names.NAMES001.format(row=4, value="q1")],
+            error__contains=[ErrorCode.NAMES_001.value.format(row=4, value="q1")],
         )
 
     def test_names__question_same_as_question_in_same_context_in_repeat__error(self):
@@ -273,7 +272,7 @@ def test_names__question_same_as_question_in_same_context_in_repeat__error(self)
         self.assertPyxformXform(
             md=md,
             errored=True,
-            error__contains=[unique_names.NAMES001.format(row=4, value="q1")],
+            error__contains=[ErrorCode.NAMES_001.value.format(row=4, value="q1")],
         )
 
     def test_names__question_same_as_group_in_same_context_in_repeat__error(self):
@@ -291,7 +290,7 @@ def test_names__question_same_as_group_in_same_context_in_repeat__error(self):
         self.assertPyxformXform(
             md=md,
             errored=True,
-            error__contains=[unique_names.NAMES001.format(row=4, value="q1")],
+            error__contains=[ErrorCode.NAMES_001.value.format(row=4, value="q1")],
         )
 
     def test_names__question_same_as_repeat_in_same_context_in_repeat__error(self):
@@ -309,7 +308,7 @@ def test_names__question_same_as_repeat_in_same_context_in_repeat__error(self):
         self.assertPyxformXform(
             md=md,
             errored=True,
-            error__contains=[unique_names.NAMES001.format(row=4, value="q1")],
+            error__contains=[ErrorCode.NAMES_001.value.format(row=4, value="q1")],
         )
 
     def test_names__question_same_as_question_in_same_context_in_survey__case_insensitive_warning(
@@ -323,7 +322,8 @@ def test_names__question_same_as_question_in_same_context_in_survey__case_insens
         | | text        | Q1   | Q2    |
         """
         self.assertPyxformXform(
-            md=md, warnings__contains=[unique_names.NAMES002.format(row=3, value="Q1")]
+            md=md,
+            warnings__contains=[ErrorCode.NAMES_002.value.format(row=3, value="Q1")],
         )
 
     def test_names__question_same_as_group_in_same_context_in_survey__case_insensitive_warning(
@@ -339,7 +339,8 @@ def test_names__question_same_as_group_in_same_context_in_survey__case_insensiti
         | | end group   |      |       |
         """
         self.assertPyxformXform(
-            md=md, warnings__contains=[unique_names.NAMES002.format(row=3, value="Q1")]
+            md=md,
+            warnings__contains=[ErrorCode.NAMES_002.value.format(row=3, value="Q1")],
         )
 
     def test_names__question_same_as_repeat_in_same_context_in_survey__case_insensitive_warning(
@@ -355,7 +356,8 @@ def test_names__question_same_as_repeat_in_same_context_in_survey__case_insensit
         | | end repeat   |      |       |
         """
         self.assertPyxformXform(
-            md=md, warnings__contains=[unique_names.NAMES002.format(row=3, value="Q1")]
+            md=md,
+            warnings__contains=[ErrorCode.NAMES_002.value.format(row=3, value="Q1")],
         )
 
     def test_names__question_same_as_question_in_same_context_in_group__case_insensitive_warning(
@@ -371,7 +373,8 @@ def test_names__question_same_as_question_in_same_context_in_group__case_insensi
         | | end group   |      |       |
         """
         self.assertPyxformXform(
-            md=md, warnings__contains=[unique_names.NAMES002.format(row=4, value="Q1")]
+            md=md,
+            warnings__contains=[ErrorCode.NAMES_002.value.format(row=4, value="Q1")],
         )
 
     def test_names__question_same_as_group_in_same_context_in_group__case_insensitive_warning(
@@ -389,7 +392,8 @@ def test_names__question_same_as_group_in_same_context_in_group__case_insensitiv
         | | end group   |      |       |
         """
         self.assertPyxformXform(
-            md=md, warnings__contains=[unique_names.NAMES002.format(row=4, value="Q1")]
+            md=md,
+            warnings__contains=[ErrorCode.NAMES_002.value.format(row=4, value="Q1")],
         )
 
     def test_names__question_same_as_repeat_in_same_context_in_group__case_insensitive_warning(
@@ -407,7 +411,8 @@ def test_names__question_same_as_repeat_in_same_context_in_group__case_insensiti
         | | end group    |      |       |
         """
         self.assertPyxformXform(
-            md=md, warnings__contains=[unique_names.NAMES002.format(row=4, value="Q1")]
+            md=md,
+            warnings__contains=[ErrorCode.NAMES_002.value.format(row=4, value="Q1")],
         )
 
     def test_names__question_same_as_question_in_same_context_in_repeat__case_insensitive_warning(
@@ -423,7 +428,8 @@ def test_names__question_same_as_question_in_same_context_in_repeat__case_insens
         | | end repeat   |      |       |
         """
         self.assertPyxformXform(
-            md=md, warnings__contains=[unique_names.NAMES002.format(row=4, value="Q1")]
+            md=md,
+            warnings__contains=[ErrorCode.NAMES_002.value.format(row=4, value="Q1")],
         )
 
     def test_names__question_same_as_group_in_same_context_in_repeat__case_insensitive_warning(
@@ -441,7 +447,8 @@ def test_names__question_same_as_group_in_same_context_in_repeat__case_insensiti
         | | end repeat   |      |       |
         """
         self.assertPyxformXform(
-            md=md, warnings__contains=[unique_names.NAMES002.format(row=4, value="Q1")]
+            md=md,
+            warnings__contains=[ErrorCode.NAMES_002.value.format(row=4, value="Q1")],
         )
 
     def test_names__question_same_as_repeat_in_same_context_in_repeat__case_insensitive_warning(
@@ -459,7 +466,8 @@ def test_names__question_same_as_repeat_in_same_context_in_repeat__case_insensit
         | | end repeat   |      |       |
         """
         self.assertPyxformXform(
-            md=md, warnings__contains=[unique_names.NAMES002.format(row=4, value="Q1")]
+            md=md,
+            warnings__contains=[ErrorCode.NAMES_002.value.format(row=4, value="Q1")],
         )
 
     def test_reference_name_not_found__target_after_source__error(self):