PyBitmessage icon indicating copy to clipboard operation
PyBitmessage copied to clipboard

No more prints

Open PeterSurda opened this issue 7 years ago • 2 comments

There are still occasions where print has remained and should be replaced by the logger.*. Some can remain, e.g. the notification about daemonizing or missing dependencies. This issue will be updated as I find more locations.

  • [x] src/api.py

PeterSurda avatar Oct 12 '18 07:10 PeterSurda

@PeterSurda can we be clear about scope and expected results please? Some thoughts that come to mind:

  • Increase scope to use the opportunity of going through the code thoroughly with a mind on logging
  • Test various logging configurations (which?), remove config cruft, document what to expect out of logging, maybe testing further logging config examples (rsyslog, elasticsearch?)
  • Ensure log levels are appropriate and sent to stdout/stderr as appropriate
  • Consider consolidating the number of log levels in use
  • Consider any refactoring or standardisation of logging code (e.g. avoid code repetition, circular imports)
  • Consider whether a log entry is actually required; maybe the point of a log entry is to watch out for a condition that better testing could have guarded against
  • Ensure consistent log message style (tenses, first/third sing/pl person etc.)
  • Change print statements to use the logger
  • Implement tests around logging (critical examples?)

Quick check of the scale of this task: 12 logger.exception() calls 12 logger.fatal() calls 13 logger.critical() calls 20 logger.warning() calls 167 logger.info() calls 185 logger.debug() calls 467 (approx) print statements

coffeedogs avatar Oct 19 '18 15:10 coffeedogs

I have removed the print statement of the api.py module. https://github.com/Bitmessage/PyBitmessage/pull/1673

navjotcis avatar Sep 22 '20 13:09 navjotcis