Skip to content

Module dcm2bids.utils.logger⚓︎

Setup logging configuration

View Source 
 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
# -*- coding: utf-8 -*-

"""Setup logging configuration"""

import logging

import sys

def setup_logging(log_level, log_file=None):

    """ Setup logging configuration"""

    # Check level

    level = getattr(logging, log_level.upper(), None)

    if not isinstance(level, int):

        raise ValueError(f"Invalid log level: {log_level}")

    fh = logging.FileHandler(log_file)

    # fh.setFormatter(formatter)

    fh.setLevel("DEBUG")

    sh = logging.StreamHandler(sys.stdout)

    sh.setLevel(log_level)

    sh_fmt = CustomFormatter(fmt="%(levelname)-8s| %(message)s")

    sh.setFormatter(sh_fmt)

    # default formatting is kept for the log file"

    logging.basicConfig(

        level=logging.DEBUG,

        format="%(asctime)s.%(msecs)02d - %(levelname)-8s - %(module)s.%(funcName)s | "

        "%(message)s",

        datefmt="%Y-%m-%d %H:%M:%S",

        handlers=[fh, sh]

    )

class CustomFormatter(logging.Formatter):

    """Logging colored formatter, adapted from https://stackoverflow.com/a/56944256/3638629"""

    grey = '\x1b[38;21m'

    blue = '\x1b[38;5;39m'

    yellow = '\x1b[38;5;226m'

    red = '\x1b[38;5;196m'

    bold_red = '\x1b[31;1m'

    reset = '\x1b[0m'

    def __init__(self, fmt):

        super().__init__()

        self.fmt = fmt

        self.FORMATS = {

            logging.DEBUG: self.grey + self.fmt + self.reset,

            logging.INFO: self.blue + self.fmt + self.reset,

            logging.WARNING: self.yellow + self.fmt + self.reset,

            logging.ERROR: self.red + self.fmt + self.reset,

            logging.CRITICAL: self.bold_red + self.fmt + self.reset

        }

    def format(self, record):

        log_fmt = self.FORMATS.get(record.levelno)

        formatter = logging.Formatter(log_fmt)

        return formatter.format(record)

Functions⚓︎

setup_logging⚓︎

1
2
3
4
def setup_logging(
    log_level,
    log_file=None
)

Setup logging configuration

View Source 
 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
def setup_logging(log_level, log_file=None):

    """ Setup logging configuration"""

    # Check level

    level = getattr(logging, log_level.upper(), None)

    if not isinstance(level, int):

        raise ValueError(f"Invalid log level: {log_level}")

    fh = logging.FileHandler(log_file)

    # fh.setFormatter(formatter)

    fh.setLevel("DEBUG")

    sh = logging.StreamHandler(sys.stdout)

    sh.setLevel(log_level)

    sh_fmt = CustomFormatter(fmt="%(levelname)-8s| %(message)s")

    sh.setFormatter(sh_fmt)

    # default formatting is kept for the log file"

    logging.basicConfig(

        level=logging.DEBUG,

        format="%(asctime)s.%(msecs)02d - %(levelname)-8s - %(module)s.%(funcName)s | "

        "%(message)s",

        datefmt="%Y-%m-%d %H:%M:%S",

        handlers=[fh, sh]

    )

Classes⚓︎

CustomFormatter⚓︎

1
2
3
class CustomFormatter(
    fmt
)

Logging colored formatter, adapted from https://stackoverflow.com/a/56944256/3638629

View Source 
 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
class CustomFormatter(logging.Formatter):

    """Logging colored formatter, adapted from https://stackoverflow.com/a/56944256/3638629"""

    grey = '\x1b[38;21m'

    blue = '\x1b[38;5;39m'

    yellow = '\x1b[38;5;226m'

    red = '\x1b[38;5;196m'

    bold_red = '\x1b[31;1m'

    reset = '\x1b[0m'

    def __init__(self, fmt):

        super().__init__()

        self.fmt = fmt

        self.FORMATS = {

            logging.DEBUG: self.grey + self.fmt + self.reset,

            logging.INFO: self.blue + self.fmt + self.reset,

            logging.WARNING: self.yellow + self.fmt + self.reset,

            logging.ERROR: self.red + self.fmt + self.reset,

            logging.CRITICAL: self.bold_red + self.fmt + self.reset

        }

    def format(self, record):

        log_fmt = self.FORMATS.get(record.levelno)

        formatter = logging.Formatter(log_fmt)

        return formatter.format(record)

Ancestors (in MRO)⚓︎

  • logging.Formatter

Class variables⚓︎

1
blue

1
bold_red

1
default_msec_format

1
default_time_format

1
grey

1
red

1
reset

1
yellow

Methods⚓︎

