Remove the Reform and chart functions that call the Public API
维护者通常 3 天内回复
评估
调研方向
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.
由索引模型根据 Issue 内容生成。
描述
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 withGET /{country}/policy/{id}and builds aReformfrom it.Reform.api_id(same module) sends the reform's parameter values toPOST /{country}/policyand returns the new policy's ID.policyengine_core/charts/api.py:get_api_chart_datareadsGET /{country}/metadata, then requestsGET /{country}/economy/{reform}/over/{baseline}once a second until the result is ready;intra_decile_chartanddecile_chartplot that result.policyengine_core.chartsre-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_rangeandclassproperty, and therequestsimport in the reform module), andpolicyengine_core/charts/api.pywith its re-export frompolicyengine_core.charts. - Add a test that fails if any file in the package source contains
api.policyengine.org. - Keep the
requestsdependency, whichpolicyengine_core/data/dataset.pyuses. - Release it as a minor version through a
removedchangelog 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.
- 主要语言
- Python
- 星标
- 22
- 派生
- 30
- 平均合并
- 4 天 16 小时
- 30 天内合并 PR
- 35
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
PolicyEngine/policyengine-core 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 76/100
PolicyEngine/policyengine-core#605 · 1 条评论 ·
维护者通常 3 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
PolicyEngine/policyengine-core#549 ·
维护者通常 3 天内回复
-
`restore_simulation` silently drops memberless group entities可能已有人在做 @Adelagric 于 43 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 78/100
PolicyEngine/policyengine-core#547 ·
维护者通常 3 天内回复
-
SimulationBuilder.build_from_dict should clear dataset provenance when rebuilding from a situation未关闭
难度 4/5 3-5 天 新手友好度 45/100
PolicyEngine/policyengine-core#627 ·
维护者通常 3 天内回复
-
难度 5/5 一周以上 新手友好度 8/100
PolicyEngine/policyengine-core#621 ·
维护者通常 3 天内回复
查看 PolicyEngine/policyengine-core 的全部 Issue
相似的 Issue
-
good first issue infrastructure
难度 2/5 1-3 小时 新手友好度 76/100
kuznia-rdzeni/coreblocks#1135 ·
-
good first issue server
难度 2/5 1-3 小时 新手友好度 85/100
维护者通常 1 天内回复
-
documentation priority: high
难度 2/5 1-3 小时 新手友好度 78/100
a-lex-s/mealie-telegram-bot#54 ·
维护者通常 1 天内回复
-
type/test
难度 2/5 1-3 小时 新手友好度 76/100
SaltedTan/virgil-language-server#218 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 83/100
btclib-org/btclib-wallet#541 ·
维护者通常 1 天内回复