NCAS-CMS / NCAS-CMS/cf-python

Utility to consolidate log messages of form f"X={X}"

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

Nessuno ha ancora preso questa issue.

code tidy
Lingua principale
Python
Stelle
150
Fork
23
Merge medio
1g 11h
PR unite (30g)
2

Descrizione

Particularly in the field module, but also frequently elsewhere throughout the modules in the codebase, we have logging or error messages (often for debugging but not always) which name a variable and then print it's value, for example across these blocks from field (though not always contiguously so as to be condensable into one statement):

https://github.com/NCAS-CMS/cf-python/blob/af15b433ea88fb3cbb712bea6c5e5a0c24f88dff/cf/field.py#L480-L483

and
https://github.com/NCAS-CMS/cf-python/blob/af15b433ea88fb3cbb712bea6c5e5a0c24f88dff/cf/field.py#L1724-L1735

These aren't necessarily troublesome and not usually user-facing (unless the user is hardcore and debugging), but to add flexibility of pretty-printed output (indentation, etc., even allowing for support of a machine-parsable output which can be queried rather than eyeballed for serious debugging) and reduce duplication it might be good to create a method that manages the logic of printing the name and value (and perhaps registering in some structure for such easy querying).

Guida per i contributori

Apri la guida per i contributori

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.

Direzione di ricerca

Inizia esaminando i blocchi di logging indicati in cf/field.py intorno alle righe 480–483 e 1724–1735, quindi cerca messaggi simili nei moduli. Chiarisci se l’utility debba solo consolidare l’output nome/valore o supportare anche record formattati in modo leggibile e interrogabili dalle macchine. Il lavoro è considerato completato quando sono stati concordati l’ambito e i test che coprono il comportamento di output scelto.

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

Valutazione

Stack tecnologico
python
Ambito
observability-sre
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
30/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.