Use literals as unit values

Author: Mauko Quiroga

openfisca_core/periods/__init__.py

@@ -41,7 +41,7 @@
 from .helpers import unit_weight, unit_weights  # noqa: F401
 
 for item in DateUnit:
-    globals()[item.name] = item.value
+    globals()[item.name.upper()] = item.value
 
 str_by_instant_cache: Dict[Any, Any] = {}
 """Cache to store :obj:`str` reprentations of :obj:`.Instant`.

tests/core/test_calculate_output.py

@@ -10,20 +10,20 @@
 
 class simple_variable(Variable):
     entity = entities.Person
-    definition_period = DateUnit.MONTH
+    definition_period = DateUnit.MONTH.value
     value_type = int
 
 
 class variable_with_calculate_output_add(Variable):
     entity = entities.Person
-    definition_period = DateUnit.MONTH
+    definition_period = DateUnit.MONTH.value
     value_type = int
     calculate_output = simulations.calculate_output_add
 
 
 class variable_with_calculate_output_divide(Variable):
     entity = entities.Person
-    definition_period = DateUnit.YEAR
+    definition_period = DateUnit.YEAR.value
     value_type = int
     calculate_output = simulations.calculate_output_divide
 

tests/core/test_countries.py

@@ -103,7 +103,7 @@ def test_variable_with_reference(make_simulation, isolated_tax_benefit_system):
     assert result > 0
 
     class disposable_income(Variable):
-        definition_period = DateUnit.MONTH
+        definition_period = DateUnit.MONTH.value
 
         def formula(household, period):
             return household.empty_array()
@@ -120,7 +120,7 @@ def test_variable_name_conflict(tax_benefit_system):
 
     class disposable_income(Variable):
         reference = "disposable_income"
-        definition_period = DateUnit.MONTH
+        definition_period = DateUnit.MONTH.value
 
         def formula(household, period):
             return household.empty_array()

tests/core/test_cycles.py

@@ -23,7 +23,7 @@ def simulation(tax_benefit_system):
 class variable1(Variable):
     value_type = int
     entity = entities.Person
-    definition_period = DateUnit.MONTH
+    definition_period = DateUnit.MONTH.value
 
     def formula(person, period):
         return person('variable2', period)
@@ -32,7 +32,7 @@ def formula(person, period):
 class variable2(Variable):
     value_type = int
     entity = entities.Person
-    definition_period = DateUnit.MONTH
+    definition_period = DateUnit.MONTH.value
 
     def formula(person, period):
         return person('variable1', period)
@@ -42,7 +42,7 @@ def formula(person, period):
 class variable3(Variable):
     value_type = int
     entity = entities.Person
-    definition_period = DateUnit.MONTH
+    definition_period = DateUnit.MONTH.value
 
     def formula(person, period):
         return person('variable4', period.last_month)
@@ -51,7 +51,7 @@ def formula(person, period):
 class variable4(Variable):
     value_type = int
     entity = entities.Person
-    definition_period = DateUnit.MONTH
+    definition_period = DateUnit.MONTH.value
 
     def formula(person, period):
         return person('variable3', period)
@@ -62,7 +62,7 @@ def formula(person, period):
 class variable5(Variable):
     value_type = int
     entity = entities.Person
-    definition_period = DateUnit.MONTH
+    definition_period = DateUnit.MONTH.value
 
     def formula(person, period):
         variable6 = person('variable6', period.last_month)
@@ -72,7 +72,7 @@ def formula(person, period):
 class variable6(Variable):
     value_type = int
     entity = entities.Person
-    definition_period = DateUnit.MONTH
+    definition_period = DateUnit.MONTH.value
 
     def formula(person, period):
         variable5 = person('variable5', period)
@@ -82,7 +82,7 @@ def formula(person, period):
 class variable7(Variable):
     value_type = int
     entity = entities.Person
-    definition_period = DateUnit.MONTH
+    definition_period = DateUnit.MONTH.value
 
     def formula(person, period):
         variable5 = person('variable5', period)
@@ -93,7 +93,7 @@ def formula(person, period):
 class cotisation(Variable):
     value_type = int
     entity = entities.Person
-    definition_period = DateUnit.MONTH
+    definition_period = DateUnit.MONTH.value
 
     def formula(person, period):
         if period.start.month == 12:

tests/core/test_formulas.py

@@ -13,14 +13,14 @@
 class choice(Variable):
     value_type = int
     entity = entities.Person
-    definition_period = DateUnit.MONTH
+    definition_period = DateUnit.MONTH.value
 
 
 class uses_multiplication(Variable):
     value_type = int
     entity = entities.Person
     label = 'Variable with formula that uses multiplication'
-    definition_period = DateUnit.MONTH
+    definition_period = DateUnit.MONTH.value
 
     def formula(person, period):
         choice = person('choice', period)
@@ -32,7 +32,7 @@ class returns_scalar(Variable):
     value_type = int
     entity = entities.Person
     label = 'Variable with formula that returns a scalar value'
-    definition_period = DateUnit.MONTH
+    definition_period = DateUnit.MONTH.value
 
     def formula(person, period):
         return 666
@@ -42,7 +42,7 @@ class uses_switch(Variable):
     value_type = int
     entity = entities.Person
     label = 'Variable with formula that uses switch'
-    definition_period = DateUnit.MONTH
+    definition_period = DateUnit.MONTH.value
 
     def formula(person, period):
         choice = person('choice', period)

tests/core/test_holders.py

@@ -90,9 +90,9 @@ def test_permanent_variable_filled(single):
     simulation = single
     holder = simulation.person.get_holder('birth')
     value = numpy.asarray(['1980-01-01'], dtype = holder.variable.dtype)
-    holder.set_input(periods.period(DateUnit.ETERNITY), value)
+    holder.set_input(periods.period(DateUnit.ETERNITY.value), value)
     assert holder.get_array(None) == value
-    assert holder.get_array(DateUnit.ETERNITY) == value
+    assert holder.get_array(DateUnit.ETERNITY.value) == value
     assert holder.get_array('2016-01') == value
 
 

tests/core/test_opt_out_cache.py

@@ -14,14 +14,14 @@ class input(Variable):
     value_type = int
     entity = Person
     label = "Input variable"
-    definition_period = DateUnit.MONTH
+    definition_period = DateUnit.MONTH.value
 
 
 class intermediate(Variable):
     value_type = int
     entity = Person
     label = "Intermediate result that don't need to be cached"
-    definition_period = DateUnit.MONTH
+    definition_period = DateUnit.MONTH.value
 
     def formula(person, period):
         return person('input', period)
@@ -31,7 +31,7 @@ class output(Variable):
     value_type = int
     entity = Person
     label = 'Output variable'
-    definition_period = DateUnit.MONTH
+    definition_period = DateUnit.MONTH.value
 
     def formula(person, period):
         return person('intermediate', period)

tests/core/test_periods.py

@@ -17,43 +17,43 @@
 # Years
 
 def test_year():
-    assert str(Period((DateUnit.YEAR, first_jan, 1))) == '2014'
+    assert str(Period((DateUnit.YEAR.value, first_jan, 1))) == '2014'
 
 
 def test_12_months_is_a_year():
-    assert str(Period((DateUnit.MONTH, first_jan, 12))) == '2014'
+    assert str(Period((DateUnit.MONTH.value, first_jan, 12))) == '2014'
 
 
 def test_rolling_year():
-    assert str(Period((DateUnit.MONTH, first_march, 12))) == 'year:2014-03'
-    assert str(Period((DateUnit.YEAR, first_march, 1))) == 'year:2014-03'
+    assert str(Period((DateUnit.MONTH.value, first_march, 12))) == 'year:2014-03'
+    assert str(Period((DateUnit.YEAR.value, first_march, 1))) == 'year:2014-03'
 
 
 def test_several_years():
-    assert str(Period((DateUnit.YEAR, first_jan, 3))) == 'year:2014:3'
-    assert str(Period((DateUnit.YEAR, first_march, 3))) == 'year:2014-03:3'
+    assert str(Period((DateUnit.YEAR.value, first_jan, 3))) == 'year:2014:3'
+    assert str(Period((DateUnit.YEAR.value, first_march, 3))) == 'year:2014-03:3'
 
 
 # Months
 
 def test_month():
-    assert str(Period((DateUnit.MONTH, first_jan, 1))) == '2014-01'
+    assert str(Period((DateUnit.MONTH.value, first_jan, 1))) == '2014-01'
 
 
 def test_several_months():
-    assert str(Period((DateUnit.MONTH, first_jan, 3))) == 'month:2014-01:3'
-    assert str(Period((DateUnit.MONTH, first_march, 3))) == 'month:2014-03:3'
+    assert str(Period((DateUnit.MONTH.value, first_jan, 3))) == 'month:2014-01:3'
+    assert str(Period((DateUnit.MONTH.value, first_march, 3))) == 'month:2014-03:3'
 
 
 # Days
 
 def test_day():
-    assert str(Period((DateUnit.DAY, first_jan, 1))) == '2014-01-01'
+    assert str(Period((DateUnit.DAY.value, first_jan, 1))) == '2014-01-01'
 
 
 def test_several_days():
-    assert str(Period((DateUnit.DAY, first_jan, 3))) == 'day:2014-01-01:3'
-    assert str(Period((DateUnit.DAY, first_march, 3))) == 'day:2014-03-01:3'
+    assert str(Period((DateUnit.DAY.value, first_jan, 3))) == 'day:2014-01-01:3'
+    assert str(Period((DateUnit.DAY.value, first_march, 3))) == 'day:2014-03-01:3'
 
 
 '''
@@ -64,15 +64,15 @@ def test_several_days():
 # Years
 
 def test_parsing_year():
-    assert period('2014') == Period((DateUnit.YEAR, first_jan, 1))
+    assert period('2014') == Period((DateUnit.YEAR.value, first_jan, 1))
 
 
 def test_parsing_rolling_year():
-    assert period('year:2014-03') == Period((DateUnit.YEAR, first_march, 1))
+    assert period('year:2014-03') == Period((DateUnit.YEAR.value, first_march, 1))
 
 
 def test_parsing_several_years():
-    assert period('year:2014:2') == Period((DateUnit.YEAR, first_jan, 2))
+    assert period('year:2014:2') == Period((DateUnit.YEAR.value, first_jan, 2))
 
 
 def test_wrong_syntax_several_years():
@@ -83,11 +83,11 @@ def test_wrong_syntax_several_years():
 # Months
 
 def test_parsing_month():
-    assert period('2014-01') == Period((DateUnit.MONTH, first_jan, 1))
+    assert period('2014-01') == Period((DateUnit.MONTH.value, first_jan, 1))
 
 
 def test_parsing_several_months():
-    assert period('month:2014-03:3') == Period((DateUnit.MONTH, first_march, 3))
+    assert period('month:2014-03:3') == Period((DateUnit.MONTH.value, first_march, 3))
 
 
 def test_wrong_syntax_several_months():
@@ -98,11 +98,11 @@ def test_wrong_syntax_several_months():
 # Days
 
 def test_parsing_day():
-    assert period('2014-01-01') == Period((DateUnit.DAY, first_jan, 1))
+    assert period('2014-01-01') == Period((DateUnit.DAY.value, first_jan, 1))
 
 
 def test_parsing_several_days():
-    assert period('day:2014-03-01:3') == Period((DateUnit.DAY, first_march, 3))
+    assert period('day:2014-03-01:3') == Period((DateUnit.DAY.value, first_march, 3))
 
 
 def test_wrong_syntax_several_days():
@@ -160,7 +160,7 @@ def test_ambiguous_period():
 
 def test_deprecated_signature():
     with pytest.raises(TypeError):
-        period(DateUnit.MONTH, 2014)
+        period(DateUnit.MONTH.value, 2014)
 
 
 def test_wrong_argument():
@@ -184,13 +184,13 @@ def test_empty_string():
 
 
 @pytest.mark.parametrize("test", [
-    (period('year:2014:2'), DateUnit.YEAR, 2, period('2014'), period('2015')),
-    (period(2017), DateUnit.MONTH, 12, period('2017-01'), period('2017-12')),
-    (period('year:2014:2'), DateUnit.MONTH, 24, period('2014-01'), period('2015-12')),
-    (period('month:2014-03:3'), DateUnit.MONTH, 3, period('2014-03'), period('2014-05')),
-    (period(2017), DateUnit.DAY, 365, period('2017-01-01'), period('2017-12-31')),
-    (period('year:2014:2'), DateUnit.DAY, 730, period('2014-01-01'), period('2015-12-31')),
-    (period('month:2014-03:3'), DateUnit.DAY, 92, period('2014-03-01'), period('2014-05-31')),
+    (period('year:2014:2'), DateUnit.YEAR.value, 2, period('2014'), period('2015')),
+    (period(2017), DateUnit.MONTH.value, 12, period('2017-01'), period('2017-12')),
+    (period('year:2014:2'), DateUnit.MONTH.value, 24, period('2014-01'), period('2015-12')),
+    (period('month:2014-03:3'), DateUnit.MONTH.value, 3, period('2014-03'), period('2014-05')),
+    (period(2017), DateUnit.DAY.value, 365, period('2017-01-01'), period('2017-12-31')),
+    (period('year:2014:2'), DateUnit.DAY.value, 730, period('2014-01-01'), period('2015-12-31')),
+    (period('month:2014-03:3'), DateUnit.DAY.value, 92, period('2014-03-01'), period('2014-05-31')),
     ])
 def test_subperiods(test):
 

tests/core/test_reforms.py

@@ -15,7 +15,7 @@ class goes_to_school(Variable):
     default_value = True
     entity = Person
     label = "The person goes to school (only relevant for children)"
-    definition_period = DateUnit.MONTH
+    definition_period = DateUnit.MONTH.value
 
 
 class WithBasicIncomeNeutralized(Reform):
@@ -216,7 +216,7 @@ class new_variable(Variable):
         value_type = int
         label = "Nouvelle variable introduite par la réforme"
         entity = Household
-        definition_period = DateUnit.MONTH
+        definition_period = DateUnit.MONTH.value
 
         def formula(household, period):
             return household.empty_array() + 10
@@ -240,7 +240,7 @@ class new_dated_variable(Variable):
         value_type = int
         label = "Nouvelle variable introduite par la réforme"
         entity = Household
-        definition_period = DateUnit.MONTH
+        definition_period = DateUnit.MONTH.value
 
         def formula_2010_01_01(household, period):
             return household.empty_array() + 10
@@ -263,7 +263,7 @@ def apply(self):
 def test_update_variable(make_simulation, tax_benefit_system):
 
     class disposable_income(Variable):
-        definition_period = DateUnit.MONTH
+        definition_period = DateUnit.MONTH.value
 
         def formula_2018(household, period):
             return household.empty_array() + 10
@@ -294,7 +294,7 @@ def apply(self):
 def test_replace_variable(tax_benefit_system):
 
     class disposable_income(Variable):
-        definition_period = DateUnit.MONTH
+        definition_period = DateUnit.MONTH.value
         entity = Person
         label = "Disposable income"
         value_type = float
@@ -355,7 +355,7 @@ class some_variable(Variable):
         value_type = int
         entity = Person
         label = "Variable with many attributes"
-        definition_period = DateUnit.MONTH
+        definition_period = DateUnit.MONTH.value
         set_input = set_input_divide_by_period
         calculate_output = calculate_output_add