Skip to content

# Logger

The tool to check the availability or syntax of domain, IP or URL.

::

    ██████╗ ██╗   ██╗███████╗██╗   ██╗███╗   ██╗ ██████╗███████╗██████╗ ██╗     ███████╗
    ██╔══██╗╚██╗ ██╔╝██╔════╝██║   ██║████╗  ██║██╔════╝██╔════╝██╔══██╗██║     ██╔════╝
    ██████╔╝ ╚████╔╝ █████╗  ██║   ██║██╔██╗ ██║██║     █████╗  ██████╔╝██║     █████╗
    ██╔═══╝   ╚██╔╝  ██╔══╝  ██║   ██║██║╚██╗██║██║     ██╔══╝  ██╔══██╗██║     ██╔══╝
    ██║        ██║   ██║     ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
    ╚═╝        ╚═╝   ╚═╝      ╚═════╝ ╚═╝  ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝

Provides our logger.

Author: Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom

Special thanks: https://pyfunceble.github.io/#/special-thanks

Contributors: https://pyfunceble.github.io/#/contributors

Project link: https://github.com/funilrys/PyFunceble

Project documentation: https://docs.pyfunceble.com

Project homepage: https://pyfunceble.github.io/

License: ::

    Copyright 2017, 2018, 2019, 2020, 2022, 2023, 2024 Nissar Chababy

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        https://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

## `Logger`

Provides our logging logic.

.. warning:: There is several way to activate the logging.

    1. Through the :code:`PYFUNCEBLE_DEBUG_ON_SCREEN` environment variable.
    2. Through the :code:`DEBUG_PYFUNCEBLE_ON_SCREEN` environment variable.
    3. Through the :code:`PYFUNCEBLE_DEBUG` environment variable.
    4. Through the :code:`DEBUG_PYFUNCEBLE` environment variable.
    5. Through the :py:meth:`PyFunceble.logger.Logger.set_activated` method.

