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/question.py",
  "content": "        if self[\"query\"]:\n            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\", [])",
  "start_line": 100,
  "end_line": 160,
  "total_lines": 351,
  "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/survey_element.py",
  "content": "# -*- coding: utf-8 -*-\n\"\"\"\nSurvey Element base class for all survey elements.\n\"\"\"\nimport json\nimport re\n\nfrom pyxform import constants\nfrom pyxform.errors import PyXFormError\nfrom pyxform.question_type_dictionary import QUESTION_TYPE_DICT\nfrom pyxform.utils import (\n    INVALID_XFORM_TAG_REGEXP,\n    is_valid_xml_tag,\n    node,\n    unicode,\n    basestring,\n    default_is_dynamic,\n)\nfrom pyxform.xls2json import print_pyobj_to_json\n\ntry:\n    from functools import lru_cache\nexcept ImportError:\n    from functools32 import lru_cache\n\n\ndef _overlay(over, under):\n    if type(under) == dict:\n        result = under.copy()\n        result.update(over)\n        return result\n    return over if over else under\n\n\nclass SurveyElement(dict):\n    \"\"\"\n    SurveyElement is the base class we'll looks for the following keys\n    in kwargs: name, label, hint, type, bind, control, parent,\n    children, and question_type_dictionary.\n    \"\"\"\n\n    # the following are important keys for the underlying dict that\n    # describes this survey element\n    FIELDS = {\n        \"name\": unicode,\n        constants.COMPACT_TAG: unicode,  # used for compact (sms) representation\n        \"sms_field\": unicode,\n        \"sms_option\": unicode,\n        \"label\": unicode,\n        \"hint\": unicode,\n        \"guidance_hint\": unicode,\n        \"default\": unicode,\n        \"type\": unicode,\n        \"appearance\": unicode,\n        \"parameters\": unicode,\n        \"intent\": unicode,\n        \"jr:count\": unicode,\n        \"bind\": dict,\n        \"instance\": dict,\n        \"control\": dict,\n        \"media\": dict,\n        # this node will also have a parent and children, like a tree!\n        \"parent\": lambda: None,\n        \"children\": list,\n        \"itemset\": unicode,\n        \"choice_filter\": unicode,\n        \"query\": unicode,\n        \"autoplay\": unicode,\n        \"flat\": lambda: False,\n        \"action\": unicode,\n        \"list_name\": unicode,\n        \"trigger\": unicode,\n    }\n\n    def _default(self):\n        # TODO: need way to override question type dictionary\n        defaults = QUESTION_TYPE_DICT\n        return defaults.get(self.get(\"type\"), {})\n\n    def __getattr__(self, key):\n        \"\"\"\n        Get attributes from FIELDS rather than the class.\n        \"\"\"\n        if key in self.FIELDS:\n            question_type_dict = self._default()\n            under = question_type_dict.get(key, None)\n            over = self.get(key)\n            if not under:\n                return over\n            return _overlay(over, under)\n        raise AttributeError(key)\n\n    def __hash__(self):\n        return hash(id(self))\n\n    @property\n    def __name__(self):\n        return \"SurveyElement\"\n\n    def __setattr__(self, key, value):\n        self[key] = value\n\n    def __init__(self, **kwargs):\n        for key, default in self.FIELDS.items():\n            self[key] = kwargs.get(key, default())\n        self._link_children()\n\n        # Create a space label for unlabeled elements with the label\n        # appearance tag. # This is because such elements are used to label the\n        # options for selects in a field-list and might want blank labels for\n        # themselves.\n        if self.control.get(\"appearance\") == \"label\" and not self.label:\n            self[\"label\"] = \" \"\n\n    def _link_children(self):\n        for child in self.children:\n            child.parent = self\n\n    def add_child(self, child):\n        self.children.append(child)\n        child.parent = self\n\n    def add_children(self, children):\n        if type(children) == list:\n            for child in children:\n                self.add_child(child)\n        else:\n            self.add_child(children)\n\n    binding_conversions = {\n        \"yes\": \"true()\",\n        \"Yes\": \"true()\",\n        \"YES\": \"true()\",\n        \"true\": \"true()\",\n        \"True\": \"true()\",\n        \"TRUE\": \"true()\",\n        \"no\": \"false()\",\n        \"No\": \"false()\",\n        \"NO\": \"false()\",\n        \"false\": \"false()\",\n        \"False\": \"false()\",\n        \"FALSE\": \"false()\",\n    }\n\n    CONVERTIBLE_BIND_ATTRIBUTES = [\n        \"readonly\",\n        \"required\",\n        \"relevant\",\n        \"constraint\",\n        \"calculate\",",
  "start_line": 1,
  "end_line": 150,
  "total_lines": 503,
  "is_truncated": true
}

