config.py

# Copyright CNRS/Inria/UCA
# Contributor(s): Eric Debreuve (since 2023)
#
# eric.debreuve@cnrs.fr
#
# This software is governed by the CeCILL  license under French law and
# abiding by the rules of distribution of free software.  You can  use,
# modify and/ or redistribute the software under the terms of the CeCILL
# license as circulated by CEA, CNRS and INRIA at the following URL
# "http://www.cecill.info".
#
# As a counterpart to the access to the source code and  rights to copy,
# modify and redistribute granted by the license, users are provided only
# with a limited warranty  and the software's author,  the holder of the
# economic rights,  and the successive licensors  have only  limited
# liability.
#
# In this respect, the user's attention is drawn to the risks associated
# with loading,  using,  modifying and/or developing or reproducing the
# software by the user in light of its specific status of free software,
# that may mean  that it is complicated to manipulate,  and  that  also
# therefore means  that it is reserved for developers  and  experienced
# professionals having in-depth computer knowledge. Users are therefore
# encouraged to load and test the software's suitability as regards their
# requirements in conditions enabling the security of their systems and/or
# data to be ensured and,  more generally, to use and operate it in the
# same conditions as regards security.
#
# The fact that you are presently reading this means that you have had
# knowledge of the CeCILL license and that you accept its terms.

import typing as h

LOGGER_NAME = "logger-36"
# https://docs.python.org/3/library/logging.html#logging.captureWarnings
WARNING_LOGGER_NAME = "py.warnings"


WARNING_TYPE_PATTERN = r"([^:]+):([0-9]+): ([^:]+): ([^\n]+)\n"


SHOW_W_RULE_ATTR = "show_w_rule"
SHOW_WHERE_ATTR = "where"
HIDE_WHERE_ATTR = "hide_where"
SHOW_MEMORY_ATTR = "show_memory_usage"

LEVEL_OPENING = "("
LEVEL_CLOSING = ")"
MESSAGE_MARKER = "| "
WHERE_SEPARATOR = "@"
ELAPSED_TIME_SEPARATOR = "+"
MEMORY_SEPARATOR = ":"
INTERCEPTION_SEPARATOR = " >>> "

DATE_FORMAT = "%Y-%m-%d"
TIME_FORMAT = "%H:%M:%S"
DATE_TIME_FORMAT = f"{DATE_FORMAT}@{TIME_FORMAT}"
WHERE_FORMAT = f" {WHERE_SEPARATOR} {{module}}:{{funcName}}:{{lineno}}"
ELAPSED_TIME_FORMAT = f" {ELAPSED_TIME_SEPARATOR}%(elapsed_time)s"
MEMORY_FORMAT = f" {MEMORY_SEPARATOR}%(memory_usage)s"


handler_codes_h = h.Literal["g", "c", "f", "a"]


HIDE_WHERE_KWARG = {"extra": {HIDE_WHERE_ATTR: True}}