OpenFisca-France-Local 6.13.0__py3-none-any.whl → 6.14.1__py3-none-any.whl

{OpenFisca_France_Local-6.13.0.dist-info → OpenFisca_France_Local-6.14.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: OpenFisca-France-Local
-Version: 6.13.0
+Version: 6.14.1
 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.13.0.dist-info → OpenFisca_France_Local-6.14.1.dist-info}/RECORD

@@ -1,6 +1,6 @@
-OpenFisca_France_Local-6.13.0.data/scripts/openfisca_local_test,sha256=M55UQ5tskwZpJVLXGqlIcVs1nVZ2pBr_-R9jh-z2tbw,128
+OpenFisca_France_Local-6.14.1.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
@@ -17,6 +17,8 @@ openfisca_france_local/communes/illkirch_graffenstaden/base.py,sha256=L90ys8g0jd
 openfisca_france_local/communes/iwuy/aide_permis.py,sha256=Xr-5NCWux1Hk4oFGurkWFkIFyEhxVDWYsR1hszzngvQ,933
 openfisca_france_local/communes/le_cateau/aide_permis.py,sha256=Ms2PKH-35eZc0ibbRbVIjOLc5gIwS0aHHdZh-ef20FI,1238
 openfisca_france_local/communes/les_rues_des_vignes/aide_permis.py,sha256=bPTeIT7ap4suySmzKBXDOORDmFpBaNyCQMuL-LFVQqg,1058
+openfisca_france_local/communes/montpellier/eligibilite.py,sha256=aC3UfG7dZ9qHFa_DPVqUHKJJC4IwZYV5YPh4zQatAzk,360
+openfisca_france_local/communes/montpellier/montpellier_mutuelle_communale.py,sha256=h4i5HTuHoGMwh7O1m8hxyN5ul4-KjaI1qszEPNe6J28,764
 openfisca_france_local/communes/nantes/aide_carte_blanche.py,sha256=uGs6HUZgJzuqddClJIuVU9l731ZjVCKQTW9RWRCNhtc,871
 openfisca_france_local/communes/saint_louis/eligibilite.py,sha256=UoTy7S7WABNTMcEVZai-vhj-mC5gyhcsW456dw7-iyg,398
 openfisca_france_local/departements/cotes_d_armor/eligibilite.py,sha256=8-qOmLSEc2i9jcKOkM-AD1s9Ug9GeWxsgguym7t8WkE,448
@@ -186,6 +188,7 @@ tests/communes/carcassonne/aide_permis.yaml,sha256=gqE1qdqz0l3cjDQMCuKjYpN-klauO
 tests/communes/iwuy/aide_permis.yml,sha256=vbWLT4hP4x3xDBBP8fh-zShCGjxsEEduhGzinS_TPCk,142
 tests/communes/le_cateau/aide_permis.yml,sha256=Hf1RI6pdgkL7pvyDb4euV9PVea7s1U-AyZ5JDNrJ0_0,223
 tests/communes/les_rues_des_vignes/aide_permis.yml,sha256=NbGXyaOT1lft1eAvB1zecuS1qqJMDnbnV8k-byhB_xk,157
+tests/communes/montpellier/montpellier_mutuelle_communale.yml,sha256=07b43kilDgf2F9dwdNvLnl2RfwkhYVwg8t-bH_e4S1g,335
 tests/communes/nantes/aide_carte_blanche.yml,sha256=mPbfGL3I5nS9bPrtl0vERBYnG7B9RhY3EZonrM0l-sU,326
 tests/departements/cotes_d_armor/base_ressource.yml,sha256=FWHCWUeKedi5HiluAr9vBQt1ZjugxvAogKtXAZ2wkJU,1125
 tests/departements/cotes_d_armor/eligibilite.yml,sha256=Iilaz7lBJ1GmeW-QWFtX4WNQAWyQ4co3zClBVpCHr2U,119
@@ -253,8 +256,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.13.0.dist-info/LICENSE,sha256=dql8h4yceoMhuzlcK0TT_i-NgTFNIZsgE47Q4t3dUYI,34520
-OpenFisca_France_Local-6.13.0.dist-info/METADATA,sha256=pk9JbBrJBe4oNOFM6aEQNaEm4Vkt4HiAyEvoquqKoiw,1170
-OpenFisca_France_Local-6.13.0.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-OpenFisca_France_Local-6.13.0.dist-info/top_level.txt,sha256=DPfQtZjavxRdHDsGTetqu5AEeVMEEBtG1qdv7ijuwWQ,56
-OpenFisca_France_Local-6.13.0.dist-info/RECORD,,
+OpenFisca_France_Local-6.14.1.dist-info/LICENSE,sha256=dql8h4yceoMhuzlcK0TT_i-NgTFNIZsgE47Q4t3dUYI,34520
+OpenFisca_France_Local-6.14.1.dist-info/METADATA,sha256=9NyjtSZrO3EA5yhxggVndS8lFIaRHIWCNDPeuoHXKmM,1170
+OpenFisca_France_Local-6.14.1.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
+OpenFisca_France_Local-6.14.1.dist-info/top_level.txt,sha256=DPfQtZjavxRdHDsGTetqu5AEeVMEEBtG1qdv7ijuwWQ,56
+OpenFisca_France_Local-6.14.1.dist-info/RECORD,,

{OpenFisca_France_Local-6.13.0.dist-info → OpenFisca_France_Local-6.14.1.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/communes/montpellier/eligibilite.py

@@ -0,0 +1,10 @@
+from openfisca_france.model.base import Menage, MONTH, Variable
+
+class montpellier_eligibilite_residence(Variable):
+    value_type = bool
+    entity = Menage
+    definition_period = MONTH
+    label = "Éligibilité résidentielle d'un ménage aux dipositifs de Montpellier"
+
+    def formula(menage, period):
+        return menage('depcom', period) == b'34172'

openfisca_france_local/communes/montpellier/montpellier_mutuelle_communale.py

@@ -0,0 +1,17 @@
+from openfisca_france.model.base import Variable, MONTH, not_, Famille
+
+class montpellier_mutuelle_communale(Variable):
+    value_type = bool
+    entity = Famille
+    definition_period = MONTH
+    label = "Mutuelle communale de la ville de Montpellier"
+    reference = [
+        "https://www.montpellier.fr/4884-mutuelle-communale.htm"
+        ]
+
+    def formula(famille, period):
+        eligibilite_residentielle = famille.demandeur.menage('montpellier_eligibilite_residence', period)
+        css_participation_forfaitaire = famille('css_participation_forfaitaire', period)
+        cmu_c = famille('cmu_c', period)
+        eligibilite_css_cmu_c = (css_participation_forfaitaire > 0) | cmu_c
+        return eligibilite_residentielle * not_(eligibilite_css_cmu_c)

tests/communes/montpellier/montpellier_mutuelle_communale.yml

@@ -0,0 +1,8 @@
+- name: "Égibilité à la mutuelle communale de Montpellier"
+  period: 2024-10
+  input:
+    depcom: ["34172","34172", "34172", "68400", "68400"]
+    css_participation_forfaitaire_montant: [0, 0, 20, 25, 30]
+    cmu_c: [False, True, False, False, False]
+  output:
+    montpellier_mutuelle_communale: [True, False, False, False, False]