Method: rich.console.Console.pager
Calls: 2, Exceptions: 0, Paths: 1Back
Path 1: 2 calls (1.0)
SystemPager (2)
False (1) True (1)
False (2)
PagerContext (2)
1def pager(
2 self, pager: Optional[Pager] = None, styles: bool = False, links: bool = False
3 ) -> PagerContext:
4 """A context manager to display anything printed within a "pager". The pager application
5 is defined by the system and will typically support at least pressing a key to scroll.
6
7 Args:
8 pager (Pager, optional): A pager object, or None to use :class:`~rich.pager.SystemPager`. Defaults to None.
9 styles (bool, optional): Show styles in pager. Defaults to False.
10 links (bool, optional): Show links in pager. Defaults to False.
11
12 Example:
13 >>> from rich.console import Console
14 >>> from rich.__main__ import make_test_card
15 >>> console = Console()
16 >>> with console.pager():
17 console.print(make_test_card())
18
19 Returns:
20 PagerContext: A context manager.
21 """
22 return PagerContext(self, pager=pager, styles=styles, links=links)