Method: rich.console.Console.update_screen
Calls: 3, Exceptions: 1, Paths: 3Back
Path 1: 1 calls (0.33)
'foo' (1)
None (1)
None (1)
NoAltScreen (1)
1def update_screen(
2 self,
3 renderable: RenderableType,
4 *,
5 region: Optional[Region] = None,
6 options: Optional[ConsoleOptions] = None,
7 ) -> None:
8 """Update the screen at a given offset.
9
10 Args:
11 renderable (RenderableType): A Rich renderable.
12 region (Region, optional): Region of screen to update, or None for entire screen. Defaults to None.
13 x (int, optional): x offset. Defaults to 0.
14 y (int, optional): y offset. Defaults to 0.
15
16 Raises:
17 errors.NoAltScreen: If the Console isn't in alt screen mode.
18
19 """
20 if not self.is_alt_screen:
21 raise errors.NoAltScreen("Alt screen must be enabled to call update_screen")
22 render_options = options or self.options
23 if region is None:
24 x = y = 0
25 render_options = render_options.update_dimensions(
26 render_options.max_width, render_options.height or self.height
27 )
28 else:
29 x, y, width, height = region
30 render_options = render_options.update_dimensions(width, height)
31
32 lines = self.render_lines(renderable, options=render_options)
33 self.update_screen_lines(lines, x, y)
Path 2: 1 calls (0.33)
'foo' (1)
None (1)
None (1)
1def update_screen(
2 self,
3 renderable: RenderableType,
4 *,
5 region: Optional[Region] = None,
6 options: Optional[ConsoleOptions] = None,
7 ) -> None:
8 """Update the screen at a given offset.
9
10 Args:
11 renderable (RenderableType): A Rich renderable.
12 region (Region, optional): Region of screen to update, or None for entire screen. Defaults to None.
13 x (int, optional): x offset. Defaults to 0.
14 y (int, optional): y offset. Defaults to 0.
15
16 Raises:
17 errors.NoAltScreen: If the Console isn't in alt screen mode.
18
19 """
20 if not self.is_alt_screen:
21 raise errors.NoAltScreen("Alt screen must be enabled to call update_screen")
22 render_options = options or self.options
23 if region is None:
24 x = y = 0
25 render_options = render_options.update_dimensions(
26 render_options.max_width, render_options.height or self.height
27 )
28 else:
29 x, y, width, height = region
30 render_options = render_options.update_dimensions(width, height)
31
32 lines = self.render_lines(renderable, options=render_options)
33 self.update_screen_lines(lines, x, y)
Path 3: 1 calls (0.33)
'bar' (1)
Region (1)
None (1)
1def update_screen(
2 self,
3 renderable: RenderableType,
4 *,
5 region: Optional[Region] = None,
6 options: Optional[ConsoleOptions] = None,
7 ) -> None:
8 """Update the screen at a given offset.
9
10 Args:
11 renderable (RenderableType): A Rich renderable.
12 region (Region, optional): Region of screen to update, or None for entire screen. Defaults to None.
13 x (int, optional): x offset. Defaults to 0.
14 y (int, optional): y offset. Defaults to 0.
15
16 Raises:
17 errors.NoAltScreen: If the Console isn't in alt screen mode.
18
19 """
20 if not self.is_alt_screen:
21 raise errors.NoAltScreen("Alt screen must be enabled to call update_screen")
22 render_options = options or self.options
23 if region is None:
24 x = y = 0
25 render_options = render_options.update_dimensions(
26 render_options.max_width, render_options.height or self.height
27 )
28 else:
29 x, y, width, height = region
30 render_options = render_options.update_dimensions(width, height)
31
32 lines = self.render_lines(renderable, options=render_options)
33 self.update_screen_lines(lines, x, y)