Implement UnitTesting for UI Units handling, and improve it #39267

New Issue

Bastien Montagne · 2014-03-19T16:37:42+01:00

Bastien Montagne commented

2014-03-19 16:37:42 +01:00

Implement UnitTesting for UI Units handling, and improve it

So, related to #38722 and proposed fix (D340), I talked a bit with Campbell and he suggested to first expose 'units' in bpy, and create a test for it.

Test should gather a bunch of expressions and their desired result, to check what's currently working, what’s currently broken, and how this change when we modify underlying C code.

I made a quick prototype for this: D416. For now, it only contains trivial tests (two input, one know as broken, and one output). The main purpose of this design task is to gather a representative set of inputs (text to value) and outputs (value to text), that would made a good testing base for this code.

API

Exposed in bpy.utils.units. For now, I kept it simple:

*str_to_value(unit_system, unit_type, str_input, str_ref_unit=None) to parse string into a float value.
*value_to_str(unit_system, unit_type, value, precision=3, split_unit=False, compatible_unit=False) to print a float value into a string with units.
*systems is a named tuple gathering all known unit systems ('NONE', 'METRIC', etc.).
*types is a named tuple gathering all known unit types ('LENGTH', 'AREA', 'ROTATION', etc.).

Tests

Tests are a mere tuple of tuples.

For each input test, you have:

  (unit_system,     # 'NONE', 'METRIC' or 'IMPERIAL'.
   unit_type,       # E.g. 'LENGTH', 'AREA', 'ROTATION', etc.
   ref_string,      # optional (can be empty), a reference string from which to take a unit, if none is found in str

                  # (e.g. for num buttons, it is the previous string displayed...).

   str,             # The string to convert to a float value.
   expected_value,  # The expected value.
  )

This mimics current parameters of new bpy.utils.units.str_to_value function.
E.g.: ('IMPERIAL', 'LENGTH', "", "1ft", 0.3048)

For each output test, you have:

  (unit_system,   # As above.
   unit_type,     # As above.
   precision,     # Number of digits after the comma.
   split_unit,    # If True, output e.g. '1m1cm', else output e.g. '1.01m'.
   compat_unit,   # If True, only use simple chars in units (e.g. '1m2'), else use nicer ones (e.g. '1m²').
   value,         # Input value to convert to a string.
   expected_str,  # Expected string result.
  )

This mimics current parameters of new bpy.utils.units.value_to_str function.
E.g.: ('IMPERIAL', 'LENGTH', 3, False, False, 0.3048, "1'")

# Implement UnitTesting for UI Units handling, and improve it So, related to #38722 and proposed fix ([D340](https://archive.blender.org/developer/D340)), I talked a bit with Campbell and he suggested to first expose 'units' in bpy, and create a test for it. Test should gather a bunch of expressions and their desired result, to check what's currently working, what’s currently broken, and how this change when we modify underlying C code. I made a quick prototype for this: [D416](https://archive.blender.org/developer/D416). For now, it only contains trivial tests (two input, one know as broken, and one output). The main purpose of this design task is to gather a representative set of inputs (text to value) and outputs (value to text), that would made a good testing base for this code. ## API Exposed in `bpy.utils.units`. For now, I kept it simple: *`str_to_value(unit_system, unit_type, str_input, str_ref_unit=None)` to parse string into a float value. *`value_to_str(unit_system, unit_type, value, precision=3, split_unit=False, compatible_unit=False)` to print a float value into a string with units. *`systems` is a named tuple gathering all known unit systems ('NONE', 'METRIC', etc.). *`types` is a named tuple gathering all known unit types ('LENGTH', 'AREA', 'ROTATION', etc.). ## Tests Tests are a mere tuple of tuples. For each input test, you have: ``` (unit_system, # 'NONE', 'METRIC' or 'IMPERIAL'. unit_type, # E.g. 'LENGTH', 'AREA', 'ROTATION', etc. ref_string, # optional (can be empty), a reference string from which to take a unit, if none is found in str ``` # (e.g. for num buttons, it is the previous string displayed...). ``` str, # The string to convert to a float value. expected_value, # The expected value. ) ``` This mimics current parameters of new `bpy.utils.units.str_to_value` function. E.g.: `('IMPERIAL', 'LENGTH', "", "1ft", 0.3048)` For each output test, you have: ``` (unit_system, # As above. unit_type, # As above. precision, # Number of digits after the comma. split_unit, # If True, output e.g. '1m1cm', else output e.g. '1.01m'. compat_unit, # If True, only use simple chars in units (e.g. '1m2'), else use nicer ones (e.g. '1m²'). value, # Input value to convert to a string. expected_str, # Expected string result. ) ``` This mimics current parameters of new `bpy.utils.units.value_to_str` function. E.g.: `('IMPERIAL', 'LENGTH', 3, False, False, 0.3048, "1'")`

Bastien Montagne commented

2014-03-19 16:37:42 +01:00

Changed status to: 'Open'

Bastien Montagne self-assigned this 2014-03-19 16:37:42 +01:00

Bastien Montagne commented

2014-03-19 16:37:42 +01:00

Added subscribers: @mont29, @JonathanWilliamson, @ideasman42