{
  "status": "ok",
  "filepath": "pyxform/question_type_dictionary.py",
  "content": "# -*- coding: utf-8 -*-\n\"\"\"\nXForm survey question type mapping dictionary module.\n\"\"\"\nfrom pyxform.xls2json import QuestionTypesReader, print_pyobj_to_json\n\n\ndef generate_new_dict():\n    \"\"\"\n    This is just here incase there is ever any need to generate the question\n    type dictionary from all.xls again.\n    It shouldn't be called as part of any application.\n    \"\"\"\n    path_to_question_types = \"/pyxform/question_types/all.xls\"\n    json_dict = QuestionTypesReader(path_to_question_types).to_json_dict()\n    print_pyobj_to_json(json_dict, \"new_question_type_dict.json\")\n\n\nQUESTION_TYPE_DICT = {\n    \"q picture\": {\n        \"control\": {\"tag\": \"upload\", \"mediatype\": \"image/*\"},\n        \"bind\": {\"type\": \"binary\"},\n    },\n    \"photo\": {\n        \"control\": {\"tag\": \"upload\", \"mediatype\": \"image/*\"},\n        \"bind\": {\"type\": \"binary\"},\n    },\n    \"add date time prompt\": {\"control\": {\"tag\": \"input\"}, \"bind\": {\"type\": \"dateTime\"}},\n    \"add audio prompt\": {\n        \"control\": {\"tag\": \"upload\", \"mediatype\": \"audio/*\"},\n        \"bind\": {\"type\": \"binary\"},\n    },\n    \"q date time\": {\"control\": {\"tag\": \"input\"}, \"bind\": {\"type\": \"dateTime\"}},\n    \"phonenumber\": {\n        \"bind\": {\n            \"jr:preload\": \"property\",\n            \"type\": \"string\",\n            \"jr:preloadParams\": \"phonenumber\",\n        }\n    },\n    \"get start time\": {\n        \"bind\": {\n            \"jr:preload\": \"timestamp\",\n            \"type\": \"dateTime\",\n            \"jr:preloadParams\": \"start\",\n        }\n    },\n    \"add select multiple prompt using\": {\n        \"control\": {\"tag\": \"select\"},\n        \"bind\": {\"type\": \"string\"},\n    },\n    \"add note prompt\": {\n        \"control\": {\"tag\": \"input\"},\n        \"bind\": {\"readonly\": \"true()\", \"type\": \"string\"},\n    },\n    \"calculate\": {\"bind\": {\"type\": \"string\"}},\n    \"acknowledge\": {\"control\": {\"tag\": \"trigger\"}, \"bind\": {\"type\": \"string\"}},\n    \"location\": {\"control\": {\"tag\": \"input\"}, \"bind\": {\"type\": \"geopoint\"}},\n    \"text\": {\"control\": {\"tag\": \"input\"}, \"bind\": {\"type\": \"string\"}},\n    \"select all that apply from\": {\n        \"control\": {\"tag\": \"select\"},\n        \"bind\": {\"type\": \"string\"},\n    },\n    \"simserial\": {\n        \"bind\": {\n            \"jr:preload\": \"property\",\n            \"type\": \"string\",\n            \"jr:preloadParams\": \"simserial\",\n        }\n    },\n    \"string\": {\"control\": {\"tag\": \"input\"}, \"bind\": {\"type\": \"string\"}},\n    \"q string\": {\"control\": {\"tag\": \"input\"}, \"bind\": {\"type\": \"string\"}},\n    \"imei\": {\n        \"bind\": {\n            \"jr:preload\": \"property\",\n            \"type\": \"string\",\n            \"jr:preloadParams\": \"deviceid\",\n        }\n    },\n    \"integer\": {\"control\": {\"tag\": \"input\"}, \"bind\": {\"type\": \"int\"}},\n    \"datetime\": {\"control\": {\"tag\": \"input\"}, \"bind\": {\"type\": \"dateTime\"}},\n    \"q note\": {\n        \"control\": {\"tag\": \"input\"},\n        \"bind\": {\"readonly\": \"true()\", \"type\": \"string\"},\n    },\n    \"subscriber id\": {\n        \"bind\": {\n            \"jr:preload\": \"property\",\n            \"type\": \"string\",\n            \"jr:preloadParams\": \"subscriberid\",\n        }\n    },\n    \"decimal\": {\"control\": {\"tag\": \"input\"}, \"bind\": {\"type\": \"decimal\"}},\n    \"dateTime\": {\"control\": {\"tag\": \"input\"}, \"bind\": {\"type\": \"dateTime\"}},\n    \"q audio\": {\n        \"control\": {\"tag\": \"upload\", \"mediatype\": \"audio/*\"},\n        \"bind\": {\"type\": \"binary\"},\n    },\n    \"q geopoint\": {\"control\": {\"tag\": \"input\"}, \"bind\": {\"type\": \"geopoint\"}},\n    \"q geoshape\": {\"control\": {\"tag\": \"input\"}, \"bind\": {\"type\": \"geoshape\"}},\n    \"q geotrace\": {\"control\": {\"tag\": \"input\"}, \"bind\": {\"type\": \"geotrace\"}},\n    \"q image\": {\n        \"control\": {\"tag\": \"upload\", \"mediatype\": \"image/*\"},\n        \"bind\": {\"type\": \"binary\"},\n    },\n    \"get today\": {\n        \"bind\": {\"jr:preload\": \"date\", \"type\": \"date\", \"jr:preloadParams\": \"today\"}\n    },\n    \"video\": {\n        \"control\": {\"tag\": \"upload\", \"mediatype\": \"video/*\"},\n        \"bind\": {\"type\": \"binary\"},\n    },\n    \"q acknowledge\": {\"control\": {\"tag\": \"trigger\"}, \"bind\": {\"type\": \"string\"}},\n    \"add video prompt\": {\n        \"control\": {\"tag\": \"upload\", \"mediatype\": \"video/*\"},\n        \"bind\": {\"type\": \"binary\"},\n    },\n    \"number of days in last month\": {\n        \"control\": {\"tag\": \"input\"},\n        \"bind\": {\"type\": \"int\", \"constraint\": \"0 <= . and . <= 31\"},\n        \"hint\": \"Enter a number 0-31.\",\n    },\n    \"get sim id\": {\n        \"bind\": {\n            \"jr:preload\": \"property\",\n            \"type\": \"string\",\n            \"jr:preloadParams\": \"simserial\",\n        }\n    },\n    \"q location\": {\"control\": {\"tag\": \"input\"}, \"bind\": {\"type\": \"geopoint\"}},\n    \"select one\": {\"control\": {\"tag\": \"select1\"}, \"bind\": {\"type\": \"string\"}},\n    \"select one external\": {\"control\": {\"tag\": \"input\"}, \"bind\": {\"type\": \"string\"}},\n    \"add image prompt\": {\n        \"control\": {\"tag\": \"upload\", \"mediatype\": \"image/*\"},\n        \"bind\": {\"type\": \"binary\"},\n    },\n    \"select all that apply\": {\"control\": {\"tag\": \"select\"}, \"bind\": {\"type\": \"string\"}},\n    \"get end time\": {\n        \"bind\": {\n            \"jr:preload\": \"timestamp\",\n            \"type\": \"dateTime\",\n            \"jr:preloadParams\": \"end\",\n        }\n    },\n    \"barcode\": {\"control\": {\"tag\": \"input\"}, \"bind\": {\"type\": \"barcode\"}},\n    \"q video\": {\n        \"control\": {\"tag\": \"upload\", \"mediatype\": \"video/*\"},\n        \"bind\": {\"type\": \"binary\"},\n    },\n    \"geopoint\": {\"control\": {\"tag\": \"input\"}, \"bind\": {\"type\": \"geopoint\"}},",
  "start_line": 1,
  "end_line": 150,
  "total_lines": 377,
  "is_truncated": true
}

