Refactor

CHANGELOG.md

@@ -4,20 +4,20 @@
 
 * First stable version with tax modelling, UBI reforms, and some benefits modelling.
 * Details:
-  - Income Tax, National Insurance, Capital Gains Tax.
-  - All benefits are at least taken from survey reporting (can be switched on-off).
-  - Child Benefit is modelled, others such as Income Support, JSA (both types), Tax Credits can be simulated/reformed but require more reviewing in how to account for discrepancies caused by take-up rates.
-  - Four budget-neutral UBI reforms are implemented.
-  - 15 test cases (unit and integration) testing benefits and taxes.
-  - Simulation helper tools.
+  + Income Tax, National Insurance, Capital Gains Tax.
+  + All benefits are at least taken from survey reporting (can be switched on-off).
+  + Child Benefit is modelled, others such as Income Support, JSA (both types), Tax Credits can be simulated/reformed but require more reviewing in how to account for discrepancies caused by take-up rates.
+  + Four budget-neutral UBI reforms are implemented.
+  + 15 test cases (unit and integration) testing benefits and taxes.
+  + Simulation helper tools.
 
 ### 0.2.0
 
 * Improvements to handling of time periods, MTRs and more
 * Details:
-  - Time periods now appropriate, using an implementation of WEEK for most benefits
-  - MTRs handled properly and include a breakdown
-  - Simulation tools are improved and included in a class
+  + Time periods now appropriate, using an implementation of WEEK for most benefits
+  + MTRs handled properly and include a breakdown
+  + Simulation tools are improved and included in a class
 
 ### 0.2.1
 
@@ -51,3 +51,7 @@
 * Tests for variable naming conventions
 * Postcode lookup optional features available
 * LHA rates for all BRMA areas added
+
+### 0.7.17
+
+* Code refactoring, including adding units to more variables

openfisca_uk/config/postcode_lookup.py

@@ -1,5 +1,4 @@
-from openfisca_uk.tools.general import *
-from openfisca_uk.entities import *
+from openfisca_uk.model_api import *
 from openfisca_uk.variables.demographic.locations import LocalAuthority
 import pandas as pd
 

openfisca_uk/reforms/presets/modelling.py

@@ -1,5 +1,4 @@
-from openfisca_uk.tools.general import *
-from openfisca_uk.entities import *
+from openfisca_uk.model_api import *
 
 
 class tax(Variable):

openfisca_uk/reforms/tools/parametric.py

@@ -1,6 +1,5 @@
 import openfisca_uk
-from openfisca_uk.tools.general import *
-from openfisca_uk.entities import *
+from openfisca_uk.model_api import *
 from typing import Union
 
 

openfisca_uk/reforms/tools/structural.py

@@ -1,5 +1,4 @@
-from openfisca_uk.tools.general import *
-from openfisca_uk.entities import *
+from openfisca_uk.model_api import *
 from typing import Union
 
 

openfisca_uk/tests/policy/baseline/hmrc/income_tax/allowances/meets_marriage_allowance_income_conditions.yaml

@@ -0,0 +1,20 @@
+- name: Basic rate band is eligible for Marriage Allowance
+  period: 2021
+  input:
+    tax_band: BASIC
+  output:
+    meets_marriage_allowance_income_conditions: true
+
+- name: Higher rate band is ineligible for Marriage Allowance
+  period: 2021
+  input:
+    tax_band: HIGHER
+  output:
+    meets_marriage_allowance_income_conditions: false
+
+- name: Additional rate band is ineligible for Marriage Allowance
+  period: 2021
+  input:
+    tax_band: ADDITIONAL
+  output:
+    meets_marriage_allowance_income_conditions: false

openfisca_uk/variables/consumption/property.py

@@ -43,9 +43,9 @@ class main_residential_property_purchased(Variable):
     unit = "currency-GBP"
 
     def formula(household, period):
-        return household("property_purchased", period) * household(
-            "main_residence_value", period
-        )
+        property_purchased = household("property_purchased", period)
+        main_residence_value = household("main_residence_value", period)
+        return main_residence_value * property_purchased
 
 
 class additional_residential_property_purchased(Variable):
@@ -57,9 +57,11 @@ class additional_residential_property_purchased(Variable):
     unit = "currency-GBP"
 
     def formula(household, period):
