xlsform__pyxform-489

{
  "status": "ok",
  "stdout": "pyxform/tests_v1/test_trigger.py:56:                '<bind nodeset=\"/trigger-column/b\" type=\"dateTime\" calculate=\"now()\"/>'\npyxform/tests_v1/test_trigger.py:81:                '<bind nodeset=\"/trigger-column/c\" type=\"dateTime\" calculate=\"now()\"/>'\npyxform/tests_v1/test_trigger.py:108:                '<bind nodeset=\"/trigger-column/b\" type=\"int\" calculate=\"1+1\"/>',\npyxform/tests_v1/test_trigger.py:109:                '<bind nodeset=\"/trigger-column/c\" type=\"dateTime\" calculate=\"now()\"/>',\npyxform/tests_v1/test_trigger.py:133:                '<bind nodeset=\"/trigger-column/d\" type=\"dateTime\" calculate=\"\"/>'\npyxform/tests_v1/test_trigger.py:156:                '<bind nodeset=\"/trigger-column/e\" type=\"decimal\" calculate=\"\"/>',\npyxform/tests_v1/test_trigger.py:177:    def test_typed_calculate_cant_be_trigger(self):\npyxform/tests_v1/test_trigger.py:215:                '<bind nodeset=\"/trigger-column/c\" type=\"dateTime\" calculate=\"now()\"/>',\npyxform/survey_element.py:417:            if self.trigger and \"calculate\" in self.bind:\npyxform/builder.py:121:            self._save_trigger_as_setvalue_and_remove_calculate(d)\npyxform/builder.py:127:    def _save_trigger_as_setvalue_and_remove_calculate(self, d):\npyxform/question.py:35:        if (\"calculate\" in self.bind or self.trigger) and not (self.label or self.hint):\n",
  "stderr": "",
  "exit_code": 0
}

{
  "status": "ok",
  "filepath": "pyxform/question.py",
  "content": "        if self.type not in QUESTION_TYPE_DICT:\n            raise PyXFormError(\"Unknown question type '%s'.\" % self.type)\n\n    def xml_instance(self, **kwargs):\n        survey = self.get_root()\n        attributes = {}\n        attributes.update(self.get(\"instance\", {}))\n        for key, value in attributes.items():\n            attributes[key] = survey.insert_xpaths(value, self)\n\n        if self.get(\"default\") and not default_is_dynamic(self.default, self.type):\n            return node(self.name, unicode(self.get(\"default\")), **attributes)\n        return node(self.name, **attributes)\n\n    def xml_control(self):\n        if (\"calculate\" in self.bind or self.trigger) and not (self.label or self.hint):\n            nested_setvalues = self.get_root().get_setvalues_for_question_name(\n                self.name\n            )\n            if nested_setvalues:\n                for setvalue in nested_setvalues:\n                    msg = (\n                        \"The question ${%s} is not user-visible so it can't be used as a calculation trigger for question ${%s}.\"\n                        % (self.name, setvalue[0])\n                    )\n                    raise PyXFormError(msg)\n            return None\n\n        xml_node = self.build_xml()\n\n        if xml_node:\n            self.nest_setvalues(xml_node)\n\n        return xml_node\n\n    def nest_setvalues(self, xml_node):\n        nested_setvalues = self.get_root().get_setvalues_for_question_name(self.name)\n\n        if nested_setvalues:\n            for setvalue in nested_setvalues:\n                setvalue_attrs = {",
  "start_line": 20,
  "end_line": 60,
  "total_lines": 351,
  "is_truncated": false
}