Source code in `PyFunceble/logger.py`

     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
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423
    424
    425
    426
    427
    428
    429
    430
    431
    432
    433
    434
    435
    436
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449
    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    464
    465
    466
    467
    468
    469
    470
    471
    472
    473
    474
    475
    476
    477
    478
    479
    480
    481
    482
    483
    484
    485
    486
    487
    488
    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    531
    532
    533
    534
    535
    536
    537
    538
    539
    540
    541
    542
    543
    544
    545
    546
    547
    548
    549
    550
    551
    552

    class Logger:
        """
        Provides our logging logic.

        .. warning::
            There is several way to activate the logging.

            1. Through the :code:`PYFUNCEBLE_DEBUG_ON_SCREEN` environment variable.
            2. Through the :code:`DEBUG_PYFUNCEBLE_ON_SCREEN` environment variable.
            3. Through the :code:`PYFUNCEBLE_DEBUG` environment variable.
            4. Through the :code:`DEBUG_PYFUNCEBLE` environment variable.
            5. Through the :py:meth:`PyFunceble.logger.Logger.set_activated` method.
        """

        # pylint: disable=too-many-public-methods

        # pylint: disable=line-too-long
        OWN_FORMAT: str = (
            "[%(asctime)s | %(levelname)s | %(origin_path)s:"
            "%(origin_line)s@%(origin_func)s | PPID%(process)d:%(processName)s]:\n"
            "%(message)s\n"
        )
        """
        Our very own format.
        """

        ROOT_FORMAT: str = (
            "[%(asctime)s::%(levelname)s](PID%(process)s:%(processName)s): %(message)s"
        )
        """
        The format of the root loggy.
        """

        STD_MIN_LEVEL: int = logging.INFO

        _activated: bool = False
        _min_level: int = logging.INFO
        _output_directory: Optional[str] = None

        own_formatter: logging.Formatter = logging.Formatter(OWN_FORMAT)
        root_formatter: logging.Formatter = logging.Formatter(ROOT_FORMAT)

        info_logger: Optional[logging.Logger] = None
        debug_logger: Optional[logging.Logger] = None
        warning_logger: Optional[logging.Logger] = None
        error_logger: Optional[logging.Logger] = None
        fatal_logger: Optional[logging.Logger] = None
        critical_logger: Optional[logging.Logger] = None
        sqlalchemy_logger: Optional[logging.Logger] = None

        env_var_helper: EnvironmentVariableHelper = EnvironmentVariableHelper()

        def __init__(
            self,
            *,
            activated: Optional[bool] = None,
            min_level: Optional[int] = None,
            output_dir: Optional[str] = None,
        ) -> None:
            if output_dir:
                self.output_directory = output_dir
            else:
                self.output_directory = os.path.join(
                    PyFunceble.cli.storage.OUTPUT_DIRECTORY,
                    PyFunceble.cli.storage.OUTPUTS.logs.directories.parent,
                )

            if activated is not None:
                self.activated = activated

            if min_level is not None:
                self.min_level = min_level
            else:
                self.guess_and_set_min_level()

        @property
        def on_screen(self) -> bool:
            """
            Provides the authorization to log on screen.
            """

            return (
                self.env_var_helper.set_name("PYFUNCEBLE_DEBUG_ON_SCREEN").exists()
                or self.env_var_helper.set_name("DEBUG_PYFUNCEBLE_ON_SCREEN").exists()
            )

        @property
        def on_file(self) -> bool:
            """
            Provides the authorization to log on file.
            """

            return (
                self.env_var_helper.set_name("PYFUNCEBLE_DEBUG").exists()
                or self.env_var_helper.set_name("DEBUG_PYFUNCEBLE").exists()
            )

        @property
        def activated(self) -> bool:
            """
            Provides the current state of the :code:`_activated` attribute.
            """

            return self._activated

        @activated.setter
        def activated(self, value: bool) -> None:
            """
            Sets the value of the activated attribute.

            :param value:
                The value to set.

            :raise TypeError:
                When the given value is not a :py:class:`bool`.
            """

            if not isinstance(value, bool):
                raise TypeError(f"<value> should be {bool}, {type(value)} given.")

            self._activated = value

        def set_activated(self, value: bool) -> "Logger":
            """
            Sets the value of the activated attribute.

            :param value:
                The value to set.
            """

            self.activated = value

            return self

        @property
        def min_level(self) -> int:
            """
            Provides the current state of the :code:`_min_level` attribute.
            """

            return self._min_level

        @min_level.setter
        def min_level(self, value: Union[int, str]) -> None:
            """
            Sets the minimum level to log.

            :param value:
                The value to set.

            :raise TypeError:
                When the given value is not a :py:class:`int` or :py:class:`str`.
            :raise ValueError:
                When the given value is not supported
            """

            if not isinstance(value, (int, str)):
                raise TypeError(f"<value> should be {int} or {str}, {type(value)} given.")

            # pylint: disable=protected-access
            if isinstance(value, int) and value not in logging._levelToName:
                raise ValueError(f"<value> is not in {list(logging._nameToLevel.keys())}")

            if isinstance(value, str):
                if value.upper() not in logging._nameToLevel:
                    raise ValueError(
                        f"<value> is not in {list(logging._nameToLevel.keys())}"
                    )
                value = logging._nameToLevel[value.upper()]

            self._min_level = value

            return self

        def set_min_level(self, value: Union[int, str]) -> "Logger":
            """
            Sets the minimum level to log.

            :param value:
                The value to set.
            """

            self.min_level = value

            return self

        @property
        def output_directory(self) -> Optional[str]:
            """
            Provides the current state of the :code:`_output_directory` attribute.
            """

            if self.authorized:
                DirectoryHelper(self._output_directory).create()

            return self._output_directory

        @output_directory.setter
        def output_directory(self, value: str) -> None:
            """
            Sets the directory to write.

            Side Effect:
                Creation of the given value if it does not exists.

            :param value:
                The value to set.

            :raise TypeError:
                When the given value is not a  :py:class:`str`.
            """

            if not isinstance(value, str):
                raise TypeError(f"<value> should be {int}, {type(value)} given.")

            self._output_directory = value

        def set_output_directory(self, value: str) -> "Logger":
            """
            Sets the directory to write.

            :param value:
                The value to set.
            """

            self.output_directory = value

            return self

        @property
        def authorized(self) -> bool:
            """
            Provides the authorization to actually log.
            """

            return (
                self.activated
                or self.on_screen
                or self.on_file
                or (
                    bool(PyFunceble.storage.CONFIGURATION)
                    and bool(PyFunceble.storage.CONFIGURATION.debug.active)
                )
            )

        @staticmethod
        def get_origin() -> dict:
            """
            Provides the informatioon about where the logger was triggered.

            :return:
                A tuple, which is composed of the following.

                (trigger file path, trigger line, trigger function/method name)
            """

            stackback = [
                y for x in [x.split("\n") for x in traceback.format_stack()] for y in x if y
            ]
            interest = stackback[-6].split(",")

            complete_file = interest[0].strip()[6:-1].split(os.sep)

            try:
                if complete_file[-2] != PyFunceble.storage.PROJECT_NAME:
                    file = "/".join(complete_file)
                else:
                    file = "/".join(complete_file[-2:])
            except IndexError:
                file = "/".join(complete_file)

            line = interest[1].strip().split()[-1].strip()
            func_name = interest[2].strip()[3:]

            if PyFunceble.storage.PROJECT_NAME in file:
                file = os.path.relpath(file)

            return {"origin_path": file, "origin_line": line, "origin_func": func_name}

        def single_logger_factory(level_name: str):  # pylint: disable=no-self-argument
            """
            Provides the general factory.

            :param level_name:
                The level to log.
            """

            def single_logger(func):
                @functools.wraps(func)
                def wrapper(self, *args, **kwargs):
                    # pylint: disable=no-member, protected-access

                    if (
                        self.authorized
                        and logging._nameToLevel[level_name.upper()] >= self.min_level
                    ):
                        try:
                            logger = getattr(
                                getattr(self, f"{level_name.lower()}_logger"),
                                level_name.lower(),
                            )

                            if not logger:
                                self.init_loggers()
                        except AttributeError:
                            self.init_loggers()

                            logger = getattr(
                                getattr(self, f"{level_name.lower()}_logger"),
                                level_name.lower(),
                            )

                        return logger(*args, **kwargs, extra=self.get_origin())

                    return func

                return wrapper

            return single_logger

        def guess_and_set_min_level(self) -> "Logger":
            """
            Tries to guess the min level from the configuration.
            """

            env_vars = ["PYFUNCEBLE_DEBUG_LVL", "PYFUNCEBLE_LOGGING_LVL"]

            env_var_helper = EnvironmentVariableHelper()
            env_var_found = False

            for env_var in env_vars:
                if env_var_helper.set_name(env_var).exists():
                    self.min_level = env_var_helper.get_value()
                    env_var_found = True

                    break

            if not env_var_found:
                if PyFunceble.storage.CONFIGURATION:
                    # pylint: disable=protected-access
                    self.min_level = logging._nameToLevel[
                        PyFunceble.storage.CONFIGURATION.debug.level.upper()
                    ]
                else:
                    self.min_level = self.STD_MIN_LEVEL

        def guess_all_settings(self) -> "Logger":
            """
            Try to guess all settings.
            """

            to_ignore = ["guess_all_settings"]

            for method in dir(self):
                if method in to_ignore or not method.startswith("guess_"):
                    continue

                getattr(self, method)()

            return self

        def destroy_loggers(self) -> "Logger":
            """
            Destroyes all existing loggers.
            """

            for logger, level in self.get_next_logger():
                logger.handlers.clear()

                delattr(self, f"{level}_logger")
                setattr(self, f"{level}_logger", None)

        def get_next_logger(self) -> Generator[None, Tuple[logging.Logger, str], None]:
            """
            Provides the next logger.
            """

            for logger_var_name in Logger.__dict__:
                if (
                    not logger_var_name.endswith("_logger")
                    or logger_var_name == "get_next_logger"
                    or "sqlalchemy" in logger_var_name
                ):
                    continue

                level = logger_var_name.split("_", 1)[0]

                if not getattr(self, logger_var_name):
                    setattr(self, logger_var_name, logging.getLogger(f"PyFunceble.{level}"))

                yield getattr(self, logger_var_name), level

        def init_loggers(self) -> "Logger":
            """
            Init all our logger.
            """

            if self.authorized:
                self.destroy_loggers()

                if not self.sqlalchemy_logger:
                    self.sqlalchemy_logger = logging.getLogger("sqlalchemy")

                self.sqlalchemy_logger.setLevel(self.min_level)
                self.sqlalchemy_logger.propagate = False

                for logger, level in self.get_next_logger():
                    logger.propagate = False

                    # pylint: disable=protected-access
                    logger.setLevel(logging._nameToLevel[level.upper()])
                    logger.addHandler(self.get_handler(level))

            return self

        def get_handler(
            self, level_name: str
        ) -> Optional[Union[logging.StreamHandler, logging.handlers.RotatingFileHandler]]:
            """
            Given a level name, this method provides the right handler for it!
            """

            level_name = level_name.upper()
            specials = ["SQLALCHEMY"]

            if hasattr(logging, level_name) or level_name in specials:
                if self.on_screen:
                    handler = logging.StreamHandler()
                else:
                    handler = logging.handlers.RotatingFileHandler(
                        os.path.join(self.output_directory, f"{level_name.lower()}.log"),
                        maxBytes=100_000_000,
                        backupCount=5,
                    )

                if level_name in specials:
                    handler.setLevel(self.min_level)
                    handler.setFormatter(self.root_formatter)
                else:
                    handler.setLevel(getattr(logging, level_name))
                    handler.setFormatter(self.own_formatter)

                return handler

            return None

        @single_logger_factory("info")
        def info(self, *args, **kwargs):
            """
            Logs to the PyFunceble.info logger.
            """

        @single_logger_factory("debug")
        def debug(self, *args, **kwargs):
            """
            Logs to the PyFunceble.debug logger.
            """

        @single_logger_factory("warning")
        def warning(self, *args, **kwargs):
            """
            Logs to the PyFunceble.warning logger.
            """

        @single_logger_factory("error")
        def error(self, *args, **kwargs):
            """
            Logs to the PyFunceble.error logger.
            """

        @single_logger_factory("fatal")
        def fatal(self, *args, **kwargs):
            """
            Logs to the PyFunceble.fatal logger.
            """

        @single_logger_factory("critical")
        def critical(self, *args, **kwargs):
            """
            Logs to the PyFunceble.critical logger.
            """

        @single_logger_factory("exception")
        def exception(self, *args, **kwargs):
            """
            Logs to the PyFunceble.exception logger.
            """

