windows fix

Author: willmcgugan

CHANGELOG.md

@@ -5,6 +5,22 @@ 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.4] - 2020-05-16
+
+### Fixed
+
+- Fixed incorrect file and link in progress.log
+- Fixes for legacy windows: Bar, Panel, and Rule now use ASCII characters
+- show_cursor is now a no-op on legacy windows
+
+### Added
+
+- Added Console.input
+
+### Changed
+
+- Disable progress bars when not writing to a terminal
+
 ## [1.1.3] - 2020-05-15
 
 ### Fixed

pyproject.toml

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

rich/bar.py

@@ -57,9 +57,11 @@ def update(self, completed: float, total: float = None) -> None:
     def __console__(self, console: Console, options: ConsoleOptions) -> RenderResult:
         completed = min(self.total, max(0, self.completed))
         width = min(self.width or options.max_width, options.max_width)
-        bar = "━"
-        half_bar_right = "╸"
-        half_bar_left = "╺"
+
+        legacy_windows = console.legacy_windows
+        bar = "▓" if legacy_windows else "━"
+        half_bar_right = "░" if legacy_windows else "╸"
+        half_bar_left = " " if legacy_windows else "╺"
         complete_halves = int(width * 2 * completed / self.total)
         bar_count = complete_halves // 2
         half_bar_count = complete_halves % 2

rich/console.py

@@ -429,8 +429,9 @@ def show_cursor(self, show: bool = True) -> None:
         Args:
             show (bool, optional): Set visibility of the cursor.
         """
-        self._check_buffer()
-        self.file.write("\033[?25h" if show else "\033[?25l")
+        if self.is_terminal and not self.legacy_windows:
+            self._check_buffer()
+            self.file.write("\033[?25h" if show else "\033[?25l")
 
     def _render(
         self, renderable: RenderableType, options: Optional[ConsoleOptions],
@@ -815,16 +816,35 @@ def _render_buffer(self) -> str:
             with self._record_buffer_lock:
                 self._record_buffer.extend(buffer)
         del self._buffer[:]
+        not_terminal = not self.is_terminal
         for line in Segment.split_and_crop_lines(buffer, self.width, pad=False):
             for text, style, is_control in line:
                 if style and not is_control:
                     append(style.render(text, color_system=color_system))
                 else:
-                    append(text)
+                    if not (not_terminal and is_control):
+                        append(text)
 
         rendered = "".join(output)
         return rendered
 
+    def input(
+        self, prompt: Union[str, Text] = "", *, markup: bool = True, emoji: bool = True
+    ) -> str:
+        """Displays a prompt and waits for input from the user. The prompt may contain color / style. 
+
+        Args:
+            prompt (Union[Str, Text]): Text to render in the prompt.
+            markup (bool, optional): Enable console markup (requires a str prompt). Defaults to True.
+            emoji (bool, optional): Enable emoji (requires a str prompt). Defaults to True.
+        
+        Returns:
+            str: Text read from stdin.
+        """
+        self.print(prompt, markup=markup, emoji=emoji, end="")
+        result = input()
+        return result
+
     def export_text(self, clear: bool = True, styles: bool = False) -> str:
         """Generate text from console contents (requires record=True argument in constructor).
 

rich/panel.py

@@ -1,6 +1,7 @@
 from typing import Optional, Tuple, Union
 
