1. Python
1.1. Initialisation
1.1.1. Class "static" member
Logger should be defined as a static member of a class. Suggested name is "logger" . An example:
import logging class B: # class logger logger = logging.getLogger(__name__ + "." +__qualname__)
1.1.2. A global variable
Logger can be defined as a global variable (i.e. out of a class scope). This is not recommended way , because names may clash, if two or more modules will use the same name of variable.
import logging # global variable logger = logging.getLogger(__name__) class B: # class content pass
1.2. Printing information
The recommended way to access logger from within a class is __class__.logger
__class__.logger.debug('This is a debug message') __class__.logger.info('This is an info message') __class__.logger.warning('This is a warning message') __class__.logger.error('This is an error message') __class__.logging.critical('This is a critical message')
1.3. Setting logging level
Logging levels
# LOGGING LEVELS:
- logging.DEBUG
- logging.INFO
- logging.WARNING
- logging.ERROR
- logging.CRITICAL
User can configure logging level for:
all classes and modules of given application (via root logger)
import logging # setting ALL loggers logging.basicConfig(level=logging.ERROR)
particular class (via class logger )
import logging #setting particular logger logging.getLogger('fully.qualified.class.name').setLevel(logging.INFO)
module (via logger defined as global variable)
import logging #setting particular logger logging.getLogger('fully.qualified.module.name').setLevel(logging.INFO)
Fully Qualified Name
A name is fully qualified when it "is complete in the sense that it includes
(a) all names in the hierarchic sequence above the given element and
(b) the name of the given element itself."
Acknowledgement
This work has been carried out within the framework of the EUROfusion Consortium and has received funding from the Euratom research and training programme 2014-2018 under grant agreement No 633053.The scientific work is published for the realization of the international project co-financed by Polish Ministry of Science and Higher Education in 2019 and 2020 from financial resources of the program entitled "PMW"; Agreement No. 5040/H2020/Euratom/2019/2 and 5142/H2020-Euratom/2020/2”.