{
  "status": "error",
  "error_type": "CommandError",
  "error_message": "  File \"<stdin>\", line 34\n    label='calculate item label' if has_label := True else '', \n          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\nSyntaxError: expected 'else' after 'if' expression\n",
  "details": {
    "stdout": "",
    "stderr": "  File \"<stdin>\", line 34\n    label='calculate item label' if has_label := True else '', \n          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\nSyntaxError: expected 'else' after 'if' expression\n",
    "exit_code": 1
  }
}

{
  "status": "ok",
  "stdout": "No error for has_label=False\nNo error for has_label=True\n",
  "stderr": "",
  "exit_code": 0
}

{
  "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\"]:\n            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",
  "start_line": 1,
  "end_line": 150,
  "total_lines": 351,
  "is_truncated": true
}

{
  "status": "ok",
  "filepath": "pyxform/survey_element.py",
  "content": "# -*- coding: utf-8 -*-\n\"\"\"\nSurvey Element base class for all survey elements.\n\"\"\"\nimport json\nimport re\n\nfrom pyxform import constants\nfrom pyxform.errors import PyXFormError\nfrom pyxform.question_type_dictionary import QUESTION_TYPE_DICT\nfrom pyxform.utils import (\n    INVALID_XFORM_TAG_REGEXP,\n    is_valid_xml_tag,\n    node,\n    unicode,\n    basestring,\n    default_is_dynamic,\n)\nfrom pyxform.xls2json import print_pyobj_to_json\n\ntry:\n    from functools import lru_cache\nexcept ImportError:\n    from functools32 import lru_cache\n\n\ndef _overlay(over, under):\n    if type(under) == dict:\n        result = under.copy()\n        result.update(over)\n        return result\n    return over if over else under\n\n\nclass SurveyElement(dict):\n    \"\"\"\n    SurveyElement is the base class we'll looks for the following keys\n    in kwargs: name, label, hint, type, bind, control, parent,\n    children, and question_type_dictionary.\n    \"\"\"\n\n    # the following are important keys for the underlying dict that\n    # describes this survey element\n    FIELDS = {\n        \"name\": unicode,\n        constants.COMPACT_TAG: unicode,  # used for compact (sms) representation\n        \"sms_field\": unicode,\n        \"sms_option\": unicode,\n        \"label\": unicode,\n        \"hint\": unicode,\n        \"guidance_hint\": unicode,\n        \"default\": unicode,\n        \"type\": unicode,\n        \"appearance\": unicode,\n        \"parameters\": unicode,\n        \"intent\": unicode,\n        \"jr:count\": unicode,\n        \"bind\": dict,\n        \"instance\": dict,\n        \"control\": dict,\n        \"media\": dict,\n        # this node will also have a parent and children, like a tree!\n        \"parent\": lambda: None,\n        \"children\": list,\n        \"itemset\": unicode,\n        \"choice_filter\": unicode,\n        \"query\": unicode,\n        \"autoplay\": unicode,\n        \"flat\": lambda: False,\n        \"action\": unicode,\n        \"list_name\": unicode,\n        \"trigger\": unicode,\n    }\n\n    def _default(self):\n        # TODO: need way to override question type dictionary\n        defaults = QUESTION_TYPE_DICT\n        return defaults.get(self.get(\"type\"), {})\n\n    def __getattr__(self, key):\n        \"\"\"\n        Get attributes from FIELDS rather than the class.\n        \"\"\"\n        if key in self.FIELDS:\n            question_type_dict = self._default()\n            under = question_type_dict.get(key, None)\n            over = self.get(key)\n            if not under:\n                return over\n            return _overlay(over, under)\n        raise AttributeError(key)\n\n    def __hash__(self):\n        return hash(id(self))\n\n    @property\n    def __name__(self):\n        return \"SurveyElement\"\n\n    def __setattr__(self, key, value):\n        self[key] = value\n\n    def __init__(self, **kwargs):\n        for key, default in self.FIELDS.items():\n            self[key] = kwargs.get(key, default())\n        self._link_children()\n\n        # Create a space label for unlabeled elements with the label\n        # appearance tag. # This is because such elements are used to label the\n        # options for selects in a field-list and might want blank labels for\n        # themselves.\n        if self.control.get(\"appearance\") == \"label\" and not self.label:\n            self[\"label\"] = \" \"\n\n    def _link_children(self):\n        for child in self.children:\n            child.parent = self\n\n    def add_child(self, child):\n        self.children.append(child)\n        child.parent = self\n\n    def add_children(self, children):\n        if type(children) == list:\n            for child in children:\n                self.add_child(child)\n        else:\n            self.add_child(children)\n\n    binding_conversions = {\n        \"yes\": \"true()\",\n        \"Yes\": \"true()\",\n        \"YES\": \"true()\",\n        \"true\": \"true()\",\n        \"True\": \"true()\",\n        \"TRUE\": \"true()\",\n        \"no\": \"false()\",\n        \"No\": \"false()\",\n        \"NO\": \"false()\",\n        \"false\": \"false()\",\n        \"False\": \"false()\",\n        \"FALSE\": \"false()\",\n    }\n\n    CONVERTIBLE_BIND_ATTRIBUTES = [\n        \"readonly\",\n        \"required\",\n        \"relevant\",\n        \"constraint\",\n        \"calculate\",",
  "start_line": 1,
  "end_line": 150,
  "total_lines": 503,
  "is_truncated": true
}