-from . import box
+from .box import Box, SQUARE, ROUNDED
+
 from .console import (
     Console,
     ConsoleOptions,
@@ -33,7 +34,7 @@ class Panel:
     def __init__(
         self,
         renderable: RenderableType,
-        box: box.Box = box.ROUNDED,
+        box: Box = None,
         expand: bool = True,
         style: Union[str, Style] = "none",
         width: Optional[int] = None,
@@ -59,8 +60,7 @@ def __console__(self, console: Console, options: ConsoleOptions) -> RenderResult
         width = child_width + 2
         child_options = options.update(width=child_width)
         lines = console.render_lines(self.renderable, child_options)
-
-        box = self.box
+        box = SQUARE if console.legacy_windows else (self.box or ROUNDED)
         line_start = Segment(box.mid_left, style)
         line_end = Segment(f"{box.mid_right}\n", style)
         yield Segment(box.get_top([width - 2]), style)

rich/progress.py

@@ -324,7 +324,7 @@ class Progress:
     """Renders an auto-updating progress bar(s).
     
     Args:
-        console (Console, optional): Optional Console instance. Default will create own internal Console instance.
+        console (Console, optional): Optional Console instance. Default will an internal Console instance writing to stderr.
         auto_refresh (bool, optional): Enable auto refresh. If disabled, you will need to call `refresh()`.
         refresh_per_second (int, optional): Number of times per second to refresh the progress information. Defaults to 10.
         speed_estimate_period: (float, optional): Period (in seconds) used to calculate the speed estimate. Defaults to 30.
@@ -544,9 +544,10 @@ def refresh(self) -> None:
         """Refresh (render) the progress information."""
         with self._lock:
             self._live_render.set_renderable(self.get_renderable())
-            with self.console:
-                self.console.print(self._live_render.position_cursor())
-                self.console.print(self._live_render)
+            if self.console.is_terminal:
+                with self.console:
+                    self.console.print(self._live_render.position_cursor())
+                    self.console.print(self._live_render)
             self._refresh_count += 1
 
     def get_renderable(self) -> RenderableType:
@@ -652,9 +653,11 @@ def print(
         highlight: bool = None,
     ) -> None:
         """Print to the terminal and preserve progress display. Parameters identical to :class:`~rich.console.Console.print`."""
-        with self.console:
-            self.console.print(self._live_render.position_cursor())
-            self.console.print(
+        console = self.console
+        with console:
+            if console.is_terminal:
+                console.print(self._live_render.position_cursor())
+            console.print(
                 *objects,
                 sep=sep,
                 end=end,
@@ -663,7 +666,8 @@ def print(
                 markup=markup,
                 highlight=highlight,
             )
-            self.console.print(self._live_render)
+            if console.is_terminal:
+                console.print(self._live_render)
 
     def log(
         self,
@@ -677,19 +681,22 @@ def log(
         _stack_offset=1,
     ) -> None:
         """Log to the terminal and preserve progress display. Parameters identical to :class:`~rich.console.Console.log`."""
-        with self.console:
-            self.console.print(self._live_render.position_cursor())
-            self.console.log(
+        console = self.console
+        with console:
+            if console.is_terminal:
+                console.print(self._live_render.position_cursor())
+            console.log(
                 *objects,
                 sep=sep,
                 end=end,
                 emoji=emoji,
                 markup=markup,
                 highlight=highlight,
                 log_locals=log_locals,
-                _stack_offset=_stack_offset,
+                _stack_offset=_stack_offset + 1,
             )
-            self.console.print(self._live_render)
+            if console.is_terminal:
+                console.print(self._live_render)
 
 
 if __name__ == "__main__":  # pragma: no coverage

rich/rule.py

@@ -16,10 +16,10 @@ class Rule:
     def __init__(
         self,
         title: Union[str, Text] = "",
-        character: str = "━",
+        character: str = None,
         style: Union[str, Style] = "rule.line",
     ) -> None:
-        if len(character) != 1:
+        if character and len(character) != 1:
             raise ValueError(
                 "Rule requires character argument to be a string of length 1"
             )
@@ -33,8 +33,10 @@ def __repr__(self) -> str:
     def __console__(self, console: Console, options: ConsoleOptions) -> RenderResult:
         width = options.max_width
 
+        character = "-" if console.legacy_windows else (self.character or "━")
+
         if not self.title:
-            yield Text(self.character * width, self.style)
+            yield Text(character * width, self.style)
         else:
             if isinstance(self.title, Text):
                 title_text = self.title
@@ -45,11 +47,9 @@ def __console__(self, console: Console, options: ConsoleOptions) -> RenderResult
 
             rule_text = Text()
             center = (width - len(title_text)) // 2
-            rule_text.append(self.character * (center - 1) + " ", self.style)
+            rule_text.append(character * (center - 1) + " ", self.style)
             rule_text.append(title_text)
-            rule_text.append(
-                " " + self.character * (width - len(rule_text) - 1), self.style
-            )
+            rule_text.append(" " + character * (width - len(rule_text) - 1), self.style)
             yield rule_text
 
 

tests/test_console.py

@@ -82,7 +82,7 @@ def test_print_style():
 
 
 def test_show_cursor():
-    console = Console(file=io.StringIO())
+    console = Console(file=io.StringIO(), force_terminal=True)
     console.show_cursor(False)
     console.print("foo")
     console.show_cursor(True)
@@ -109,7 +109,7 @@ def test_render_error():
 
 
 def test_control():
-    console = Console(file=io.StringIO())
+    console = Console(file=io.StringIO(), force_terminal=True)
     console.control("FOO")
     console.print("BAR")
     assert console.file.getvalue() == "FOOBAR\n"