Merge pull request #854 from lindsay-stevens/pyxform-711

711: remove support for enketo-validate

Author: lindsay-stevens

README.md

@@ -1,6 +1,6 @@
 # pyxform
 
-`pyxform` is a Python library that simplifies writing forms for ODK Collect and Enketo by converting spreadsheets that follow the [XLSForm standard](http://xlsform.org/) into [ODK XForms](https://github.com/opendatakit/xforms-spec). The XLSForms format is used in a [number of tools](http://xlsform.org/en/#tools-that-support-xlsforms).
+`pyxform` is a Python library that simplifies writing forms for ODK Collect, ODK Web Forms, and Enketo by converting spreadsheets that follow the [XLSForm standard](http://xlsform.org/) into [ODK XForms](https://github.com/opendatakit/xforms-spec). The XLSForms format is used in a [number of tools](http://xlsform.org/en/#tools-that-support-xlsforms).
 
 ## Project status
 

pyxform/survey.py

@@ -27,7 +27,7 @@
     escape_text_for_xml,
     node,
 )
-from pyxform.validators import enketo_validate, odk_validate
+from pyxform.validators import odk_validate
 from pyxform.validators.pyxform import unique_names
 from pyxform.validators.pyxform.iana_subtags.validation import get_languages_with_bad_tags
 from pyxform.validators.pyxform.pyxform_reference import (
@@ -1206,7 +1206,7 @@ def _var_repl_output_function(matchobj):
             return text, False
 
     def print_xform_to_file(
-        self, path=None, validate=True, pretty_print=True, warnings=None, enketo=False
+        self, path=None, validate=True, pretty_print=True, warnings=None
     ) -> str:
         """
         Print the xForm to a file and optionally validate it as well by
@@ -1229,8 +1229,6 @@ def print_xform_to_file(
             raise
         if validate:
             warnings.extend(odk_validate.check_xform(path))
-        if enketo:
-            warnings.extend(enketo_validate.check_xform(path))
 
         # Warn if one or more translation is missing a valid IANA subtag
         translations = self._translations
@@ -1246,15 +1244,15 @@ def print_xform_to_file(
                 )
         return xml
 
-    def to_xml(self, validate=True, pretty_print=True, warnings=None, enketo=False):
+    def to_xml(self, validate=True, pretty_print=True, warnings=None):
         """
-        Generates the XForm XML.
-        validate is True by default - pass the XForm XML through ODK Validator.
-        pretty_print is True by default - formats the XML for readability.
-        warnings - if a list is passed it stores all warnings generated
-        enketo - pass the XForm XML though Enketo Validator.
+        Generate the XForm XML.
 
-        Return XForm XML string.
+        :param validate: True by default - pass the XForm XML through ODK Validator.
+        :param pretty_print: True by default - formats the XML for readability.
+        :param warnings: if a list is passed it stores all warnings generated
+
+        :returns: XForm XML string.
         """
         # On Windows, NamedTemporaryFile must be opened exclusively.
         # So it must be explicitly created, opened, closed, and removed.
@@ -1268,7 +1266,6 @@ def to_xml(self, validate=True, pretty_print=True, warnings=None, enketo=False):
                 validate=validate,
                 pretty_print=pretty_print,
                 warnings=warnings,
-                enketo=enketo,
             )
         finally:
             tmp_path.unlink(missing_ok=True)

pyxform/validators/enketo_validate/__init__.py

@@ -66,9 +66,3 @@ def odk_validate(error_message):
         java_clean = [ErrorCleaner._remove_java_content(i) for i in common]
         final_message = ErrorCleaner._join_final(java_clean)
         return final_message
-
-    @staticmethod
-    def enketo_validate(error_message):
-        common = ErrorCleaner._cleanup_errors(error_message)
-        final_message = ErrorCleaner._join_final(common)
-        return final_message

pyxform/validators/error_cleaner.py

@@ -12,7 +12,7 @@
 from zipfile import ZipFile, is_zipfile
 
 from pyxform.errors import PyXFormError
-from pyxform.validators import enketo_validate, odk_validate
+from pyxform.validators import odk_validate
 from pyxform.validators.util import HERE, CapturingHandler, request_get
 
 UTC_FMT = "%Y-%m-%dT%H:%M:%SZ"
@@ -483,25 +483,6 @@ def _install_check(bin_file_path=None):
         raise NotImplementedError()
 
 
-class EnketoValidateUpdater(_UpdateService):
-    def __init__(self):
-        self.update_info = _UpdateInfo(
-            api_url="https://api.github.com/repos/enketo/enketo-validate/releases/latest",
-            repo_url="https://github.com/enketo/enketo-validate",
-            validate_subfolder="enketo_validate",
-            install_check=self._install_check,
-            validator_basename=os.path.basename(enketo_validate.ENKETO_VALIDATE_PATH),
-        )
-
-    @staticmethod
-    def _install_check(bin_file_path=None):
-        if bin_file_path is None:
-            return enketo_validate.install_ok()
-        else:
-            extracted = os.path.join(os.path.dirname(bin_file_path), "validate")
-            return enketo_validate.install_ok(bin_file_path=extracted)
-
-
 class ODKValidateUpdater(_UpdateService):
     def __init__(self):
         self.update_info = _UpdateInfo(
@@ -561,8 +542,8 @@ def _create_parser():
         "------------------------------------------------------\n"
         "Use this tool to update external validators.\n\n"
         "Example usage:\n\n"
-        "updater.py enketo list\n"
-        "updater.py enketo update linux.zip\n\n"
+        "updater.py ODK list\n"
+        "updater.py ODK update linux.zip\n\n"
         "First, use the 'list' sub-command for the validator\n"
         "to check for a new release and to show what (if any) \n"
         "files are attached to it.\n\n"
@@ -576,11 +557,6 @@ def _create_parser():
         formatter_class=argparse.RawDescriptionHelpFormatter,
     )
     sub_parsers = main_parser.add_subparsers(metavar="<sub_menu>")
-    _build_validator_menu(
-        main_subparser=sub_parsers,
-        validator_name="Enketo",
-        updater_instance=EnketoValidateUpdater(),
-    )
     _build_validator_menu(
         main_subparser=sub_parsers,
         validator_name="ODK",

pyxform/validators/updater.py

@@ -65,7 +65,6 @@ def convert(
     warnings: list[str] | None = None,
     validate: bool = False,
     pretty_print: bool = False,
-    enketo: bool = False,
     form_name: str | None = None,
     default_language: str | None = None,
     file_type: str | None = None,
@@ -75,10 +74,9 @@ def convert(
 
     This function avoids result file IO so it is more suited to library usage of pyxform.
 
-    If validate=True or Enketo=True, then the XForm will be written to a temporary file
-    to be checked by ODK Validate and/or Enketo Validate. These validators are run as
-    external processes. A recent version of ODK Validate is distributed with pyxform,
-    while Enketo Validate is not. A script to download or update these validators is
+    If validate=True, then the XForm will be written to a temporary file to be checked by
+    ODK Validate. This validator is run as an external process. A recent version of ODK
+    Validate is distributed with pyxform. A script to download or update ODK Validate is
     provided in `validators/updater.py`.
 
     :param xlsform: The input XLSForm file path or content. If the content is bytes or
@@ -87,7 +85,6 @@ def convert(
     :param warnings: The conversions warnings list.
     :param validate: If True, check the XForm with ODK Validate
     :param pretty_print: If True, format the XForm with spaces, line breaks, etc.
-    :param enketo: If True, check the XForm with Enketo Validate.
     :param form_name: Used for the main instance root node name.
     :param default_language: The name of the default language for the form.
     :param file_type: If provided, attempt parsing the data only as this type. Otherwise,
@@ -113,7 +110,6 @@ def convert(
         validate=validate,
         pretty_print=pretty_print,
         warnings=warnings,
-        enketo=enketo,
     )
     return ConvertResult(
         xform=xform,
@@ -129,14 +125,12 @@ def xls2xform_convert(
     xform_path: str | PathLike[str],
     validate: bool = True,
     pretty_print: bool = True,
-    enketo: bool = False,
 ) -> list[str]:
     warnings = []
     result = convert(
         xlsform=xlsform_path,
         validate=validate,
         pretty_print=pretty_print,
-        enketo=enketo,
         warnings=warnings,
     )
     with open(xform_path, mode="w", encoding="utf-8") as f:
@@ -176,12 +170,6 @@ def _create_parser():
         default=False,
         help="Run the ODK Validate XForm external validator.",
     )
-    parser.add_argument(
-        "--enketo_validate",
-        action="store_true",
-        default=False,
-        help="Run the Enketo Validate XForm external validator.",
-    )
     parser.add_argument(
         "--pretty_print",
         action="store_true",
@@ -202,17 +190,13 @@ def _validator_args_logic(args):
     `xls2xform.py myform`: ODK only
 
     **new**
-    `xls2xform.py myform --enketo_validate`: Enketo only
     `xls2xform.py myform --odk_validate`: ODK only
-    `xls2xform.py myform --enketo_validate --odk_validate`: both
-    `xls2xform.py myform --enketo_validate --odk_validate --skip_validate`: no validators
+    `xls2xform.py myform --odk_validate --skip_validate`: no validators
     """
     if not args.skip_validate:
         args.odk_validate = False
-        args.enketo_validate = False
-    elif args.skip_validate and not (args.odk_validate or args.enketo_validate):
+    elif args.skip_validate and not args.odk_validate:
         args.odk_validate = True
-        args.enketo_validate = False
     return args
 
 
@@ -236,7 +220,6 @@ def main_cli():
                 xform_path=args.output_path,
                 validate=args.odk_validate,
                 pretty_print=args.pretty_print,
-                enketo=args.enketo_validate,
             )
 
             response["code"] = 100
@@ -259,7 +242,6 @@ def main_cli():
                 xform_path=args.output_path,
                 validate=args.odk_validate,
                 pretty_print=args.pretty_print,
-                enketo=args.enketo_validate,
             )
         except OSError:
             # Do not crash if 'java' not installed