ansilogs 1.0.0__py3-none-any.whl

ansilogs/__init__.py

@@ -0,0 +1,173 @@
+"""
+Colored, single-line log output for command-line tools.
+
+A small, dependency-free replacement for ``coloredlogs.install()``::
+
+    import logging
+    import ansilogs
+
+    ansilogs.install(logging.DEBUG)
+
+Each record is one line, ``<time> <host> <name>[<pid>] <LEVEL> <message>``, colored with ANSI
+escape codes when stderr is a terminal (honoring ``NO_COLOR`` and ``FORCE_COLOR``, and switching
+Windows consoles to ANSI processing). The handler writes to whatever ``sys.stderr`` is at the
+time of each record, so redirections (test capture, live progress displays) are respected.
+"""
+
+import logging
+import os
+import socket
+import sys
+from typing import IO, Optional, Union
+
+__all__ = ["DATE_FORMAT", "ColoredFormatter", "StderrHandler", "install", "set_level", "supports_color"]
+
+DATE_FORMAT = "%Y-%m-%d %H:%M:%S"
+
+_RESET = "\x1b[0m"
+_TIME = "32"  # green
+_HOST = "35"  # magenta
+_NAME = "34"  # blue
+_LEVEL_NAME = "1;30"  # bold black
+_MESSAGE_BY_LEVEL = {
+    logging.DEBUG: "32",  # green
+    logging.WARNING: "33",  # yellow
+    logging.ERROR: "31",  # red
+    logging.CRITICAL: "1;31",  # bold red
+}
+
+# SetConsoleMode flag that makes a Windows console interpret ANSI escape sequences.
+_ENABLE_VIRTUAL_TERMINAL_PROCESSING = 0x0004
+_STD_ERROR_HANDLE = -12
+
+
+def _sgr(code: str, text: str) -> str:
+    return f"\x1b[{code}m{text}{_RESET}"
+
+
+class ColoredFormatter(logging.Formatter):
+    """
+    ``<time> <host> <name>[<pid>] <LEVEL> <message>``, with ANSI colors when ``colors`` is set.
+
+    The colors are baked into the format string once; per record only the message is wrapped in
+    its level's color. Tracebacks and stack info are appended uncolored.
+    """
+
+    def __init__(self, colors: bool = True, hostname: Optional[str] = None) -> None:
+        host = (hostname or socket.gethostname()).replace("%", "%%")
+        fields = [
+            ("%(asctime)s", _TIME),
+            (host, _HOST),
+            ("%(name)s[%(process)d]", _NAME),
+            ("%(levelname)s", _LEVEL_NAME),
+        ]
+        prefix = " ".join(_sgr(code, text) if colors else text for text, code in fields)
+        super().__init__(f"{prefix} %(message)s", datefmt=DATE_FORMAT)
+        self.colors = colors
+
+    def formatMessage(self, record: logging.LogRecord) -> str:
+        code = _MESSAGE_BY_LEVEL.get(record.levelno) if self.colors else None
+        if code is None:
+            return super().formatMessage(record)
+        message = record.message
+        record.message = _sgr(code, message)
+        try:
+            return super().formatMessage(record)
+        finally:
+            record.message = message
+
+
+class StderrHandler(logging.Handler):
+    """Writes each record to the current ``sys.stderr`` (looked up per record, never cached)."""
+
+    terminator = "\n"
+
+    def emit(self, record: logging.LogRecord) -> None:
+        try:
+            line = self.format(record)
+            stream = sys.stderr
+            if stream is None:
+                return
+            stream.write(line + self.terminator)
+            stream.flush()
+        except RecursionError:
+            raise
+        except Exception:
+            self.handleError(record)
+
+
+def _enable_windows_ansi(stream: IO[str]) -> bool:
+    """Switch the Windows console behind ``stream`` to ANSI processing; False if it isn't a console."""
+    if sys.platform != "win32":
+        return True
+    import ctypes
+    from ctypes import wintypes
+
+    if stream is not sys.__stderr__:
+        # Only the process' own stderr maps to the standard error console handle.
+        return False
+    kernel32 = ctypes.windll.kernel32
+    handle = kernel32.GetStdHandle(_STD_ERROR_HANDLE)
+    mode = wintypes.DWORD()
+    if not kernel32.GetConsoleMode(handle, ctypes.byref(mode)):
+        return False
+    if mode.value & _ENABLE_VIRTUAL_TERMINAL_PROCESSING:
+        return True
+    return bool(kernel32.SetConsoleMode(handle, mode.value | _ENABLE_VIRTUAL_TERMINAL_PROCESSING))
+
+
+def supports_color(stream: Optional[IO[str]] = None) -> bool:
+    """
+    Whether to color output written to ``stream`` (default: ``sys.stderr``).
+
+    ``NO_COLOR`` (non-empty) disables colors and ``FORCE_COLOR`` (non-empty) forces them;
+    otherwise the stream must be a terminal, and on Windows a console that accepts ANSI codes.
+    """
+    if os.environ.get("NO_COLOR"):
+        return False
+    if os.environ.get("FORCE_COLOR"):
+        return True
+    stream = sys.stderr if stream is None else stream
+    if stream is None:
+        return False
+    isatty = getattr(stream, "isatty", None)
+    try:
+        if isatty is None or not isatty():
+            return False
+    except ValueError:  # closed stream
+        return False
+    return _enable_windows_ansi(stream)
+
+
+def _installed_handler() -> Optional[StderrHandler]:
+    return next((h for h in logging.getLogger().handlers if isinstance(h, StderrHandler)), None)
+
+
+def install(level: Union[int, str] = logging.INFO, colors: Optional[bool] = None) -> None:
+    """
+    Attach a colored stderr handler to the root logger and show records from ``level`` up.
+
+    Calling it again reconfigures the existing handler instead of adding another. ``colors``
+    defaults to :func:`supports_color` for the current ``sys.stderr``.
+    """
+    handler = _installed_handler()
+    if handler is None:
+        handler = StderrHandler()
+        logging.getLogger().addHandler(handler)
+    handler.setFormatter(ColoredFormatter(colors=supports_color() if colors is None else colors))
+    set_level(level)
+
+
+def set_level(level: Union[int, str]) -> None:
+    """
+    Show records from ``level`` up: sets the handler's level (installing it if needed) and relaxes
+    the root logger's level if it would filter those records out.
+    """
+    handler = _installed_handler()
+    if handler is None:
+        install(level)
+        return
+    handler.setLevel(level)
+    root = logging.getLogger()
+    if root.getEffectiveLevel() > handler.level:
+        root.setLevel(handler.level)

