Logging enhancements
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 150
- Forks
- 23
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 2
Description
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 &
verbosekwargs 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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing PR #82 and the corresponding NCAS-CMS/cfdm#35 issue, following its points in order. Define the scope for meaningful messages and verbose kwargs, readable object displays, and optional timestamped file logging; the work is done when these three checklist items are addressed, while the cf/cfdm global-settings interaction remains separate.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- observability
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100