Edit childcare programs' interactions and edit is_parent variable (#1106)

* Add fix to is_parent

* Add total targets for universal childcare

* Add a pytest

* Edit pytest

* Edit pytest

* Edit year

* Edit bounds

* Hard code takeup rate

* Black

* Add no TFC condition

* Format

* Replace <= 0 with ==0

* Edit condition

* Edit changes

* Add other pytests

* Format

* Rename variable

* Add intractions

* Edit test

* Add TFC

* Edit

* Add number of eligible children

* Remove test_childcare.py to be excluded from PR

* Remove test_childcare.py to be excluded from PR

* add changelog

* Edit changelog

* Add comments

* Black

* Add would claim variable

* Add max_free_entitlement_hours_used

* Edit py file

* Format

* edit definition_period

* edit definition_period

* Add weeks_per_year

* Add hours condition

* Format

* Add unit tests

* Edit unit tests

---------

Co-authored-by: Nikhil Woodruff <nikhil.woodruff@outlook.com>

Author: vahid-ahmadi

changelog_entry.yaml

@@ -0,0 +1,5 @@
+- bump: patch
+  changes:
+    fixed:
+    - Corrected the is_parent variable to properly identify parents.
+    - Fixed logic in childcare programs to ensure accurate calculations.

policyengine_uk/parameters/gov/dfe/weeks_per_year.yaml

@@ -0,0 +1,14 @@
+description: The Department for Education provides targeted, extended, and universal childcare entitlement for these weeks per year.
+metadata:
+  period: year
+  unit: week
+  label: childcare entitlement weeks per year
+  reference:
+    - title: The Local Authority (Duty to Secure Early Years Provision Free of Charge) Regulations 2014 - regulation 4
+      href: https://www.legislation.gov.uk/uksi/2014/2147/regulation/4/made
+    - title: Childcare Choices document - 15 and 30 hours childcare support
+      href: https://www.childcarechoices.gov.uk/15-and-30-hours-childcare-support/working-families/eligibility
+    - title: Childcare (Early Years Provision Free of Charge) (Extended Entitlement) Regulations 2016 - Regulation 35(3)
+      href: https://www.legislation.gov.uk/uksi/2016/1257/part/4/made    
+values:
+  2016-01-01: 38

policyengine_uk/tests/policy/baseline/gov/dfe/extended_childcare_entitlement/extended_childcare_entitlement.yaml

@@ -103,4 +103,37 @@
         members: [child1]
         extended_childcare_entitlement_eligible: false
   output:
-    extended_childcare_entitlement: 0  # Not eligible
+    extended_childcare_entitlement: 0  # Not eligible
+
+- name: Child using fewer hours than maximum entitlement
+  period: 2025
+  absolute_error_margin: 1
+  input:
+    people:
+      child1:
+        age: 3
+        max_free_entitlement_hours_used: 20
+    benunits:
+      benunit1:
+        members: [child1]
+        extended_childcare_entitlement_eligible: true
+  output:
+    extended_childcare_entitlement: 4611.457  # 20 hours * 38 weeks * £6.07 per hour (2025 rate)
+
+- name: Child using fewer hours than maximum entitlement - multiple children
+  period: 2025
+  absolute_error_margin: 100
+  input:
+    people:
+      child1:
+        age: 2
+        max_free_entitlement_hours_used: 10
+      child2:
+        age: 3
+        max_free_entitlement_hours_used: 15
+    benunits:
+      benunit1:
+        members: [child1, child2]
+        extended_childcare_entitlement_eligible: true
+  output:
+    extended_childcare_entitlement: 6705.43  # (10 hours * 38 weeks * £8.58 per hour) + (15 hours * 38 weeks * £6.07 per hour) for 2025 rates

policyengine_uk/tests/policy/baseline/gov/dfe/targeted_childcare_entitlement/targeted_childcare_entitlement.yaml