{
  "status": "ok",
  "filepath": "pyxform/tests_v1/test_trigger.py",
  "content": "# -*- coding: utf-8 -*-\n\"\"\"\nTest handling setvalue of 'trigger' column in forms\n\"\"\"\n\nfrom pyxform.tests_v1.pyxform_test_case import PyxformTestCase\n\n\nclass TriggerSetvalueTests(PyxformTestCase):\n    def test_trigger_reference_to_nonexistent_node_gives_error(self):\n        self.assertPyxformXform(\n            name=\"trigger-missing-ref\",\n            md=\"\"\"\n            | survey |          |      |             |             |         |\n            |        | type     | name | label       | calculation | trigger |\n            |        | dateTime | b    |             | now()       | ${a}    |\n            \"\"\",\n            errored=True,\n            error__contains=[\n                \"There has been a problem trying to replace ${a} with the XPath to the survey element named 'a'. There is no survey element with this name.\"\n            ],\n        )\n\n    def test_trigger_with_something_other_than_node_ref_gives_error(self):\n        self.assertPyxformXform(\n            name=\"trigger-invalid-ref\",\n            md=\"\"\"\n            | survey |          |      |             |             |         |\n            |        | type     | name | label       | calculation | trigger |\n            |        | dateTime | b    |             | now()       | 6       |\n            \"\"\",\n            errored=True,\n            error__contains=[\n                \"Only references to other fields are allowed in the 'trigger' column.\"\n            ],\n        )\n\n    def test_handling_trigger_column_no_label_and_no_hint(self):\n        md = \"\"\"\n        | survey |          |      |             |             |         |\n        |        | type     | name | label       | calculation | trigger |\n        |        | text     | a    | Enter text  |             |         |\n        |        | dateTime | b    |             | now()       | ${a}    |\n        \"\"\"\n        self.assertPyxformXform(\n            md=md,\n            name=\"trigger-column\",\n            id_string=\"id\",\n            model__contains=[\"<a/>\", \"<b/>\",],\n            xml__contains=[\n                '<bind nodeset=\"/trigger-column/b\" type=\"dateTime\"/>',\n                '<input ref=\"/trigger-column/a\">',\n                '<setvalue event=\"xforms-value-changed\" ref=\"/trigger-column/b\" value=\"now()\"/>',\n            ],\n            xml__excludes=[\n                '<bind nodeset=\"/trigger-column/b\" type=\"dateTime\" calculate=\"now()\"/>'\n                '<input ref=\"/trigger-column/b\">',\n            ],\n        )\n\n    def test_handling_trigger_column_with_label_and_hint(self):\n        md = \"\"\"\n        | survey |          |      |                    |             |         |\n        |        | type     | name | label              | calculation | trigger |\n        |        | text     | a    | Enter text         |             |         |\n        |        | dateTime | c    | Date of diagnostic | now()       | ${a}    |\n        \"\"\"\n\n        self.assertPyxformXform(\n            md=md,\n            name=\"trigger-column\",\n            id_string=\"id\",\n            model__contains=[\"<a/>\", \"<c/>\",],\n            xml__contains=[\n                '<bind nodeset=\"/trigger-column/c\" type=\"dateTime\"/>',\n                '<input ref=\"/trigger-column/a\">',\n                '<input ref=\"/trigger-column/c\">',\n                '<setvalue event=\"xforms-value-changed\" ref=\"/trigger-column/c\" value=\"now()\"/>',\n            ],\n            xml__excludes=[\n                '<bind nodeset=\"/trigger-column/c\" type=\"dateTime\" calculate=\"now()\"/>'\n            ],\n        )\n\n    def test_handling_multiple_trigger_column(self):\n        md = \"\"\"\n        | survey |          |      |            |             |         |        |\n        |        | type     | name | label      | calculation | trigger | hint   |\n        |        | text     | a    | Enter text |             |         |        |\n        |        | integer  | b    |            | 1+1         | ${a}    |        |\n        |        | dateTime | c    |            | now()       | ${a}    | A hint |\n        \"\"\"\n\n        self.assertPyxformXform(\n            md=md,\n            name=\"trigger-column\",\n            id_string=\"id\",\n            model__contains=[\"<a/>\", \"<b/>\", \"<c/>\",],\n            xml__contains=[\n                '<bind nodeset=\"/trigger-column/b\" type=\"int\"/>',\n                '<bind nodeset=\"/trigger-column/c\" type=\"dateTime\"/>',\n                '<input ref=\"/trigger-column/a\">',\n                '<input ref=\"/trigger-column/c\">',\n                '<setvalue event=\"xforms-value-changed\" ref=\"/trigger-column/b\" value=\"1+1\"/>',\n                '<setvalue event=\"xforms-value-changed\" ref=\"/trigger-column/c\" value=\"now()\"/>',\n            ],\n            xml__excludes=[\n                '<bind nodeset=\"/trigger-column/b\" type=\"int\" calculate=\"1+1\"/>',\n                '<bind nodeset=\"/trigger-column/c\" type=\"dateTime\" calculate=\"now()\"/>',\n            ],\n        )\n\n    def test_handling_trigger_column_with_no_calculation(self):\n        md = \"\"\"\n        | survey |          |      |                    |             |         |\n        |        | type     | name | label              | calculation | trigger |\n        |        | text     | a    | Enter text         |             |         |\n        |        | dateTime | d    | Date of something  |             | ${a}    |\n        \"\"\"\n\n        self.assertPyxformXform(\n            md=md,\n            name=\"trigger-column\",\n            id_string=\"id\",\n            model__contains=[\"<a/>\", \"<d/>\",],\n            xml__contains=[\n                '<bind nodeset=\"/trigger-column/d\" type=\"dateTime\"/>',\n                '<input ref=\"/trigger-column/a\">',\n                '<input ref=\"/trigger-column/d\">',\n                '<setvalue event=\"xforms-value-changed\" ref=\"/trigger-column/d\"/>',\n            ],\n            xml__excludes=[\n                '<bind nodeset=\"/trigger-column/d\" type=\"dateTime\" calculate=\"\"/>'\n            ],\n        )\n\n    def test_handling_trigger_column_with_no_calculation_no_label_no_hint(self):\n        md = \"\"\"\n        | survey |          |      |            |             |         |\n        |        | type     | name | label      | calculation | trigger |\n        |        | text     | a    | Enter text |             |         |\n        |        | decimal  | e    |            |             | ${a}    |\n        \"\"\"\n\n        self.assertPyxformXform(\n            md=md,\n            name=\"trigger-column\",\n            id_string=\"id\",\n            model__contains=[\"<a/>\", \"<e/>\",],\n            xml__contains=[",
  "start_line": 1,
  "end_line": 150,
  "total_lines": 281,
  "is_truncated": true
}