-        return household("property_purchased", period) * household(
+        property_purchased = household("property_purchased", period)
+        other_residential_property_value = household(
             "other_residential_property_value", period
         )
+        return other_residential_property_value * property_purchased
 
 
 class main_residential_property_purchased_is_first_home(Variable):
@@ -103,9 +105,11 @@ class non_residential_property_purchased(Variable):
     unit = "currency-GBP"
 
     def formula(household, period):
-        return household("property_purchased", period) * household(
+        property_purchased = household("property_purchased", period)
+        non_residential_property_value = household(
             "non_residential_property_value", period
         )
+        return property_purchased * non_residential_property_value
 
 
 class cumulative_non_residential_rent(Variable):

openfisca_uk/variables/demographic/benunit.py

@@ -1,6 +1,5 @@
 from openfisca_uk.variables.demographic.household import TenureType
-from openfisca_uk.tools.general import *
-from openfisca_uk.entities import *
+from openfisca_uk.model_api import *
 
 
 class benunit_id(Variable):
@@ -54,13 +53,16 @@ class family_type(Variable):
     definition_period = YEAR
 
     def formula(benunit, period, parameters):
-        two_adults = benunit.sum(benunit.members("is_adult", period)) == 2
-        has_children = benunit.sum(benunit.members("is_child", period)) > 0
-        is_single = not_(two_adults) * not_(has_children)
-        is_couple = two_adults * not_(has_children)
-        is_lone = not_(two_adults) * has_children
-        is_full = two_adults * has_children
-        return select([is_single, is_couple, is_lone, is_full], FamilyType)
+        two_adults = aggr(benunit, period, ["is_adult"]) == 2
+        has_children = benunit.any(benunit.members("is_child", period))
+        single = ~two_adults & ~has_children
+        couple_no_children = two_adults & ~has_children
+        lone_parent = ~two_adults & has_children
+        couple_with_children = two_adults & has_children
+        return select(
+            [single, couple_no_children, lone_parent, couple_with_children],
+            FamilyType,
+        )
 
 
 class relation_type(Variable):
@@ -156,10 +158,9 @@ class benunit_tenure_type(Variable):
     definition_period = YEAR
 
     def formula(benunit, period, parameters):
-        tenure = benunit.value_from_first_person(
+        return benunit.value_from_first_person(
             benunit.members.household("tenure_type", period)
         )
-        return tenure
 
 
 class benunit_is_renting(Variable):
@@ -170,14 +171,13 @@ class benunit_is_renting(Variable):
 
     def formula(benunit, period, parameters):
         tenure = benunit("benunit_tenure_type", period)
-        return np.isin(
-            tenure,
-            (
-                TenureType.RENT_PRIVATELY,
-                TenureType.RENT_FROM_COUNCIL,
-                TenureType.RENT_FROM_HA,
-            ),
-        )
+        tenures = tenure.possible_values
+        RENT_TENURES = [
+            tenures.RENT_PRIVATELY,
+            tenures.RENT_FROM_COUNCIL,
+            tenures.RENT_FROM_HA,
+        ]
+        return np.isin(tenure, RENT_TENURES)
 
 
 class benunit_random_number(Variable):

openfisca_uk/variables/demographic/household.py

@@ -1,5 +1,4 @@
-from openfisca_uk.tools.general import *
-from openfisca_uk.entities import *
+from openfisca_uk.model_api import *
 
 
 class household_id(Variable):
@@ -55,12 +54,15 @@ class country(Variable):
     definition_period = ETERNITY
 
     def formula(household, period, parameters):
-        unknown_region = household("region", period) == Region.UNKNOWN
-        wales = household("region", period) == Region.WALES
-        ni = household("region", period) == Region.NORTHERN_IRELAND
-        scot = household("region", period) == Region.SCOTLAND
-        country = select(
-            [unknown_region, scot, wales, ni, True],
+        region = household("region", period)
+        return select(
+            [
+                region == Region.UNKNOWN,
+                region == Region.SCOTLAND,
+                region == Region.WALES,
+                region == Region.NORTHERN_IRELAND,
+                True,
+            ],
             [
                 Country.UNKNOWN,
                 Country.SCOTLAND,
@@ -69,7 +71,6 @@ def formula(household, period, parameters):
                 Country.ENGLAND,
             ],
         )
-        return country
 
 
 class Region(Enum):
@@ -123,12 +124,13 @@ class is_renting(Variable):
 
     def formula(household, period, parameters):
         tenure = household("tenure_type", period)
-        rent_types = (
-            TenureType.RENT_PRIVATELY,
-            TenureType.RENT_FROM_COUNCIL,
-            TenureType.RENT_PRIVATELY,
-        )
-        return sum([tenure == rent_type for rent_type in rent_types])
+        tenures = tenure.possible_values
+        RENT_TENURES = [
+            tenures.RENT_PRIVATELY,
+            tenures.RENT_FROM_COUNCIL,
+            tenures.RENT_PRIVATELY,
+        ]
+        return np.isin(tenure, RENT_TENURES)
 
 
 class AccommodationType(Enum):
@@ -158,22 +160,21 @@ class household_equivalisation_bhc(Variable):
     definition_period = YEAR
 
     def formula(household, period, parameters):
-        other_adults = max_(
+        count_other_adults = max_(
             household.sum(household.members("is_adult", period)) - 1, 0
         )
-        num_young_children = household.sum(
+        count_young_children = household.sum(
             household.members("is_young_child", period)
         )
-        num_older_children = household.sum(
+        count_older_children = household.sum(
             household.members("is_older_child", period)
         )
-        weighting = (
+        return (
             0.67
-            + 0.33 * other_adults
-            + 0.33 * num_older_children
-            + 0.2 * num_young_children
+            + 0.33 * count_other_adults
+            + 0.33 * count_older_children
+            + 0.2 * count_young_children
         )
-        return weighting
 
 
 class household_equivalisation_ahc(Variable):
@@ -183,22 +184,21 @@ class household_equivalisation_ahc(Variable):
     definition_period = YEAR
 
     def formula(household, period, parameters):
-        other_adults = max_(
+        count_other_adults = max_(
             household.sum(household.members("is_adult", period)) - 1, 0
         )
-        num_young_children = household.sum(
+        count_young_children = household.sum(
             household.members("is_young_child", period)
         )
-        num_older_children = household.sum(
+        count_older_children = household.sum(
             household.members("is_older_child", period)
         )
-        weighting = (
+        return (
             0.58
-            + 0.42 * other_adults
-            + 0.42 * num_older_children
-            + 0.2 * num_young_children
+            + 0.42 * count_other_adults
+            + 0.42 * count_older_children
+            + 0.2 * count_young_children
         )
-        return weighting
 
 
 class household_num_people(Variable):

openfisca_uk/variables/demographic/locations.py

@@ -1,5 +1,4 @@
-from openfisca_uk.tools.general import *
-from openfisca_uk.entities import *
+from openfisca_uk.model_api import *
 
 
 class BRMAName(Enum):

openfisca_uk/variables/demographic/person.py

@@ -1,5 +1,4 @@
-from openfisca_uk.tools.general import *
-from openfisca_uk.entities import *
+from openfisca_uk.model_api import *
 import pandas as pd
 
 
@@ -56,7 +55,10 @@ class age(Variable):
     definition_period = YEAR
 
     def formula(person, period, parameters):
-        return where(person.benunit.members_role == BenUnit.ADULT, 18, 10)
+        ADULT_DEFAULT_AGE = 18
+        CHILD_DEFAULT_AGE = 10
+        is_adult = person.benunit.members_role == BenUnit.ADULT
+        return where(is_adult, ADULT_DEFAULT_AGE, CHILD_DEFAULT_AGE)
 
 
 class birth_year(Variable):
@@ -116,10 +118,7 @@ def formula(person, period, parameters):
             + 1
         )
         # Fill in adult values
-        adjusted_for_adults = where(
-            person("is_child", period), child_ranking, 100
-        )
-        return adjusted_for_adults
+        return where(person("is_child", period), child_ranking, 100)
 
 
 class is_eldest_child(Variable):
@@ -286,8 +285,7 @@ class in_social_housing(Variable):
     def formula(person, period, parameters):
         tenure = person.household("tenure_type", period.this_year)
         tenures = tenure.possible_values
-        social = is_in(tenure, tenures.RENT_FROM_COUNCIL, tenures.RENT_FROM_HA)
-        return social
+        return is_in(tenure, tenures.RENT_FROM_COUNCIL, tenures.RENT_FROM_HA)
 
 
 class is_WA_adult(Variable):
@@ -297,7 +295,7 @@ class is_WA_adult(Variable):
     definition_period = YEAR
 
     def formula(person, period, parameters):
-        return person("is_adult", period) * not_(person("is_SP_age", period))
+        return person("is_adult", period) & ~person("is_SP_age", period)
 
 
 class is_young_child(Variable):
@@ -348,4 +346,5 @@ class is_older_child(Variable):
     definition_period = YEAR
 
     def formula(person, period, parameters):
-        return (person("age", period) >= 14) * (person("age", period) < 18)
+        age = person("age", period)
+        return (age >= 14) & (age < 18)