@@ -0,0 +1,80 @@
+- name: Child under 2 (ineligible) 
+  period: 2024
+  input:
+    people:
+      child:
+        age: 1
+    benunits:
+      benunit:
+        members: [child]
+        targeted_childcare_entitlement_eligible: False
+  output:
+    targeted_childcare_entitlement: 0.0
+
+- name: Child aged 2 (eligible)
+  period: 2024
+  input:
+    people:
+      child:
+        age: 2
+    benunits:
+      benunit:
+        members: [child]
+        targeted_childcare_entitlement_eligible: True
+  output:
+    targeted_childcare_entitlement: 4_719.60  # 15 hours * 38 weeks * £8.28 per hour
+
+- name: Child aged 3 (not eligible by age, but has targeting)
+  period: 2024
+  input:
+    people:
+      child:
+        age: 3
+    benunits:
+      benunit:
+        members: [child]
+        targeted_childcare_entitlement_eligible: True
+  output:
+    targeted_childcare_entitlement: 0.0  # Not eligible by age even if targeting criteria met
+
+- name: Child using fewer hours than maximum entitlement
+  period: 2024
+  input:
+    people:
+      child:
+        age: 2
+        max_free_entitlement_hours_used: 10
+    benunits:
+      benunit:
+        members: [child]
+        targeted_childcare_entitlement_eligible: True
+  output:
+    targeted_childcare_entitlement: 3_146.4  # 10 hours * 38 weeks * £8.28 per hour
+
+- name: Child using exactly maximum entitlement
+  period: 2024
+  input:
+    people:
+      child:
+        age: 2
+        max_free_entitlement_hours_used: 15
+    benunits:
+      benunit:
+        members: [child]
+        targeted_childcare_entitlement_eligible: True
+  output:
+    targeted_childcare_entitlement: 4_719.6  # 15 hours * 38 weeks * £8.28 per hour
+
+- name: Child using more than maximum entitlement (capped)
+  period: 2024
+  input:
+    people:
+      child:
+        age: 2
+        max_free_entitlement_hours_used: 20
+    benunits:
+      benunit:
+        members: [child]
+        targeted_childcare_entitlement_eligible: True
+  output:
+    targeted_childcare_entitlement: 4_719.6  # Capped at 15 hours * 38 weeks * £8.28 per hour

policyengine_uk/tests/policy/baseline/gov/dfe/universal_childcare_entitlement/universal_childcare_entitlement.yaml

@@ -1,63 +1,123 @@
 - name: Child under 3 isn't eligible (person-level)
   period: 2024
   input:
-    age: 2
-    universal_childcare_entitlement_eligible: False
+    people:
+      child:
+        age: 2
+        universal_childcare_entitlement_eligible: False
   output:
     universal_childcare_entitlement: 0.0
 
 - name: Child aged 3 is eligible (person-level)
   period: 2024
   input:
-    age: 3
-    universal_childcare_entitlement_eligible: True
+    people:
+      child:
+        age: 3
+        universal_childcare_entitlement_eligible: True
   output:
-    universal_childcare_entitlement: 3351.60
+    universal_childcare_entitlement: 3_351.60
 
 - name: Child aged 4 is eligible (person-level)
   period: 2024
   input:
-    age: 4
-    universal_childcare_entitlement_eligible: True
+    people:
+      child:
+        age: 4
+        universal_childcare_entitlement_eligible: True
   output:
-    universal_childcare_entitlement: 3351.60
+    universal_childcare_entitlement: 3_351.60
 
 - name: Parent (ineligible)
   period: 2024
   input:
-    age: 35
-    universal_childcare_entitlement_eligible: False
+    people:
+      parent:
+        age: 35
+        universal_childcare_entitlement_eligible: False
   output:
     universal_childcare_entitlement: 0.0
 
 - name: Child aged 2 (ineligible)
   period: 2024
   input:
-    age: 2
-    universal_childcare_entitlement_eligible: False
+    people:
+      child:
+        age: 2
+        universal_childcare_entitlement_eligible: False
   output:
     universal_childcare_entitlement: 0.0
 
 - name: Child aged 3 (eligible)
   period: 2024
   input:
-    age: 3
-    universal_childcare_entitlement_eligible: True
+    people:
+      child:
+        age: 3
+        universal_childcare_entitlement_eligible: True
   output:
-    universal_childcare_entitlement: 3351.60
+    universal_childcare_entitlement: 3_351.60
 
 - name: Child aged 4 (eligible)
   period: 2024
   input:
-    age: 4
-    universal_childcare_entitlement_eligible: True
+    people:
+      child:
+        age: 4
+        universal_childcare_entitlement_eligible: True
   output:
-    universal_childcare_entitlement: 3351.60
+    universal_childcare_entitlement: 3_351.60
 
 - name: Child aged 5 (ineligible)
   period: 2024
   input:
-    age: 5
-    universal_childcare_entitlement_eligible: False
+    people:
+      child:
+        age: 5
+        universal_childcare_entitlement_eligible: False
   output:
