Robottelo: Define standard for logging

Created on 18 Jul 2016 · 5Comments · Source: SatelliteQE/robottelo

Searching on project for "getLogger" you find several modules using it as a modules variable. Some use LOGGER=geLog... and anothers use logger = getLog...

We should use the same name for it and this issue is for discuss, define it and make changes

Source

renzon

Most helpful comment

I personally vote for logger lowercase.

Because it is an instance logger = logging.getLogger() it returns an instance of logging.RootLogger, and a custom object instance like that is not immutable as we can add more handlers and formatters to that, so using LOGGER looks like it is a constant which in my view stands better for builtin types and primary type objects.
Because it is the naming used in official documentation https://docs.python.org/3/library/logging.html and other tutorials and references uses lowercase as well http://docs.python-guide.org/en/latest/writing/logging/
Because it is simpler, logger is already the name of logger in other python libraries and frameworks, e.g: in Flask we have app.logger
Because upper case encapsulation and naming mangling is not a common pattern, I do not see too many _SOMETHING even in standard library. (referring to the previous used _LOGGER)
Because, maybe in future (after extensive testing specially in jenkins) we can move to logbook module so we just import logbook as logger logbook takes care of the configuration and module name initialization.

rochacbruno on 18 Jul 2016

👍2

All 5 comments

Particularly I prefer _LOGGER. "_" because it shoul be used only on module's scope. UPPER CASE because once created it should not be chaged.

renzon on 18 Jul 2016

I personally vote for logger lowercase.

Because it is an instance logger = logging.getLogger() it returns an instance of logging.RootLogger, and a custom object instance like that is not immutable as we can add more handlers and formatters to that, so using LOGGER looks like it is a constant which in my view stands better for builtin types and primary type objects.
Because it is the naming used in official documentation https://docs.python.org/3/library/logging.html and other tutorials and references uses lowercase as well http://docs.python-guide.org/en/latest/writing/logging/
Because it is simpler, logger is already the name of logger in other python libraries and frameworks, e.g: in Flask we have app.logger
Because upper case encapsulation and naming mangling is not a common pattern, I do not see too many _SOMETHING even in standard library. (referring to the previous used _LOGGER)
Because, maybe in future (after extensive testing specially in jenkins) we can move to logbook module so we just import logbook as logger logbook takes care of the configuration and module name initialization.

rochacbruno on 18 Jul 2016

👍2

My vote is for logger = logging.getLogger(__name__) which is a documentation recommendation, namespaces to loggers and make easy to see from what module the message came from.