### `OWN_FORMAT: str = '[%(asctime)s | %(levelname)s | %(origin_path)s:%(origin_line)s@%(origin_func)s | PPID%(process)d:%(processName)s]:\n%(message)s\n'` `class-attribute` `instance-attribute`

Our very own format.

### `ROOT_FORMAT: str = '[%(asctime)s::%(levelname)s](PID%(process)s:%(processName)s): %(message)s'` `class-attribute` `instance-attribute`

The format of the root loggy.

### `activated: bool` `property` `writable`

Provides the current state of the :code:`_activated` attribute.

### `authorized: bool` `property`

Provides the authorization to actually log.

### `min_level: int` `property` `writable`

Provides the current state of the :code:`_min_level` attribute.

### `on_file: bool` `property`

Provides the authorization to log on file.

### `on_screen: bool` `property`

Provides the authorization to log on screen.

### `output_directory: Optional[str]` `property` `writable`

Provides the current state of the :code:`_output_directory` attribute.

### `critical(*args, **kwargs)`

Logs to the PyFunceble.critical logger.

Source code in `PyFunceble/logger.py`

    542
    543
    544
    545
    546

    @single_logger_factory("critical")
    def critical(self, *args, **kwargs):
        """
        Logs to the PyFunceble.critical logger.
        """

