OpenFisca-France 169.16.8__tar.gz → 174.2.36__tar.gz

openfisca_france-174.2.36/.github/lint-changed-yaml-parameters.sh

@@ -0,0 +1,11 @@
+#! /usr/bin/env bash
+
+last_tagged_commit=`git describe --tags --abbrev=0 --first-parent`  # --first-parent ensures we don't follow tags not published in master through an unlikely intermediary merge commit
+
+if ! changes=$(git diff-index --name-only --diff-filter=ACMR --exit-code $last_tagged_commit -- "openfisca_france/parameters/*.yaml")
+then
+  echo "Linting the following changed YAML parameters:"
+  echo $changes
+  yamllint $changes
+else echo "No changed YAML parameters to lint"
+fi

openfisca_france-174.2.36/.github/pyproject_version.py

@@ -0,0 +1,82 @@
+# Read package version in pyproject.toml and replace it in .conda/recipe.yaml
+
+import argparse
+import logging
+import re
+
+logging.basicConfig(level=logging.INFO, format='%(message)s')
+PACKAGE_VERSION = 'X.X.X'
+CORE_VERSION = '>=43,<44'
+NUMPY_VERSION = '>=1.24.3,<2'
+
+
+def get_versions():
+    '''
+    Read package version and deps in pyproject.toml
+    '''
+    openfisca_core_api = None
+    openfisca_france = None
+    with open('./pyproject.toml', 'r') as file:
+        content = file.read()
+    # Extract the version of openfisca_france
+    version_match = re.search(r'^version\s*=\s*"([\d.]*)"', content, re.MULTILINE)
+    if version_match:
+        openfisca_france = version_match.group(1)
+    else:
+        raise Exception('Package version not found in pyproject.toml')
+    # Extract dependencies
+    version = re.search(r'"openfisca-core\[web-api\]\s*(>=\s*[\d.]+,\s*<\s*[\d.]+)"', content, re.MULTILINE)
+    if version:
+        openfisca_core_api = version.group(1)
+    version = re.search(r'numpy\s*(>=\s*[\d\.]*,\s*<\d*)"', content, re.MULTILINE)
+    if version:
+        numpy = version.group(1)
+    if not openfisca_core_api or not numpy:
+        raise Exception('Dependencies not found in pyproject.toml')
+    return {
+        'openfisca_france': openfisca_france,
+        'openfisca_core_api': openfisca_core_api.replace(' ', ''),
+        'numpy': numpy.replace(' ', ''),
+        }
+
+
+def replace_in_file(filepath: str, info: dict):
+    '''
+    ::filepath:: Path to meta.yaml, with filename
+    ::info:: Dict with information to populate
+    '''
+    with open(filepath, 'rt') as fin:
+        meta = fin.read()
+    # Replace with info from pyproject.toml
+    if PACKAGE_VERSION not in meta:
+        raise Exception(f'{PACKAGE_VERSION=} not found in {filepath}')
+    meta = meta.replace(PACKAGE_VERSION, info['openfisca_france'])
+    if CORE_VERSION not in meta:
+        raise Exception(f'{CORE_VERSION=} not found in {filepath}')
+    meta = meta.replace(CORE_VERSION, info['openfisca_core_api'])
+    if NUMPY_VERSION not in meta:
+        raise Exception(f'{NUMPY_VERSION=} not found in {filepath}')
+    meta = meta.replace(NUMPY_VERSION, info['numpy'])
+    with open(filepath, 'wt') as fout:
+        fout.write(meta)
+    logging.info(f'File {filepath} has been updated with informations from pyproject.toml.')
+
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-r', '--replace', type=bool, default=False, required=False, help='replace in file')
+    parser.add_argument('-f', '--filename', type=str, default='.conda/recipe.yaml', help='Path to recipe.yaml, with filename')
+    parser.add_argument('-o', '--only_package_version', type=bool, default=False, help='Only display current package version')
+    args = parser.parse_args()
+    info = get_versions()
+    file = args.filename
+    if args.only_package_version:
+        print(f'{info["openfisca_france"]}')  # noqa: T201
+        exit()
+    logging.info('Versions :')
+    print(info)  # noqa: T201
+    if args.replace:
+        logging.info(f'Replace in {file}')
+        replace_in_file(file, info)
+    else:
+        logging.info('Dry mode, no replace made')

openfisca_france-174.2.36/.github/workflows/workflow.yml

@@ -0,0 +1,354 @@
+name: OpenFisca France
+
+on:
+  push:
+  pull_request:
+    types: [opened, reopened]
+
+env:
+  # Versions disponibles visibles sur  https://raw.githubusercontent.com/actions/python-versions/main/versions-manifest.json
+  DEFAULT_PYTHON_VERSION: '3.13.7'
+  # Et sur https://anaconda.org/anaconda/python/files pour Conda.
+  # Mais la 3.13.7 disponible ne fonctionnait pas pour autant pour des problème de dépendances.
+  # On reste donc en 3.10.11 dans l'attente de la suppression de Conda.
+  CONDA_PYTHON_VERSION: '3.10.11'
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        os: ["ubuntu-24.04"]  # On peut ajouter "macos-latest" si besoin
+        python-version: ["3.9.12", "3.13.7"]
+        openfisca-dependencies: [minimal, maximal]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Cache build
+        id: restore-build
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.pythonLocation }}
+          key: build-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}-${{ github.sha }}-${{ matrix.os }}-${{ matrix.openfisca-dependencies }}
+          restore-keys: |  # in case of a cache miss (systematically unless the same commit is built repeatedly), the keys below will be used to restore dependencies from previous builds, and the cache will be stored at the end of the job, making up-to-date dependencies available for all jobs of the workflow; see more at https://docs.github.com/en/actions/advanced-guides/caching-dependencies-to-speed-up-workflows#example-using-the-cache-action
+            build-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}-${{ matrix.os }}
+            build-${{ env.pythonLocation }}-${{ matrix.os }}
+      - name: Build package
+        run: make build
+      - name: Minimal version
+        if: matrix.openfisca-dependencies == 'minimal'
+        run: | # Installs the OpenFisca dependencies minimal version from pyproject.toml
+            pip install $(python ${GITHUB_WORKSPACE}/.github/get_minimal_version.py)
+      - name: Cache release
+        id: restore-release
+        uses: actions/cache@v4
+        with:
+          path: dist
+          key: release-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}-${{ github.sha }}-${{ matrix.os }}-${{ matrix.openfisca-dependencies }}
+
+  build-and-test-conda:
+    runs-on: windows-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Cache build
+        uses: actions/cache@v4
+        with:
+          path: ./conda-bld
+          key: build-conda-${{ hashFiles('pyproject.toml') }}-${{ github.sha }}
+          enableCrossOsArchive: true
+      - name: set version
+        run: |
+          python3 .github/pyproject_version.py --replace True
+      - name: Build conda package
+        uses: prefix-dev/rattler-build-action@v0.2.16
+        with:
+          build-args: --quiet --channel openfisca --channel conda-forge --output-dir ./conda-bld
+          recipe-path: .conda/recipe.yaml
+          upload-artifact: false
+      - name: Setup conda
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          activate-environment: openfisca
+          miniforge-version: latest
+          python-version: ${{ env.CONDA_PYTHON_VERSION }}
+          use-mamba: true
+          channels: conda-forge,defaults
+      - name: Install package
+        shell: pwsh
+        run: mamba install --channel ./conda-bld --channel openfisca openfisca-france
+      - name: Test openfisca-france conda package
+        shell: pwsh
+        run: openfisca test tests/formulas/irpp.yaml
+
+  lint-files:
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        dependencies-version: [maximal]
+    needs: [ build ]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Fetch all the tags
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
+      - name: Cache build
+        id: restore-build
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.pythonLocation }}
+          key: build-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}-${{ github.sha }}-ubuntu-24.04-${{ matrix.dependencies-version }}
+      - run: make check-syntax-errors
+      - run: make check-style
+      - name: Lint Python files
+        run: "${GITHUB_WORKSPACE}/.github/lint-changed-python-files.sh"
+      - name: Lint YAML tests
+        run: "${GITHUB_WORKSPACE}/.github/lint-changed-yaml-tests.sh"
+      - name: Lint YAML parameters
+        run: "${GITHUB_WORKSPACE}/.github/lint-changed-yaml-parameters.sh"
+
+  test-python:
+    runs-on: ${{ matrix.os }}
+    needs: [ build ]
+    strategy:
+      fail-fast: true
+      matrix:
+        os: [ "ubuntu-24.04" ]  # On peut ajouter "macos-latest" si besoin
+        python-version: ["3.9.12", "3.13.7"]
+        openfisca-dependencies: [minimal, maximal]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Cache build
+        id: restore-build
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.pythonLocation }}
+          key: build-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}-${{ github.sha }}-${{ matrix.os }}-${{ matrix.openfisca-dependencies }}
+      - run: |
+          shopt -s globstar
+          openfisca test --country-package openfisca_france tests/**/*.py
+        if: matrix.openfisca-dependencies != 'minimal' || matrix.python-version != '3.9.12'
+
+  test-path-length:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
+      - name: Test max path length
+        run: make check-path-length
+
+  test-yaml:
+    runs-on: ubuntu-24.04
+    needs: [ build ]
+    strategy:
+      fail-fast: false
+      matrix:
+        # Set N number of parallel jobs to run tests on. Here we use 10 jobs
+        # Remember to update ci_node_index below to 0..N-1
+        ci_node_total: [ 10 ]
+        ci_node_index: [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ]
+        openfisca-dependencies: [minimal, maximal]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
+      - name: Cache build
+        id: restore-build
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.pythonLocation }}
+          key: build-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}-${{ github.sha }}-ubuntu-24.04-${{ matrix.openfisca-dependencies }}
+      - name: Split YAML tests
+        id: yaml-test
+        env:
+          CI_NODE_TOTAL: ${{ matrix.ci_node_total }}
+          CI_NODE_INDEX: ${{ matrix.ci_node_index }}
+        run: |
+          echo "TEST_FILES_SUBLIST=$(python "${GITHUB_WORKSPACE}/.github/split_tests.py" ${CI_NODE_TOTAL} ${CI_NODE_INDEX})" >> $GITHUB_ENV
+      - name: Run YAML test
+        run: |
+          openfisca test --country-package openfisca_france ${TEST_FILES_SUBLIST}
+
+  test-api:
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        dependencies-version: [maximal]
+    needs: [ build ]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
+      - name: Cache build
+        id: restore-build
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.pythonLocation }}
+          key: build-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}-${{ github.sha }}-ubuntu-24.04-${{ matrix.dependencies-version }}
+      - name: Test the Web API
+        run: "${GITHUB_WORKSPACE}/.github/test-api.sh"
+
+  test-on-windows-uv:
+    runs-on: windows-latest
+    needs: [ lint-files ]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@caf0cab7a618c569241d31dcd442f54681755d39 # v3.2.4
+        with:
+          version: "latest"
+      - name: Test max path length
+        run: uv run python openfisca_france/scripts/check_path_length.py
+      - name: Test lancement avec uv
+        shell: pwsh
+        run: uv run openfisca test --country-package openfisca_france tests/formulas/irpp.yaml
+
+  test-on-windows-conda:
+    runs-on: windows-latest
+    if: github.ref == 'refs/heads/master' # Only triggered for the `master` branch
+    needs: [ build-and-test-conda ]
+    steps:
+      # Checkout needed to get github.sha
+      - uses: actions/checkout@v4
+      - uses: conda-incubator/setup-miniconda@v3
+        with:
+          activate-environment: openfisca
+          miniforge-version: latest
+          python-version: ${{ env.CONDA_PYTHON_VERSION }}
+          use-mamba: true
+          channels: conda-forge,defaults
+      - name: Restore build
+        uses: actions/cache@v4
+        with:
+          path: ./conda-bld
+          key: build-conda-${{ hashFiles('pyproject.toml') }}-${{ github.sha }}
+          fail-on-cache-miss: true
+          enableCrossOsArchive: true
+      - name: Test max path length
+        run: "python3 openfisca_france/scripts/check_path_length.py"
+      - name: Install package
+        shell: pwsh
+        run: mamba install --channel ./conda-bld --channel openfisca openfisca-france
+      - name: Test conda package
+        shell: pwsh
+        run: openfisca test tests/formulas/irpp.yaml
+
+  check-version-and-changelog:
+    runs-on: ubuntu-24.04
+    needs: [ lint-files, test-python, test-yaml, test-api ] # Last job to run
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Fetch all the tags
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
+      - name: Check version number has been properly updated
+        run: "${GITHUB_WORKSPACE}/.github/is-version-number-acceptable.sh"
+
+  # GitHub Actions does not have a halt job option, to stop from deploying if no functional changes were found.
+  # We build a separate job to substitute the halt option.
+  # The `deploy` job is dependent on the output of the `check-for-functional-changes` job.
+  check-for-functional-changes:
+    runs-on: ubuntu-24.04
+    if: github.ref == 'refs/heads/master' # Only triggered for the `master` branch
+    needs: [ check-version-and-changelog ]
+    outputs:
+      status: ${{ steps.stop-early.outputs.status }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Fetch all the tags
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
+      - id: stop-early
+        run: if "${GITHUB_WORKSPACE}/.github/has-functional-changes.sh" ; then echo "::set-output name=status::success" ; fi
+
+  deploy:
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        dependencies-version: [maximal]
+    needs: [ check-for-functional-changes ]
+    if: needs.check-for-functional-changes.outputs.status == 'success'
+    env:
+      PYPI_USERNAME: __token__
+      PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Fetch all the tags
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
+      - name: Cache build
+        id: restore-build
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.pythonLocation }}
+          key: build-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}-${{ github.sha }}-ubuntu-24.04-${{ matrix.dependencies-version }}
+      - name: Cache release
+        id: restore-release
+        uses: actions/cache@v4
+        with:
+          path: dist
+          key: release-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}-${{ github.sha }}-ubuntu-24.04-${{ matrix.dependencies-version }}
+      - name: Upload a Python package to PyPi
+        run: twine upload dist/* --username $PYPI_USERNAME --password $PYPI_TOKEN
+      - name: Publish a git tag
+        run: "${GITHUB_WORKSPACE}/.github/publish-git-tag.sh"
+
+  publish-to-conda:
+    runs-on: windows-latest
+    needs: [ deploy, test-on-windows-conda ]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Restore build
+        uses: actions/cache@v4
+        with:
+          path: ./conda-bld
+          key: build-conda-${{ hashFiles('pyproject.toml') }}-${{ github.sha }}
+          fail-on-cache-miss: true
+          enableCrossOsArchive: true
+      - uses: conda-incubator/setup-miniconda@v3
+        with:
+          activate-environment: openfisca
+          miniforge-version: latest
+          python-version: ${{ env.CONDA_PYTHON_VERSION }}
+          use-mamba: true
+          channels: conda-forge,defaults
+      - name: Install package
+        shell: pwsh
+        run: mamba install --channel ./conda-bld --channel openfisca openfisca-france
+      - name: Test conda package
+        shell: pwsh
+        run: openfisca test tests/formulas/irpp.yaml
+      - name: Conda upload already built package
+        shell: pwsh
+        run: |
+          conda install --yes anaconda-client
+          anaconda -t ${{ secrets.ANACONDA_TOKEN }} upload --user openfisca ./conda-bld\noarch\openfisca-france-*