Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Remove the Reform and chart functions that call the Public API

Abierto
  • ¿Algo no está bien?
#628 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 3 días

@anth-volk ya está trabajando en esto.

Desde el 22/10/2026.

  • #629 de @anth-volk — abierto

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
45/100
Tipo de issue
Refactorización
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
python
Área
backend

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Python
Estrellas
22
Forks
30
Merge medio
4 d 16 h
PR fusionados (30 d)
35

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de PolicyEngine/policyengine-core

Todos los issues de PolicyEngine/policyengine-core

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.