### `debug(*args, **kwargs)`

Logs to the PyFunceble.debug logger.

Source code in `PyFunceble/logger.py`

    518
    519
    520
    521
    522

    @single_logger_factory("debug")
    def debug(self, *args, **kwargs):
        """
        Logs to the PyFunceble.debug logger.
        """

### `destroy_loggers()`

Destroyes all existing loggers.

Source code in `PyFunceble/logger.py`

    427
    428
    429
    430
    431
    432
    433
    434
    435
    436

    def destroy_loggers(self) -> "Logger":
        """
        Destroyes all existing loggers.
        """

        for logger, level in self.get_next_logger():
            logger.handlers.clear()

            delattr(self, f"{level}_logger")
            setattr(self, f"{level}_logger", None)

### `error(*args, **kwargs)`

Logs to the PyFunceble.error logger.

Source code in `PyFunceble/logger.py`

    530
    531
    532
    533
    534

    @single_logger_factory("error")
    def error(self, *args, **kwargs):
        """
        Logs to the PyFunceble.error logger.
        """

### `exception(*args, **kwargs)`

Logs to the PyFunceble.exception logger.

Source code in `PyFunceble/logger.py`

    548
    549
    550
    551
    552

    @single_logger_factory("exception")
    def exception(self, *args, **kwargs):
        """
        Logs to the PyFunceble.exception logger.
        """

