Repository: XLSForm/pyxform
Pull request #400 (2019-11-28 11:11:52)

Add track-changes-reason audit attribute
This adds the `track-changes-reasons` as defined in [this spec](https://docs.google.com/document/d/1NyBFhASCOAqOSmz70diQObKpymVE59_MuwjOUPCKlR8/edit#).


Patch:
diff --git a/README.rst b/README.rst
index d040423..e29059f 100644
--- a/README.rst
+++ b/README.rst
@@ -77,16 +77,25 @@ You can then run xls2xform from the commandline::
 
     xls2xform path_to_XLSForm [output_path]
 
-Testing
-=======
-To make sure the install worked out, you can do the following::
+Development
+===========
+To set up for development/contributing::
 
-    pip install nose==1.0.0
+    pip install -r requirements.pip
+
+    python setup.py develop
 
     cd your-virtual-env-dir/src/pyxform
 
+You can run tests with::
+
     nosetests
 
+
+Before committing, make sure to format your code using `black`::
+
+    black --target-version=py27 pyxform
+
 Documentation
 =============
 To check out the documentation for pyxform do the following::
@@ -127,5 +136,3 @@ Releasing pyxform
 10. Publish release to PyPI with ``twine``::
 
     $ twine upload dist/pyxform-0.15.0-py2.py3-none-any.whl dist/pyxform-0.15.0.tar.gz
-
-
diff --git a/docs/source/conf.py b/docs/source/conf.py
index c7c928c..ecd6adc 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -16,194 +16,199 @@ import sys, os
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+# sys.path.insert(0, os.path.abspath('.'))
 
 # -- General configuration -----------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc']
+extensions = ["sphinx.ext.autodoc"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'pyxform'
-copyright = u'2011, Columbia University, Modi Research Group'
+project = u"pyxform"
+copyright = u"2011, Columbia University, Modi Research Group"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '0.5'
+version = "0.5"
 # The full version, including alpha/beta/rc tags.
-release = '0.5'
+release = "0.5"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-#language = None
+# language = None
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ''
+# today = ''
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 exclude_patterns = []
 
 # The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
+# default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
 
 
 # -- Options for HTML output ---------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+html_theme = "default"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+# html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+# html_theme_path = []
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+# html_title = None
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
+# html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+# html_logo = None
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+# html_favicon = None
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+# html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-#html_additional_pages = {}
+# html_additional_pages = {}
 
 # If false, no module index is generated.
-#html_domain_indices = True
+# html_domain_indices = True
 
 # If false, no index is generated.
-#html_use_index = True
+# html_use_index = True
 
 # If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+# html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'pyxformdoc'
+htmlhelp_basename = "pyxformdoc"
 
 
 # -- Options for LaTeX output --------------------------------------------------
 
 # The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
+# latex_paper_size = 'letter'
 
 # The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
+# latex_font_size = '10pt'
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'pyxform.tex', u'pyxform Documentation',
-   u'Columbia University, Modi Research Group', 'manual'),
+    (
+        "index",
+        "pyxform.tex",
+        u"pyxform Documentation",
+        u"Columbia University, Modi Research Group",
+        "manual",
+    ),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
 
 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False
 
 # If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False
 
 # Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
+# latex_preamble = ''
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True
 
 
 # -- Options for manual page output --------------------------------------------
@@ -211,6 +216,11 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'pyxform', u'pyxform Documentation',
-     [u'Columbia University, Modi Research Group'], 1)
+    (
+        "index",
+        "pyxform",
+        u"pyxform Documentation",
+        [u"Columbia University, Modi Research Group"],
+        1,
+    )
 ]
diff --git a/pyxform/constants.py b/pyxform/constants.py
index 982587f..4dd878a 100644
--- a/pyxform/constants.py
+++ b/pyxform/constants.py
@@ -95,6 +95,7 @@ LOCATION_MIN_INTERVAL = "location-min-interval"
 LOCATION_MAX_AGE = "location-max-age"
 TRACK_CHANGES = "track-changes"
 IDENTIFY_USER = "identify-user"
+TRACK_CHANGES_REASONS = "track-changes-reasons"
 
 # supported bind keywords for which external instances will be created for pulldata function
 EXTERNAL_INSTANCES = ["calculate", "constraint", "readonly", "required", "relevant"]
