OpenFisca-France-Local 6.14.0__py3-none-any.whl → 6.15.0__py3-none-any.whl

{OpenFisca_France_Local-6.14.0.dist-info → OpenFisca_France_Local-6.15.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: OpenFisca-France-Local
-Version: 6.14.0
+Version: 6.15.0
 Summary: Extension OpenFisca pour nos partenariats avec les collectivités territoriales
 Home-page: https://github.com/openfisca/openfisca-france-local
 Author: OpenFisca Team

{OpenFisca_France_Local-6.14.0.dist-info → OpenFisca_France_Local-6.15.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
-OpenFisca_France_Local-6.14.0.data/scripts/openfisca_local_test,sha256=M55UQ5tskwZpJVLXGqlIcVs1nVZ2pBr_-R9jh-z2tbw,128
+OpenFisca_France_Local-6.15.0.data/scripts/openfisca_local_test,sha256=M55UQ5tskwZpJVLXGqlIcVs1nVZ2pBr_-R9jh-z2tbw,128
 openfisca_france_local/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-openfisca_france_local/aides_jeunes_reform.py,sha256=ai1nfE0WPmBjTNSc3WoYQ71kOquaTEjdX8iOheistK0,16418
+openfisca_france_local/aides_jeunes_reform.py,sha256=2Kf9AUH_oOelsfU8nKuzamX1X9VyJlImlJ35RrVqbDA,19055
 openfisca_france_local/convert_benefit_conditions_to_parameters.py,sha256=qMQNMQKJh-m77KWvbAaMxO2VHB8SwUtVw80c7r7YeFc,6304
 openfisca_france_local/epci_test_factory.py,sha256=QtasFXb9xH2ZZhOt4a2XpfpuaJJgH8HLaKoNV2nuhl0,1211
 openfisca_france_local/epcicom2020.xlsx,sha256=dh0_urEHajdv0FoxbFAgyXIMH4s8xlAeriBpVklrqeg,3102230
@@ -26,6 +26,7 @@ openfisca_france_local/departements/cotes_d_armor/fonds_solidarite_logement/acce
 openfisca_france_local/departements/cotes_d_armor/fonds_solidarite_logement/assurance_locative_energie.py,sha256=bGqoCLOOE6a3Fe4yLBCEW4Ex20UTg7tuO_X6cvkZ1LI,2166
 openfisca_france_local/departements/cotes_d_armor/fonds_solidarite_logement/base_ressource.py,sha256=orO3nwyVlCnGK9gIEd0lm88DgGCk1FkFqdvuI6CrdTE,2072
 openfisca_france_local/departements/eure_et_loir/adefip.py,sha256=tirnODplwwAJFT7kln0Ll-sMo7UDr1HvYmT6Gw8CK20,838
+openfisca_france_local/departements/eure_et_loir/aep.py,sha256=S9Ig5OkU80IvWMH2vOW5ta8EySGjswyeuJbRYDTOW1I,787
 openfisca_france_local/departements/eure_et_loir/aide-menagere.py,sha256=-KS-BpqJOOrQ1SGSPfpYKfafsPio93ud6RXTMFfrKKc,7546
 openfisca_france_local/departements/eure_et_loir/ash.py,sha256=7k-vlvd4dtx3sAfoq3n6sqSseV7Lt5rHSb5roJlfeJ0,5157
 openfisca_france_local/departements/eure_et_loir/caracteristiques_socio_demographiques.py,sha256=OUzrhyk6LX1iXReviF4lJVA8jkboxcIUfruVvE1y8Hs,1984
@@ -195,6 +196,7 @@ tests/departements/cotes_d_armor/eligibilite.yml,sha256=Iilaz7lBJ1GmeW-QWFtX4WNQ
 tests/departements/cotes_d_armor/fonds_solidarite_logement_acces_maintien.yml,sha256=ajuQWCnRSORQUlmtXd8Dzq2qmMmvHmDiU47Mii8YcII,999
 tests/departements/cotes_d_armor/fonds_solidarite_logement_assurance_locative_energie.yml,sha256=XLPJJx4R6eU7o4yAnivcG5nTF33sYuFeElvzzL-ciys,317
 tests/departements/eure_et_loir/adefip.yml,sha256=qgrpglaHdSk0s6m84EDAPWyS0lIDLRaSbmkjMzBHmKM,3514
+tests/departements/eure_et_loir/aep.yml,sha256=kS311GJjIL2Shi642_A1iJaOx-vD0xO41tnbcb7MTVY,2067
 tests/departements/eure_et_loir/aide-menagere-personne-agee.yml,sha256=tlxoE5U1jxpIoOSR73HB3zXYYO9AnyVyLbLi6rOXI5A,7827
 tests/departements/eure_et_loir/aide-menagere-personne-handicap.yml,sha256=xcVH8dSkVRKUndU6Oz_nxFZfm5B8HIF7J80X8962J5I,6069
 tests/departements/eure_et_loir/ash_personne_agee.yml,sha256=SEEu-jrl8koJGqivRjdro9Q2kwkFtWCv-WMR_TeMj1k,7127
@@ -256,8 +258,8 @@ tests/regions/occitanie/carte_jeune_region.yml,sha256=t86RNkSuBYr2fEt60WZi0R115n
 tests/regions/occitanie/carte_transport_scolaire.yml,sha256=ZzVRWnH6i9nni7hatdfUX0ltcWR2BCwh4BLP7UpKuZE,318
 tests/regions/occitanie/msa_midi_pyrenees_sud/aide_permis.yml,sha256=zAI_NBTfsP_Q72pDabN2ChQnpK98xasXetIQJmq6LTc,439
 tests/regions/pays_de_la_loire/epass_jeunes_culture_sport.yaml,sha256=vgdq2hFtBWYWHHmO70bPV0lR_0wohJfmJGQb48A0EpQ,336
-OpenFisca_France_Local-6.14.0.dist-info/LICENSE,sha256=dql8h4yceoMhuzlcK0TT_i-NgTFNIZsgE47Q4t3dUYI,34520
-OpenFisca_France_Local-6.14.0.dist-info/METADATA,sha256=VU5vEX7HEzkPidnO20Iq4ulJh1Zm_a_RO-7bxPhPmVg,1170
-OpenFisca_France_Local-6.14.0.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-OpenFisca_France_Local-6.14.0.dist-info/top_level.txt,sha256=DPfQtZjavxRdHDsGTetqu5AEeVMEEBtG1qdv7ijuwWQ,56
-OpenFisca_France_Local-6.14.0.dist-info/RECORD,,
+OpenFisca_France_Local-6.15.0.dist-info/LICENSE,sha256=dql8h4yceoMhuzlcK0TT_i-NgTFNIZsgE47Q4t3dUYI,34520
+OpenFisca_France_Local-6.15.0.dist-info/METADATA,sha256=-1ohIAoVozEZZOZ7aEj9MADMGWNYBY4nEd8UAHrWqyo,1170
+OpenFisca_France_Local-6.15.0.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
+OpenFisca_France_Local-6.15.0.dist-info/top_level.txt,sha256=DPfQtZjavxRdHDsGTetqu5AEeVMEEBtG1qdv7ijuwWQ,56
+OpenFisca_France_Local-6.15.0.dist-info/RECORD,,

{OpenFisca_France_Local-6.14.0.dist-info → OpenFisca_France_Local-6.15.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.1.0)
+Generator: setuptools (75.2.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

openfisca_france_local/aides_jeunes_reform.py

@@ -284,6 +284,9 @@ ProfileEvaluator = collections.namedtuple(
 
 
 def build_condition_evaluator_list(conditions: 'list[dict]') -> 'list[ConditionEvaluator]':
+    """
+        Établit une correspondance entre les conditions et les fonctions qui évaluent ces conditions.
+    """
     try:
         evaluators: 'list[ConditionEvaluator]' = [
             ConditionEvaluator(condition, condition_table[condition['type']])
@@ -296,6 +299,9 @@ def build_condition_evaluator_list(conditions: 'list[dict]') -> 'list[ConditionE
 
 
 def build_profil_evaluator(profil: dict) -> ProfileEvaluator:
+    """
+        Associe un test d'éligibilité au profil et pour chacune de ses conditions.
+    """
     try:
         predicate = profil_table[profil['type']]
     except KeyError:
@@ -334,6 +340,12 @@ def eval_profil(profil_evaluator: ProfileEvaluator,
 
 
 def generate_variable(benefit: dict):
+    """
+        Créé la variable qui va être intégrée dans le TaxAndBenefitSystem.
+
+        Génère une `Variable` Openfisca dont le type est la formule correspondent
+        aux données du dictionaire source issue d'un fichier `YAML`.
+    """
     variable_name: str = benefit['slug']
     amount = benefit.get('montant')
 
@@ -379,6 +391,21 @@ default_institutions_path = 'test_data/institutions'
 
 
 class aides_jeunes_reform_dynamic(reforms.Reform):
+    """
+        Cette réforme n'est pas une réforme au sens légal du terme.
+
+        La réforme ici présente est utilisée pour lire des fichiers `YAML`
+        qui modélisent des dispositifs d'aides sociales avec des conditions simples
+        de manière à les intégrer dans une instance Openfisca.
+
+        Pour utiliser la réforme, il faut :
+            - Définir le chemin des dossiers qui contiennent
+            les aides et les institutions avec les variables d'environement
+            `DYNAMIC_BENEFIT_FOLDER` et `DYNAMIC_INSTITUTION_FOLDER`
+            - Lancer Openfisca en appelant la réforme :
+                `--reform openfisca_france_local.aides_jeunes_reform.aides_jeunes_reform_dynamic`
+    """
+
     def __init__(self, baseline, benefits_folder_path=default_benefit_path, institutions_folder_path=default_institutions_path):
         self.benefits_folder_path = getenv('DYNAMIC_BENEFIT_FOLDER', benefits_folder_path)
         self.institutions_folder_path = getenv('DYNAMIC_INSTITUTION_FOLDER', institutions_folder_path)
@@ -403,12 +430,30 @@ class aides_jeunes_reform_dynamic(reforms.Reform):
 
     def _extract_benefit_file_content(self, benefit_path: str):
         def _convert_institution_to_condition(benefit: dict) -> dict:
+            """
+                Si le fichier `YAML` traité contient une condition de type `attached_to_institution`,
+                un traitement est nécessaire car les modalités de cette condition ne sont pas précisées
+                dans le fichier en question.
+
+                Cette condition est une condition géographique.
+
+                Il faut aller récupérer les informations liées à l'institution en question
+                dans un fichier qui modélise l'institution correspondante pour ensuite ajouter
+                une condition géographique équivalente.
+
+                Il existe 4 type de condition géographique :
+                `msa`, `caf`, `epci`, `regions`, `departements` et `communes`.
+            """
             if {'type': 'attached_to_institution'} in benefit['conditions_generales']:
                 conditions_generales_without_attached_institution = [
                     condition for condition
                     in benefit['conditions_generales']
                     if condition != {'type': 'attached_to_institution'}]
 
+                # /!\ Pas de mise en cache faite ici. Si deux fichiers font appel à la même institution,
+                # le fichier de l'institution en question sera ouvert 2 fois.
+                # Si un jour la condition `attached_to_institution` venait à être utilisée de manière
+                # intensive, il pourrait être intéressant d'implanter un cache ici
                 with open(f'{self.institutions_folder_path}/{benefit["institution"]}.yml') as file:
                     institution: dict = yaml.safe_load(file)
 
@@ -429,6 +474,13 @@ class aides_jeunes_reform_dynamic(reforms.Reform):
             return benefit
 
         def _slug_from_path(path: str):
+            """
+                Pour créer une nouvelle variable Openfisca, il est necessaire
+                de lui donner un nom qui respecte la syntaxe d'une variable Python.
+
+                Cette méthode utilise le nom du fichier pour déterminer
+                un nom de variable compatible.
+            """
             return path.split('/')[-1].replace('-', '_').split('.')[0]
 
         with open(benefit_path) as file:

openfisca_france_local/departements/eure_et_loir/aep.py

@@ -0,0 +1,18 @@
+from openfisca_france.model.base import Variable, Menage, MONTH
+
+class eure_et_loir_eligibilite_aep(Variable):
+    value_type = bool
+    entity = Menage
+    definition_period = MONTH
+    label = "En Eure-et-Loir, éligibilité a l'Action Éducative de Promixité (AEP)"
+    reference = [
+        "https://eurelien.fr/wp-content/uploads/2023/01/l_aide_educative_de_proximite.pdf",
+        "https://eurelien.fr/mon-quotidien/enfance-et-famille/#Laction-educative"
+    ]
+
+    def formula(menage, period):
+        reside_eure_et_loir = menage('eure_et_loir_eligibilite_residence', period)
+        enfants_a_charge = menage.members('enfant_a_charge', period.this_year)
+        has_enfants_a_charge = menage.sum(enfants_a_charge) > 0
+
+        return reside_eure_et_loir * has_enfants_a_charge

tests/departements/eure_et_loir/aep.yml

@@ -0,0 +1,88 @@
+- name: Eligibilité à l'aide AEP d'Eure-et-Loir avec menage ayant des enfants à charge
+  period: 2023-01
+  input:
+    individus:
+      parent1:
+        salaire_imposable: 1000
+      parent2:
+        salaire_imposable: 0
+      enfant1:
+        age: 8
+        enfant_a_charge:
+          2023: True
+      enfant2:
+        age: 12
+        enfant_a_charge:
+          2023: True
+    menage:
+      personne_de_reference: parent1
+      conjoint: parent2
+      enfants: [ "enfant1", "enfant2" ]
+      depcom: 28000
+  output:
+    eure_et_loir_eligibilite_aep: True
+
+- name: Eligibilité à l'aide AEP d'Eure-et-Loir avec menage n'ayant pas d'enfants à charge
+  period: 2023-01
+  input:
+    individus:
+      parent1:
+        salaire_imposable: 1000
+      parent2:
+        salaire_imposable: 0
+      enfant1:
+        age: 8
+        enfant_a_charge:
+          2023: False
+      enfant2:
+        age: 12
+        enfant_a_charge:
+          2023: False
+    menage:
+      personne_de_reference: parent1
+      conjoint: parent2
+      enfants: [ "enfant1", "enfant2" ]
+      depcom: 28000
+  output:
+    eure_et_loir_eligibilite_aep: False
+
+- name: Eligibilité à l'aide AEP d'Eure-et-Loir avec menage n'ayant pas d'enfants
+  period: 2023-01
+  input:
+    individus:
+      parent1:
+        salaire_imposable: 1000
+      parent2:
+        salaire_imposable: 0
+    menage:
+      personne_de_reference: parent1
+      conjoint: parent2
+      enfants: []
+      depcom: 28000
+  output:
+    eure_et_loir_eligibilite_aep: False
+
+
+- name: Eligibilité à l'aide AEP d'Eure-et-Loir avec menage n'habitant pas en Eure-et-Loir
+  period: 2023-01
+  input:
+    individus:
+      parent1:
+        salaire_imposable: 1000
+      parent2:
+        salaire_imposable: 0
+      enfant1:
+        age: 8
+        enfant_a_charge:
+          2023: True
+      enfant2:
+        age: 12
+        enfant_a_charge:
+          2023: True
+    menage:
+      personne_de_reference: parent1
+      conjoint: parent2
+      enfants: [ "enfant1", "enfant2" ]
+      depcom: 45000
+  output:
+    eure_et_loir_eligibilite_aep: False