{
  "status": "error",
  "error_type": "CommandError",
  "error_message": "Traceback (most recent call last):\n  File \"<stdin>\", line 2, in <module>\nImportError: cannot import name 'Xls2Xform' from 'pyxform.xls2xform' (/workspace/pyxform/xls2xform.py)\n",
  "details": {
    "stdout": "",
    "stderr": "Traceback (most recent call last):\n  File \"<stdin>\", line 2, in <module>\nImportError: cannot import name 'Xls2Xform' from 'pyxform.xls2xform' (/workspace/pyxform/xls2xform.py)\n",
    "exit_code": 1
  }
}

{
  "status": "ok",
  "filepath": "pyxform/xls2xform.py",
  "content": "# -*- coding: utf-8 -*-\n\"\"\"\nxls2xform converts properly formatted Excel documents into XForms for\nuse with ODK Collect.\n\"\"\"\nfrom __future__ import print_function\n\nimport argparse\nimport json\nimport logging\nimport os\nfrom os.path import splitext\n\nfrom pyxform import builder, xls2json\nfrom pyxform.utils import has_external_choices, sheet_to_csv\nfrom pyxform.validators.odk_validate import ODKValidateError\n\nlogger = logging.getLogger(__name__)\nlogger.addHandler(logging.StreamHandler())\nlogger.setLevel(logging.INFO)\n\n\ndef get_xml_path(path):\n    \"\"\"\n    Returns the xform file path\n\n    Generates an output path for the xform file from the given\n    xlsx input file path.\n    \"\"\"\n    return splitext(path)[0] + \".xml\"\n\n\ndef xls2xform_convert(\n    xlsform_path, xform_path, validate=True, pretty_print=True, enketo=False\n):\n    warnings = []\n\n    json_survey = xls2json.parse_file_to_json(xlsform_path, warnings=warnings)\n    survey = builder.create_survey_element_from_dict(json_survey)\n    # Setting validate to false will cause the form not to be processed by\n    # ODK Validate.\n    # This may be desirable since ODK Validate requires launching a subprocess\n    # that runs some java code.\n    survey.print_xform_to_file(\n        xform_path,\n        validate=validate,\n        pretty_print=pretty_print,\n        warnings=warnings,\n        enketo=enketo,\n    )\n    output_dir = os.path.split(xform_path)[0]\n    if has_external_choices(json_survey):\n        itemsets_csv = os.path.join(output_dir, \"itemsets.csv\")\n        choices_exported = sheet_to_csv(xlsform_path, itemsets_csv, \"external_choices\")\n        if not choices_exported:\n            warnings.append(\n                \"Could not export itemsets.csv, perhaps the \"\n                \"external choices sheet is missing.\"\n            )\n        else:\n            logger.info(\"External choices csv is located at: %s\", itemsets_csv)\n    return warnings\n\n\ndef _create_parser():\n    \"\"\"\n    Parse command line arguments.\n    \"\"\"\n    parser = argparse.ArgumentParser()\n    parser.add_argument(\n        \"path_to_XLSForm\",\n        help=\"Path to the Excel XLSX file with the XLSForm definition.\",\n    )\n    parser.add_argument(\"output_path\", help=\"Path to save the output to.\", nargs=\"?\")\n    parser.add_argument(\n        \"--json\",\n        action=\"store_true\",\n        help=\"Capture everything and report in JSON format.\",\n    )\n    parser.add_argument(\n        \"--skip_validate\",\n        action=\"store_false\",\n        default=True,\n        help=\"Do not run any external validators on the output XForm XML. \"\n        \"Without this flag, ODK Validate is run by default for backwards \"\n        \"compatibility. Internal pyxform checks cannot be skipped.\",\n    )\n    parser.add_argument(\n        \"--odk_validate\",\n        action=\"store_true\",\n        default=False,\n        help=\"Run the ODK Validate XForm external validator.\",\n    )\n    parser.add_argument(\n        \"--enketo_validate\",\n        action=\"store_true\",\n        default=False,\n        help=\"Run the Enketo Validate XForm external validator.\",\n    )\n    parser.add_argument(",
  "start_line": 1,
  "end_line": 100,
  "total_lines": 195,
  "is_truncated": false
}

