API review for version 4.0.0: thoughts, ideas, linked Issues, etc.
还没有人认领这个 Issue。
评估
调研方向
这是一次广泛的 API 审查，而不是范围明确的实现任务。首先阅读 Python Array API Standard 以及链接的 issue #775、#772、#773、#277、#328、#38 和 #135，然后审查列出的主题和相关的 cf-python API 讨论。不存在单一的完成标准；可执行的主题需要拆分为具有明确定义结果的聚焦 issue。
由索引模型根据 Issue 内容生成。
描述
This Issue is to collate and register any comments (thoughts, ideas, tentative decisions, questions, etc.) including links to self-contained related Issues, regarding the cf-python API (and perhaps the API of cfdm too, also keeping cf-plot and it's eventual incorporation into cf-python in mind).
The context, for those unaware, is that we will be reviewing and revising the API for a forthcoming version 4.0.0, which we hope to release by the end of 2024. Anything anyone wants to register on the topic of the cf-python API is very welcome! Brain dumps are welcome, though we may want to move distinct topics to their own Issues and link them in, if themes emerge.
Useful references are:
- the Python Array API Standard, which we want to abide by unless there is good reason not to;
- the NumPy API which is of high relevance for our array-related operations;
- the Dask API ditto;
- the CF xarray API might be useful for background/comparison.
Please try to organise points/discussion as we go along into topics and themes, noting them below (ideally linking to comments and/or Issues). Anyone contributing to the thread feel free to edit/update this.
Topics and themes
- conforming to the Python Array API standard (see link above)
- deprecated objects:
- ensure all deprecation errors include stating replacements, else messages to indicate why there isn't one any longer (etc.) - should only be a small number of cases that don't abide by this already.
- views/representations of fields/datasets:
- including identical data in different formats, #775.
- truncation for long FieldLists, arrays, etc., #772.
- (methods for) conversion to/from other formats:
- xarray, #773
- availability of methods on given objects vs. module-level, #277
- level of support for NumPy-like operations (generalising sentiment in #328)
- more binary operations (now we are well-daskified), #38
- ensuring sets of related methods have full coverage, esp. pairs e.g. minima and maxima such as argmax and argmin (see https://github.com/NCAS-CMS/cf-python/issues/135)
- aliases e.g. for longer method names - when to use, what to use and how to document (including should we have a big table listing these?)
- simplifications in general - what can sensibly be streamlined?
- verbosity and logging (e.g. which methods deserve a
verbosekeyword)- getting all outputs managed under the logging umbrella, #286.
- 主要语言
- Python
- 星标
- 151
- 派生
- 23
- 平均合并
- 21 小时 29 分钟
- 30 天内合并 PR
- 1
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
NCAS-CMS/cf-python 的其他 Issue
-
Remove abandoned `cf.etc` directory可能已有人在做 @sadielbartholomew 于 28 天前认领。 未关闭code tidy
难度 2/5 1-3 小时 新手友好度 76/100
-
installation
难度 4/5 3-5 天 新手友好度 45/100
-
Attempt at unsupported conservative 3D mesh regridding可能已有人在做 @sadielbartholomew 于 26 天前认领。 未关闭bug?
-
Release: migrate from deprecated build command可能已有人在做 @sadielbartholomew 于 28 天前认领。 未关闭release
-
Remove support for Python 3.10 (EOL)可能已有人在做 @sadielbartholomew 于 28 天前认领。 未关闭enhancement
查看 NCAS-CMS/cf-python 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 68/100
维护者通常 3 天内回复
-
难度 2/5 1-3 小时 新手友好度 88/100
modelcontextprotocol/python-sdk#3648 ·
维护者通常 1 天内回复
-
docs good first issue
难度 2/5 1-3 小时 新手友好度 78/100
VenetoStato/giorgio#6 ·
-
难度 1/5 1 小时以内 新手友好度 70/100
EclipseFdn/open-vsx.org#13831 ·
维护者通常 1 天内回复
-
feature request
难度 2/5 1-3 小时 新手友好度 68/100
维护者通常 2 天内回复