Upgrade rich to 11.0.0

Author: pradyunsg

news/rich.vendor.rst

@@ -1 +1 @@
-Add rich 10.14.0 as a vendored dependency.
+Upgrade rich to 11.0.0

src/pip/_vendor/rich/__main__.py

@@ -4,13 +4,7 @@
 
 from pip._vendor.rich import box
 from pip._vendor.rich.color import Color
-from pip._vendor.rich.console import (
-    Console,
-    ConsoleOptions,
-    Group,
-    RenderResult,
-    RenderableType,
-)
+from pip._vendor.rich.console import Console, ConsoleOptions, Group, RenderableType, RenderResult
 from pip._vendor.rich.markdown import Markdown
 from pip._vendor.rich.measure import Measurement
 from pip._vendor.rich.pretty import Pretty
@@ -222,7 +216,10 @@ def iter_last(values: Iterable[T]) -> Iterable[Tuple[bool, T]]:
     test_card = make_test_card()
 
     # Print once to warm cache
+    start = process_time()
     console.print(test_card)
+    pre_cache_taken = round((process_time() - start) * 1000.0, 1)
+
     console.file = io.StringIO()
 
     start = process_time()
@@ -234,7 +231,8 @@ def iter_last(values: Iterable[T]) -> Iterable[Tuple[bool, T]]:
     for line in text.splitlines(True):
         print(line, end="")
 
-    print(f"rendered in {taken}ms")
+    print(f"rendered in {pre_cache_taken}ms (cold cache)")
+    print(f"rendered in {taken}ms (warm cache)")
 
     from pip._vendor.rich.panel import Panel
 
@@ -243,13 +241,10 @@ def iter_last(values: Iterable[T]) -> Iterable[Tuple[bool, T]]:
     sponsor_message = Table.grid(padding=1)
     sponsor_message.add_column(style="green", justify="right")
     sponsor_message.add_column(no_wrap=True)
