python-colorlog-6.8.2/0000775000232200023220000000000014554734410015245 5ustar debalancedebalancepython-colorlog-6.8.2/setup.cfg0000664000232200023220000000024314554734410017065 0ustar debalancedebalance[flake8] exclude = .tox,.venv ignore = W503 max-line-length = 88 [tool:pytest] addopts = -p no:logging [mypy] files = colorlog,doc ignore_missing_imports = True python-colorlog-6.8.2/README.md0000664000232200023220000002247014554734410016531 0ustar debalancedebalance# Log formatting with colors! [![](https://img.shields.io/pypi/v/colorlog.svg)](https://pypi.org/project/colorlog/) [![](https://img.shields.io/pypi/l/colorlog.svg)](https://pypi.org/project/colorlog/) Add colours to the output of Python's `logging` module. * [Source on GitHub](https://github.com/borntyping/python-colorlog) * [Packages on PyPI](https://pypi.org/pypi/colorlog/) ## Status colorlog currently requires Python 3.6 or higher. Older versions (below 5.x.x) support Python 2.6 and above. * colorlog 6.x requires Python 3.6 or higher. * colorlog 5.x is an interim version that will warn Python 2 users to downgrade. * colorlog 4.x is the final version supporting Python 2. [colorama] is included as a required dependency and initialised when using colorlog on Windows. This library is over a decade old and supported a wide set of Python versions for most of its life, which has made it a difficult library to add new features to. colorlog 6 may break backwards compatibility so that newer features can be added more easily, but may still not accept all changes or feature requests. colorlog 4 might accept essential bugfixes but should not be considered actively maintained and will not accept any major changes or new features. ## Installation Install from PyPI with: ```bash pip install colorlog ``` Several Linux distributions provide official packages ([Debian], [Arch], [Fedora], [Gentoo], [OpenSuse] and [Ubuntu]), and others have user provided packages ([BSD ports], [Conda]). ## Usage ```python import colorlog handler = colorlog.StreamHandler() handler.setFormatter(colorlog.ColoredFormatter( '%(log_color)s%(levelname)s:%(name)s:%(message)s')) logger = colorlog.getLogger('example') logger.addHandler(handler) ``` The `ColoredFormatter` class takes several arguments: - `format`: The format string used to output the message (required). - `datefmt`: An optional date format passed to the base class. See [`logging.Formatter`][Formatter]. - `reset`: Implicitly adds a color reset code to the message output, unless the output already ends with one. Defaults to `True`. - `log_colors`: A mapping of record level names to color names. The defaults can be found in `colorlog.default_log_colors`, or the below example. - `secondary_log_colors`: A mapping of names to `log_colors` style mappings, defining additional colors that can be used in format strings. See below for an example. - `style`: Available on Python 3.2 and above. See [`logging.Formatter`][Formatter]. Color escape codes can be selected based on the log records level, by adding parameters to the format string: - `log_color`: Return the color associated with the records level. - `_log_color`: Return another color based on the records level if the formatter has secondary colors configured (see `secondary_log_colors` below). Multiple escape codes can be used at once by joining them with commas when configuring the color for a log level (but can't be used directly in the format string). For example, `black,bg_white` would use the escape codes for black text on a white background. The following escape codes are made available for use in the format string: - `{color}`, `fg_{color}`, `bg_{color}`: Foreground and background colors. - `bold`, `bold_{color}`, `fg_bold_{color}`, `bg_bold_{color}`: Bold/bright colors. - `thin`, `thin_{color}`, `fg_thin_{color}`: Thin colors (terminal dependent). - `reset`: Clear all formatting (both foreground and background colors). The available color names are: - `black` - `red` - `green` - `yellow` - `blue`, - `purple` - `cyan` - `white` You can also use "bright" colors. These aren't standard ANSI codes, and support for these varies wildly across different terminals. - `light_black` - `light_red` - `light_green` - `light_yellow` - `light_blue` - `light_purple` - `light_cyan` - `light_white` ## Examples ![Example output](docs/example.png) The following code creates a `ColoredFormatter` for use in a logging setup, using the default values for each argument. ```python from colorlog import ColoredFormatter formatter = ColoredFormatter( "%(log_color)s%(levelname)-8s%(reset)s %(blue)s%(message)s", datefmt=None, reset=True, log_colors={ 'DEBUG': 'cyan', 'INFO': 'green', 'WARNING': 'yellow', 'ERROR': 'red', 'CRITICAL': 'red,bg_white', }, secondary_log_colors={}, style='%' ) ``` ### Using `secondary_log_colors` Secondary log colors are a way to have more than one color that is selected based on the log level. Each key in `secondary_log_colors` adds an attribute that can be used in format strings (`message` becomes `message_log_color`), and has a corresponding value that is identical in format to the `log_colors` argument. The following example highlights the level name using the default log colors, and highlights the message in red for `error` and `critical` level log messages. ```python from colorlog import ColoredFormatter formatter = ColoredFormatter( "%(log_color)s%(levelname)-8s%(reset)s %(message_log_color)s%(message)s", secondary_log_colors={ 'message': { 'ERROR': 'red', 'CRITICAL': 'red' } } ) ``` ### With [`dictConfig`][dictConfig] ```python logging.config.dictConfig({ 'formatters': { 'colored': { '()': 'colorlog.ColoredFormatter', 'format': "%(log_color)s%(levelname)-8s%(reset)s %(blue)s%(message)s" } } }) ``` A full example dictionary can be found in `tests/test_colorlog.py`. ### With [`fileConfig`][fileConfig] ```ini ... [formatters] keys=color [formatter_color] class=colorlog.ColoredFormatter format=%(log_color)s%(levelname)-8s%(reset)s %(bg_blue)s[%(name)s]%(reset)s %(message)s from fileConfig datefmt=%m-%d %H:%M:%S ``` An instance of ColoredFormatter created with those arguments will then be used by any handlers that are configured to use the `color` formatter. A full example configuration can be found in `tests/test_config.ini`. ### With custom log levels ColoredFormatter will work with custom log levels added with [`logging.addLevelName`][addLevelName]: ```python import logging, colorlog TRACE = 5 logging.addLevelName(TRACE, 'TRACE') formatter = colorlog.ColoredFormatter(log_colors={'TRACE': 'yellow'}) handler = logging.StreamHandler() handler.setFormatter(formatter) logger = logging.getLogger('example') logger.addHandler(handler) logger.setLevel('TRACE') logger.log(TRACE, 'a message using a custom level') ``` ## Tests Tests similar to the above examples are found in `tests/test_colorlog.py`. ## Status colorlog is in maintenance mode. I try and ensure bugfixes are published, but compatibility with Python 2.6+ and Python 3+ makes this a difficult codebase to add features to. Any changes that might break backwards compatibility for existing users will not be considered. ## Alternatives There are some more modern libraries for improving Python logging you may find useful. - [structlog] - [jsonlog] ## Projects using colorlog GitHub provides [a list of projects that depend on colorlog][dependents]. Some early adopters included [Errbot], [Pythran], and [zenlog]. ## Licence Copyright (c) 2012-2021 Sam Clements Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. [dictConfig]: http://docs.python.org/3/library/logging.config.html#logging.config.dictConfig [fileConfig]: http://docs.python.org/3/library/logging.config.html#logging.config.fileConfig [addLevelName]: https://docs.python.org/3/library/logging.html#logging.addLevelName [Formatter]: http://docs.python.org/3/library/logging.html#logging.Formatter [tox]: http://tox.readthedocs.org/ [Arch]: https://archlinux.org/packages/extra/any/python-colorlog/ [BSD ports]: https://www.freshports.org/devel/py-colorlog/ [colorama]: https://pypi.python.org/pypi/colorama [Conda]: https://anaconda.org/conda-forge/colorlog [Debian]: [https://packages.debian.org/buster/python3-colorlog](https://packages.debian.org/buster/python3-colorlog) [Errbot]: http://errbot.io/ [Fedora]: https://src.fedoraproject.org/rpms/python-colorlog [Gentoo]: https://packages.gentoo.org/packages/dev-python/colorlog [OpenSuse]: http://rpm.pbone.net/index.php3?stat=3&search=python-colorlog&srodzaj=3 [Pythran]: https://github.com/serge-sans-paille/pythran [Ubuntu]: https://launchpad.net/python-colorlog [zenlog]: https://github.com/ManufacturaInd/python-zenlog [structlog]: https://www.structlog.org/en/stable/ [jsonlog]: https://github.com/borntyping/jsonlog [dependents]: https://github.com/borntyping/python-colorlog/network/dependents?package_id=UGFja2FnZS01MDk3NDcyMQ%3D%3D python-colorlog-6.8.2/LICENSE0000664000232200023220000000212314554734410016250 0ustar debalancedebalanceThe MIT License (MIT) Copyright (c) 2012-2021 Sam Clements Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. python-colorlog-6.8.2/MANIFEST.in0000664000232200023220000000021114554734410016775 0ustar debalancedebalanceglobal-exclude *.py[co] recursive-include colorlog/tests/ *.py *.ini recursive-include doc/ *.py *.png include LICENSE include README.md python-colorlog-6.8.2/colorlog/0000775000232200023220000000000014554734410017065 5ustar debalancedebalancepython-colorlog-6.8.2/colorlog/py.typed0000664000232200023220000000000014554734410020552 0ustar debalancedebalancepython-colorlog-6.8.2/colorlog/__init__.py0000664000232200023220000000223414554734410021177 0ustar debalancedebalance"""A logging formatter for colored output.""" import sys import warnings from colorlog.formatter import ( ColoredFormatter, LevelFormatter, TTYColoredFormatter, default_log_colors, ) from colorlog.wrappers import ( CRITICAL, DEBUG, ERROR, FATAL, INFO, NOTSET, StreamHandler, WARN, WARNING, basicConfig, critical, debug, error, exception, getLogger, info, log, root, warning, ) __all__ = ( "CRITICAL", "DEBUG", "ERROR", "FATAL", "INFO", "NOTSET", "WARN", "WARNING", "ColoredFormatter", "LevelFormatter", "StreamHandler", "TTYColoredFormatter", "basicConfig", "critical", "debug", "default_log_colors", "error", "exception", "exception", "getLogger", "info", "log", "root", "warning", ) if sys.version_info < (3, 6): warnings.warn( "Colorlog requires Python 3.6 or above. Pin 'colorlog<5' to your dependencies " "if you require compatibility with older versions of Python. See " "https://github.com/borntyping/python-colorlog#status for more information." ) python-colorlog-6.8.2/colorlog/escape_codes.py0000664000232200023220000000460614554734410022062 0ustar debalancedebalance""" Generates a dictionary of ANSI escape codes. http://en.wikipedia.org/wiki/ANSI_escape_code Uses colorama as an optional dependency to support color on Windows """ import sys try: import colorama except ImportError: pass else: if sys.platform == "win32": colorama.init(strip=False) __all__ = ("escape_codes", "parse_colors") # Returns escape codes from format codes def esc(*codes: int) -> str: return "\033[" + ";".join(str(code) for code in codes) + "m" escape_codes = { "reset": esc(0), "bold": esc(1), "thin": esc(2), } escape_codes_foreground = { "black": 30, "red": 31, "green": 32, "yellow": 33, "blue": 34, "purple": 35, "cyan": 36, "white": 37, "light_black": 90, "light_red": 91, "light_green": 92, "light_yellow": 93, "light_blue": 94, "light_purple": 95, "light_cyan": 96, "light_white": 97, } escape_codes_background = { "black": 40, "red": 41, "green": 42, "yellow": 43, "blue": 44, "purple": 45, "cyan": 46, "white": 47, "light_black": 100, "light_red": 101, "light_green": 102, "light_yellow": 103, "light_blue": 104, "light_purple": 105, "light_cyan": 106, "light_white": 107, # Bold background colors don't exist, # but we used to provide these names. "bold_black": 100, "bold_red": 101, "bold_green": 102, "bold_yellow": 103, "bold_blue": 104, "bold_purple": 105, "bold_cyan": 106, "bold_white": 107, } # Foreground without prefix for name, code in escape_codes_foreground.items(): escape_codes["%s" % name] = esc(code) escape_codes["bold_%s" % name] = esc(1, code) escape_codes["thin_%s" % name] = esc(2, code) # Foreground with fg_ prefix for name, code in escape_codes_foreground.items(): escape_codes["fg_%s" % name] = esc(code) escape_codes["fg_bold_%s" % name] = esc(1, code) escape_codes["fg_thin_%s" % name] = esc(2, code) # Background with bg_ prefix for name, code in escape_codes_background.items(): escape_codes["bg_%s" % name] = esc(code) # 256 colour support for code in range(256): escape_codes["fg_%d" % code] = esc(38, 5, code) escape_codes["bg_%d" % code] = esc(48, 5, code) def parse_colors(string: str) -> str: """Return escape codes from a color sequence string.""" return "".join(escape_codes[n] for n in string.split(",") if n) python-colorlog-6.8.2/colorlog/wrappers.py0000664000232200023220000000423214554734410021303 0ustar debalancedebalance"""Wrappers around the logging module.""" import functools import logging import typing from logging import ( CRITICAL, DEBUG, ERROR, FATAL, INFO, NOTSET, StreamHandler, WARN, WARNING, getLogger, root, ) import colorlog.formatter __all__ = ( "CRITICAL", "DEBUG", "ERROR", "FATAL", "INFO", "NOTSET", "WARN", "WARNING", "StreamHandler", "basicConfig", "critical", "debug", "error", "exception", "getLogger", "info", "log", "root", "warning", ) def basicConfig( style: colorlog.formatter._FormatStyle = "%", log_colors: typing.Optional[colorlog.formatter.LogColors] = None, reset: bool = True, secondary_log_colors: typing.Optional[colorlog.formatter.SecondaryLogColors] = None, format: str = "%(log_color)s%(levelname)s%(reset)s:%(name)s:%(message)s", datefmt: typing.Optional[str] = None, **kwargs ) -> None: """Call ``logging.basicConfig`` and override the formatter it creates.""" logging.basicConfig(**kwargs) logging._acquireLock() # type: ignore try: handler = logging.root.handlers[0] handler.setFormatter( colorlog.formatter.ColoredFormatter( fmt=format, datefmt=datefmt, style=style, log_colors=log_colors, reset=reset, secondary_log_colors=secondary_log_colors, stream=kwargs.get("stream", None), ) ) finally: logging._releaseLock() # type: ignore def ensure_configured(func): """Modify a function to call our basicConfig() first if no handlers exist.""" @functools.wraps(func) def wrapper(*args, **kwargs): if len(logging.root.handlers) == 0: basicConfig() return func(*args, **kwargs) return wrapper debug = ensure_configured(logging.debug) info = ensure_configured(logging.info) warning = ensure_configured(logging.warning) error = ensure_configured(logging.error) critical = ensure_configured(logging.critical) log = ensure_configured(logging.log) exception = ensure_configured(logging.exception) python-colorlog-6.8.2/colorlog/formatter.py0000664000232200023220000001707514554734410021454 0ustar debalancedebalance"""The ColoredFormatter class.""" import logging import os import sys import typing import colorlog.escape_codes __all__ = ( "default_log_colors", "ColoredFormatter", "LevelFormatter", "TTYColoredFormatter", ) # Type aliases used in function signatures. EscapeCodes = typing.Mapping[str, str] LogColors = typing.Mapping[str, str] SecondaryLogColors = typing.Mapping[str, LogColors] if sys.version_info >= (3, 8): _FormatStyle = typing.Literal["%", "{", "$"] else: _FormatStyle = str # The default colors to use for the debug levels default_log_colors = { "DEBUG": "white", "INFO": "green", "WARNING": "yellow", "ERROR": "red", "CRITICAL": "bold_red", } # The default format to use for each style default_formats = { "%": "%(log_color)s%(levelname)s:%(name)s:%(message)s", "{": "{log_color}{levelname}:{name}:{message}", "$": "${log_color}${levelname}:${name}:${message}", } class ColoredRecord: """ Wraps a LogRecord, adding escape codes to the internal dict. The internal dict is used when formatting the message (by the PercentStyle, StrFormatStyle, and StringTemplateStyle classes). """ def __init__(self, record: logging.LogRecord, escapes: EscapeCodes) -> None: self.__dict__.update(record.__dict__) self.__dict__.update(escapes) class ColoredFormatter(logging.Formatter): """ A formatter that allows colors to be placed in the format string. Intended to help in creating more readable logging output. """ def __init__( self, fmt: typing.Optional[str] = None, datefmt: typing.Optional[str] = None, style: _FormatStyle = "%", log_colors: typing.Optional[LogColors] = None, reset: bool = True, secondary_log_colors: typing.Optional[SecondaryLogColors] = None, validate: bool = True, stream: typing.Optional[typing.IO] = None, no_color: bool = False, force_color: bool = False, defaults: typing.Optional[typing.Mapping[str, typing.Any]] = None, ) -> None: """ Set the format and colors the ColoredFormatter will use. The ``fmt``, ``datefmt``, ``style``, and ``default`` args are passed on to the ``logging.Formatter`` constructor. The ``secondary_log_colors`` argument can be used to create additional ``log_color`` attributes. Each key in the dictionary will set ``{key}_log_color``, using the value to select from a different ``log_colors`` set. :Parameters: - fmt (str): The format string to use. - datefmt (str): A format string for the date. - log_colors (dict): A mapping of log level names to color names. - reset (bool): Implicitly append a color reset to all records unless False. - style ('%' or '{' or '$'): The format style to use. - secondary_log_colors (dict): Map secondary ``log_color`` attributes. (*New in version 2.6.*) - validate (bool) Validate the format string. - stream (typing.IO) The stream formatted messages will be printed to. Used to toggle colour on non-TTY outputs. Optional. - no_color (bool): Disable color output. - force_color (bool): Enable color output. Takes precedence over `no_color`. """ # Select a default format if `fmt` is not provided. fmt = default_formats[style] if fmt is None else fmt if sys.version_info >= (3, 10): super().__init__(fmt, datefmt, style, validate, defaults=defaults) elif sys.version_info >= (3, 8): super().__init__(fmt, datefmt, style, validate) else: super().__init__(fmt, datefmt, style) self.log_colors = log_colors if log_colors is not None else default_log_colors self.secondary_log_colors = ( secondary_log_colors if secondary_log_colors is not None else {} ) self.reset = reset self.stream = stream self.no_color = no_color self.force_color = force_color def formatMessage(self, record: logging.LogRecord) -> str: """Format a message from a record object.""" escapes = self._escape_code_map(record.levelname) wrapper = ColoredRecord(record, escapes) message = super().formatMessage(wrapper) # type: ignore message = self._append_reset(message, escapes) return message def _escape_code_map(self, item: str) -> EscapeCodes: """ Build a map of keys to escape codes for use in message formatting. If _blank_escape_codes() returns True, all values will be an empty string. """ codes = {**colorlog.escape_codes.escape_codes} codes.setdefault("log_color", self._get_escape_code(self.log_colors, item)) for name, colors in self.secondary_log_colors.items(): codes.setdefault("%s_log_color" % name, self._get_escape_code(colors, item)) if self._blank_escape_codes(): codes = {key: "" for key in codes.keys()} return codes def _blank_escape_codes(self): """Return True if we should be prevented from printing escape codes.""" if self.force_color or "FORCE_COLOR" in os.environ: return False if self.no_color or "NO_COLOR" in os.environ: return True if self.stream is not None and not self.stream.isatty(): return True return False @staticmethod def _get_escape_code(log_colors: LogColors, item: str) -> str: """Extract a color sequence from a mapping, and return escape codes.""" return colorlog.escape_codes.parse_colors(log_colors.get(item, "")) def _append_reset(self, message: str, escapes: EscapeCodes) -> str: """Add a reset code to the end of the message, if it's not already there.""" reset_escape_code = escapes["reset"] if self.reset and not message.endswith(reset_escape_code): message += reset_escape_code return message class LevelFormatter: """An extension of ColoredFormatter that uses per-level format strings.""" def __init__(self, fmt: typing.Mapping[str, str], **kwargs: typing.Any) -> None: """ Configure a ColoredFormatter with its own format string for each log level. Supports fmt as a dict. All other args are passed on to the ``colorlog.ColoredFormatter`` constructor. :Parameters: - fmt (dict): A mapping of log levels (represented as strings, e.g. 'WARNING') to format strings. (*New in version 2.7.0) (All other parameters are the same as in colorlog.ColoredFormatter) Example: formatter = colorlog.LevelFormatter( fmt={ "DEBUG": "%(log_color)s%(message)s (%(module)s:%(lineno)d)", "INFO": "%(log_color)s%(message)s", "WARNING": "%(log_color)sWRN: %(message)s (%(module)s:%(lineno)d)", "ERROR": "%(log_color)sERR: %(message)s (%(module)s:%(lineno)d)", "CRITICAL": "%(log_color)sCRT: %(message)s (%(module)s:%(lineno)d)", } ) """ self.formatters = { level: ColoredFormatter(fmt=f, **kwargs) for level, f in fmt.items() } def format(self, record: logging.LogRecord) -> str: return self.formatters[record.levelname].format(record) # Provided for backwards compatibility. The features provided by this subclass are now # included directly in the `ColoredFormatter` class. TTYColoredFormatter = ColoredFormatter python-colorlog-6.8.2/colorlog/tests/0000775000232200023220000000000014554734410020227 5ustar debalancedebalancepython-colorlog-6.8.2/colorlog/tests/test_config.ini0000664000232200023220000000047114554734410023236 0ustar debalancedebalance[loggers] keys=root [logger_root] handlers=stream level=DEBUG [formatters] keys=color [formatter_color] class=colorlog.ColoredFormatter format=%(log_color)s%(levelname)s:%(name)s:%(message)s:test_config.ini datefmt=%H:%M:%S [handlers] keys=stream [handler_stream] class=StreamHandler formatter=color args=() python-colorlog-6.8.2/colorlog/tests/test_colorlog.py0000664000232200023220000000655014554734410023466 0ustar debalancedebalance"""Test the colorlog.colorlog module.""" import sys import colorlog def test_colored_formatter(create_and_test_logger): create_and_test_logger() def test_custom_colors(create_and_test_logger): """Disable all colors and check no escape codes are output.""" create_and_test_logger( log_colors={}, reset=False, validator=lambda line: "\x1b[" not in line ) def test_reset(create_and_test_logger): create_and_test_logger(reset=True, validator=lambda line: line.endswith("\x1b[0m")) def test_no_reset(create_and_test_logger): create_and_test_logger( fmt="%(reset)s%(log_color)s%(levelname)s:%(name)s:%(message)s", reset=False, # Check that each line does not end with an escape code validator=lambda line: not line.endswith("\x1b[0m"), ) def test_secondary_colors(create_and_test_logger): expected = ":\x1b[31mtest_secondary_colors:\x1b[34m" create_and_test_logger( fmt=( "%(log_color)s%(levelname)s:" "%(name_log_color)s%(name)s:" "%(message_log_color)s%(message)s" ), secondary_log_colors={ "name": { "DEBUG": "red", "INFO": "red", "WARNING": "red", "ERROR": "red", "CRITICAL": "red", }, "message": { "DEBUG": "blue", "INFO": "blue", "WARNING": "blue", "ERROR": "blue", "CRITICAL": "blue", }, }, validator=lambda line: expected in line, ) def test_some_secondary_colors(create_and_test_logger): lines = create_and_test_logger( fmt="%(message_log_color)s%(message)s", secondary_log_colors={"message": {"ERROR": "red", "CRITICAL": "red"}}, ) # Check that only two lines are colored assert len([line for line in lines if "\x1b[31m" in line]) == 2 def test_percent_style(create_and_test_logger): create_and_test_logger( fmt="%(log_color)s%(levelname)s%(reset)s:%(name)s:%(message)s", style="%" ) def test_braces_style(create_and_test_logger): create_and_test_logger( fmt="{log_color}{levelname}{reset}:{name}:{message}", style="{" ) def test_template_style(create_and_test_logger): create_and_test_logger( fmt="${log_color}${levelname}${reset}:${name}:${message}", style="$" ) class TestLevelFormatter: def test_level_formatter(self, create_and_test_logger): create_and_test_logger( formatter_class=colorlog.LevelFormatter, fmt={ "DEBUG": "%(message)s", "INFO": "%(message)s", "WARNING": "%(message)s", "ERROR": "%(message)s", "CRITICAL": "%(message)s", }, ) def test_ttycolorlog(create_and_test_logger, monkeypatch): monkeypatch.setattr(sys.stderr, "isatty", lambda: True) create_and_test_logger( formatter_class=colorlog.TTYColoredFormatter, validator=lambda line: "\x1b[" in line, stream=sys.stderr, ) def test_ttycolorlog_notty(create_and_test_logger, monkeypatch): monkeypatch.setattr(sys.stderr, "isatty", lambda: False) create_and_test_logger( formatter_class=colorlog.TTYColoredFormatter, validator=lambda line: "\x1b[" not in line, stream=sys.stderr, ) python-colorlog-6.8.2/colorlog/tests/test_exports.py0000664000232200023220000000063414554734410023347 0ustar debalancedebalance"""Test that `from colorlog import *` works correctly.""" from colorlog import * # noqa def test_exports(): assert { "ColoredFormatter", "default_log_colors", "basicConfig", "root", "getLogger", "debug", "info", "warning", "error", "exception", "critical", "log", "exception", } < set(globals()) python-colorlog-6.8.2/colorlog/tests/test_config.py0000664000232200023220000000235314554734410023110 0ustar debalancedebalance"""Test using colorlog with logging.config""" import logging import logging.config import os.path def path(filename): """Return an absolute path to a file in the current directory.""" return os.path.join(os.path.dirname(os.path.realpath(__file__)), filename) def test_build_from_file(test_logger): logging.config.fileConfig(path("test_config.ini")) test_logger(logging.getLogger(), lambda line: ":test_config.ini" in line) def test_build_from_dictionary(test_logger): logging.config.dictConfig( { "version": 1, "formatters": { "colored": { "()": "colorlog.ColoredFormatter", "format": "%(log_color)s%(levelname)s:%(name)s:%(message)s:dict", } }, "handlers": { "stream": { "class": "logging.StreamHandler", "formatter": "colored", "level": "DEBUG", }, }, "loggers": { "": { "handlers": ["stream"], "level": "DEBUG", }, }, } ) test_logger(logging.getLogger(), lambda line: ":dict" in line) python-colorlog-6.8.2/colorlog/tests/conftest.py0000664000232200023220000000463314554734410022434 0ustar debalancedebalance"""Fixtures that can be used in other tests.""" import inspect import logging import sys import pytest import colorlog class TestingStreamHandler(logging.StreamHandler): """Raise errors to be caught by py.test instead of printing to stdout.""" def handleError(self, record): _type, value, _traceback = sys.exc_info() raise value def assert_log_message(capsys, log_function, message, *args): """Call a log function and check the message has been output.""" log_function(message, *args) out, err = capsys.readouterr() # Print the output so that py.test shows it when a test fails print(err, end="", file=sys.stderr) # Assert the message send to the logger was output assert message % args in err, "Log message not output to STDERR" return err @pytest.fixture(autouse=True) def clean_env(monkeypatch): monkeypatch.delenv("FORCE_COLOR", raising=False) monkeypatch.delenv("NO_COLOR", raising=False) @pytest.fixture() def reset_loggers(): logging.root.handlers = list() logging.root.setLevel(logging.DEBUG) @pytest.fixture() def test_logger(reset_loggers, capsys): def function(logger, validator=None): lines = [ assert_log_message(capsys, logger.debug, "a debug message %s", 1), assert_log_message(capsys, logger.info, "an info message %s", 2), assert_log_message(capsys, logger.warning, "a warning message %s", 3), assert_log_message(capsys, logger.error, "an error message %s", 4), assert_log_message(capsys, logger.critical, "a critical message %s", 5), ] if validator is not None: for line in lines: valid = validator(line.strip()) assert valid, f"{line.strip()!r} did not validate" return lines return function @pytest.fixture() def create_and_test_logger(test_logger): def function(*args, **kwargs): validator = kwargs.pop("validator", None) formatter_cls = kwargs.pop("formatter_class", colorlog.ColoredFormatter) formatter = formatter_cls(*args, **kwargs) stream = TestingStreamHandler(stream=sys.stderr) stream.setLevel(logging.DEBUG) stream.setFormatter(formatter) logger = logging.getLogger(inspect.stack()[1][3]) logger.setLevel(logging.DEBUG) logger.addHandler(stream) return test_logger(logger, validator) return function python-colorlog-6.8.2/colorlog/tests/test_example.py0000664000232200023220000000050114554734410023267 0ustar debalancedebalancedef test_example(): """Tests the usage example from the README""" import colorlog handler = colorlog.StreamHandler() handler.setFormatter( colorlog.ColoredFormatter("%(log_color)s%(levelname)s:%(name)s:%(message)s") ) logger = colorlog.getLogger("example") logger.addHandler(handler) python-colorlog-6.8.2/colorlog/tests/test_escape_codes.py0000664000232200023220000000304314554734410024255 0ustar debalancedebalance"""Test the colorlog.escape_codes module.""" import pytest from colorlog.escape_codes import esc, escape_codes, parse_colors def test_esc(): assert esc(1, 2, 3) == "\033[1;2;3m" def test_reset(): assert escape_codes["reset"] == "\033[0m" def test_bold_color(): assert escape_codes["bold_red"] == "\033[1;31m" def test_fg_color(): assert escape_codes["fg_bold_yellow"] == "\033[1;33m" def test_bg_color(): assert escape_codes["bg_bold_blue"] == "\033[104m" def test_rainbow(create_and_test_logger): """Test *all* escape codes, useful to ensure backwards compatibility.""" create_and_test_logger( "%(log_color)s%(levelname)s%(reset)s:%(bold_black)s%(name)s:" "%(message)s%(reset)s:" "%(bold_red)sr%(red)sa%(yellow)si%(green)sn%(bold_blue)sb" "%(blue)so%(purple)sw%(reset)s " "%(fg_bold_red)sr%(fg_red)sa%(fg_yellow)si%(fg_green)sn" "%(fg_bold_blue)sb%(fg_blue)so%(fg_purple)sw%(reset)s " "%(bg_red)sr%(bg_bold_red)sa%(bg_yellow)si%(bg_green)sn" "%(bg_bold_blue)sb%(bg_blue)so%(bg_purple)sw%(reset)s " ) def test_parse_colors(): assert parse_colors("reset") == "\033[0m" def test_parse_multiple_colors(): assert parse_colors("bold_red,bg_bold_blue") == "\033[1;31m\033[104m" def test_parse_invalid_colors(): with pytest.raises(KeyError): parse_colors("false") def test_256_colors(): for i in range(256): assert parse_colors("fg_%d" % i) == "\033[38;5;%dm" % i assert parse_colors("bg_%d" % i) == "\033[48;5;%dm" % i python-colorlog-6.8.2/colorlog/tests/test_wrappers.py0000664000232200023220000000227114554734410023505 0ustar debalancedebalance"""Test the colorlog.wrappers module.""" import logging import colorlog def test_logging_module(test_logger): test_logger(logging) def test_colorlog_module(test_logger): test_logger(colorlog) def test_colorlog_basicConfig(test_logger): colorlog.basicConfig() test_logger(colorlog.getLogger()) def test_reexports(): assert colorlog.root is logging.root assert colorlog.getLogger is logging.getLogger assert colorlog.StreamHandler is logging.StreamHandler assert colorlog.CRITICAL is logging.CRITICAL assert colorlog.FATAL is logging.FATAL assert colorlog.ERROR is logging.ERROR assert colorlog.WARNING is logging.WARNING assert colorlog.WARN is logging.WARN assert colorlog.INFO is logging.INFO assert colorlog.DEBUG is logging.DEBUG assert colorlog.NOTSET is logging.NOTSET def test_wrappers(): assert colorlog.debug is not logging.debug assert colorlog.info is not logging.info assert colorlog.warning is not logging.warning assert colorlog.error is not logging.error assert colorlog.critical is not logging.critical assert colorlog.log is not logging.log assert colorlog.exception is not logging.exception python-colorlog-6.8.2/setup.py0000664000232200023220000000251014554734410016755 0ustar debalancedebalancefrom setuptools import setup setup( name="colorlog", version="6.8.2", description="Add colours to the output of Python's logging module.", long_description=open("README.md").read(), long_description_content_type="text/markdown", author="Sam Clements", author_email="sam@borntyping.co.uk", url="https://github.com/borntyping/python-colorlog", license="MIT License", packages=["colorlog"], package_data={"colorlog": ["py.typed"]}, setup_requires=["setuptools>=38.6.0"], extras_require={ ':sys_platform=="win32"': ["colorama"], "development": ["black", "flake8", "mypy", "pytest", "types-colorama"], }, python_requires=">=3.6", classifiers=[ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Topic :: Terminals", "Topic :: Utilities", ], ) python-colorlog-6.8.2/sample.py0000664000232200023220000000032014554734410017073 0ustar debalancedebalanceimport logging import colorlog fmt = "{log_color}{levelname} {name}: {message}" colorlog.basicConfig(level=logging.DEBUG, style="{", format=fmt, stream=None) log = logging.getLogger() log.warning("hello") python-colorlog-6.8.2/docs/0000775000232200023220000000000014554734410016175 5ustar debalancedebalancepython-colorlog-6.8.2/docs/example.py0000664000232200023220000000200714554734410020201 0ustar debalancedebalance#!/usr/bin/env python """python-colorlog example.""" import logging from colorlog import ColoredFormatter def setup_logger(): """Return a logger with a default ColoredFormatter.""" formatter = ColoredFormatter( "%(log_color)s%(levelname)-8s%(reset)s %(blue)s%(message)s", datefmt=None, reset=True, log_colors={ "DEBUG": "cyan", "INFO": "green", "WARNING": "yellow", "ERROR": "red", "CRITICAL": "red", }, ) logger = logging.getLogger("example") handler = logging.StreamHandler() handler.setFormatter(formatter) logger.addHandler(handler) logger.setLevel(logging.DEBUG) return logger def main(): """Create and use a logger.""" logger = setup_logger() logger.debug("a debug message") logger.info("an info message") logger.warning("a warning message") logger.error("an error message") logger.critical("a critical message") if __name__ == "__main__": main() python-colorlog-6.8.2/docs/yaml_example.yaml0000664000232200023220000000150514554734410021537 0ustar debalancedebalanceversion: 1 formatters: logging: format: '%(asctime)s - %(name)-11s - %(levelname)-8s - %(message)-60s - formatter=logging.Formatter' colorlog: (): 'colorlog.ColoredFormatter' format: '%(log_color)s%(asctime)s - %(name)-11s - %(levelname)-8s - %(message)-60s - formatter=colorlog.ColoredFormatter' handlers: console: class: logging.StreamHandler level: DEBUG formatter: logging stream: ext://sys.stdout file: class: logging.FileHandler level: WARNING formatter: logging filename: doc/example_yaml.log colour: class: logging.StreamHandler level: DEBUG formatter: colorlog loggers: '': level: DEBUG handlers: [console] example: level: INFO handlers: [file] propagate: yes application: level: INFO handlers: [colour, file] propagate: no python-colorlog-6.8.2/docs/custom_level.py0000664000232200023220000000073114554734410021251 0ustar debalancedebalanceimport logging from colorlog import ColoredFormatter logging.addLevelName(5, "TRACE") def main(): """Create and use a logger.""" formatter = ColoredFormatter(log_colors={"TRACE": "yellow"}) handler = logging.StreamHandler() handler.setFormatter(formatter) logger = logging.getLogger("example") logger.addHandler(handler) logger.setLevel("TRACE") logger.log(5, "a message using a custom level") if __name__ == "__main__": main() python-colorlog-6.8.2/docs/yaml_example.py0000664000232200023220000000351614554734410021231 0ustar debalancedebalance""" Based on an example provided by Ricardo Reis. https://github.com/ricardo-reis-1970/colorlog-YAML This configures the `logging` module from a YAML file, and provides specific configuration for the loggers named 'application' and 'example'. """ import logging.config import pathlib import yaml def config(): """ Configure `logging` from a YAML file. You might adjust this function to provide the configuration path as an argument. """ path = pathlib.Path(__file__).with_suffix(".yaml") logging.config.dictConfig(yaml.safe_load(path.read_text())) if __name__ == "__main__": config() root = logging.getLogger() root.debug("Root logs debug example") root.info("Root logs written to console without colours") root.warning("Root logs warning") root.error("Root logs error") root.critical("Root logs critical") unknown = logging.getLogger("unknown") unknown.debug("Unknown logs debug example") unknown.info("Unknown logs propagated to root logger") unknown.warning("Unknown logs warning") unknown.error("Unknown logs error") unknown.critical("Unknown logs critical") application = logging.getLogger("application") application.debug("Application logs debug filtered by log level") application.info("Application logs written to console and file") application.warning("Application logs not propagated to the root logger") application.error("Application logs error example") application.critical("Application logs critical example") example = logging.getLogger("example") example.debug("Example logs debug filtered by log level") example.info("Example logs configured to write to file") example.warning("Example logs propagated to the root logger") example.error("Example logs error example") example.critical("Example logs critical example") python-colorlog-6.8.2/docs/CONTRIBUTING.md0000664000232200023220000000211514554734410020425 0ustar debalancedebalance# Contributing to colorlog ## New features Open a thread in the "[Discussions]" section of the GitHub repository before doing any significant work on a new feature. This library is over a decade old, and my priority in maintaining it is stability rather than features. See the [Status](../README.md#Status]) section of the README file for more information. ## Bugfixes _Please_ provide a simple way to reproduce any bug you encounter when opening an issue. It's very common for bugs to be reported for this library that are actually caused by the calling code or another library being used alongside it. ## Pull requests Open pull requests against the `main` branch. Make sure your changes pass the test suite, which runs tests against most recent versions of Python 3 and checks the `black` formatter makes no changes. * You can run tests locally with `tox` if you have suitable versions of Python 3 installed... * ...or use the GitHub Actions pipeline which will run automatically once you open a pull request. [Discussions]: https://github.com/borntyping/python-colorlog/discussions python-colorlog-6.8.2/docs/colors.py0000664000232200023220000000041314554734410020046 0ustar debalancedebalance""" Print every color code supported by colorlog in it's own color. """ import colorlog.escape_codes if __name__ == "__main__": for key, value in colorlog.escape_codes.escape_codes.items(): print(value, key, colorlog.escape_codes.escape_codes["reset"]) python-colorlog-6.8.2/docs/example.png0000664000232200023220000002465714554734410020354 0ustar debalancedebalancePNG  IHDR|VCźy iCCPICC ProfileH wTSF z/Х$PBL*6TWpEeEA\"kA,XQ`_EEY 6T~/=~s|ޝ;w̛9 %f DAĤd1 :bOTT⍔VX9\1( N9Cj[( \I )grfČOls<e@zi $ ¶_aO6AXeNN6MG0&bexv/LdaXZ>lr%y}%DHODά6+7TƂ9;$qs!g9;cIVDcα(7Z_!39Ls1st~ s x sϏcqV,.DrN#Ff.}<^lc N0WG=sgf @"QɨtUDգZP]^Mj ES4CKЫћFt;&z=`17 ,c*1 6ym(=Uұ.`l6 ۊcG8NgEX<\1n' 4n7'@|2^_ c!!,' )"N 3kUyC[d@r%'I*aE0YlN#%n=[ bB$S()MǔrT9k9Gn\\܀+y"J & ~ , 5 &v9(^R|S2Q P()U:4BEQ ~T6u=u3ǧ7HO(OJI\x%I3ԙKOnH\`; -HsQMŤ&HŠdճ&Әiil?K73s{?ؖ1U~j̺YY[s99J,\eB aphےK&D1$^(SFDUpg~MǥK.S\&Xvu˟gʵ+WڳZgᚢ5Akk^[g|ݻ 뻊t F~XXT<}Cݏ?mtظsNR/؛.dSOӛ79ނ"rgrm+h%/~ұnqdPUXUN[v~U߮iծXagn-u:uu|wOОzʽؽ{ 㗦͆҆545>P 7KqPgU˞V_Ss$HQіcjۨm%P^PgRg=]]mY*'NO>]pz[=~&Hg:7\/^8{.̸qJUmל9_wyFWS^gn߼pywL˹^O=(|yXHQc:6~b|//U_;v} p:gzZf itD% *rZxKuJ^q8o":M }zAVl;D@I[D:8==1=~?h>FRv]ga+) pHYs  iTXtXML:com.adobe.xmp 380 84 IDATx] |չ?ڙ}o6 !bbP""E*@/*D KҪXK5, HxBH&}ofM"Ȇs~wf̜RA pϔ!b @ hC3 :gnb @8;AG9RYП, [/s)SD@lqdgOEmz0B#[ŴV#qR)",/E%s[W,t^,Uq={6FӖs^zq2 t %L$u" :ٗ?I#Oo-_h1!Ssr 0"Ub yF9-㧳r>hUsQ!ax%'S)zu!/M:EQPV"&@utgqg3v{ ԿÇ#:Ի埱Aa:gHJԗ&:sݒTށCNǪ(rN#>80BB#Kͳc$V\buhHA8ᝎ(޼2 u9kͭM κ›{"yP sǻ3$9$dn^pH=oQ;n(T zmP,d?ؒcAqJ ׮*kq^[g WrQࣼlnm)as¡?Cuuf9: 'm䞬#d)Kppؔ_ySN ێqi ffP(9MQx)*E1; G2.;wKXCW@o!͠g.x#G lC-[/~=]%=:CDO9ɐ% T2̳]ŇB#ʀ?厹b\&9a5,N?:&` [G\̈́|=!Ew= /IBx1.) {G#>aQHud^hTK:TT2R0o=5b= τpVhF+kJPɄ@>y X5Ry %G| ?,ZO!lmohXF^_ᚎ_Kq.hcَhm2LJBah.xO,ͭaj܈Bw[f/P ):̀ bZ˗j Zǒ[W.뛖\kIw#5PeuOi&5`S]/TecZ%E=C 5 ;~ߕ/QnCueޢMçi=-+4|&&c3DF4ŝГRTuDLnVo[A wȵZwSTk2z!Fw 34+GI pPD&Ai XaE,gRGu,F* k#Dy*?)cLOweNV.DJD2@6!@N6}ZW@?@2 2`g[(ڧ[};Zv]FmPN7A@C Z_ȉcQrԲ~[+9' 5*qc!^84F}iq<٦e=(mj!69@ۭmuLGba @Htٗfib^5[Nk!Gx!u"|E!u@B]V7?[9-?ȧ[t7TP7,2,COA !2`JTu;^zeuc5RgEv> م5,Qz CdE]S{L_i+!nxބPZJGKg0b=e;,ɇ.wNlW=ī>KpSmg %HZS G e^aE6R`3-7XN P$^^4|GZ箑xZ.ٔwevxu6H B ]QGq8og;1loTk^q%9j.-fE/ۉ;+QI0B3 cѠ@# /F=*[ ׅe"$^] L. zPZ/UձV)U1lhcT=סI^Zsi+YmM4' ƇX'IN'9 [@^T;6* .),;$؞]t<K52Y`zՠ}'4AW8ʢp]W/<#@<`:FOX]Z+l.ضڏvkMd\ʑ[~QM (ku`̚G A U#=Nvvk?r|WM</b|6:̱9}'#"IymZyd|y'KQ3/PYFj.hZI,Wƫ[^\jin_Bh>ˁ|2(hИߧa}֮Xz5ld"Nj '#b[h٧⺤j$^r@,` հy<'V$dE_pl M::URsnE4F`i`pL wk{뤩" t>!] X]jֻ* Y*~mѵ i%wv*pB,JdT38C)"2zC#ؿTxim$5榜"YF5l<4SpB qiVFz x_4Oze?(EPӤPDDV9K%{7Tj= CJeG`ɚ8nN80H5{HtЩ` \lf9O<~G ۫n^OL͉L5 V-tA"R[Ém. 57T)GqXcpg\5 ,5]^@Z/2d^MEv !9TX蓱tI@CG<ۿ]|#o]>bhPh(ײS:t"RkwĒ4wӍ)xxa.'ג$^0PR ":B+DO[܃?m.wJ̷2{uVGHa1zlQX}Ű ,F2 ݉K@~$^ٽ;"S]S5 R/UuytBrԧH |WO(鴮tfnyXd #*ezqU*} u)Q99&t@_tAka{zOt1!dt2& @wK4@ Aǐ @G=FCF:@14q:@B s:򨸇F̴06'E+a7Ţm5޿ %!!.XBǔ%vEBǃm>erʳ %"C^uAy*𚚜AA ] 6p*OEB\̨(mLAj^P@UWThBCEnj#[a%@ IV׫Im''V3>JƄH2[Vը {;z3>mP.F`X C0V S=$kFU2cnN9uuf9ZSL& rO ˫l9qΗ';@1!~@8dBE  _s Wyr(|w}ڰ[)ȱ`'̪3;Q^-\i,Y?;&񭩺c@ tDz,H͕Aj>cVdFhRN+ݲ4DoV5IfT%)Yipv)X fZn]DbH '3{E68W F3"@Hi*J-Qf_駗0}HiW*w ^H-{懂}w?{ Inu\W-4|.v;iKGBwlm6<+u4;FH@a?BwÁEfggc`?(3V0.U)xRw0bCF׃9neT_D lrԤ Ks!e]>e BN42h*Szܰ*3#Q NjlH A tq,! st鏟L p AcN,iH9?~2yGS%Ө];cNs*ʀ5a˻_5;So}kGI!3= S}(ypW%=fE=yVc{JS+4o!UĨ(#qFT0lD|FQe+hƵ lM jhbn  :q4"2ѓrE QX/}m"{5EdR扯T 8a |:=;SGDvYpjFh/mP~?D챲;яpv"$d5^O#(}L3X}!k+JcթCE' Bd`}3iD7`HR}Pd'.>Ċ­[<'T#V= j_xm㼣 |HJJ'cк-+-<"Z3B8 īC{24U#j}qݹTp$^hxau;=R8=$u6kz%r/.2lKhr-=N!8V#t_1,H-kHhS`Iz& BdV#i .8/1;~~Es:GfKI뢽(%ՁJ_Iuwh0<$ϒ\.la3٩J:AWz6)(e+!u143@':=8SxannnEt/K4ԕ]P't_gOeBF_|il?Yb"ܰB(*ic4qk"OO*xK$^7Ekda8BWKyGKE|LEaHF+85O&˦ш9O(ILs{&'F'<#u&e8e7. Q*V3ᾕBwlyczfx 8OxD}']L|b)ECf[|v{Öv+VئyӚ/8:DZN8Ci7oqC ֺ1{5Bg]2g.~dP"gUZu*BNkʮ ܙI l(*?> 7&VRR4 +Lt}a!&@A; K:/W