clear method, optimizations, export links

Author: willmcgugan

CHANGELOG.md

@@ -5,6 +5,17 @@ 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).
 
+## [1.1.8] - 2020-05-20
+
+### Changed
+
+- Optimizations for Segment, Console and Table
+
+### Added
+
+- Added Console.clear method
+- Added exporting of links to HTML
+
 ## [1.1.7] - 2020-05-19
 
 ### Added

pyproject.toml

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

rich/__main__.py

@@ -63,8 +63,7 @@ def make_test_card() -> Table:
     )
 
     lorem = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque in metus sed sapien ultricies pretium a at justo. Maecenas luctus velit et auctor maximus. Donec faucibus vel arcu id pretium."
-    lorem_table = Table.grid()
-    lorem_table.padding = (0, 1, 0, 1)
+    lorem_table = Table.grid(padding=1, collapse_padding=True)
     lorem_table.pad_edge = False
     lorem_table.add_row(
         Text(lorem, justify="left", style="green"),
@@ -83,7 +82,7 @@ def make_test_card() -> Table:
     )
 
     def comparison(renderable1, renderable2) -> Table:
-        table = Table(show_header=False, box=None, expand=True)
+        table = Table(show_header=False, pad_edge=False, box=None, expand=True)
         table.add_column("1", ratio=1)
         table.add_column("2", ratio=1)
         table.add_row(renderable1, renderable2)

rich/console.py

@@ -425,6 +425,16 @@ def line(self, count: int = 1) -> None:
             self._buffer.append(Segment("\n" * count))
             self._check_buffer()
 
+    def clear(self, home: bool = True) -> None:
+        """Clear the screen.
+
+        Args:
+            home (bool, optional): Also move the cursor to 'home' position. Defaults to True.
+        """
+        if self.is_terminal:
+            self._check_buffer()
+            self.file.write("\033[2J\033[H" if home else "\033[2J")
+
     def show_cursor(self, show: bool = True) -> None:
         """Show or hide the cursor.
         
@@ -436,7 +446,7 @@ def show_cursor(self, show: bool = True) -> None:
             self.file.write("\033[?25h" if show else "\033[?25l")
 
     def _render(
-        self, renderable: RenderableType, options: Optional[ConsoleOptions],
+        self, renderable: RenderableType, options: ConsoleOptions,
     ) -> Iterable[Segment]:
         """Render an object in to an iterable of `Segment` instances.
 
