NCAS-CMS / NCAS-CMS/cf-python

Logging enhancements

Offen
#84 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

enhancement
Vorherrschende Sprache
Python
Sterne
150
Forks
23
Ø Merge
1 T. 11 Std.
Gemergte PRs (30 T.)
2

Beschreibung

Suggestions for extensions to the initial work merged in the PR #82. Equivalent to NCAS-CMS/cfdm#35 but for cf; for more details for each point here cross-reference with the points in the same order under that Issue:

  • new meaningful messages across the codebase & verbose kwargs to functions as applicable;
  • improved display in log calls of objects for readability;
  • add a file handler to optionally log messages and user calls with timestamps to file(s).

In this case there is also the matter of the interrelation between the logging emerging directly from cf & that originating from cfdm via import, but I will include that as part of a separate GH Issue as there are other global settings in both libraries which should be examined in that respect.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der Durchsicht von PR #82 und des entsprechenden Issues NCAS-CMS/cfdm#35 und arbeite dessen Punkte der Reihe nach ab. Lege den Umfang für aussagekräftige Meldungen und ausführliche kwargs, lesbare Objektdarstellungen sowie optionales Logging in Dateien mit Zeitstempeln fest; die Arbeit ist abgeschlossen, wenn diese drei Checklistenpunkte behandelt wurden, während die Interaktion der globalen Einstellungen von cf/cfdm separat bleibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
observability
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.