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

Merge branch 'master' into remove-typing-extensions-runtime

Browse source
This commit is contained in:
Will McGugan 2025-06-18 18:49:34 +01:00 • committed by GitHub
commit 6ae321ad86
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
11 changed files with 219 additions and 150 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/source/live.rst
View file

@ -3,7 +3,7 @@
Live Display
============
Progress bars and status indicators use a *live* display to animate parts of the terminal. You can build custom live displays with the :class:`~rich.live.Live` class.
Progress bars and status indicators use a *live* display to animate parts of the terminal. You can build custom live displays with the :class:`~rich.live.Live` class.
For a demonstration of a live display, run the following command::
@ -72,7 +72,7 @@ You can also change the renderable on-the-fly by calling the :meth:`~rich.live.L
Alternate screen
~~~~~~~~~~~~~~~~
You can opt to show a Live display in the "alternate screen" by setting ``screen=True`` on the constructor. This will allow your live display to go full screen and restore the command prompt on exit.
You can opt to show a Live display in the "alternate screen" by setting ``screen=True`` on the constructor. This will allow your live display to go full screen and restore the command prompt on exit.
You can use this feature in combination with :ref:`Layout` to display sophisticated terminal "applications".
@ -80,7 +80,7 @@ Transient display
~~~~~~~~~~~~~~~~~
Normally when you exit live context manager (or call :meth:`~rich.live.Live.stop`) the last refreshed item remains in the terminal with the cursor on the following line.
You can also make the live display disappear on exit by setting ``transient=True`` on the Live constructor.
You can also make the live display disappear on exit by setting ``transient=True`` on the Live constructor.
Auto refresh
~~~~~~~~~~~~
@ -149,13 +149,10 @@ This feature is enabled by default, but you can disable by setting ``redirect_st
Nesting Lives
-------------
Note that only a single live context may be active at any one time. The following will raise a :class:`~rich.errors.LiveError` because status also uses Live::
If you create a Live instance within the context of an existing Live instance, then the content of the inner Live will be displayed below the outer Live.
with Live(table, console=console):
with console.status("working"): # Will not work
do_work()
Prior to version 14.0.0 this would have resulted in a :class:`~rich.errors.LiveError` exception.
In practice this is rarely a problem because you can display any combination of renderables in a Live context.
Examples
--------

22
docs/source/progress.rst
View file

@ -266,6 +266,28 @@ If you expect to be reading from multiple files, you can use :meth:`~rich.progre
See `cp_progress.py <https://github.com/willmcgugan/rich/blob/master/examples/cp_progress.py>`_ for a minimal clone of the ``cp`` command which shows a progress bar as the file is copied.
Nesting Progress bars
---------------------
If you create a new progress bar within the context of an existing progress bar (with the context manager or `track` function), then Rich will display the inner progress bar(s) under the initial bar.
Here's an example that nests progress bars::
from rich.progress import track
from time import sleep
for count in track(range(10)):
for letter in track("ABCDEF", transient=True):
print(f"Stage {count}{letter}")
sleep(0.1)
sleep(0.1)
The inner loop creates a new progress bar below the first, but both can update.
Note that if you nest progress bars like this, then the nested bars will updating according to the `refresh_per_second` attribute of the outer bar.
Multiple Progress
-----------------