### `fatal(*args, **kwargs)`

Logs to the PyFunceble.fatal logger.

Source code in `PyFunceble/logger.py`

    536
    537
    538
    539
    540

    @single_logger_factory("fatal")
    def fatal(self, *args, **kwargs):
        """
        Logs to the PyFunceble.fatal logger.
        """

### `get_handler(level_name)`

Given a level name, this method provides the right handler for it!

Source code in `PyFunceble/logger.py`

    481
    482
    483
    484
    485
    486
    487
    488
    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510

    def get_handler(
        self, level_name: str
    ) -> Optional[Union[logging.StreamHandler, logging.handlers.RotatingFileHandler]]:
        """
        Given a level name, this method provides the right handler for it!
        """

        level_name = level_name.upper()
        specials = ["SQLALCHEMY"]

        if hasattr(logging, level_name) or level_name in specials:
            if self.on_screen:
                handler = logging.StreamHandler()
            else:
                handler = logging.handlers.RotatingFileHandler(
                    os.path.join(self.output_directory, f"{level_name.lower()}.log"),
                    maxBytes=100_000_000,
                    backupCount=5,
                )

            if level_name in specials:
                handler.setLevel(self.min_level)
                handler.setFormatter(self.root_formatter)
            else:
                handler.setLevel(getattr(logging, level_name))
                handler.setFormatter(self.own_formatter)

            return handler

        return None

### `get_next_logger()`

Provides the next logger.

Source code in `PyFunceble/logger.py`

    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449
    450
    451
    452
    453
    454
    455
    456

    def get_next_logger(self) -> Generator[None, Tuple[logging.Logger, str], None]:
        """
        Provides the next logger.
        """

        for logger_var_name in Logger.__dict__:
            if (
                not logger_var_name.endswith("_logger")
                or logger_var_name == "get_next_logger"
                or "sqlalchemy" in logger_var_name
            ):
                continue

            level = logger_var_name.split("_", 1)[0]

            if not getattr(self, logger_var_name):
                setattr(self, logger_var_name, logging.getLogger(f"PyFunceble.{level}"))

            yield getattr(self, logger_var_name), level

### `get_origin()` `staticmethod`

Provides the informatioon about where the logger was triggered.

Returns:

Type | Description
--- | ---
`dict` | A tuple, which is composed of the following. (trigger file path, trigger line, trigger function/method name)

Source code in `PyFunceble/logger.py`

    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343

    @staticmethod
    def get_origin() -> dict:
        """
        Provides the informatioon about where the logger was triggered.

        :return:
            A tuple, which is composed of the following.

            (trigger file path, trigger line, trigger function/method name)
        """

        stackback = [
            y for x in [x.split("\n") for x in traceback.format_stack()] for y in x if y
        ]
        interest = stackback[-6].split(",")

        complete_file = interest[0].strip()[6:-1].split(os.sep)

        try:
            if complete_file[-2] != PyFunceble.storage.PROJECT_NAME:
                file = "/".join(complete_file)
            else:
                file = "/".join(complete_file[-2:])
        except IndexError:
            file = "/".join(complete_file)

        line = interest[1].strip().split()[-1].strip()
        func_name = interest[2].strip()[3:]

        if PyFunceble.storage.PROJECT_NAME in file:
            file = os.path.relpath(file)

        return {"origin_path": file, "origin_line": line, "origin_func": func_name}

### `guess_all_settings()`

Try to guess all settings.

Source code in `PyFunceble/logger.py`

    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423
    424
    425

    def guess_all_settings(self) -> "Logger":
        """
        Try to guess all settings.
        """

        to_ignore = ["guess_all_settings"]

        for method in dir(self):
            if method in to_ignore or not method.startswith("guess_"):
                continue

            getattr(self, method)()

        return self

### `guess_and_set_min_level()`

Tries to guess the min level from the configuration.

