Merge pull request #124 from willmcgugan/path-highlight

Improve path highlight

Author: willmcgugan

CHANGELOG.md

@@ -5,6 +5,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.3.0] - 2020-06-26
+
+### Fixed
+
+- Fixed highlighting of paths / filenames
+- Corrected docs for RichHandler which erroneously said default console writes to stderr
+
+### Changed
+
+- Allowed `style` parameter for `highlight_regex` to be a callable that returns a style
+
+### Added
+
+- Added optional highlighter parameter to RichHandler
+
 ## [2.2.6] - 2020-06-24
 
 ### Changed

pyproject.toml

@@ -2,7 +2,7 @@
 name = "rich"
 homepage = "https://github.com/willmcgugan/rich"
 documentation = "https://rich.readthedocs.io/en/latest/"
-version = "2.2.6"
+version = "2.3.0"
 description = "Render rich text, tables, progress bars, syntax highlighting, markdown and more to the terminal"
 authors = ["Will McGugan <willmcgugan@gmail.com>"]
 license = "MIT"

rich/default_styles.py

@@ -65,7 +65,7 @@
     "rule.line": Style(color="bright_green"),
     "rule.text": Style(),
     "repr.path": Style(color="magenta"),
-    "repr.filename": Style(color="bright_magenta", bold=True),
+    "repr.filename": Style(color="bright_magenta"),
     "table.header": Style(bold=True),
     "table.footer": Style(bold=True),
     "table.cell": Style(),

rich/highlighter.py

