Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Remove the Reform and chart functions that call the Public API

Aperta
  • Qualcosa non va?
#628 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 3 giorni

@anth-volk ci sta già lavorando.

Dal 22/10/2026.

  • #629 di @anth-volk — aperta

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
45/100
Tipo di issue
Refactoring
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python
Ambito
backend

Direzione di ricerca

Start by reading policyengine_core/reforms/reform.py, policyengine_core/charts/api.py, and the exports in policyengine_core.charts; trace the named methods and helpers and check their callers. Add the source scan test for api.policyengine.org, keep the dataset requests dependency, and add a removed changelog fragment. Done means the API functions and their exports are removed, the new test passes, and dependent repositories have merged their updates before release.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

What

Three parts of policyengine-core send HTTP requests to the PolicyEngine Public API (api.policyengine.org):

  • Reform.from_api (policyengine_core/reforms/reform.py) downloads a saved policy by its numeric ID with GET /{country}/policy/{id} and builds a Reform from it.
  • Reform.api_id (same module) sends the reform's parameter values to POST /{country}/policy and returns the new policy's ID.
  • policyengine_core/charts/api.py: get_api_chart_data reads GET /{country}/metadata, then requests GET /{country}/economy/{reform}/over/{baseline} once a second until the result is ready; intra_decile_chart and decile_chart plot that result. policyengine_core.charts re-exports all three.

Why

The Public API depends on the country packages, which depend on policyengine-core, so these functions make the lowest-level package depend on the top-level service at run time. The Public API's newer policy routes also have no lookup by these numeric policy IDs, and the routes these functions call are planned for removal.

Proposed change

  • Remove Reform.from_api, Reform.api_id, the helpers only they use (_api_period_range and classproperty, and the requests import in the reform module), and policyengine_core/charts/api.py with its re-export from policyengine_core.charts.
  • Add a test that fails if any file in the package source contains api.policyengine.org.
  • Keep the requests dependency, which policyengine_core/data/dataset.py uses.
  • Release it as a minor version through a removed changelog fragment.

Release order

The known users of these functions are being updated first: two test cases in policyengine-uk, three public repositories (uk-local-area-calibration, obr-forecast and blank-slate-ubi-in-the-us) and one private repository. policyengine-uk accepts any policyengine-core>=3.32.27, so the release containing this change must be published only after those changes merge; otherwise policyengine-uk's tests fail as soon as it is published.

Lingua principale
Python
Stelle
22
Fork
30
Merge medio
4g 16h
PR unite (30g)
35

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di PolicyEngine/policyengine-core

Tutte le issue di PolicyEngine/policyengine-core

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.