Source code in `PyFunceble/logger.py`

    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410

    def guess_and_set_min_level(self) -> "Logger":
        """
        Tries to guess the min level from the configuration.
        """

        env_vars = ["PYFUNCEBLE_DEBUG_LVL", "PYFUNCEBLE_LOGGING_LVL"]

        env_var_helper = EnvironmentVariableHelper()
        env_var_found = False

        for env_var in env_vars:
            if env_var_helper.set_name(env_var).exists():
                self.min_level = env_var_helper.get_value()
                env_var_found = True

                break

        if not env_var_found:
            if PyFunceble.storage.CONFIGURATION:
                # pylint: disable=protected-access
                self.min_level = logging._nameToLevel[
                    PyFunceble.storage.CONFIGURATION.debug.level.upper()
                ]
            else:
                self.min_level = self.STD_MIN_LEVEL

### `info(*args, **kwargs)`

Logs to the PyFunceble.info logger.

Source code in `PyFunceble/logger.py`

    512
    513
    514
    515
    516

    @single_logger_factory("info")
    def info(self, *args, **kwargs):
        """
        Logs to the PyFunceble.info logger.
        """

### `init_loggers()`

Init all our logger.

Source code in `PyFunceble/logger.py`

    458
    459
    460
    461
    462
    463
    464
    465
    466
    467
    468
    469
    470
    471
    472
    473
    474
    475
    476
    477
    478
    479

    def init_loggers(self) -> "Logger":
        """
        Init all our logger.
        """

        if self.authorized:
            self.destroy_loggers()

            if not self.sqlalchemy_logger:
                self.sqlalchemy_logger = logging.getLogger("sqlalchemy")

            self.sqlalchemy_logger.setLevel(self.min_level)
            self.sqlalchemy_logger.propagate = False

            for logger, level in self.get_next_logger():
                logger.propagate = False

                # pylint: disable=protected-access
                logger.setLevel(logging._nameToLevel[level.upper()])
                logger.addHandler(self.get_handler(level))

        return self

### `set_activated(value)`

Sets the value of the activated attribute.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`value` | `bool` | The value to set. | required

Source code in `PyFunceble/logger.py`

    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198

    def set_activated(self, value: bool) -> "Logger":
        """
        Sets the value of the activated attribute.

        :param value:
            The value to set.
        """

        self.activated = value

        return self

### `set_min_level(value)`

Sets the minimum level to log.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`value` | `Union[int, str]` | The value to set. | required

Source code in `PyFunceble/logger.py`

    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250

    def set_min_level(self, value: Union[int, str]) -> "Logger":
        """
        Sets the minimum level to log.

        :param value:
            The value to set.
        """

        self.min_level = value

        return self

### `set_output_directory(value)`

Sets the directory to write.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`value` | `str` | The value to set. | required

Source code in `PyFunceble/logger.py`

    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293

    def set_output_directory(self, value: str) -> "Logger":
        """
        Sets the directory to write.

        :param value:
            The value to set.
        """

        self.output_directory = value

        return self

### `single_logger_factory(level_name)`

Provides the general factory.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`level_name` | `str` | The level to log. | required

Source code in `PyFunceble/logger.py`

    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384

    def single_logger_factory(level_name: str):  # pylint: disable=no-self-argument
        """
        Provides the general factory.

        :param level_name:
            The level to log.
        """

        def single_logger(func):
            @functools.wraps(func)
            def wrapper(self, *args, **kwargs):
                # pylint: disable=no-member, protected-access

                if (
                    self.authorized
                    and logging._nameToLevel[level_name.upper()] >= self.min_level
                ):
                    try:
                        logger = getattr(
                            getattr(self, f"{level_name.lower()}_logger"),
                            level_name.lower(),
                        )

                        if not logger:
                            self.init_loggers()
                    except AttributeError:
                        self.init_loggers()

                        logger = getattr(
                            getattr(self, f"{level_name.lower()}_logger"),
                            level_name.lower(),
                        )

                    return logger(*args, **kwargs, extra=self.get_origin())

                return func

            return wrapper

        return single_logger

### `warning(*args, **kwargs)`

Logs to the PyFunceble.warning logger.

Source code in `PyFunceble/logger.py`

    524
    525
    526
    527
    528

    @single_logger_factory("warning")
    def warning(self, *args, **kwargs):
        """
        Logs to the PyFunceble.warning logger.
        """