{
  "status": "ok",
  "filepath": "pyxform/xls2json.py",
  "content": "# -*- coding: utf-8 -*-\n\"\"\"\nA Python script to convert excel files into JSON.\n\"\"\"\nfrom __future__ import print_function, unicode_literals\n\nimport codecs\nimport json\nimport os\nimport re\nimport sys\nfrom collections import Counter\n\nfrom pyxform import aliases, constants\nfrom pyxform.errors import PyXFormError\nfrom pyxform.utils import basestring, is_valid_xml_tag, unicode, default_is_dynamic\nfrom pyxform.xls2json_backends import csv_to_dict, xls_to_dict\n\nSMART_QUOTES = {\"\\u2018\": \"'\", \"\\u2019\": \"'\", \"\\u201c\": '\"', \"\\u201d\": '\"'}\n\n\ndef print_pyobj_to_json(pyobj, path=None):\n    \"\"\"\n    dump a python nested array/dict structure to the specified file\n    or stdout if no file is specified\n    \"\"\"\n    if path:\n        fp = codecs.open(path, mode=\"w\", encoding=\"utf-8\")\n        json.dump(pyobj, fp=fp, ensure_ascii=False, indent=4)\n        fp.close()\n    else:\n        sys.stdout.write(json.dumps(pyobj, ensure_ascii=False, indent=4))\n\n\ndef merge_dicts(dict_a, dict_b, default_key=\"default\"):\n    \"\"\"\n    Recursively merge two nested dicts into a single dict.\n    When keys match their values are merged using\n    a recursive call to this function,\n    otherwise they are just added to the output dict.\n    \"\"\"\n    if dict_a is None or dict_a == {}:\n        return dict_b\n    if dict_b is None or dict_b == {}:\n        return dict_a\n\n    if type(dict_a) is not dict:\n        if default_key in dict_b:\n            return dict_b\n        dict_a = {default_key: dict_a}\n    if type(dict_b) is not dict:\n        if default_key in dict_a:\n            return dict_a\n        dict_b = {default_key: dict_b}\n\n    all_keys = set(dict_a.keys()).union(set(dict_b.keys()))\n\n    out_dict = dict()\n    for key in all_keys:\n        out_dict[key] = merge_dicts(dict_a.get(key), dict_b.get(key), default_key)\n    return out_dict\n\n\ndef list_to_nested_dict(lst):\n    \"\"\"\n    [1,2,3,4] -> {1:{2:{3:4}}}\n    \"\"\"\n    if len(lst) > 1:\n        return {lst[0]: list_to_nested_dict(lst[1:])}\n    else:\n        return lst[0]\n\n\ndef replace_smart_quotes_in_dict(_d):\n    for key, value in _d.items():\n        _changed = False\n        for smart_quote, dumb_quote in SMART_QUOTES.items():\n            if isinstance(value, basestring):\n                if smart_quote in value:\n                    value = value.replace(smart_quote, dumb_quote)\n                    _changed = True\n        if _changed:\n            _d[key] = value\n\n\ndef dealias_and_group_headers(\n    dict_array,\n    header_aliases,\n    use_double_colons,\n    default_language=\"default\",\n    ignore_case=False,\n):\n    \"\"\"\n    For each row in the worksheet, group all keys that contain a double colon.\n    So\n        {\"text::english\": \"hello\", \"text::french\" : \"bonjour\"}\n    becomes\n        {\"text\": {\"english\": \"hello\", \"french\" : \"bonjour\"}.\n    Dealiasing is done to the first token\n    (the first term separated by the delimiter).",
  "start_line": 1,
  "end_line": 100,
  "total_lines": 1574,
  "is_truncated": false
}

{
  "status": "ok",
  "filepath": "pyxform/builder.py",
  "content": "# -*- coding: utf-8 -*-\n\"\"\"\nSurvey builder functionality.\n\"\"\"\nimport copy\nimport os\nimport re\n\nfrom pyxform import file_utils, utils\nfrom pyxform.errors import PyXFormError\nfrom pyxform.external_instance import ExternalInstance\nfrom pyxform.question import (\n    InputQuestion,\n    MultipleChoiceQuestion,\n    OsmUploadQuestion,\n    Question,\n    RangeQuestion,\n    TriggerQuestion,\n    UploadQuestion,\n)\nfrom pyxform.question_type_dictionary import QUESTION_TYPE_DICT\nfrom pyxform.section import GroupedSection, RepeatingSection\nfrom pyxform.survey import Survey\nfrom pyxform.utils import unicode\nfrom pyxform.xls2json import SurveyReader\n\n\ndef copy_json_dict(json_dict):\n    \"\"\"\n    Returns a deep copy of the input json_dict\n    \"\"\"\n    json_dict_copy = None\n    items = None\n\n    if type(json_dict) is list:\n        json_dict_copy = [None] * len(json_dict)\n        items = enumerate(json_dict)\n    elif type(json_dict) is dict:\n        json_dict_copy = {}\n        items = json_dict.items()\n\n    for key, value in items:\n        if type(value) is dict or type(value) is list:\n            json_dict_copy[key] = copy_json_dict(value)\n        else:\n            json_dict_copy[key] = value\n\n    return json_dict_copy\n\n\nclass SurveyElementBuilder(object):\n    # we use this CLASSES dict to create questions from dictionaries\n    QUESTION_CLASSES = {\n        \"\": Question,\n        \"action\": Question,\n        \"input\": InputQuestion,\n        \"odk:rank\": MultipleChoiceQuestion,\n        \"osm\": OsmUploadQuestion,\n        \"range\": RangeQuestion,\n        \"select\": MultipleChoiceQuestion,\n        \"select1\": MultipleChoiceQuestion,\n        \"trigger\": TriggerQuestion,\n        \"upload\": UploadQuestion,\n    }\n\n    SECTION_CLASSES = {\n        \"group\": GroupedSection,\n        \"repeat\": RepeatingSection,\n        \"survey\": Survey,\n    }\n\n    def __init__(self, **kwargs):\n        # I don't know why we would need an explicit none option for\n        # select alls\n        self._add_none_option = False\n        self.set_sections(kwargs.get(\"sections\", {}))\n\n        # dictionary of setvalue target and value tuple indexed by triggering element\n        self.setvalues_by_triggering_ref = {}\n\n    def set_sections(self, sections):\n        \"\"\"\n        sections is a dict of python objects, a key in this dict is\n        the name of the section and the value is a dict that can be\n        used to create a whole survey.\n        \"\"\"\n        assert type(sections) == dict\n        self._sections = sections\n\n    def create_survey_element_from_dict(self, d):\n        \"\"\"\n        Convert from a nested python dictionary/array structure (a json dict I\n        call it because it corresponds directly with a json object)\n        to a survey object\n        \"\"\"\n        if \"add_none_option\" in d:\n            self._add_none_option = d[\"add_none_option\"]\n        if d[\"type\"] in self.SECTION_CLASSES:\n            section = self._create_section_from_dict(d)\n\n            if d[\"type\"] == \"survey\":\n                section.setvalues_by_triggering_ref = self.setvalues_by_triggering_ref\n\n            return section\n        elif d[\"type\"] == \"loop\":\n            return self._create_loop_from_dict(d)\n        elif d[\"type\"] == \"include\":\n            section_name = d[\"name\"]\n            if section_name not in self._sections:\n                raise PyXFormError(\n                    \"This section has not been included.\",\n                    section_name,\n                    self._sections.keys(),\n                )\n            d = self._sections[section_name]\n            full_survey = self.create_survey_element_from_dict(d)\n            return full_survey.children\n        elif d[\"type\"] == \"xml-external\":\n            return ExternalInstance(**d)\n        else:\n            self._save_trigger_as_setvalue_and_remove_calculate(d)\n\n            return self._create_question_from_dict(\n                d, copy_json_dict(QUESTION_TYPE_DICT), self._add_none_option\n            )\n\n    def _save_trigger_as_setvalue_and_remove_calculate(self, d):\n        if \"trigger\" in d:\n            triggering_ref = re.sub(r\"\\s+\", \"\", d[\"trigger\"])\n            value = \"\"\n            if \"bind\" in d and \"calculate\" in d[\"bind\"]:\n                value = d[\"bind\"][\"calculate\"]\n\n            if triggering_ref in self.setvalues_by_triggering_ref:\n                self.setvalues_by_triggering_ref[triggering_ref].append(\n                    (d[\"name\"], value)\n                )\n            else:\n                self.setvalues_by_triggering_ref[triggering_ref] = [(d[\"name\"], value)]\n\n    @staticmethod\n    def _create_question_from_dict(d, question_type_dictionary, add_none_option=False):\n        question_type_str = d[\"type\"]\n        d_copy = d.copy()\n\n        # TODO: Keep add none option?\n        if add_none_option and question_type_str.startswith(\"select all that apply\"):\n            SurveyElementBuilder._add_none_option_to_select_all_that_apply(d_copy)\n\n        # Handle or_other on select type questions",
  "start_line": 1,
  "end_line": 150,
  "total_lines": 400,
  "is_truncated": false
}

