Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Remove the Reform and chart functions that call the Public API

Đang mở
  • Có gì không ổn?
#628 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 3 ngày

@anth-volk đang làm issue này rồi.

Từ ngày 22/10/2026.

  • #629 của @anth-volk — đang mở

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
45/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
python
Lĩnh vực
backend

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Python
Star
22
Fork
30
Merge trung bình
4 ngày 16 giờ
Pull request đã merge (30 ngày)
35

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của PolicyEngine/policyengine-core

Tất cả issue của PolicyEngine/policyengine-core

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.