1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
# -*- coding: utf-8 -*-
# Copyright 2007-2023 The HyperSpy developers
#
# This file is part of RosettaSciIO.
#
# RosettaSciIO is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# RosettaSciIO is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with RosettaSciIO. If not, see <https://www.gnu.org/licenses/#GPL>.
import logging
import sys
def set_log_level(level):
"""
Convenience function to set the log level of all rsciio modules.
Note: The log level of all other modules are left untouched.
Parameters
----------
level : int or str
The log level to set. Any values that `logging.Logger.setLevel()`
accepts are valid. The default options are:
- 'CRITICAL'
- 'ERROR'
- 'WARNING'
- 'INFO'
- 'DEBUG'
- 'NOTSET'
Examples
--------
For normal logging of rsciio functions, you can set the log level like
this:
>>> import rsciio
>>> rsciio.set_log_level('INFO')
>>> from rsciio.digitalmicrograph import file_reader
>>> file_reader('my_file.dm3')
INFO:rsciio.digital_micrograph:DM version: 3
INFO:rsciio.digital_micrograph:size 4796607 B
INFO:rsciio.digital_micrograph:Is file Little endian? True
INFO:rsciio.digital_micrograph:Total tags in root group: 15
"""
logger = initialize_logger("rsciio")
logger.setLevel(level)
class ColoredFormatter(logging.Formatter):
"""Colored log formatter.
This class is used to format the log output. The colors can be changed
by changing the ANSI escape codes in the class variables.
This is a modified version of both this
https://github.com/herzog0/best_python_logger
and this https://stackoverflow.com/questions/384076/how-can-i-color-python-logging-output/56944256#56944256
"""
grey = "\x1b[38;20m"
yellow = "\x1b[33;20m"
red = "\x1b[31;20m"
bold_red = "\x1b[31;1m"
reset = "\x1b[0m"
green = "\x1b[1;32m"
format = "%(levelname)s | RosettaSciIO | %(message)s (%(name)s:%(lineno)d)"
FORMATS = {
logging.DEBUG: grey + format + reset,
logging.INFO: green + format + reset,
logging.WARNING: yellow + format + reset,
logging.ERROR: red + format + reset,
logging.CRITICAL: bold_red + format + reset,
}
def format(self, record):
log_fmt = self.FORMATS.get(record.levelno)
formatter = logging.Formatter(log_fmt)
return formatter.format(record)
def initialize_logger(*args):
"""Creates a pretty logging instance where the colors can be changed
via the ColoredFormatter class. Any arguments passed to initialize_logger
will be passed to `logging.getLogger`
The logging output will also be redirected from the standard error file to
the standard output file.
"""
formatter = ColoredFormatter()
handler = logging.StreamHandler(sys.stdout)
handler.setFormatter(formatter)
_logger = logging.getLogger(*args)
# Remove existing handler
while len(_logger.handlers):
_logger.removeHandler(_logger.handlers[0])
_logger.addHandler(handler)
return _logger
|