{
  "status": "ok",
  "filepath": "pyxform/survey.py",
  "content": "# -*- coding: utf-8 -*-\n\"\"\"\nSurvey module with XForm Survey objects and utility functions.\n\"\"\"\nfrom __future__ import print_function\n\nimport codecs\nimport os\nimport re\nfrom re import split\nimport tempfile\nimport xml.etree.ElementTree as ETree\nfrom collections import defaultdict\nfrom datetime import datetime\n\nfrom pyxform import constants\nfrom pyxform.errors import PyXFormError, ValidationError\nfrom pyxform.external_instance import ExternalInstance\nfrom pyxform.instance import SurveyInstance\nfrom pyxform.instance_info import InstanceInfo\nfrom pyxform.question import Question\nfrom pyxform.section import Section\nfrom pyxform.survey_element import SurveyElement\nfrom pyxform.utils import (\n    NSMAP,\n    PatchedText,\n    basestring,\n    get_languages_with_bad_tags,\n    node,\n    unicode,\n)\nfrom pyxform.validators import enketo_validate, odk_validate\n\ntry:\n    from functools import lru_cache\nexcept ImportError:\n    from functools32 import lru_cache\n\nLAST_SAVED_INSTANCE_NAME = \"__last-saved\"\nBRACKETED_TAG_REGEX = re.compile(r\"\\${(last-saved#)?(.*?)}\")\nLAST_SAVED_REGEX = re.compile(r\"\\${last-saved#(.*?)}\")\n\n\ndef register_nsmap():\n    \"\"\"Function to register NSMAP namespaces with ETree\"\"\"\n    for prefix, uri in NSMAP.items():\n        prefix_no_xmlns = prefix.replace(\"xmlns\", \"\").replace(\":\", \"\")\n        ETree.register_namespace(prefix_no_xmlns, uri)\n\n\nregister_nsmap()\n\n\n@lru_cache(maxsize=None)\ndef is_parent_a_repeat(survey, xpath):\n    \"\"\"\n    Returns the XPATH of the first repeat of the given xpath in the survey,\n    otherwise False will be returned.\n    \"\"\"\n    parent_xpath = \"/\".join(xpath.split(\"/\")[:-1])\n    if not parent_xpath:\n        return False\n\n    if survey.any_repeat(parent_xpath):\n        return parent_xpath\n\n    return is_parent_a_repeat(survey, parent_xpath)\n\n\n@lru_cache(maxsize=None)\ndef share_same_repeat_parent(survey, xpath, context_xpath, reference_parent=False):\n    \"\"\"\n    Returns a tuple of the number of steps from the context xpath to the shared\n    repeat parent and the xpath to the target xpath from the shared repeat\n    parent.\n\n    For example,\n        xpath = /data/repeat_a/group_a/name\n        context_xpath = /data/repeat_a/group_b/age\n\n        returns (2, '/group_a/name')'\n    \"\"\"\n\n    def _get_steps_and_target_xpath(context_parent, xpath_parent, include_parent=False):\n        parts = []\n        steps = 1\n        if not include_parent:\n            remainder_xpath = xpath[len(xpath_parent) :]\n            context_parts = context_xpath[len(xpath_parent) + 1 :].split(\"/\")\n            xpath_parts = xpath[len(xpath_parent) + 1 :].split(\"/\")\n        else:\n            split_idx = len(xpath_parent.split(\"/\"))\n            context_parts = context_xpath.split(\"/\")[split_idx - 1 :]\n            xpath_parts = xpath.split(\"/\")[split_idx - 1 :]\n            remainder_xpath = \"/\".join(xpath_parts)\n\n        for index, item in enumerate(context_parts[:-1]):\n            try:\n                if xpath[len(context_parent) + 1 :].split(\"/\")[index] != item:\n                    steps = len(context_parts[index:])",
  "start_line": 1,
  "end_line": 100,
  "total_lines": 1046,
  "is_truncated": false
}