ansilogs/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '1.0.0'
+__version_tuple__ = version_tuple = (1, 0, 0)
+
+__commit_id__ = commit_id = 'gaa8e027c2'

ansilogs-1.0.0.dist-info/METADATA

@@ -0,0 +1,96 @@
+Metadata-Version: 2.4
+Name: ansilogs
+Version: 1.0.0
+Summary: Colored, single-line log output for command-line tools: a dependency-free coloredlogs.install() replacement
+Author-email: doronz88 <doron88@gmail.com>
+Maintainer-email: doronz88 <doron88@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 doronz88
+        
+        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.
+        
+Project-URL: Homepage, https://github.com/doronz88/ansilogs
+Project-URL: Bug Reports, https://github.com/doronz88/ansilogs/issues
+Keywords: logging,color,ansi,terminal,cli
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: System :: Logging
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Dynamic: license-file
+
+# ansilogs
+
+Colored, single-line log output for command-line tools. A small, dependency-free replacement
+for `coloredlogs.install()` with the same default look.
+
+```python
+import logging
+
+import ansilogs
+
+ansilogs.install(logging.DEBUG)
+logging.getLogger(__name__).warning("careful")
+```
+
+```
+2026-10-19 09:35:12 my-host my_tool.cli[4242] WARNING careful
+```
+
+- One line per record: `<time> <host> <name>[<pid>] <LEVEL> <message>`; tracebacks follow
+  uncolored.
+- Colors only when stderr is a terminal. `NO_COLOR` (non-empty) disables them, `FORCE_COLOR`
+  (non-empty) forces them. On Windows the console is switched to ANSI processing; if that
+  fails, output is plain.
+- Records go to whatever `sys.stderr` is at the time (test capture and live progress displays
+  that redirect stderr keep working).
+
+## API
+
+- `install(level=logging.INFO, colors=None)`: attach the handler to the root logger (once) and
+  show records from `level` up. `colors=None` means `supports_color()`.
+- `set_level(level)`: change the shown level (installs the handler if needed).
+- `supports_color(stream=None)`: the color decision used by `install()`.
+- `ColoredFormatter(colors=True, hostname=None)` and `StderrHandler` for custom setups.
+
+## Migrating from coloredlogs
+
+```diff
+-import coloredlogs
+-coloredlogs.install(level=logging.DEBUG)
++import ansilogs
++ansilogs.install(logging.DEBUG)
+```
+
+`coloredlogs.set_level(level)` becomes `ansilogs.set_level(level)`. `COLOREDLOGS_*` environment
+variables and custom field/level styles are not supported.

ansilogs-1.0.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+ansilogs/__init__.py,sha256=nBjnREOzvlPmODpcCawH07WIFg_YB3LytcPaQSSiKQc,5959
+ansilogs/_version.py,sha256=AJPm44ajQjO1SQUg8c6rfc3xjhbaff-iRq7PTfDEQd8,528
+ansilogs/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ansilogs-1.0.0.dist-info/licenses/LICENSE,sha256=yLCk8rOuuGsdobWBq_7cZBbX5LgGqK7cwF081kL9AzU,1065
+ansilogs-1.0.0.dist-info/METADATA,sha256=D92rIu5-iRhYyDcza_oUz3zfJeEPme839TMXpR6k60g,4008
+ansilogs-1.0.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+ansilogs-1.0.0.dist-info/top_level.txt,sha256=9HngRK4yiRWsJDSHFiaOx-h61aDiR6Mm1PfDBQ11MIo,9
+ansilogs-1.0.0.dist-info/RECORD,,

ansilogs-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

ansilogs-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 doronz88
+
+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.

ansilogs-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+ansilogs