OpenFisca-Core-test 46.0.0__py3-none-any.whl

openfisca_core/scripts/migrations/v16_2_to_v17/legislation.xsd

@@ -0,0 +1,102 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
+
+    <xs:element name="NODE" type="nodeType"/>
+
+    <xs:group name="valuesHistory">
+        <xs:sequence>
+            <xs:choice maxOccurs="unbounded">
+                <xs:element name="VALUE" type="valueType"/>
+                <xs:element name="END" type="endType"/>
+                <xs:element name="PLACEHOLDER" type="placeholderType"/>
+            </xs:choice>
+        </xs:sequence>
+    </xs:group>
+
+    <xs:complexType name="nodeType">
+        <xs:sequence>
+            <xs:choice minOccurs="0" maxOccurs="unbounded">
+                <xs:element name="NODE" type="nodeType"/>
+                <xs:element name="CODE" type="codeType"/>
+                <xs:element name="BAREME" type="baremeType"/>
+            </xs:choice>
+        </xs:sequence>
+        <xs:attribute name="code" type="xs:string" use="required"/>
+        <xs:attribute name="description" type="xs:string"/>
+        <xs:attribute name="origin" type="xs:string"/>
+        <xs:attribute name="reference" type="xs:string"/>
+    </xs:complexType>
+
+    <xs:complexType name="codeType">
+        <xs:group ref="valuesHistory"/>
+        <xs:attribute name="code" type="xs:string" use="required"/>
+        <xs:attribute name="description" type="xs:string"/>
+        <xs:attribute name="format" type="xs:string"/>
+        <xs:attribute name="origin" type="xs:string"/>
+        <xs:attribute name="type" type="xs:string"/>
+        <xs:attribute name="conflicts" type="xs:string"/>
+        <xs:attribute name="reference" type="xs:string"/>
+    </xs:complexType>
+
+    <xs:complexType name="endType">
+        <xs:attribute name="deb" type="xs:date" use="required"/>
+        <xs:attribute name="reference" type="xs:string"/>
+    </xs:complexType>
+
+    <xs:complexType name="valueType">
+        <xs:attribute name="deb" type="xs:date" use="required"/>
+        <xs:attribute name="valeur" type="xs:float" use="required"/>
+        <xs:attribute name="reference" type="xs:string"/>
+    </xs:complexType>
+
+    <xs:complexType name="baremeType">
+        <xs:sequence>
+            <xs:element name="TRANCHE" type="trancheType" minOccurs="0" maxOccurs="unbounded"/>
+        </xs:sequence>
+        <xs:attribute name="code" type="xs:string" use="required"/>
+        <xs:attribute name="description" type="xs:string"/>
+        <xs:attribute name="origin" type="xs:string"/>
+        <xs:attribute name="type" type="xs:string"/>
+        <xs:attribute name="conflicts" type="xs:string"/>
+        <xs:attribute name="option" type="xs:string"/>
+        <xs:attribute name="reference" type="xs:string"/>
+    </xs:complexType>
+
+    <xs:complexType name="trancheType">
+        <xs:all>
+            <xs:element name="ASSIETTE" type="assietteType" minOccurs="0"/>
+            <xs:element name="SEUIL" type="seuilType"/>
+            <xs:element name="TAUX" type="tauxType" minOccurs="0"/>
+            <xs:element name="MONTANT" type="montantType" minOccurs="0"/>
+        </xs:all>
+        <xs:attribute name="code" type="xs:string"/>
+        <xs:attribute name="reference" type="xs:string"/>
+    </xs:complexType>
+
+    <xs:complexType name="assietteType">
+        <xs:group ref="valuesHistory"/>
+        <xs:attribute name="reference" type="xs:string"/>
+    </xs:complexType>
+
+    <xs:complexType name="tauxType">
+        <xs:group ref="valuesHistory"/>
+        <xs:attribute name="reference" type="xs:string"/>
+    </xs:complexType>
+
+    <xs:complexType name="montantType">
+        <xs:group ref="valuesHistory"/>
+        <xs:attribute name="reference" type="xs:string"/>
+    </xs:complexType>
+
+    <xs:complexType name="seuilType">
+        <xs:group ref="valuesHistory"/>
+        <xs:attribute name="conflicts" type="xs:string"/>
+        <xs:attribute name="reference" type="xs:string"/>
+    </xs:complexType>
+
+    <xs:complexType name="placeholderType">
+        <xs:attribute name="deb" type="xs:date" use="required"/>
+        <xs:attribute name="reference" type="xs:string"/>
+    </xs:complexType>
+
+</xs:schema>

