Define each country's years once and refuse society-wide requests for other years

Fermée
  • Quelque chose ne va pas ?
#4,211 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 2 jours

Une pull request liée a déjà été fusionnée.

  • #4212 par @anth-volk — fusionnée

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
54/100
Type d'issue
Fonctionnalité
Clarté
Clairement spécifiée
Activité
Active
Stack technique
python
Domaine
api, backend, databases

Piste de recherche

Read policyengine_api/country.py, policyengine_api/economy_years.py, and policyengine_api/data/v2/catalog/extraction.py to trace the current year lists, then inspect the economy routes and assert_country_matches to find request validation and catalog publication behavior. Check the existing route and catalog tests before making changes. Done means the shared country year lists drive metadata and extraction, unavailable economy years return 400 with DATASET_YEAR_UNAVAILABLE before stored results or simulation calls, and publication updates only time periods while still rejecting other differences.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

Problem

The maintainer decided on 4–5 November 2026 that:

  • US 2022 and 2023 are dropped everywhere. Household and society-wide calculations share one list of years per country, starting in 2024 for the US.
  • Each country's years are defined once, as constants in the Public API: US 2024–2035, UK 2024–2032.
  • A society-wide (economy) request for a year outside its country's list is refused with a 400, including when a result for that year is already stored.
  • Household calculations are not refused; only the menus stop offering those years.

Today the years are defined in three places:

  • /{country}/metadata's economy_options.time_period for the US is a hand-written list in policyengine_api/country.py, 2035 down to 2022.
  • The UK years come from uk_economy_years in policyengine_api/economy_years.py, from the installed policyengine-uk's projection end.
  • The v2 catalog has its own copy, METADATA_TIME_PERIODS in policyengine_api/data/v2/catalog/extraction.py: US 2035 to 2022, and UK 2024 to 2030, which is out of date.

The economy routes accept any four-digit year and pass it to the simulation service, and answer a stored result for it.

Catalog publication also fails when a stored catalog version's time periods (metadata_time_periods) differ from the staged ones (assert_country_matches), so changing the catalog's years would stop the next release's publication for an already-stored PolicyEngine.py version.

Change

  • Define each country's years once and use them for /{country}/metadata and catalog extraction.
  • Answer a society-wide request for any other year with 400 and the code DATASET_YEAR_UNAVAILABLE, before any stored result is read or anything is sent to the simulation service.
  • Make catalog publication replace a stored version's time periods with the staged ones, with a log entry, instead of failing. Every other column and table keeps failing on a difference.
Langage dominant
Python
Étoiles
18
Forks
33
Merge moyen
2 j 15 h
PR mergées (30 j)
110

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de PolicyEngine/policyengine-api

Toutes les issues de PolicyEngine/policyengine-api

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.