Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Convert schema-like objects to dataclasses

Aperta
#943 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Refactoring
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
python
Ambito
data

Direzione di ricerca

Inizia esaminando i dizionari paralleli in constants.py, soprattutto il formula term system e la sezione CF-supported Parametric Vertical Coordinates collegata nell’issue. Esamina la codebase insieme all’issue #942 alla ricerca di altri oggetti simili a schemi e considera solo i candidati con un consumer realmente utile; il lavoro è completo quando i casi meritevoli hanno schemas espliciti basati su dataclass, senza over-engineering.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

code tidy

As well as incorporating enumerations (see #942), there are objects in the codebase where we could convert to further data classes in order to better encode and handle their schema-like nature. Though we should only do so if a genuinely useful case for the logic using them, to avoid over-engineering.

An immediate example I see is from the parallel dictionaries in the constants module, e.g. the formula term system, where the same key space for the CF-supported Parametric Vertical Coordinates are spread across four parallel dicts which each define constraints set out in Appendix D of the CF Conventions:

https://github.com/NCAS-CMS/cf-python/blob/8c760f82ed119cdda0ad041bc9deec49f3bc15d4/cf/constants.py#L212-L494

and where conversion to data classes of a template similar to the following would make the underlying schema explicit and improve readability/maintainability:

from dataclasses import dataclass

@dataclass(frozen=True)
class FormulaDefinition:
    standard_names: dict
    units: dict
    max_dimensions: dict
    computed_standard_names: dict

But we can systematically survey the codebase for further candidates, ideally at the same time as we plan #942.

Lingua principale
Python
Stelle
151
Fork
23
Merge medio
21h 29m
PR unite (30g)
1

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di NCAS-CMS/cf-python

Tutte le issue di NCAS-CMS/cf-python

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.