@@ -446,17 +456,16 @@ def _render(
         Args:
             renderable (RenderableType): An object supporting the console protocol, or
                 an object that may be converted to a string.
-            options (ConsoleOptions, optional): An options objects. Defaults to None.
+            options (ConsoleOptions): An options objects. Defaults to None.
 
         Returns:
             Iterable[Segment]: An iterable of segments that may be rendered.
         """
         render_iterable: RenderResult
-        render_options = options or self.options
         if isinstance(renderable, ConsoleRenderable):
-            render_iterable = renderable.__console__(self, render_options)
+            render_iterable = renderable.__console__(self, options)
         elif isinstance(renderable, str):
-            yield from self.render(self.render_str(renderable), render_options)
+            yield from self._render(self.render_str(renderable), options)
             return
         else:
             raise errors.NotRenderableError(
@@ -474,7 +483,7 @@ def _render(
             if isinstance(render_output, Segment):
                 yield render_output
             else:
-                yield from self.render(render_output, render_options)
+                yield from self._render(render_output, options)
 
     def render(
         self, renderable: RenderableType, options: Optional[ConsoleOptions] = None
@@ -969,9 +978,10 @@ def escape(text: str) -> str:
                     text = escape(text)
                     if style:
                         rule = style.get_html_style(_theme)
-                        append(f'<span style="{rule}">{text}</span>' if rule else text)
-                    else:
-                        append(text)
+                        text = f'<span style="{rule}">{text}</span>' if rule else text
+                        if style.link:
+                            text = f'<a href="{style.link}">{text}</a>'
+                    append(text)
             else:
                 styles: Dict[str, int] = {}
                 for text, style, _ in Segment.filter_control(
@@ -982,11 +992,10 @@ def escape(text: str) -> str:
                         rule = style.get_html_style(_theme)
                         if rule:
                             style_number = styles.setdefault(rule, len(styles) + 1)
-                            append(f'<span class="r{style_number}">{text}</span>')
-                        else:
-                            append(text)
-                    else:
-                        append(text)
+                            text = f'<span class="r{style_number}">{text}</span>'
+                        if style.link:
+                            text = f'<a href="{style.link}">{text}</a>'
+                    append(text)
                 stylesheet_rules: List[str] = []
                 stylesheet_append = stylesheet_rules.append
                 for style_rule, style_number in styles.items():

rich/segment.py

@@ -3,7 +3,8 @@
 from .cells import cell_len, set_cell_size
 from .style import Style, StyleType
 
-from itertools import zip_longest
+from itertools import filterfalse, zip_longest
+from operator import attrgetter
 from typing import Iterable, List, Tuple
 
 
@@ -81,7 +82,10 @@ def filter_control(
             Iterable[Segment]: And iterable of Segment instances.
         
         """
-        return (segment for segment in segments if segment.is_control == is_control)
+        if is_control:
+            return filter(attrgetter("is_control"), segments)
+        else:
+            return filterfalse(attrgetter("is_control"), segments)
 
     @classmethod
     def split_lines(cls, segments: Iterable["Segment"]) -> Iterable[List["Segment"]]:
@@ -104,8 +108,9 @@ def split_lines(cls, segments: Iterable["Segment"]) -> Iterable[List["Segment"]]
                     if _text:
                         append(cls(_text, style))
                     if new_line:
-                        yield line[:]
-                        del line[:]
+                        yield line
+                        line = []
+                        append = line.append
             else:
                 append(segment)
         if line:
@@ -132,8 +137,11 @@ def split_and_crop_lines(
         Returns:
             Iterable[List[Segment]]: An iterable of lines of segments.
         """
-        lines: List[List[Segment]] = [[]]
-        append = lines[-1].append
+        line: List[Segment] = []
+        append = line.append
+
+        adjust_line_length = cls.adjust_line_length
+        new_line_segment = cls("\n")
 
         for segment in segments:
             if "\n" in segment.text and not segment.is_control:
@@ -143,18 +151,17 @@ def split_and_crop_lines(
                     if _text:
                         append(cls(_text, style))
                     if new_line:
-                        line = cls.adjust_line_length(
-                            lines[-1], length, style=style, pad=pad,
+                        cropped_line = adjust_line_length(
+                            line, length, style=style, pad=pad
                         )
                         if include_new_lines:
-                            line.append(cls("\n"))
-                        yield line
-                        lines.append([])
-                        append = lines[-1].append
+                            cropped_line.append(new_line_segment)
+                        yield cropped_line
+                        del line[:]
             else:
                 append(segment)
-        if lines[-1]:
-            yield cls.adjust_line_length(lines[-1], length, style=style, pad=pad)
+        if line:
+            yield adjust_line_length(line, length, style=style, pad=pad)
 
     @classmethod
     def adjust_line_length(

rich/table.py

@@ -490,11 +490,30 @@ def _render(
         show_edge = self.show_edge
         show_lines = self.show_lines
 
+        _Segment = Segment
         if _box and show_edge:
+            box_segments = [
+                (
+                    _Segment(_box.head_left, border_style),
+                    _Segment(_box.head_right, border_style),
+                    _Segment(_box.head_vertical, border_style),
+                ),
+                (
+                    Segment(_box.foot_left, border_style),
+                    _Segment(_box.foot_right, border_style),
+                    _Segment(_box.foot_vertical, border_style),
+                ),
+                (
+                    _Segment(_box.mid_left, border_style),
+                    _Segment(_box.mid_right, border_style),
+                    _Segment(_box.mid_vertical, border_style),
+                ),
+            ]
             yield Segment(_box.get_top(widths), border_style)
             yield new_line
+        else:
+            box_segments = []
 
-        _Segment = Segment
         get_row_style = self.get_row_style
         get_style = console.get_style
         for index, (first, last, row) in enumerate(loop_first_last(rows)):
@@ -529,17 +548,11 @@ def _render(
                     )
                     yield new_line
                 if first:
-                    left = _Segment(_box.head_left, border_style)
-                    right = _Segment(_box.head_right, border_style)
-                    divider = _Segment(_box.head_vertical, border_style)
+                    left, right, divider = box_segments[0]
                 elif last:
-                    left = _Segment(_box.foot_left, border_style)
-                    right = _Segment(_box.foot_right, border_style)
-                    divider = _Segment(_box.foot_vertical, border_style)
+                    left, right, divider = box_segments[2]
                 else:
-                    left = _Segment(_box.mid_left, border_style)
-                    right = _Segment(_box.mid_right, border_style)
-                    divider = _Segment(_box.mid_vertical, border_style)
+                    left, right, divider = box_segments[1]
 
                 for line_no in range(max_height):
                     if show_edge:

tests/_card_render.py

@@ -90,6 +90,20 @@ def test_show_cursor():
     assert console.file.getvalue() == "\x1b[?25lfoo\n\x1b[?25h"
 
 
+def test_clear():
+    console = Console(file=io.StringIO(), force_terminal=True)
+    console.clear()
+    console.clear(home=False)
+    assert console.file.getvalue() == "\033[2J\033[H" + "\033[2J"
+
+
+def test_clear_no_terminal():
+    console = Console(file=io.StringIO())
+    console.clear()
+    console.clear(home=False)
+    assert console.file.getvalue() == ""
+
+
 def test_get_style():
     console = Console()
     console.get_style("repr.brace") == Style(bold=True)
@@ -197,17 +211,17 @@ def test_export_text():
 
 def test_export_html():
     console = Console(record=True, width=100)
-    console.print("[b]foo")
+    console.print("[b]foo [link=https://example.org]Click[/link]")
     html = console.export_html()
-    expected = "<!DOCTYPE html>\n<head>\n<style>\n.r1 {font-weight: bold}\nbody {\n    color: #000000;\n    background-color: #ffffff;\n}\n</style>\n</head>\n<html>\n<body>\n    <code>\n        <pre style=\"font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\"><span class=\"r1\">foo</span>\n</pre>\n    </code>\n</body>\n</html>\n"
+    expected = '<!DOCTYPE html>\n<head>\n<style>\n.r1 {font-weight: bold}\nbody {\n    color: #000000;\n    background-color: #ffffff;\n}\n</style>\n</head>\n<html>\n<body>\n    <code>\n        <pre style="font-family:Menlo,\'DejaVu Sans Mono\',consolas,\'Courier New\',monospace"><span class="r1">foo </span><a href="https://example.org"><span class="r1">Click</span></a>\n</pre>\n    </code>\n</body>\n</html>\n'
     assert html == expected
 
 
 def test_export_html_inline():
     console = Console(record=True, width=100)
-    console.print("[b]foo")
+    console.print("[b]foo [link=https://example.org]Click[/link]")
     html = console.export_html(inline_styles=True)
-    expected = "<!DOCTYPE html>\n<head>\n<style>\n\nbody {\n    color: #000000;\n    background-color: #ffffff;\n}\n</style>\n</head>\n<html>\n<body>\n    <code>\n        <pre style=\"font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\"><span style=\"font-weight: bold\">foo</span>\n</pre>\n    </code>\n</body>\n</html>\n"
+    expected = '<!DOCTYPE html>\n<head>\n<style>\n\nbody {\n    color: #000000;\n    background-color: #ffffff;\n}\n</style>\n</head>\n<html>\n<body>\n    <code>\n        <pre style="font-family:Menlo,\'DejaVu Sans Mono\',consolas,\'Courier New\',monospace"><span style="font-weight: bold">foo </span><a href="https://example.org"><span style="font-weight: bold">Click</span></a>\n</pre>\n    </code>\n</body>\n</html>\n'
     assert html == expected
 
 

tests/test_console.py

@@ -19,6 +19,11 @@ def test_apply_style():
     ]
 
 
+def test_split_lines():
+    lines = [Segment("Hello\nWorld")]
+    assert list(Segment.split_lines(lines)) == [[Segment("Hello")], [Segment("World")]]
+
+
 def test_split_and_crop_lines():
     assert list(
         Segment.split_and_crop_lines([Segment("Hello\nWorld!\n"), Segment("foo")], 4)