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

API review for version 4.0.0: thoughts, ideas, linked Issues, etc.

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

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
18/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
numpy, python
Área
api, data

Línea de trabajo

Esta es una revisión amplia de la API, no una tarea de implementación con un alcance definido. Empieza leyendo el Python Array API Standard y las issues vinculadas #775, #772, #773, #277, #328, #38 y #135; después, revisa los temas enumerados y las discusiones relacionadas sobre la API de cf-python. No existe un único criterio de finalización; los temas accionables tendrían que separarse en issues específicas con resultados definidos.

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

Descripción

API review (4.0.0) enhancement

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:

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 verbose keyword)
    • getting all outputs managed under the logging umbrella, #286.
Lenguaje dominante
Python
Estrellas
150
Forks
23
Merge medio
21 h 29 min
PR fusionados (30 d)
1

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 NCAS-CMS/cf-python

Todos los issues de NCAS-CMS/cf-python

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.