diff --git a/pyxform/xls2json.py b/pyxform/xls2json.py
index a212e3f..efe27f2 100644
--- a/pyxform/xls2json.py
+++ b/pyxform/xls2json.py
@@ -657,6 +657,7 @@ def workbook_to_json(
                     constants.LOCATION_MAX_AGE,
                     constants.TRACK_CHANGES,
                     constants.IDENTIFY_USER,
+                    constants.TRACK_CHANGES_REASONS,
                 ],
             )
 
@@ -680,6 +681,17 @@ def workbook_to_json(
                         }
                     )
 
+            if constants.TRACK_CHANGES_REASONS in parameters.keys():
+                if parameters[constants.TRACK_CHANGES_REASONS] != "on-form-edit":
+                    raise PyXFormError(
+                        constants.TRACK_CHANGES_REASONS + " must be set to on-form-edit"
+                    )
+                else:
+                    new_dict["bind"] = new_dict.get("bind", {})
+                    new_dict["bind"].update(
+                        {"odk:" + constants.TRACK_CHANGES_REASONS: "on-form-edit"}
+                    )
+
             if constants.IDENTIFY_USER in parameters.keys():
                 if (
                     parameters[constants.IDENTIFY_USER] != "true"
diff --git a/pyxform/xls2json_backends.py b/pyxform/xls2json_backends.py
index 6f4b7a5..752bc02 100644
--- a/pyxform/xls2json_backends.py
+++ b/pyxform/xls2json_backends.py
@@ -210,17 +210,19 @@ def xls_to_dict(path_or_file):
         # Do not process sheets that have nothing to do with XLSForm.
         if sheet.name not in constants.SUPPORTED_SHEET_NAMES:
             if len(workbook.sheets()) == 1:
-                result[constants.SURVEY], result[
-                    "%s_header" % constants.SURVEY
-                ] = xls_to_dict_normal_sheet(sheet)
+                (
+                    result[constants.SURVEY],
+                    result["%s_header" % constants.SURVEY],
+                ) = xls_to_dict_normal_sheet(sheet)
             else:
                 continue
         if sheet.name == constants.CASCADING_CHOICES:
             result[sheet.name] = _xls_to_dict_cascade_sheet(sheet)
         else:
-            result[sheet.name], result[
-                "%s_header" % sheet.name
-            ] = xls_to_dict_normal_sheet(sheet)
+            (
+                result[sheet.name],
+                result["%s_header" % sheet.name],
+            ) = xls_to_dict_normal_sheet(sheet)
 
     return result
 


Test patch:
diff --git a/pyxform/tests_v1/test_audit.py b/pyxform/tests_v1/test_audit.py
index a9bc544..9ffa5cf 100644
--- a/pyxform/tests_v1/test_audit.py
+++ b/pyxform/tests_v1/test_audit.py
@@ -218,8 +218,8 @@ class AuditTest(PyxformTestCase):
         self.assertPyxformXform(
             name="meta_audit",
             md="""
-            | survey |        |          |                    |
-            |        | type   |   name   | parameters         |
+            | survey |        |          |                     |
+            |        | type   |   name   | parameters          |
             |        | audit  |   audit  | identify-user=false |
             """,
             xml__contains=[
@@ -230,6 +230,34 @@ class AuditTest(PyxformTestCase):
             ],
         )
 
+    def test_audit_track_changes_reasons_foo(self):
+        self.assertPyxformXform(
+            name="meta_audit",
+            md="""
+            | survey |        |          |                          |
+            |        | type   |   name   | parameters               |
+            |        | audit  |   audit  | track-changes-reasons=foo |
+            """,
+            errored=True,
+            error__contains=["track-changes-reasons must be set to on-form-edit"],
+        )
+
+    def test_audit_track_changes_reasons_on_form_edit(self):
+        self.assertPyxformXform(
+            name="meta_audit",
+            md="""
+            | survey |        |          |                          |
+            |        | type   |   name   | parameters               |
+            |        | audit  |   audit  | track-changes-reasons=on-form-edit |
+            """,
+            xml__contains=[
+                "<meta>",
+                "<audit/>",
+                "</meta>",
+                '<bind nodeset="/meta_audit/meta/audit" type="binary" odk:track-changes-reasons="on-form-edit"/>',
+            ],
+        )
+
     def test_audit_location_track_changes(self):
         self.assertPyxformXform(
             name="meta_audit",