@@ -73,12 +73,11 @@ class ReprHighlighter(RegexHighlighter):
     highlights = [
         r"(?P<brace>[\{\[\(\)\]\}])",
         r"(?P<tag_start>\<)(?P<tag_name>\w*)(?P<tag_contents>.*?)(?P<tag_end>\>)",
-        r"(?P<attrib_name>\w+?)=(?P<attrib_value>\"?\w+\"?)",
+        r"(?P<attrib_name>\w+?)=(?P<attrib_value>\"?\S+\"?)",
         r"(?P<bool_true>True)|(?P<bool_false>False)|(?P<none>None)",
         r"(?P<number>(?<!\w)\-?[0-9]+\.?[0-9]*\b)",
         r"(?P<number>0x[0-9a-f]*)",
-        r"(?P<path>(\/\w+)+\/)",
-        r"(?P<filename>\/\w*\.\w{3,4})\s",
+        r"(?P<path>\B(\/[\w\.\-\_\+]+)*\/)(?P<filename>[\w\.\-\_\+]*)?",
         r"(?<!\\)(?P<str>b?\'\'\'.*?(?<!\\)\'\'\'|b?\'.*?(?<!\\)\'|b?\"\"\".*?(?<!\\)\"\"\"|b?\".*?(?<!\\)\")",
         r"(?P<url>https?:\/\/[0-9a-zA-Z\$\-\_\+\!`\(\)\,\.\?\/\;\:\&\=\%]*)",
         r"(?P<uuid>[a-fA-F0-9]{8}\-[a-fA-F0-9]{4}\-[a-fA-F0-9]{4}\-[a-fA-F0-9]{4}\-[a-fA-F0-9]{12})",
@@ -91,3 +90,18 @@ class ReprHighlighter(RegexHighlighter):
     console = Console()
     console.print("[bold green]hello world![/bold green]")
     console.print("'[bold green]hello world![/bold green]'")
+
+    console.print(" /foo")
+    console.print("/foo/")
+    console.print("/foo/bar")
+    console.print("foo/bar/baz")
+
+    console.print("/foo/bar/baz?foo=bar+egg&egg=baz")
+    console.print("/foo/bar/baz/")
+    console.print("/foo/bar/baz/egg")
+    console.print("/foo/bar/baz/egg.py")
+    console.print("/foo/bar/baz/egg.py word")
+    console.print(" /foo/bar/baz/egg.py word")
+    console.print("foo /foo/bar/baz/egg.py word")
+    console.print("foo /foo/bar/ba._++z/egg+.py word")
+    console.print("https://example.org?foo=bar")

rich/logging.py

@@ -18,9 +18,10 @@ class RichHandler(Handler):
     Args:
         level (int, optional): Log level. Defaults to logging.NOTSET.
         console (:class:`~rich.console.Console`, optional): Optional console instance to write logs.
-            Default will create a new console writing to stderr.
-        show_path (bool, optional): Show the path to the original logging message. Defaults to True.
+            Default will use a global console instance writing to stdout.
+        show_path (bool, optional): Show the path to the original log call. Defaults to True.
         enable_link_path (bool, optional): Enable terminal link of path column to file. Defaults to True.
+        highlighter (Highlighter, optional): Highlighter to style log messages, or None to use ReprHighlighter. Defaults to None.
   
     """
 
@@ -43,10 +44,11 @@ def __init__(
         *,
         show_path: bool = True,
         enable_link_path: bool = True,
+        highlighter: Highlighter = None,
     ) -> None:
         super().__init__(level=level)
         self.console = console or get_console()
-        self.highlighter = self.HIGHLIGHTER_CLASS()
+        self.highlighter = highlighter or self.HIGHLIGHTER_CLASS()
         self._log_render = LogRender(show_level=True, show_path=show_path)
         self.enable_link_path = enable_link_path
 

rich/text.py

@@ -3,6 +3,7 @@
 from typing import (
     TYPE_CHECKING,
     Any,
+    Callable,
     Dict,
     Iterable,
     List,
@@ -40,6 +41,8 @@
 
 TextType = Union[str, "Text"]
 
+GetStyleCallable = Callable[[str], Optional[StyleType]]
+
 
 class Span(NamedTuple):
     """A marked up region in some text."""
@@ -335,32 +338,37 @@ def get_style_at_offset(self, console: "Console", offset: int) -> Style:
     def highlight_regex(
         self,
         re_highlight: str,
-        style: Union[str, Style] = None,
+        style: Union[GetStyleCallable, StyleType] = None,
         *,
         style_prefix: str = "",
     ) -> int:
-        """Highlight text with a regular expression, where group names are 
+        """Highlight text with a regular expression, where group names are
         translated to styles.
-        
+
         Args:
             re_highlight (str): A regular expression.
-            style (Union[str, Style]): Optional style to apply to whole match.
-            style_prefix (str, optional): Optional prefix to add to style group names.
-        
+            style (Union[GetStyleCallable, StyleType]): Optional style to apply to whole match, or a callable
+                which accepts the matched text and returns a style. Defaults to None.
+            style_prefix (str, optional): Optional prefix to add to style group names.            
+
         Returns:
             int: Number of regex matches
         """
         count = 0
         append_span = self._spans.append
         _Span = Span
-        for match in re.finditer(re_highlight, self.plain):
-            _span = match.span
+        plain = self.plain
+        for match in re.finditer(re_highlight, plain):
+            get_span = match.span
             if style:
-                start, end = _span()
-                append_span(_Span(start, end, style))
+                start, end = get_span()
+                match_style = style(plain[start:end]) if callable(style) else style
+                if match_style is not None:
+                    append_span(_Span(start, end, match_style))
+
             count += 1
-            for name, _ in match.groupdict().items():
-                start, end = _span(name)
+            for name in match.groupdict().keys():
+                start, end = get_span(name)
                 if start != -1:
                     append_span(_Span(start, end, f"{style_prefix}{name}"))
         return count
@@ -852,3 +860,11 @@ def fit(self, width: int) -> Lines:
     console = Console()
     t = Text("foo bar", justify="left")
     print(repr(t.wrap(console, 4)))
+
+    test = Text("Vulnerability CVE-2018-6543 detected")
+
+    def get_style(text: str) -> str:
+        return f"bold link https://cve.mitre.org/cgi-bin/cvekey.cgi?keyword={text}"
+
+    test.highlight_regex(r"CVE-\d{4}-\d+", get_style)
+    console.print(test)

tests/test_text.py

@@ -146,6 +146,26 @@ def test_highlight_regex():
     ]
 
 
+def test_highlight_regex_callable():
+    test = Text("Vulnerability CVE-2018-6543 detected")
+    re_cve = r"CVE-\d{4}-\d+"
+
+    def get_style(text: str) -> Style:
+        return Style.parse(
+            f"bold yellow link https://cve.mitre.org/cgi-bin/cvekey.cgi?keyword={text}"
+        )
+
+    count = test.highlight_regex(re_cve, get_style)
+    assert count == 1
+    assert len(test._spans) == 1
+    assert test._spans[0].start == 14
+    assert test._spans[0].end == 27
+    assert (
+        test._spans[0].style.link
+        == "https://cve.mitre.org/cgi-bin/cvekey.cgi?keyword=CVE-2018-6543"
+    )
+
+
 def test_highlight_words():
     test = Text("Do NOT! touch anything!")
     words = ["NOT", "!"]