docsig 0.49.0__tar.gz → 0.49.2__tar.gz

{docsig-0.49.0 → docsig-0.49.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: docsig
-Version: 0.49.0
+Version: 0.49.2
 Summary: Check signature params for proper documentation
 Home-page: https://pypi.org/project/docsig/
 License: MIT
@@ -223,7 +223,7 @@ It can be added to your .pre-commit-config.yaml as follows:
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.49.0
+        rev: v0.49.2
         hooks:
           - id: docsig
             args:

{docsig-0.49.0 → docsig-0.49.2}/README.rst

@@ -195,7 +195,7 @@ It can be added to your .pre-commit-config.yaml as follows:
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.49.0
+        rev: v0.49.2
         hooks:
           - id: docsig
             args:

{docsig-0.49.0 → docsig-0.49.2}/docsig/_display.py

@@ -5,6 +5,7 @@ docsig._display
 
 from __future__ import annotations as _
 
+import sys as _sys
 import typing as _t
 from collections import UserString as _UserString
 
@@ -187,7 +188,7 @@ class Display(_t.Dict[str, _t.List[Failures]]):
 
     def __init__(self, no_ansi: bool = False) -> None:
         super().__init__()
-        self._ansi = not no_ansi
+        self._ansi = not no_ansi and _sys.stdout.isatty()
 
     def __getitem__(self, key: str) -> list[Failures]:
         if key not in super().__iter__():

{docsig-0.49.0 → docsig-0.49.2}/docsig/_hooks.py

@@ -9,9 +9,14 @@ from os import environ as _e
 import click as _click
 
 
-def pretty_print_error() -> None:
-    """Print user friendly commandline error if debug not enabled."""
+def pretty_print_error(no_ansi: bool = False) -> None:
+    """Print user friendly commandline error if debug not enabled.
+
+    :param no_ansi: Disable ANSI output.
+    """
     if _e.get("DOCSIG_DEBUG", None) != "1":
-        _sys.excepthook = lambda x, y, _: print(
-            f"{_click.style(x.__name__, fg='red', bold=True)}: {y}"
+        _sys.excepthook = lambda x, y, _: _click.echo(
+            f"{_click.style(x.__name__, fg='red', bold=True)}: {y}",
+            file=_sys.stderr,
+            color=not no_ansi and _sys.stderr.isatty(),
         )

{docsig-0.49.0 → docsig-0.49.2}/docsig/_main.py

@@ -20,7 +20,7 @@ def main() -> str | int:
     :return: Exit status for whether test failed or not.
     """
     p = _Parser()
-    _pretty_print_error()
+    _pretty_print_error(p.args.no_ansi)
     return _docsig(
         *p.args.path,
         string=p.args.string,

{docsig-0.49.0 → docsig-0.49.2}/docsig/_report.py

@@ -81,7 +81,7 @@ class Report(_t.List[str]):
             message = message.format(**kwargs)
 
         if hint:
-            message += f"\nhint: {value.hint}"
+            message += f"\n    hint: {value.hint}"
 
         if value not in self._disable and message not in self:
             super().append(message)

{docsig-0.49.0 → docsig-0.49.2}/docsig/_version.py

@@ -8,4 +8,4 @@ Allows for access to the version internally without cyclic imports
 caused by accessing it through __init__.
 """
 
-__version__ = "0.49.0"
+__version__ = "0.49.2"

{docsig-0.49.0 → docsig-0.49.2}/pyproject.toml

@@ -73,7 +73,7 @@ maintainers = [
 name = "docsig"
 readme = "README.rst"
 repository = "https://github.com/jshwi/docsig"
-version = "0.49.0"
+version = "0.49.2"
 
 [tool.poetry.dependencies]
 Pygments = "^2.13.0"