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
- 星號
- 150
- 分支
- 23
- 平均合併
- 21 小時 29 分鐘
- 30 天內合併 PR
- 1
環境準備
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
NCAS-CMS/cf-python 的其他 Issue
-
code tidy
難度 2/5 1-3 小時 新手友好度 76/100
-
Attempt at unsupported conservative 3D mesh regridding可能已有人在做 @sadielbartholomew 於 19 天前認領。 未關閉bug?
-
Release: migrate from deprecated build command可能已有人在做 @sadielbartholomew 於 21 天前認領。 未關閉release
-
Remove support for Python 3.10 (EOL)可能已有人在做 @sadielbartholomew 於 21 天前認領。 未關閉enhancement
-
bug
難度 3/5 1-2 天 新手友好度 45/100
查看 NCAS-CMS/cf-python 的全部 Issue
相似的 Issue
-
[Bug] @deck.gl/arcgis dist import resolves to unpublished @deck.gl/core source path (9.3.11, 9.4.0)未關閉
難度 2/5 1-3 小時 新手友好度 72/100
維護者通常 1 天內回覆
-
workflow: a tick's dispatch counts as 'only this step', and no review self-grants a round unattended未關閉workflow
難度 2/5 1-3 小時 新手友好度 85/100
kristofdegrave/homeassistant-smart-charging#1505 ·
維護者通常 1 天內回覆
-
metadata submission
難度 2/5 1-3 小時 新手友好度 82/100
-
bug
難度 2/5 1-3 小時 新手友好度 65/100
canonical/content-cache-operator#163 · 1 則留言 ·
維護者通常 1 天內回覆
-
[submission]未關閉submission
難度 1/5 1 小時以內 新手友好度 65/100
leanprover/lean-eval-submissions#1852 ·
維護者通常 1 天內回覆