{
  "status": "ok",
  "filepath": "pyxform/section.py",
  "content": "# -*- coding: utf-8 -*-\n\"\"\"\nSection survey element module.\n\"\"\"\nfrom pyxform.errors import PyXFormError\nfrom pyxform.external_instance import ExternalInstance\nfrom pyxform.question import SurveyElement\nfrom pyxform.utils import node\n\n\nclass Section(SurveyElement):\n    def validate(self):\n        super(Section, self).validate()\n        for element in self.children:\n            element.validate()\n        self._validate_uniqueness_of_element_names()\n\n    # there's a stronger test of this when creating the xpath\n    # dictionary for a survey.\n    def _validate_uniqueness_of_element_names(self):\n        element_slugs = []\n        for element in self.children:\n            if any(element.name.lower() == s.lower() for s in element_slugs):\n                raise PyXFormError(\n                    \"There are more than one survey elements named '%s' \"\n                    \"(case-insensitive) in the section named '%s'.\"\n                    % (element.name.lower(), self.name)\n                )\n            element_slugs.append(element.name)\n\n    def xml_instance(self, **kwargs):\n        \"\"\"\n        Creates an xml representation of the section\n        \"\"\"\n        append_template = kwargs.pop(\"append_template\", False)\n\n        attributes = {}\n        attributes.update(kwargs)\n        attributes.update(self.get(\"instance\", {}))\n        survey = self.get_root()\n        # Resolve field references in attributes\n        for key, value in attributes.items():\n            attributes[key] = survey.insert_xpaths(value, self)\n        result = node(self.name, **attributes)\n\n        for child in self.children:\n            repeating_template = None\n            if child.get(\"flat\"):\n                for grandchild in child.xml_instance_array():\n                    result.appendChild(grandchild)\n            elif isinstance(child, ExternalInstance):\n                continue\n            else:\n                if isinstance(child, RepeatingSection) and not append_template:\n                    append_template = not append_template\n                    repeating_template = child.generate_repeating_template()\n                result.appendChild(child.xml_instance(append_template=append_template))\n            if append_template and repeating_template:\n                append_template = not append_template\n                result.insertBefore(repeating_template, result._get_lastChild())\n        return result\n\n    def generate_repeating_template(self, **kwargs):\n        attributes = {\"jr:template\": \"\"}\n        result = node(self.name, **attributes)\n        for child in self.children:\n            if isinstance(child, RepeatingSection):\n                result.appendChild(child.template_instance())\n            else:\n                result.appendChild(child.xml_instance())\n        return result\n\n    def xml_instance_array(self):\n        \"\"\"\n        This method is used for generating flat instances.\n        \"\"\"\n        for child in self.children:\n            if child.get(\"flat\"):\n                for grandchild in child.xml_instance_array():\n                    yield grandchild\n            else:\n                yield child.xml_instance()\n\n    def xml_control(self):\n        \"\"\"\n        Ideally, we'll have groups up and rolling soon, but for now\n        let's just yield controls from all the children of this section\n        \"\"\"\n        for e in self.children:\n            control = e.xml_control()\n            if control is not None:\n                yield control\n\n\nclass RepeatingSection(Section):\n    def xml_control(self):\n        \"\"\"\n        <group>\n        <label>Fav Color</label>\n        <repeat nodeset=\"fav-color\">",
  "start_line": 1,
  "end_line": 100,
  "total_lines": 203,
  "is_truncated": false
}

