mirrors/rich
1
0
Fork 0
mirror of https://github.com/Textualize/rich.git synced 2025-08-04 10:08:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix up the trivial changes first from review

Browse source
This commit is contained in:
Nathan Page 2020-11-01 09:50:58 -05:00
parent cbb88a44a4
commit d890c4ed1c
2 changed files with 17 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

42
rich/live.py
View file

@ -86,6 +86,19 @@ class _LiveRender:
class Live(JupyterMixin, RenderHook):
"""Renders an auto-updating live display of any given renderable.
Args:
renderable (RenderableType, optional): [The renderable to live display. Defaults to displaying nothing.
console (Console, optional): Optional Console instance. Default will an internal Console instance writing to stdout.
auto_refresh (bool, optional): Enable auto refresh. If disabled, you will need to call `refresh()` or `update()` with refresh flag. Defaults to True
refresh_per_second (float, optional): Number of times per second to refresh the live display. Defaults to 1.
transient (bool, optional): Clear the renderable on exit. Defaults to False.
redirect_stdout (bool, optional): Enable redirection of stdout, so ``print`` may be used. Defaults to True.
redirect_stderr (bool, optional): Enable redirection of stderr. Defaults to True.
hide_overflow (bool, optional): Checks that the renderable isn't too large for terminal and auto-hides. Defaults to True.
"""
def __init__(
self,
renderable: RenderableType = "",
@ -98,18 +111,6 @@ class Live(JupyterMixin, RenderHook):
redirect_stderr: bool = True,
hide_overflow: bool = True,
) -> None:
"""Renders an auto-updating live display of any given renderable.
Args:
renderable (RenderableType, optional): [The renderable to live display. Defaults to displaying nothing.
console (Console, optional): Optional Console instance. Default will an internal Console instance writing to stdout.
auto_refresh (bool, optional): Enable auto refresh. If disabled, you will need to call `refresh()` or `update()` with refresh flag. Defaults to True
refresh_per_second (float, optional): Number of times per second to refresh the live display. Defaults to 1.
transient (bool, optional): Clear the renderable on exit. Defaults to False.
redirect_stdout (bool, optional): Enable redirection of stdout, so ``print`` may be used. Defaults to True.
redirect_stderr (bool, optional): Enable redirection of stderr. Defaults to True.
hide_overflow (bool, optional): Checks that the renderable isn't too large for terminal and auto-hides. Defaults to True.
"""
assert refresh_per_second > 0, "refresh_per_second must be > 0"
self.console = console if console is not None else get_console()
self._live_render = _LiveRender(renderable, hide_overflow=hide_overflow)
@ -190,7 +191,7 @@ class Live(JupyterMixin, RenderHook):
sys.stdout = _FileProxy(self.console, sys.stdout)
@property
def item(self) -> RenderableType:
def renderable(self) -> RenderableType:
"""Get the renderable that is being displayed
Returns:
@ -199,15 +200,6 @@ class Live(JupyterMixin, RenderHook):
with self._lock:
return self._live_render.renderable
@property
def is_started(self) -> bool:
"""Indicate if it is currently live rendering.
Returns:
bool: Is live rendering.
"""
return self._started
def update(self, renderable: RenderableType, *, refresh: bool = False) -> None:
"""Update the renderable that is being displayed
@ -243,7 +235,7 @@ class Live(JupyterMixin, RenderHook):
with self._lock, self.console:
self.console.print(Control(""))
elif (
not self.is_started and not self.transient
not self._started and not self.transient
): # if it is finished allow files or dumb-terminals to see final result
with self.console:
self.console.print(Control(""))
@ -271,14 +263,14 @@ class Live(JupyterMixin, RenderHook):
self._live_render,
]
elif (
not self.is_started and not self.transient
not self._started and not self.transient
): # if it is finished render the final output for files or dumb_terminals
return [*renderables, self._live_render]
return renderables
if __name__ == "__main__":
if __name__ == "__main__": # pragma: no cover
import random
import time
from itertools import cycle

4
tests/test_live.py
View file

@ -41,10 +41,6 @@ def check_output(output_file: str, output: str) -> None:
correct_output = get_capture_text("live", output_file).replace("\r", "")
if os.getenv("VERBOSE") is not None:
print("Current Output\n", output)
print("Correct Output\n", correct_output)
assert output == correct_output, "Console output differs from the correct output"