{
  "status": "ok",
  "filepath": "pyxform/survey_element.py",
  "content": "    ]\n\n    # Supported media types for attaching to questions\n    SUPPORTED_MEDIA = [\"image\", \"audio\", \"video\"]\n\n    def validate(self):\n        if not is_valid_xml_tag(self.name):\n            invalid_char = re.search(INVALID_XFORM_TAG_REGEXP, self.name)\n            msg = (\n                \"The name '{}' is an invalid XML tag, it contains an \"\n                \"invalid character '{}'. Names must begin with a letter, \"\n                \"colon, or underscore, subsequent characters can include \"\n                \"numbers, dashes, and periods\".format(self.name, invalid_char.group(0))\n            )\n            raise PyXFormError(msg)\n\n    # TODO: Make sure renaming this doesn't cause any problems\n    def iter_descendants(self):\n        \"\"\"\n        A survey_element is a dictionary of survey_elements\n        This method does a preorder traversal over them.\n        For the time being this survery_element is included among its\n        descendants\n        \"\"\"\n        # it really seems like this method should not yield self\n        yield self\n        for e in self.children:\n            for f in e.iter_descendants():\n                yield f\n\n    @lru_cache(maxsize=None)\n    def any_repeat(self, parent_xpath):\n        \"\"\"Return True if there ia any repeat in `parent_xpath`.\"\"\"\n        for item in self.iter_descendants():\n            if item.get_xpath() == parent_xpath and item.type == constants.REPEAT:\n                return True\n\n        return False\n\n    def get_lineage(self):\n        \"\"\"\n        Return a the list [root, ..., self._parent, self]\n        \"\"\"\n        result = [self]\n        current_element = self\n        while current_element.parent:\n            current_element = current_element.parent\n            result = [current_element] + result\n        # For some reason the root element has a True flat property...\n        output = [result[0]]\n        for item in result[1:]:\n            if not item.get(\"flat\"):\n                output.append(item)\n        return output\n\n    def get_root(self):\n        return self.get_lineage()[0]\n\n    def get_xpath(self):\n        \"\"\"\n        Return the xpath of this survey element.\n        \"\"\"\n        return \"/\".join([\"\"] + [n.name for n in self.get_lineage()])\n\n    def get_abbreviated_xpath(self):\n        lineage = self.get_lineage()\n        if len(lineage) >= 2:\n            return \"/\".join([unicode(n.name) for n in lineage[1:]])\n        else:\n            return lineage[0].name\n\n    def to_json_dict(self):\n        \"\"\"\n        Create a dict copy of this survey element by removing inappropriate\n        attributes and converting its children to dicts\n        \"\"\"\n        self.validate()\n        result = self.copy()\n        to_delete = [\"parent\", \"question_type_dictionary\", \"_created\"]\n        for key in to_delete:\n            if key in result:\n                del result[key]\n        children = result.pop(\"children\")\n        result[\"children\"] = []\n        for child in children:\n            result[\"children\"].append(child.to_json_dict())\n        # remove any keys with empty values\n        for k, v in list(result.items()):\n            if not v:\n                del result[k]\n\n        return result\n\n    def to_json(self):\n        return json.dumps(self.to_json_dict())\n\n    def json_dump(self, path=\"\"):\n        if not path:\n            path = self.name + \".json\"\n        print_pyobj_to_json(self.to_json_dict(), path)\n\n    def __eq__(self, y):\n        return (\n            hasattr(y, \"to_json_dict\")\n            and callable(y.to_json_dict)\n            and self.to_json_dict() == y.to_json_dict()\n        )\n\n    def _translation_path(self, display_element):\n        return self.get_xpath() + \":\" + display_element\n\n    def get_translations(self, default_language):\n        \"\"\"\n        Returns translations used by this element so they can be included in\n        the <itext> block. @see survey._setup_translations\n        \"\"\"\n        bind_dict = self.get(\"bind\")\n        if bind_dict and type(bind_dict) is dict:\n            constraint_msg = bind_dict.get(\"jr:constraintMsg\")\n            if type(constraint_msg) is dict:\n                for lang, text in constraint_msg.items():\n                    yield {\n                        \"path\": self._translation_path(\"jr:constraintMsg\"),\n                        \"lang\": lang,\n                        \"text\": text,\n                        \"output_context\": self,\n                    }\n            required_msg = bind_dict.get(\"jr:requiredMsg\")\n            if type(required_msg) is dict:\n                for lang, text in required_msg.items():\n                    yield {\n                        \"path\": self._translation_path(\"jr:requiredMsg\"),\n                        \"lang\": lang,\n                        \"text\": text,\n                        \"output_context\": self,\n                    }\n            no_app_error_string = bind_dict.get(\"jr:noAppErrorString\")\n            if type(no_app_error_string) is dict:\n                for lang, text in no_app_error_string.items():\n                    yield {\n                        \"path\": self._translation_path(\"jr:noAppErrorString\"),\n                        \"lang\": lang,\n                        \"text\": text,\n                        \"output_context\": self,\n                    }\n\n        for display_element in [\"label\", \"hint\", \"guidance_hint\"]:\n            label_or_hint = self[display_element]\n\n            if (",
  "start_line": 151,
  "end_line": 300,
  "total_lines": 503,
  "is_truncated": true
}

{
  "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:])\n                    parts = xpath_parts[index:]\n                    break\n                else:\n                    parts = remainder_xpath.split(\"/\")[index + 2 :]\n            except IndexError:\n                steps = len(context_parts[index - 1 :])\n                parts = xpath_parts[index - 1 :]\n                break\n        return (steps, \"/\" + \"/\".join(parts) if parts else remainder_xpath)\n\n    context_parent = is_parent_a_repeat(survey, context_xpath)\n    xpath_parent = is_parent_a_repeat(survey, xpath)\n    if context_parent and xpath_parent and xpath_parent in context_parent:\n        include_parent = False\n        if not context_parent == xpath_parent and reference_parent:\n            context_shared_ancestor = is_parent_a_repeat(survey, context_parent)\n            if context_shared_ancestor == xpath_parent:\n                # Check if context_parent is a child repeat of the xpath_parent\n                # If the context_parent is a child of the xpath_parent reference the entire\n                # xpath_parent in the generated nodeset\n                include_parent = True\n                context_parent = context_shared_ancestor\n        return _get_steps_and_target_xpath(context_parent, xpath_parent, include_parent)\n    elif context_parent and xpath_parent:\n        # Check if context_parent and xpath_parent share a common\n        # repeat ancestor\n        context_shared_ancestor = is_parent_a_repeat(survey, context_parent)\n        xpath_shared_ancestor = is_parent_a_repeat(survey, xpath_parent)\n\n        if (\n            xpath_shared_ancestor\n            and context_shared_ancestor\n            and xpath_shared_ancestor == context_shared_ancestor\n        ):\n            return _get_steps_and_target_xpath(\n                context_shared_ancestor, xpath_shared_ancestor\n            )\n\n    return (None, None)\n\n\nclass Survey(Section):\n    \"\"\"\n    Survey class - represents the full XForm XML.\n    \"\"\"\n\n    FIELDS = Section.FIELDS.copy()\n    FIELDS.update(\n        {\n            \"_xpath\": dict,",
  "start_line": 1,
  "end_line": 150,
  "total_lines": 1046,
  "is_truncated": true
}