openfisca_core/scripts/migrations/v16_2_to_v17/xml_to_yaml_country_template.py

@@ -0,0 +1,30 @@
+"""xml_to_yaml_country_template.py : Parse XML parameter files for Country-Template and convert them to YAML files. Comments are NOT transformed.
+
+Usage :
+  `python xml_to_yaml_country_template.py output_dir`
+or just (output is written in a directory called `yaml_parameters`):
+  `python xml_to_yaml_country_template.py`
+"""
+
+import os
+import sys
+
+from openfisca_country_template import COUNTRY_DIR, CountryTaxBenefitSystem
+
+from . import xml_to_yaml
+
+tax_benefit_system = CountryTaxBenefitSystem()
+
+target_path = sys.argv[1] if len(sys.argv) > 1 else "yaml_parameters"
+
+param_dir = os.path.join(COUNTRY_DIR, "parameters")
+param_files = [
+    "benefits.xml",
+    "general.xml",
+    "taxes.xml",
+]
+legislation_xml_info_list = [
+    (os.path.join(param_dir, param_file), []) for param_file in param_files
+]
+
+xml_to_yaml.write_parameters(legislation_xml_info_list, target_path)

openfisca_core/scripts/migrations/v16_2_to_v17/xml_to_yaml_extension_template.py

@@ -0,0 +1,26 @@
+"""xml_to_yaml_extension_template.py : Parse XML parameter files for Extension-Template and convert them to YAML files. Comments are NOT transformed.
+
+Usage :
+  `python xml_to_yaml_extension_template.py output_dir`
+or just (output is written in a directory called `yaml_parameters`):
+  `python xml_to_yaml_extension_template.py`
+"""
+
+import os
+import sys
+
+import openfisca_extension_template
+
+from . import xml_to_yaml
+
+target_path = sys.argv[1] if len(sys.argv) > 1 else "yaml_parameters"
+
+param_dir = os.path.dirname(openfisca_extension_template.__file__)
+param_files = [
+    "parameters.xml",
+]
+legislation_xml_info_list = [
+    (os.path.join(param_dir, param_file), []) for param_file in param_files
+]
+
+xml_to_yaml.write_parameters(legislation_xml_info_list, target_path)

openfisca_core/scripts/migrations/v24_to_25.py

@@ -0,0 +1,156 @@
+# flake8: noqa T001
+
+import argparse
+import glob
+import os
+
+from ruamel.yaml import YAML
+from ruamel.yaml.comments import CommentedSeq
+
+from openfisca_core.scripts import (
+    add_tax_benefit_system_arguments,
+    build_tax_benefit_system,
+)
+
+yaml = YAML()
+yaml.default_flow_style = False
+yaml.width = 4096
+
+TEST_METADATA = {
+    "period",
+    "name",
+    "reforms",
+    "only_variables",
+    "ignore_variables",
+    "absolute_error_margin",
+    "relative_error_margin",
+    "description",
+    "keywords",
+}
+
+
+def build_parser():
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "path",
+        help="paths (files or directories) of tests to execute",
+        nargs="+",
+    )
+    return add_tax_benefit_system_arguments(parser)
+
+
+class Migrator:
+    def __init__(self, tax_benefit_system) -> None:
+        self.tax_benefit_system = tax_benefit_system
+        self.entities_by_plural = {
+            entity.plural: entity for entity in self.tax_benefit_system.entities
+        }
+
+    def migrate(self, path) -> None:
+        if isinstance(path, list):
+            for item in path:
+                self.migrate(item)
+            return
+
+        if os.path.isdir(path):
+            yaml_paths = glob.glob(os.path.join(path, "*.yaml"))
+            subdirectories = glob.glob(os.path.join(path, "*/"))
+
+            for yaml_path in yaml_paths:
+                self.migrate(yaml_path)
+
+            for subdirectory in subdirectories:
+                self.migrate(subdirectory)
+
+            return
+
+        with open(path) as yaml_file:
+            tests = yaml.safe_load(yaml_file)
+        if isinstance(tests, CommentedSeq):
+            migrated_tests = [self.convert_test(test) for test in tests]
+        else:
+            migrated_tests = self.convert_test(tests)
+
+        with open(path, "w") as yaml_file:
+            yaml.dump(migrated_tests, yaml_file)
+
+    def convert_test(self, test):
+        if test.get("output"):
+            # This test is already converted, ignoring it
+            return test
+        result = {}
+        outputs = test.pop("output_variables")
+        inputs = test.pop("input_variables", {})
+        for key, value in test.items():
+            if key in TEST_METADATA:
+                result[key] = value
+            else:
+                inputs[key] = value
+        result["input"] = self.convert_inputs(inputs)
+        result["output"] = outputs
+        return result
+
+    def convert_inputs(self, inputs):
+        first_key = next(iter(inputs.keys()), None)
+        if first_key not in self.entities_by_plural:
+            return inputs
+        results = {}
+        for entity_plural, entities_description in inputs.items():
+            entity = self.entities_by_plural[entity_plural]
+            if not isinstance(entities_description, (CommentedSeq, list)):
+                entities_description = [entities_description]
+            if not entity.is_person and len(entities_description) == 1:
+                results[entity.key] = remove_id(entities_description[0])
+                continue
+            results[entity_plural] = self.convert_entities(entity, entities_description)
+
+        return self.generate_missing_entities(results)
+
+    def convert_entities(self, entity, entities_description):
+        return {
+            entity_description.get("id", f"{entity.key}_{index}"): remove_id(
+                entity_description,
+            )
+            for index, entity_description in enumerate(entities_description)
+        }
+
+    def generate_missing_entities(self, inputs):
+        for entity in self.tax_benefit_system.entities:
+            if entity.plural in inputs or entity.key in inputs:
+                continue
+            persons = inputs[self.tax_benefit_system.person_entity.plural]
+            if len(persons) == 1:
+                person_id = next(iter(persons))
+                inputs[entity.key] = {
+                    entity.roles[0].plural or entity.roles[0].key: [person_id],
+                }
+            else:
+                inputs[entity.plural] = {
+                    f"{entity.key}_{index}": {
+                        entity.roles[0].plural or entity.roles[0].key: [person_id],
+                    }
+                    for index, person_id in enumerate(persons.keys())
+                }
+        return inputs
+
+
+def remove_id(input_dict):
+    return {key: value for (key, value) in input_dict.items() if key != "id"}
+
+
+def main() -> None:
+    parser = build_parser()
+    args = parser.parse_args()
+    paths = [os.path.abspath(path) for path in args.path]
+
+    tax_benefit_system = build_tax_benefit_system(
+        args.country_package,
+        args.extensions,
+        args.reforms,
+    )
+
+    Migrator(tax_benefit_system).migrate(paths)
+
+
+if __name__ == "__main__":
+    main()

openfisca_core/scripts/openfisca_command.py

@@ -0,0 +1,192 @@
+import argparse
+import sys
+import warnings
+from importlib.metadata import version
+
+from openfisca_core.scripts import add_tax_benefit_system_arguments
+
+"""
+    Define the `openfisca` command line interface.
+"""
+
+
+def get_parser():
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "--version",
+        action="version",
+        version=f"OpenFisca-Core {version('OpenFisca-Core')}",
+    )
+
+    subparsers = parser.add_subparsers(help="Available commands", dest="command")
+    subparsers.required = (
+        True  # Can be added as an argument of add_subparsers in Python 3
+    )
+
+    def build_serve_parser(parser):
+        # Define OpenFisca modules configuration
+        parser = add_tax_benefit_system_arguments(parser)
+
+        # Define server configuration
+        parser.add_argument(
+            "-p",
+            "--port",
+            action="store",
+            help="port to serve on (use --bind to specify host and port)",
+            type=int,
+        )
+        parser.add_argument(
+            "--tracker-url",
+            action="store",
+            help="tracking service url",
+            type=str,
+        )
+        parser.add_argument(
+            "--tracker-idsite",
+            action="store",
+            help="tracking service id site",
+            type=int,
+        )
+        parser.add_argument(
+            "--tracker-token",
+            action="store",
+            help="tracking service authentication token",
+            type=str,
+        )
+        parser.add_argument(
+            "--welcome-message",
+            action="store",
+            help="welcome message users will get when visiting the API root",
+            type=str,
+        )
+        parser.add_argument(
+            "-f",
+            "--configuration-file",
+            action="store",
+            help="configuration file",
+            type=str,
+        )
+
+        return parser
+
+    parser_serve = subparsers.add_parser("serve", help="Run the OpenFisca Web API")
+    parser_serve = build_serve_parser(parser_serve)
+
+    def build_test_parser(parser):
+        parser.add_argument(
+            "path",
+            help="paths (files or directories) of tests to execute",
+            nargs="+",
+        )
+        parser = add_tax_benefit_system_arguments(parser)
+        parser.add_argument(
+            "-n",
+            "--name_filter",
+            default=None,
+            help="partial name of tests to execute. Only tests with the given name_filter in their name, file name, or keywords will be run.",
+        )
+        parser.add_argument(
+            "-p",
+            "--pdb",
+            action="store_true",
+            default=False,
+            help="drop into debugger on failures or errors",
+        )
+        parser.add_argument(
+            "--performance-graph",
+            "--performance",
+            action="store_true",
+            default=False,
+            help="output a performance graph in a 'performance_graph.html' file",
+        )
+        parser.add_argument(
+            "--performance-tables",
+            action="store_true",
+            default=False,
+            help="output performance CSV tables",
+        )
+        parser.add_argument(
+            "-v",
+            "--verbose",
+            action="store_true",
+            default=False,
+            help="increase output verbosity. If specified, output the entire calculation trace.",
+        )
+        parser.add_argument(
+            "-a",
+            "--aggregate",
+            action="store_true",
+            default=False,
+            help="increase output verbosity to aggregate. If specified, output the avg, max, and min values of the calculation trace. This flag has no effect without --verbose.",
+        )
+        parser.add_argument(
+            "-d",
+            "--max-depth",
+            type=int,
+            default=sys.maxsize,
+            help="set maximal verbosity depth. If specified, output the calculation trace up to the provided depth. This flag has no effect without --verbose.",
+        )
+        parser.add_argument(
+            "-o",
+            "--only-variables",
+            nargs="*",
+            default=None,
+            help="variables to test. If specified, only test the given variables.",
+        )
+        parser.add_argument(
+            "-i",
+            "--ignore-variables",
+            nargs="*",
+            default=None,
+            help="variables to ignore. If specified, do not test the given variables.",
+        )
+        parser.add_argument(
+            "--in-parallel",
+            action="store_true",
+            default=False,
+            help="run tests in parallel",
+        )
+        parser.add_argument(
+            "--num-workers",
+            type=int,
+            default=0,
+            help="number of parallel workers (default: CPU count - 1)",
+        )
+        parser.add_argument(
+            "--ignore-default",
+            action="store_true",
+            default=False,
+            help="in verbose mode, do not display variables that have their default value",
+        )
+
+        return parser
+
+    parser_test = subparsers.add_parser("test", help="Run OpenFisca YAML tests")
+    parser_test = build_test_parser(parser_test)
+
+    return parser
+
+
+def main():
+    if sys.argv[0].endswith("openfisca-run-test"):
+        sys.argv[0:1] = ["openfisca", "test"]
+        message = "The 'openfisca-run-test' command has been deprecated in favor of 'openfisca test' since version 25.0, and will be removed in the future."
+        warnings.warn(message, Warning, stacklevel=2)
+
+    parser = get_parser()
+
+    args, _ = parser.parse_known_args()
+
+    if args.command == "serve":
+        from openfisca_web_api.scripts.serve import main
+
+        return sys.exit(main(parser))
+    if args.command == "test":
+        from openfisca_core.scripts.run_test import main
+
+        return sys.exit(main(parser))
+    return None
+
+
+if __name__ == "__main__":
+    sys.exit(main())