-    universal_childcare_entitlement: 0.0
+    universal_childcare_entitlement: 0.0
+
+- name: Child using fewer hours than maximum entitlement
+  period: 2024
+  input:
+    people:
+      child:
+        age: 3
+        universal_childcare_entitlement_eligible: True
+        max_free_entitlement_hours_used: 10
+  output:
+    universal_childcare_entitlement: 2_234.4  # 10 hours * 38 weeks * £5.88 per hour
+
+- name: Child using half of maximum entitlement
+  period: 2024
+  input:
+    people:
+      child:
+        age: 3
+        universal_childcare_entitlement_eligible: True
+        max_free_entitlement_hours_used: 15
+  output:
+    universal_childcare_entitlement: 3_351.6  # 15 hours * 38 weeks * £5.88 per hour
+
+- name: Child using exactly maximum entitlement
+  period: 2024
+  input:
+    people:
+      child:
+        age: 4
+        universal_childcare_entitlement_eligible: True
+        max_free_entitlement_hours_used: 15
+  output:
+    universal_childcare_entitlement: 3_351.6  # 15 hours * 38 weeks * £5.88 per hour
+
+- name: Child using more than maximum entitlement (capped)
+  period: 2024
+  input:
+    people:
+      child:
+        age: 3
+        universal_childcare_entitlement_eligible: True
+        max_free_entitlement_hours_used: 20
+  output:
+    universal_childcare_entitlement: 3_351.6  # Capped at 15 hours * 38 weeks * £5.88 per hour

policyengine_uk/variables/gov/dfe/care_to_learn/care_to_learn_eligible.py

@@ -6,6 +6,7 @@ class care_to_learn_eligible(Variable):
     entity = Person
     label = "eligible for Care to Learn childcare support"
     definition_period = YEAR
+    defined_for = "would_claim_care_to_learn"
 
     def formula(person, period, parameters):
         # Link for instruction: https://www.gov.uk/care-to-learn/eligibility

policyengine_uk/variables/gov/dfe/care_to_learn/would_claim_care_to_learn.py

@@ -0,0 +1,12 @@
+from policyengine_uk.model_api import *
+
+
+class would_claim_care_to_learn(Variable):
+    value_type = bool
+    entity = BenUnit
+    label = "would claim Care to Learn"
+    documentation = (
+        "Whether this BenUnit would claim Care to Learn if eligible"
+    )
+    definition_period = YEAR
+    default_value = True

policyengine_uk/variables/gov/dfe/extended_childcare_entitlement/extended_childcare_entitlement.py

@@ -19,13 +19,19 @@ def formula(benunit, period, parameters):
             age
         )
 
+        # Get max hours used per child
+        max_hours_used = benunit.members(
+            "max_free_entitlement_hours_used", period
+        )
+
+        # Use the appropriate hours based on the condition
+        weekly_hours_to_use = min_(max_hours_used, weekly_hours_per_child)
+
         # Compute weekly subsidy per child
         weekly_subsidy_per_child = (
-            weekly_hours_per_child * p.childcare_funding_rate.calc(age)
+            weekly_hours_to_use * p.childcare_funding_rate.calc(age)
         )
 
         # Compute total annual expenses
-        return (
-            benunit.sum(weekly_subsidy_per_child)
-            * p.extended_childcare_entitlement.weeks_per_year
-        )
+        weeks = p.weeks_per_year
+        return benunit.sum(weekly_subsidy_per_child) * weeks

policyengine_uk/variables/gov/dfe/extended_childcare_entitlement/extended_childcare_entitlement_eligible.py

@@ -6,6 +6,7 @@ class extended_childcare_entitlement_eligible(Variable):
     entity = BenUnit
     label = "eligibility for extended childcare entitlement"
     definition_period = YEAR
+    defined_for = "would_claim_extended_childcare"
 
     def formula(benunit, period, parameters):
         # Check if household is in England

policyengine_uk/variables/gov/dfe/extended_childcare_entitlement/would_claim_extended_childcare.py

@@ -0,0 +1,10 @@
+from policyengine_uk.model_api import *
+
+
+class would_claim_extended_childcare(Variable):
+    value_type = bool
+    entity = BenUnit
+    label = "would claim extended childcare entitlement"
+    documentation = "Whether this family would claim extended childcare entitlement if eligible"
+    definition_period = YEAR
+    default_value = True