converter⚓︎

1
2
3
def converter(
    ...
)

localtime([seconds]) -> (tm_year,tm_mon,tm_mday,tm_hour,tm_min,

tm_sec,tm_wday,tm_yday,tm_isdst)

Convert seconds since the Epoch to a time tuple expressing local time. When 'seconds' is not passed in, convert the current time instead.

format⚓︎

1
2
3
4
def format(
    self,
    record
)

Format the specified record as text.

The record's attribute dictionary is used as the operand to a string formatting operation which yields the returned string. Before formatting the dictionary, a couple of preparatory steps are carried out. The message attribute of the record is computed using LogRecord.getMessage(). If the formatting string uses the time (as determined by a call to usesTime(), formatTime() is called to format the event time. If there is exception information, it is formatted using formatException() and appended to the message.

View Source 
1
2
3
4
5
6
7
    def format(self, record):

        log_fmt = self.FORMATS.get(record.levelno)

        formatter = logging.Formatter(log_fmt)

        return formatter.format(record)

formatException⚓︎

1
2
3
4
def formatException(
    self,
    ei
)

Format and return the specified exception information as a string.

This default implementation just uses traceback.print_exception()

View Source 
 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
    def formatException(self, ei):

        """

        Format and return the specified exception information as a string.

        This default implementation just uses

        traceback.print_exception()

        """

        sio = io.StringIO()

        tb = ei[2]

        # See issues #9427, #1553375. Commented out for now.

        #if getattr(self, 'fullstack', False):

        #    traceback.print_stack(tb.tb_frame.f_back, file=sio)

        traceback.print_exception(ei[0], ei[1], tb, None, sio)

        s = sio.getvalue()

        sio.close()

        if s[-1:] == "\n":

            s = s[:-1]

        return s

formatMessage⚓︎

1
2
3
4
def formatMessage(
    self,
    record
)
View Source 
1
2
3
    def formatMessage(self, record):

        return self._style.format(record)

formatStack⚓︎

1
2
3
4
def formatStack(
    self,
    stack_info
)

This method is provided as an extension point for specialized

formatting of stack information.

The input data is a string as returned from a call to

View Source 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
    def formatStack(self, stack_info):

        """

        This method is provided as an extension point for specialized

        formatting of stack information.

        The input data is a string as returned from a call to

        :func:`traceback.print_stack`, but with the last trailing newline

        removed.

        The base implementation just returns the value passed in.

        """

        return stack_info

formatTime⚓︎

1
2
3
4
5
def formatTime(
    self,
    record,
    datefmt=None
)

Return the creation time of the specified LogRecord as formatted text.

This method should be called from format() by a formatter which wants to make use of a formatted time. This method can be overridden in formatters to provide for any specific requirement, but the basic behaviour is as follows: if datefmt (a string) is specified, it is used with time.strftime() to format the creation time of the record. Otherwise, an ISO8601-like (or RFC 3339-like) format is used. The resulting string is returned. This function uses a user-configurable function to convert the creation time to a tuple. By default, time.localtime() is used; to change this for a particular formatter instance, set the 'converter' attribute to a function with the same signature as time.localtime() or time.gmtime(). To change it for all formatters, for example if you want all logging times to be shown in GMT, set the 'converter' attribute in the Formatter class.

View Source 
 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
    def formatTime(self, record, datefmt=None):

        """

        Return the creation time of the specified LogRecord as formatted text.

        This method should be called from format() by a formatter which

        wants to make use of a formatted time. This method can be overridden

        in formatters to provide for any specific requirement, but the

        basic behaviour is as follows: if datefmt (a string) is specified,

        it is used with time.strftime() to format the creation time of the

        record. Otherwise, an ISO8601-like (or RFC 3339-like) format is used.

        The resulting string is returned. This function uses a user-configurable

        function to convert the creation time to a tuple. By default,

        time.localtime() is used; to change this for a particular formatter

        instance, set the 'converter' attribute to a function with the same

        signature as time.localtime() or time.gmtime(). To change it for all

        formatters, for example if you want all logging times to be shown in GMT,

        set the 'converter' attribute in the Formatter class.

        """

        ct = self.converter(record.created)

        if datefmt:

            s = time.strftime(datefmt, ct)

        else:

            s = time.strftime(self.default_time_format, ct)

            if self.default_msec_format:

                s = self.default_msec_format % (s, record.msecs)

        return s

usesTime⚓︎

1
2
3
def usesTime(
    self
)

Check if the format uses the creation time of the record.

View Source 
1
2
3
4
5
6
7
8
9
    def usesTime(self):

        """

        Check if the format uses the creation time of the record.

        """

        return self._style.usesTime()
Last update: 2024-07-26
Created: 2024-07-26