{
  "status": "ok",
  "filepath": "pyxform/question.py",
  "content": "# -*- coding: utf-8 -*-\n\"\"\"\nXForm Survey element classes for different question types.\n\"\"\"\nimport os.path\nimport re\n\nfrom pyxform.errors import PyXFormError\nfrom pyxform.question_type_dictionary import QUESTION_TYPE_DICT\nfrom pyxform.survey_element import SurveyElement\nfrom pyxform.utils import basestring, node, unicode, default_is_dynamic\n\n\nclass Question(SurveyElement):\n    def validate(self):\n        SurveyElement.validate(self)\n\n        # make sure that the type of this question exists in the\n        # question type dictionary.\n        if self.type not in QUESTION_TYPE_DICT:\n            raise PyXFormError(\"Unknown question type '%s'.\" % self.type)\n\n    def xml_instance(self, **kwargs):\n        survey = self.get_root()\n        attributes = {}\n        attributes.update(self.get(\"instance\", {}))\n        for key, value in attributes.items():\n            attributes[key] = survey.insert_xpaths(value, self)\n\n        if self.get(\"default\") and not default_is_dynamic(self.default, self.type):\n            return node(self.name, unicode(self.get(\"default\")), **attributes)\n        return node(self.name, **attributes)\n\n    def xml_control(self):\n        if (\"calculate\" in self.bind or self.trigger) and not (self.label or self.hint):\n            nested_setvalues = self.get_root().get_setvalues_for_question_name(\n                self.name\n            )\n            if nested_setvalues:\n                for setvalue in nested_setvalues:\n                    msg = (\n                        \"The question ${%s} is not user-visible so it can't be used as a calculation trigger for question ${%s}.\"\n                        % (self.name, setvalue[0])\n                    )\n                    raise PyXFormError(msg)\n            return None\n\n        xml_node = self.build_xml()\n\n        if xml_node:\n            self.nest_setvalues(xml_node)\n\n        return xml_node\n\n    def nest_setvalues(self, xml_node):\n        nested_setvalues = self.get_root().get_setvalues_for_question_name(self.name)\n\n        if nested_setvalues:\n            for setvalue in nested_setvalues:\n                setvalue_attrs = {\n                    \"ref\": self.get_root()\n                    .insert_xpaths(\"${%s}\" % setvalue[0], self.get_root())\n                    .strip(),\n                    \"event\": \"xforms-value-changed\",\n                }\n                if not (setvalue[1] == \"\"):\n                    setvalue_attrs[\"value\"] = self.get_root().insert_xpaths(\n                        setvalue[1], self\n                    )\n\n                setvalue_node = node(\"setvalue\", **setvalue_attrs)\n\n                xml_node.appendChild(setvalue_node)\n\n    def build_xml(self):\n        return None\n\n\nclass InputQuestion(Question):\n    \"\"\"\n    This control string is the same for: strings, integers, decimals,\n    dates, geopoints, barcodes ...\n    \"\"\"\n\n    def build_xml(self):\n        control_dict = self.control\n        label_and_hint = self.xml_label_and_hint()\n        survey = self.get_root()\n        # Resolve field references in attributes\n        for key, value in control_dict.items():\n            control_dict[key] = survey.insert_xpaths(value, self)\n        control_dict[\"ref\"] = self.get_xpath()\n\n        result = node(**control_dict)\n        if label_and_hint:\n            for element in self.xml_label_and_hint():\n                result.appendChild(element)\n\n        # Input types are used for selects with external choices sheets.\n        if self[\"query\"]:",
  "start_line": 1,
  "end_line": 100,
  "total_lines": 351,
  "is_truncated": false
}

{
  "status": "ok",
  "filepath": "pyxform/question.py",
  "content": "        return result\n\n    def validate(self):\n        pass\n\n\nclass OsmUploadQuestion(UploadQuestion):\n    def __init__(self, **kwargs):\n        kwargs_copy = kwargs.copy()\n        tags = kwargs_copy.pop(\"tags\", []) + kwargs_copy.pop(\"children\", [])\n\n        super(OsmUploadQuestion, self).__init__(**kwargs_copy)\n\n        if tags:\n            self.children = []\n\n            for tag in tags:\n                self.add_tag(**tag)\n\n    def add_tag(self, **kwargs):\n        tag = Tag(**kwargs)\n        self.add_child(tag)\n\n    def build_xml(self):\n        control_dict = self.control\n        control_dict[\"ref\"] = self.get_xpath()\n        control_dict[\"mediatype\"] = self._get_media_type()\n        result = node(\"upload\", *self.xml_label_and_hint(), **control_dict)\n\n        for osm_tag in self.children:\n            result.appendChild(osm_tag.xml())\n\n        return result\n\n\nclass RangeQuestion(Question):\n    def build_xml(self):\n        control_dict = self.control\n        label_and_hint = self.xml_label_and_hint()\n        survey = self.get_root()\n        # Resolve field references in attributes\n        for key, value in control_dict.items():\n            control_dict[key] = survey.insert_xpaths(value, self)\n        control_dict[\"ref\"] = self.get_xpath()\n        params = self.get(\"parameters\", {})\n        control_dict.update(params)\n        result = node(**control_dict)\n        if label_and_hint:\n            for element in self.xml_label_and_hint():\n                result.appendChild(element)\n\n        return result",
  "start_line": 300,
  "end_line": 351,
  "total_lines": 351,
  "is_truncated": false
}

