Skip to content

Commit ba8817f

Browse files
lognaturellognaturel
authored
Merge pull request #832 from lindsay-stevens/pyxform-817
817: Add configurability to range question type
2 parents 98954a1 + ac82bd6 commit ba8817f

7 files changed

Lines changed: 1241 additions & 172 deletions

File tree

‎pyxform/errors.py‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -390,6 +390,100 @@ class ErrorCode(Enum):
390390
"'{q}' appears more than once."
391391
),
392392
)
393+
RANGE_001 = Detail(
394+
name="Range type - parameter is not a number",
395+
msg=(
396+
"[row : {row}] On the 'survey' sheet, the 'parameters' value is invalid. "
397+
"For the 'range' question type, the parameter '{name}' must be a number."
398+
),
399+
)
400+
RANGE_002 = Detail(
401+
name="Range type - parameter is zero",
402+
msg=(
403+
"[row : {row}] On the 'survey' sheet, the 'parameters' value is invalid. "
404+
"For the 'range' question type, the parameter '{name}' must not be '0' (zero)."
405+
),
406+
)
407+
RANGE_003 = Detail(
408+
name="Range type - parameter larger than range",
409+
msg=(
410+
"[row : {row}] On the 'survey' sheet, the 'parameters' value is invalid. "
411+
"For the 'range' question type, the parameter '{name}' must not be larger than "
412+
"the range (the difference between 'start' and 'end')."
413+
),
414+
)
415+
RANGE_004 = Detail(
416+
name="Range type - parameter not a multiple of tick",
417+
msg=(
418+
"[row : {row}] On the 'survey' sheet, the 'parameters' value is invalid. "
419+
"For the 'range' question type, the parameter '{name}' must be a multiple of 'step'."
420+
),
421+
)
422+
RANGE_005 = Detail(
423+
name="Range type - parameter outside range",
424+
msg=(
425+
"[row : {row}] On the 'survey' sheet, the 'parameters' value is invalid. "
426+
"For the 'range' question type, the parameter '{name}' must be "
427+
"between the 'start' and 'end' values, inclusive)."
428+
),
429+
)
430+
RANGE_006 = Detail(
431+
name="Range type - tick_labelset not found",
432+
msg=(
433+
"[row : {row}] On the 'survey' sheet, the 'parameters' value is invalid. "
434+
"For the 'range' question type, the parameter 'tick_labelset' must be a "
435+
"choice list name from the 'list_name' column on the choices sheet."
436+
),
437+
)
438+
RANGE_007 = Detail(
439+
name="Range type - tick_labelset too many choices with no-ticks",
440+
msg=(
441+
"[row : {row}] On the 'survey' sheet, the 'parameters' value is invalid. "
442+
"For the 'range' question type, the parameter 'tick_labelset' choice list "
443+
"must have only 2 items when the 'appearance' is 'no-ticks'."
444+
),
445+
)
446+
RANGE_008 = Detail(
447+
name="Range type - parameter not compatible with appearance",
448+
msg=(
449+
"[row : {row}] On the 'survey' sheet, the 'parameters' value is invalid. "
450+
"For the 'range' question type, the parameters 'tick_interval', 'placeholder', "
451+
"and 'tick_labelset' are only supported for the appearances 'vertical', 'no-ticks' "
452+
"and the default (empty) horizontal."
453+
),
454+
)
455+
RANGE_009 = Detail(
456+
name="Range type - tick_labelset choice is not a number",
457+
msg=(
458+
"[row : {row}] On the 'survey' sheet, the 'parameters' value is invalid. "
459+
"For the 'range' question type, the parameter '{tick_labelset}' choices must "
460+
"all be numbers."
461+
),
462+
)
463+
RANGE_010 = Detail(
464+
name="Range type - tick_labelset choice outside range",
465+
msg=(
466+
"[row : {row}] On the 'survey' sheet, the 'parameters' value is invalid. "
467+
"For the 'range' question type, the parameter 'tick_labelset' choices must "
468+
"be between the 'start' and 'end' values, inclusive."
469+
),
470+
)
471+
RANGE_011 = Detail(
472+
name="Range type - tick_labelset choice not a multiple of tick",
473+
msg=(
474+
"[row : {row}] On the 'survey' sheet, the 'parameters' value is invalid. "
475+
"For the 'range' question type, the parameter 'tick_labelset' choices' must "
476+
"be equal to the start of the range plus a multiple of '{name}'."
477+
),
478+
)
479+
RANGE_012 = Detail(
480+
name="Range type - tick_labelset choices not start/end for no-ticks",
481+
msg=(
482+
"[row : {row}] On the 'survey' sheet, the 'parameters' value is invalid. "
483+
"For the 'range' question type, the parameter 'tick_labelset' choice list "
484+
"match the range 'start' and 'end' values when the 'appearance' is 'no-ticks'."
485+
),
486+
)
393487
SURVEY_001 = Detail(
394488
name="Survey sheet - unmatched group/repeat/loop end",
395489
msg=(

‎pyxform/question_type_dictionary.py‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -356,7 +356,11 @@
356356
"control": {"tag": "upload", "mediatype": "application/*"},
357357
"bind": {"type": "binary"},
358358
},
359-
"range": {"control": {"tag": "range"}, "bind": {"type": "int"}},
359+
"range": {
360+
"control": {"tag": "range"},
361+
"bind": {"type": "int"},
362+
"parameters": {"start": "1", "end": "10", "step": "1"},
363+
},
360364
"audit": {"bind": {"type": "binary"}},
361365
"xml-external": {
362366
# Only effect is to add an external instance.

‎pyxform/validators/pyxform/parameters_generic.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,13 @@ def parse(raw_parameters: str) -> PARAMETERS_TYPE:
1919

2020
params = {}
2121
for param in parts:
22-
if "=" not in param:
22+
kv_split = param.split("=")
23+
if "=" not in param or len(kv_split) != 2:
2324
raise PyXFormError(
2425
"Expecting parameters to be in the form of "
2526
"'parameter1=value parameter2=value'."
2627
)
27-
k, v = param.split("=")[:2]
28+
k, v = kv_split
2829
key = maybe_strip(k.lower())
2930
params[key] = v if key in CASE_SENSITIVE_VALUES else maybe_strip(v.lower())
3031

‎pyxform/validators/pyxform/question_types.py‎

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,14 @@
33
"""
44

55
from collections.abc import Collection, Iterable
6+
from decimal import Decimal, InvalidOperation
7+
from math import isinf
8+
from typing import Any
69

710
from pyxform import aliases
811
from pyxform.errors import ErrorCode, PyXFormError
12+
from pyxform.question_type_dictionary import QUESTION_TYPE_DICT
13+
from pyxform.validators.pyxform import parameters_generic
914
from pyxform.validators.pyxform.pyxform_reference import (
1015
is_pyxform_reference_candidate,
1116
parse_pyxform_references,
@@ -100,3 +105,140 @@ def validate_geo_parameter_incremental(value: str) -> None:
100105
raise PyXFormError(
101106
code=ErrorCode.SURVEY_003,
102107
)
108+
109+
110+
def process_range_question_type(
111+
row_number: int,
112+
row: dict[str, Any],
113+
parameters: parameters_generic.PARAMETERS_TYPE,
114+
appearance: str,
115+
choices: dict[str, Any],
116+
) -> dict[str, Any]:
117+
"""
118+
Returns a new row that includes the Range parameters start, end and step.
119+
120+
Raises PyXFormError when invalid range parameters are used.
121+
"""
122+
parameters = parameters_generic.validate(
123+
parameters=parameters,
124+
allowed={"start", "end", "step", "tick_interval", "placeholder", "tick_labelset"},
125+
)
126+
if (
127+
appearance
128+
and appearance not in {"vertical", "no-ticks"}
129+
and any(
130+
k in parameters for k in ("tick_interval", "placeholder", "tick_labelset")
131+
)
132+
):
133+
raise PyXFormError(ErrorCode.RANGE_008.value.format(row=row_number))
134+
no_ticks_appearance = appearance and appearance == "no-ticks"
135+
136+
defaults = QUESTION_TYPE_DICT["range"]["parameters"]
137+
# set defaults
138+
for key in defaults:
139+
if key not in parameters:
140+
parameters[key] = defaults[key]
141+
142+
def process_parameter(name: str) -> Decimal | None:
143+
value = parameters.get(name)
144+
if value is None:
145+
return value
146+
err = False
147+
try:
148+
value = Decimal(value)
149+
except InvalidOperation:
150+
err = True
151+
152+
if err or isinf(value):
153+
raise PyXFormError(
154+
ErrorCode.RANGE_001.value.format(row=row_number, name=name)
155+
)
156+
return value
157+
158+
start = process_parameter(name="start")
159+
end = process_parameter(name="end")
160+
step = process_parameter(name="step")
161+
tick_interval = process_parameter(name="tick_interval")
162+
placeholder = process_parameter(name="placeholder")
163+
tick_labelset = parameters.get("tick_labelset")
164+
range_width = abs(end - start)
165+
166+
if step == 0:
167+
raise PyXFormError(ErrorCode.RANGE_002.value.format(row=row_number, name="step"))
168+
if step > range_width:
169+
raise PyXFormError(ErrorCode.RANGE_003.value.format(row=row_number, name="step"))
170+
171+
if tick_interval is not None:
172+
if tick_interval == 0:
173+
raise PyXFormError(
174+
ErrorCode.RANGE_002.value.format(row=row_number, name="tick_interval")
175+
)
176+
if tick_interval > range_width:
177+
raise PyXFormError(
178+
ErrorCode.RANGE_003.value.format(row=row_number, name="tick_interval")
179+
)
180+
if (tick_interval % step) != 0:
181+
raise PyXFormError(
182+
ErrorCode.RANGE_004.value.format(row=row_number, name="tick_interval")
183+
)
184+
parameters["odk:tick-interval"] = parameters.pop("tick_interval")
185+
186+
if placeholder is not None:
187+
if (placeholder - start) % step != 0:
188+
raise PyXFormError(
189+
ErrorCode.RANGE_004.value.format(row=row_number, name="placeholder")
190+
)
191+
if placeholder < min(start, end) or placeholder > max(start, end):
192+
raise PyXFormError(
193+
ErrorCode.RANGE_005.value.format(row=row_number, name="placeholder")
194+
)
195+
parameters["odk:placeholder"] = parameters.pop("placeholder")
196+
197+
if tick_labelset:
198+
tick_list = choices.get(tick_labelset)
199+
if tick_list is None:
200+
raise PyXFormError(ErrorCode.RANGE_006.value.format(row=row_number))
201+
202+
no_ticks_labels = set()
203+
for item in tick_list:
204+
errored = False
205+
try:
206+
value = Decimal(item.get("name"))
207+
except InvalidOperation:
208+
errored = True
209+
210+
if errored or isinf(value):
211+
raise PyXFormError(ErrorCode.RANGE_009.value.format(row=row_number))
212+
213+
if value < min(start, end) or value > max(start, end):
214+
raise PyXFormError(ErrorCode.RANGE_010.value.format(row=row_number))
215+
if tick_interval is not None and (value - start) % tick_interval != 0:
216+
raise PyXFormError(
217+
ErrorCode.RANGE_011.value.format(row=row_number, name="tick_interval")
218+
)
219+
elif (value - start) % step != 0:
220+
raise PyXFormError(
221+
ErrorCode.RANGE_011.value.format(row=row_number, name="step")
222+
)
223+
if no_ticks_appearance:
224+
no_ticks_labels.add(value)
225+
226+
if no_ticks_appearance:
227+
if len(no_ticks_labels) > 2:
228+
raise PyXFormError(ErrorCode.RANGE_007.value.format(row=row_number))
229+
if no_ticks_labels != {start, end}:
230+
raise PyXFormError(ErrorCode.RANGE_012.value.format(row=row_number))
231+
232+
parameters["odk:tick-labelset"] = parameters.pop("tick_labelset")
233+
234+
# Default is integer, but if the values have decimals then change the bind type.
235+
if any(
236+
i is not None and not i == i.to_integral_value()
237+
for i in (start, end, step, tick_interval, placeholder)
238+
):
239+
row["bind"] = row.get("bind", {})
240+
row["bind"].update({"type": "decimal"})
241+
242+
row["parameters"] = parameters
243+
244+
return row

‎pyxform/xls2json.py‎

Lines changed: 10 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -132,47 +132,6 @@ def add_flat_annotations(prompt_list, parent_relevant="", name_prefix=""):
132132
# prompt['name'] = name_prefix + prompt['name']
133133

134134

135-
def process_range_question_type(
136-
row: dict[str, Any], parameters: parameters_generic.PARAMETERS_TYPE
137-
) -> dict[str, Any]:
138-
"""
139-
Returns a new row that includes the Range parameters start, end and step.
140-
141-
Raises PyXFormError when invalid range parameters are used.
142-
"""
143-
new_dict = row.copy()
144-
parameters = parameters_generic.validate(
145-
parameters=parameters, allowed=("start", "end", "step")
146-
)
147-
parameters_map = {"start": "start", "end": "end", "step": "step"}
148-
defaults = {"start": "1", "end": "10", "step": "1"}
149-
150-
# set defaults
151-
for key in parameters_map.values():
152-
if key not in parameters:
153-
parameters[key] = defaults[key]
154-
155-
has_float = False
156-
try:
157-
# Check all parameters.
158-
for x in parameters.values():
159-
if float(x) and "." in str(x):
160-
has_float = True
161-
except ValueError as range_err:
162-
raise PyXFormError(
163-
"Range parameters 'start', 'end' or 'step' must all be numbers."
164-
) from range_err
165-
else:
166-
# is integer by default, convert to decimal if it has any float values
167-
if has_float:
168-
new_dict["bind"] = new_dict.get("bind", {})
169-
new_dict["bind"].update({"type": "decimal"})
170-
171-
new_dict["parameters"] = parameters
172-
173-
return new_dict
174-
175-
176135
def process_image_default(default_value):
177136
# prepend image files with the correct prefix, if they don't have it.
178137
image_jr_prefix = "jr://images/"
@@ -519,6 +478,7 @@ def workbook_to_json(
519478

520479
# Get question type
521480
question_type = row.get(constants.TYPE)
481+
appearance = row.get("control", {}).get("appearance")
522482

523483
if not question_type:
524484
# if name and label are also missing,
@@ -888,10 +848,8 @@ def workbook_to_json(
888848

889849
# Code to deal with table_list appearance flags
890850
# (for groups of selects)
891-
ctrl_ap = new_json_dict.get("control", {}).get("appearance")
892-
893-
if ctrl_ap:
894-
appearance_mods_as_list = ctrl_ap.split()
851+
if appearance:
852+
appearance_mods_as_list = appearance.split()
895853
if constants.TABLE_LIST in appearance_mods_as_list:
896854
# Table List modifier should add field list to the new dict,
897855
# as well as appending other appearance modifiers.
@@ -1195,7 +1153,13 @@ def workbook_to_json(
11951153

11961154
# range question_type
11971155
if question_type == "range":
1198-
new_dict = process_range_question_type(row=row, parameters=parameters)
1156+
new_dict = qt.process_range_question_type(
1157+
row_number=row_number,
1158+
row=row,
1159+
parameters=parameters,
1160+
appearance=appearance,
1161+
choices=choices,
1162+
)
11991163
parent_children_array.append(new_dict)
12001164
continue
12011165

@@ -1247,7 +1211,6 @@ def workbook_to_json(
12471211
)
12481212

12491213
if "app" in parameters:
1250-
appearance = row.get("control", {}).get("appearance")
12511214
if appearance is None or appearance == "annotate":
12521215
app_package_name = str(parameters["app"])
12531216
validation_result = validate_android_package_name(app_package_name)

0 commit comments

Comments
 (0)