+
     sponsor_message.add_row(
-        "Sponsor me",
-        "[u blue link=https://github.com/sponsors/willmcgugan]https://github.com/sponsors/willmcgugan",
-    )
-    sponsor_message.add_row(
-        "Buy me a :coffee:",
-        "[u blue link=https://ko-fi.com/willmcgugan]https://ko-fi.com/willmcgugan",
+        "Buy devs a :coffee:",
+        "[u blue link=https://ko-fi.com/textualize]https://ko-fi.com/textualize",
     )
     sponsor_message.add_row(
         "Twitter",
@@ -261,9 +256,9 @@ def iter_last(values: Iterable[T]) -> Iterable[Tuple[bool, T]]:
 
     intro_message = Text.from_markup(
         """\
-It takes a lot of time to develop Rich and to provide support.
+We hope you enjoy using Rich!
 
-Consider supporting my work via Github Sponsors (ask your company / organization), or buy me a coffee to say thanks.
+Rich is maintained with :heart: by [link=https://www.textualize.io]Textualize.io[/]
 
 - Will McGugan"""
     )

src/pip/_vendor/rich/_windows.py

@@ -1,5 +1,4 @@
 import sys
-
 from dataclasses import dataclass
 
 
@@ -15,8 +14,7 @@ class WindowsConsoleFeatures:
 
 try:
     import ctypes
-    from ctypes import wintypes
-    from ctypes import LibraryLoader
+    from ctypes import LibraryLoader, wintypes
 
     if sys.platform == "win32":
         windll = LibraryLoader(ctypes.WinDLL)
@@ -30,7 +28,6 @@ def get_windows_console_features() -> WindowsConsoleFeatures:
         features = WindowsConsoleFeatures()
         return features
 
-
 else:
 
     STDOUT = -11

src/pip/_vendor/rich/cells.py

@@ -1,9 +1,13 @@
 from functools import lru_cache
+import re
 from typing import Dict, List
 
 from ._cell_widths import CELL_WIDTHS
 from ._lru_cache import LRUCache
 
+# Regex to match sequence of the most common character ranges
+_is_single_cell_widths = re.compile("^[\u0020-\u006f\u00a0\u02ff\u0370-\u0482]*$").match
+
 
 def cell_len(text: str, _cache: Dict[str, int] = LRUCache(1024 * 4)) -> int:
     """Get the number of cells required to display text.
@@ -12,16 +16,19 @@ def cell_len(text: str, _cache: Dict[str, int] = LRUCache(1024 * 4)) -> int:
         text (str): Text to display.
 
     Returns:
-        int: Number of cells required to display the text.
+        int: Get the number of cells required to display text.
     """
-    cached_result = _cache.get(text, None)
-    if cached_result is not None:
-        return cached_result
-
-    _get_size = get_character_cell_size
-    total_size = sum(_get_size(character) for character in text)
-    if len(text) <= 64:
-        _cache[text] = total_size
+
+    if _is_single_cell_widths(text):
+        return len(text)
+    else:
+        cached_result = _cache.get(text, None)
+        if cached_result is not None:
+            return cached_result
+        _get_size = get_character_cell_size
+        total_size = sum(_get_size(character) for character in text)
+        if len(text) <= 64:
+            _cache[text] = total_size
     return total_size
 
 
@@ -35,12 +42,10 @@ def get_character_cell_size(character: str) -> int:
     Returns:
         int: Number of cells (0, 1 or 2) occupied by that character.
     """
-
-    codepoint = ord(character)
-    if 127 > codepoint > 31:
-        # Shortcut for ascii
+    if _is_single_cell_widths(character):
         return 1
-    return _get_codepoint_cell_size(codepoint)
+
+    return _get_codepoint_cell_size(ord(character))
 
 
 @lru_cache(maxsize=4096)
@@ -74,6 +79,13 @@ def _get_codepoint_cell_size(codepoint: int) -> int:
 
 def set_cell_size(text: str, total: int) -> str:
     """Set the length of a string to fit within given number of cells."""
+
+    if _is_single_cell_widths(text):
+        size = len(text)
+        if size < total:
+            return text + " " * (total - size)
+        return text[:total]
+
     if not total:
         return ""
     cell_size = cell_len(text)

src/pip/_vendor/rich/console.py

@@ -1,7 +1,6 @@
 import inspect
 import os
 import platform
-import shutil
 import sys
 import threading
 from abc import ABC, abstractmethod
@@ -12,8 +11,9 @@
 from html import escape
 from inspect import isclass
 from itertools import islice
+from threading import RLock
 from time import monotonic
-from types import FrameType, TracebackType, ModuleType
+from types import FrameType, ModuleType, TracebackType
 from typing import (
     IO,
     TYPE_CHECKING,
@@ -25,7 +25,6 @@
     Mapping,
     NamedTuple,
     Optional,
-    Set,
     TextIO,
     Tuple,
     Type,
@@ -212,6 +211,19 @@ def update_width(self, width: int) -> "ConsoleOptions":
         options.min_width = options.max_width = max(0, width)
         return options
 
+    def update_height(self, height: int) -> "ConsoleOptions":
+        """Update the height, and return a copy.
+
+        Args:
+            height (int): New height
+
+        Returns:
+            ~ConsoleOptions: New Console options instance.
+        """
+        options = self.copy()
+        options.max_height = options.height = height
+        return options
+
     def update_dimensions(self, width: int, height: int) -> "ConsoleOptions":
         """Update the width and height, and return a copy.
 
@@ -224,8 +236,7 @@ def update_dimensions(self, width: int, height: int) -> "ConsoleOptions":
         """
         options = self.copy()
         options.min_width = options.max_width = max(0, width)
-        options.height = height
-        options.max_height = height
+        options.height = options.max_height = height
         return options
 
 
@@ -247,11 +258,12 @@ def __rich_console__(
         ...
 
 
+# A type that may be rendered by Console.
 RenderableType = Union[ConsoleRenderable, RichCast, str]
-"""A type that may be rendered by Console."""
 
+
+# The result of calling a __rich_console__ method.
 RenderResult = Iterable[Union[RenderableType, Segment]]
-"""The result of calling a __rich_console__ method."""
 
 
 _null_highlighter = NullHighlighter()
@@ -464,9 +476,6 @@ def __rich_console__(
         yield from self.renderables
 
 
-RenderGroup = Group  # TODO: deprecate at some point
-
-
 def group(fit: bool = True) -> Callable[..., Callable[..., Group]]:
     """A decorator that turns an iterable of renderables in to a group.
 
@@ -477,7 +486,7 @@ def group(fit: bool = True) -> Callable[..., Callable[..., Group]]:
     def decorator(
         method: Callable[..., Iterable[RenderableType]]
     ) -> Callable[..., Group]:
-        """Convert a method that returns an iterable of renderables in to a RenderGroup."""
+        """Convert a method that returns an iterable of renderables in to a Group."""
 
         @wraps(method)
         def _replace(*args: Any, **kwargs: Any) -> Group:
@@ -489,9 +498,6 @@ def _replace(*args: Any, **kwargs: Any) -> Group:
     return decorator
 
 
-render_group = group
-
-
 def _is_jupyter() -> bool:  # pragma: no cover
     """Check if we're running in a Jupyter notebook."""
     try:
@@ -813,12 +819,13 @@ def push_render_hook(self, hook: RenderHook) -> None:
         Args:
             hook (RenderHook): Render hook instance.
         """
-
-        self._render_hooks.append(hook)
+        with self._lock:
+            self._render_hooks.append(hook)
 
     def pop_render_hook(self) -> None:
         """Pop the last renderhook from the stack."""
-        self._render_hooks.pop()
+        with self._lock:
+            self._render_hooks.pop()
 
     def __enter__(self) -> "Console":
         """Own context manager to enter buffer context."""
@@ -1495,9 +1502,8 @@ def control(self, *control: Control) -> None:
             control_codes (str): Control codes, such as those that may move the cursor.
         """
         if not self.is_dumb_terminal:
-            for _control in control:
-                self._buffer.append(_control.segment)
-            self._check_buffer()
+            with self:
+                self._buffer.extend(_control.segment for _control in control)
 
     def out(
         self,
@@ -1579,7 +1585,7 @@ def print(
             if overflow is None:
                 overflow = "ignore"
             crop = False
-
+        render_hooks = self._render_hooks[:]
         with self:
             renderables = self._collect_renderables(
                 objects,
@@ -1590,7 +1596,7 @@ def print(
                 markup=markup,
                 highlight=highlight,
             )
-            for hook in self._render_hooks:
+            for hook in render_hooks:
                 renderables = hook.process_renderables(renderables)
             render_options = self.options.update(
                 justify=justify,
@@ -1847,6 +1853,8 @@ def log(
         if not objects:
             objects = (NewLine(),)
 
+        render_hooks = self._render_hooks[:]
+
         with self:
             renderables = self._collect_renderables(
                 objects,
@@ -1881,7 +1889,7 @@ def log(
                     link_path=link_path,
                 )
             ]
-            for hook in self._render_hooks:
+            for hook in render_hooks:
                 renderables = hook.process_renderables(renderables)
             new_segments: List[Segment] = []
             extend = new_segments.extend

src/pip/_vendor/rich/default_styles.py

@@ -157,3 +157,27 @@
     "markdown.link": Style(color="bright_blue"),
     "markdown.link_url": Style(color="blue"),
 }
+
+
+if __name__ == "__main__":  # pragma: no cover
+    import argparse
+    import io
+
+    from pip._vendor.rich.console import Console
+    from pip._vendor.rich.table import Table
+    from pip._vendor.rich.text import Text
+
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--html", action="store_true", help="Export as HTML table")
+    args = parser.parse_args()
+    html: bool = args.html
+    console = Console(record=True, width=70, file=io.StringIO()) if html else Console()
+
+    table = Table("Name", "Styling")
+
+    for style_name, style in DEFAULT_STYLES.items():
+        table.add_row(Text(style_name, style=style), str(style))
+
+    console.print(table)
+    if html:
+        print(console.export_html(inline_styles=True))

src/pip/_vendor/rich/file_proxy.py

@@ -44,7 +44,7 @@ def write(self, text: str) -> int:
                 output = Text("\n").join(
                     self.__ansi_decoder.decode_line(line) for line in lines
                 )
-                console.print(output, markup=False, emoji=False, highlight=False)
+                console.print(output)
         return len(text)
 
     def flush(self) -> None:

src/pip/_vendor/rich/jupyter.py

@@ -4,7 +4,6 @@
 from .segment import Segment
 from .terminal_theme import DEFAULT_TERMINAL_THEME
 
-
 JUPYTER_HTML_FORMAT = """\
 <pre style="white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace">{code}</pre>
 """
@@ -75,11 +74,16 @@ def escape(text: str) -> str:
 
 def display(segments: Iterable[Segment], text: str) -> None:
     """Render segments to Jupyter."""
-    from IPython.display import display as ipython_display
-
     html = _render_segments(segments)
     jupyter_renderable = JupyterRenderable(html, text)
-    ipython_display(jupyter_renderable)
+    try:
+        from IPython.display import display as ipython_display
+
+        ipython_display(jupyter_renderable)
+    except ModuleNotFoundError:
+        # Handle the case where the Console has force_jupyter=True,
+        # but IPython is not installed.
+        pass
 
 
 def print(*args: Any, **kwargs: Any) -> None: