Fix T38722: Adding units in Imperial setting results in inconsistent values
[blender.git] / tests / python / bl_pyapi_units.py
1 # Apache License, Version 2.0
2
3 # ./blender.bin --background -noaudio --python tests/python/bl_pyapi_units.py
4 import unittest
5 from test import support
6
7 from bpy.utils import units
8
9 class UnitsTesting(unittest.TestCase):
10     # From user typing to 'internal' Blender value.
11     INPUT_TESTS = (
12         # system,    type,    ref, input, value
13         ##### LENGTH
14         ('IMPERIAL', 'LENGTH', "", "1ft", 0.3048),
15         ('IMPERIAL', 'LENGTH', "", "(1+1)ft", 0.3048 * 2),
16         ('IMPERIAL', 'LENGTH', "", "1mi4\"", 1609.344 + 0.0254 * 4),
17         ('METRIC',   'LENGTH', "", "0.005┬Ám", 0.000001 * 0.005),
18         ('METRIC',   'LENGTH', "", "1e6km", 1000.0 * 1e6),
19         ('IMPERIAL', 'LENGTH', "", "1ft5cm", 0.3048 + 0.01 * 5),
20         ('METRIC',   'LENGTH', "", "1ft5cm", 0.3048 + 0.01 * 5),
21         # Using reference string to find a unit when none is given.
22         ('IMPERIAL', 'LENGTH', "33.3ft", "1", 0.3048),
23         ('METRIC',   'LENGTH', "33.3dm", "1", 0.1),
24         ('IMPERIAL', 'LENGTH', "33.3cm", "1", 0.3048),  # ref unit is not in IMPERIAL system, default to feet...
25         ('IMPERIAL', 'LENGTH', "33.3ft", "1\"", 0.0254),  # unused ref unit, since one is given already!
26         ('IMPERIAL', 'LENGTH', "", "1+1ft", 0.3048 * 2),  # default unit taken from current string (feet).
27         ('METRIC',   'LENGTH', "", "1+1ft", 1.3048),  # no metric units, we default to meters.
28         ('IMPERIAL', 'LENGTH', "", "3+1in+1ft", 0.3048 * 4 + 0.0254),  # bigger unit becomes default one!
29         ('IMPERIAL', 'LENGTH', "", "(3+1)in+1ft", 0.3048 + 0.0254 * 4),
30     )
31
32     # From 'internal' Blender value to user-friendly printing
33     OUTPUT_TESTS = (
34         # system,    type,    prec, sep, compat, value, output
35         ##### LENGTH
36         ('IMPERIAL', 'LENGTH', 3, False, False, 0.3048, "1'"),
37         ('IMPERIAL', 'LENGTH', 3, False, True,  0.3048, "1ft"),
38         ('IMPERIAL', 'LENGTH', 3, True,  False, 0.3048 * 2 + 0.0254 * 5.5, "2' 5.5\""),
39         # Those next two fail, here again because precision ignores order magnitude :/
40         #('IMPERIAL', 'LENGTH', 3, False, False, 1609.344 * 1e6, "1000000mi"), # == 1000000.004mi!!!
41         #('IMPERIAL', 'LENGTH', 6, False, False, 1609.344 * 1e6, "1000000mi"), # == 1000000.003641mi!!!
42         ('METRIC',   'LENGTH', 3, True,  False, 1000 * 2 + 0.001 * 15, "2km 1.5cm"),
43         ('METRIC',   'LENGTH', 3, True,  False, 1234.56789, "1km 234.6m"),
44         # Note: precision seems basically unused when using multi units!
45         ('METRIC',   'LENGTH', 9, True,  False, 1234.56789, "1km 234.6m"),
46         ('METRIC',   'LENGTH', 9, False, False, 1234.56789, "1.23456789km"),
47         ('METRIC',   'LENGTH', 9, True,  False, 1000.000123456789, "1km 0.1mm"),
48     )
49
50     def test_units_inputs(self):
51         # Stolen from FBX addon!
52         def similar_values(v1, v2, e):
53             if v1 == v2:
54                 return True
55             return ((abs(v1 - v2) / max(abs(v1), abs(v2))) <= e)
56
57         for usys, utype, ref, inpt, val in self.INPUT_TESTS:
58             opt_val = units.to_value(usys, utype, inpt, ref)
59             # Note: almostequal is not good here, precision is fixed on decimal digits, not variable with
60             # magnitude of numbers (i.e. 1609.4416 ~= 1609.4456 fails even at 5 of 'places'...).
61             self.assertTrue(similar_values(opt_val, val, 1e-7),
62                             msg="%s, %s: \"%s\" (ref: \"%s\") => %f, expected %f"
63                                 "" % (usys, utype, inpt, ref, opt_val, val))
64
65     def test_units_outputs(self):
66         for usys, utype, prec, sep, compat, val, output in self.OUTPUT_TESTS:
67             opt_str = units.to_string(usys, utype, val, prec, sep, compat)
68             self.assertEqual(opt_str, output,
69                             msg="%s, %s: %f (precision: %d, separate units: %d, compat units: %d) => "
70                                 "\"%s\", expected \"%s\"" % (usys, utype, val, prec, sep, compat, opt_str, output))
71
72
73 def test_main():
74     try:
75         support.run_unittest(UnitsTesting)
76     except:
77         import traceback
78         traceback.print_exc()
79
80         # alert CTest we failed
81         import sys
82         sys.exit(1)
83
84 if __name__ == '__main__':
85     test_main()