{
  "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\">\n          <select1 ref=\".\">\n            <label ref=\"jr:itext('fav')\" />\n            <item><label ref=\"jr:itext('red')\" /><value>red</value></item>\n            <item><label ref=\"jr:itext('green')\" /><value>green</value></item>\n            <item><label ref=\"jr:itext('blue')\" /><value>blue</value></item>\n          </select1>\n        </repeat>\n        </group>\n        \"\"\"\n        control_dict = self.control.copy()\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        repeat_node = node(\"repeat\", nodeset=self.get_xpath(), **control_dict)\n\n        for n in Section.xml_control(self):\n            repeat_node.appendChild(n)\n\n        setvalue_nodes = self._get_setvalue_nodes_for_dynamic_defaults()\n\n        for setvalue_node in setvalue_nodes:\n            repeat_node.appendChild(setvalue_node)\n\n        label = self.xml_label()\n        if label:\n            return node(\"group\", self.xml_label(), repeat_node, ref=self.get_xpath())\n        return node(\"group\", repeat_node, ref=self.get_xpath(), **self.control)\n\n    # Get setvalue nodes for all descendants of this repeat that have dynamic defaults and aren't nested in other repeats.\n    def _get_setvalue_nodes_for_dynamic_defaults(self):\n        setvalue_nodes = []\n        self._dynamic_defaults_helper(self, setvalue_nodes)\n        return setvalue_nodes\n\n    def _dynamic_defaults_helper(self, current, nodes):\n        for e in current.children:\n            if e.type != \"repeat\":  # let nested repeats handle their own defaults\n                dynamic_default = e.get_setvalue_node_for_dynamic_default(\n                    in_repeat=True\n                )\n                if dynamic_default:\n                    nodes.append(dynamic_default)\n                self._dynamic_defaults_helper(e, nodes)\n\n    # I'm anal about matching function signatures when overriding a function,\n    # but there's no reason for kwargs to be an argument\n    def template_instance(self, **kwargs):\n        return super(RepeatingSection, self).generate_repeating_template(**kwargs)\n",
  "start_line": 1,
  "end_line": 150,
  "total_lines": 203,
  "is_truncated": true
}