{
  "status": "ok",
  "filepath": "pyxform/question.py",
  "content": "            choice_filter = self.get(\"choice_filter\")\n            query = \"instance('\" + self[\"query\"] + \"')/root/item\"\n            choice_filter = survey.insert_xpaths(choice_filter, self, True)\n            if choice_filter:\n                query += \"[\" + choice_filter + \"]\"\n            result.setAttribute(\"query\", query)\n        return result\n\n\nclass TriggerQuestion(Question):\n    def build_xml(self):\n        control_dict = self.control\n        survey = self.get_root()\n        # Resolve field references in attributes\n        for key, value in control_dict.items():\n            control_dict[key] = survey.insert_xpaths(value, self)\n        control_dict[\"ref\"] = self.get_xpath()\n        return node(\"trigger\", *self.xml_label_and_hint(), **control_dict)\n\n\nclass UploadQuestion(Question):\n    def _get_media_type(self):\n        return self.control[\"mediatype\"]\n\n    def build_xml(self):\n        control_dict = self.control\n        survey = self.get_root()\n        # Resolve field references in attributes\n        for key, value in control_dict.items():\n            control_dict[key] = survey.insert_xpaths(value, self)\n        control_dict[\"ref\"] = self.get_xpath()\n        control_dict[\"mediatype\"] = self._get_media_type()\n        return node(\"upload\", *self.xml_label_and_hint(), **control_dict)\n\n\nclass Option(SurveyElement):\n    def xml_value(self):\n        return node(\"value\", self.name)\n\n    def xml(self):\n        item = node(\"item\")\n        self.xml_label()\n        item.appendChild(self.xml_label())\n        item.appendChild(self.xml_value())\n\n        return item\n\n    def validate(self):\n        pass\n\n\nclass MultipleChoiceQuestion(Question):\n    def __init__(self, **kwargs):\n        kwargs_copy = kwargs.copy()\n        # Notice that choices can be specified under choices or children.\n        # I'm going to try to stick to just choices.\n        # Aliases in the json format will make it more difficult\n        # to use going forward.\n        choices = list(kwargs_copy.pop(\"choices\", [])) + list(\n            kwargs_copy.pop(\"children\", [])\n        )\n        Question.__init__(self, **kwargs_copy)\n        for choice in choices:\n            self.add_choice(**choice)\n\n    def add_choice(self, **kwargs):\n        option = Option(**kwargs)\n        self.add_child(option)\n\n    def validate(self):\n        Question.validate(self)\n        descendants = self.iter_descendants()\n        next(descendants)  # iter_descendants includes self; we need to pop it\n\n        for choice in descendants:\n            choice.validate()\n\n    def build_xml(self):\n        assert self.bind[\"type\"] in [\"string\", \"odk:rank\"]\n        survey = self.get_root()\n        control_dict = self.control.copy()\n        # Resolve field references in attributes\n        for key, value in control_dict.items():\n            control_dict[key] = survey.insert_xpaths(value, self)\n        control_dict[\"ref\"] = self.get_xpath()\n\n        result = node(**control_dict)\n        for element in self.xml_label_and_hint():\n            result.appendChild(element)\n\n        choices = survey.get(\"choices\")\n        multi_language = False\n        if choices is not None and len(choices) > 0:\n            first_choices = next(iter(choices.values()))\n            multi_language = isinstance(first_choices[0].get(\"label\"), dict)\n\n        # itemset are only supposed to be strings,\n        # check to prevent the rare dicts that show up\n        if self[\"itemset\"] and isinstance(self[\"itemset\"], basestring):\n            choice_filter = self.get(\"choice_filter\")\n            itemset, file_extension = os.path.splitext(self[\"itemset\"])\n            has_media = False\n            is_previous_question = bool(re.match(r\"^\\${.*}$\", self.get(\"itemset\")))\n\n            if choices.get(itemset):\n                has_media = bool(choices[itemset][0].get(\"media\"))\n\n            if file_extension in [\".csv\", \".xml\"]:\n                itemset = itemset\n                itemset_label_ref = \"label\"\n            else:\n                if not multi_language and not has_media:\n                    itemset = self[\"itemset\"]\n                    itemset_label_ref = \"label\"\n                else:\n                    itemset = self[\"itemset\"]\n                    itemset_label_ref = \"jr:itext(itextId)\"\n\n            choice_filter = survey.insert_xpaths(choice_filter, self, True, True)\n            if is_previous_question:\n                path = (\n                    survey.insert_xpaths(self[\"itemset\"], self, reference_parent=True)\n                    .strip()\n                    .split(\"/\")\n                )\n                nodeset = \"/\".join(path[:-1])\n                itemset_label_ref = path[-1]\n                if choice_filter:\n                    choice_filter = choice_filter.replace(\n                        \"current()/\" + nodeset, \".\"\n                    ).replace(nodeset, \".\")\n                else:\n                    # Choices must have a value. Filter out repeat instances without\n                    # an answer for the linked question\n                    name = path[-1]\n                    choice_filter = f\"./{name} != ''\"\n            else:\n                nodeset = \"instance('\" + itemset + \"')/root/item\"\n\n            if choice_filter:\n                nodeset += \"[\" + choice_filter + \"]\"\n\n            if self[\"parameters\"]:\n                params = self[\"parameters\"]\n\n                if \"randomize\" in params and params[\"randomize\"] == \"true\":\n                    nodeset = \"randomize(\" + nodeset\n\n                    if \"seed\" in params:\n                        if params[\"seed\"].startswith(\"${\"):",
  "start_line": 101,
  "end_line": 250,
  "total_lines": 351,
  "is_truncated": true
}