Skip to content

Fix typing for save_html, save_text, save_svg to accept PathLike #3941

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SudheerKovvuru wants to merge 1 commit into
base: master
Choose a base branch
from
+7 −6
Open

Fix typing for save_html, save_text, save_svg to accept PathLike #3941

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions rich/console.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
cast,
runtime_checkable,
)
from os import PathLike

from rich._null_file import NULL_FILE

Expand Down Expand Up @@ -2206,11 +2207,11 @@ def export_text(self, *, clear: bool = True, styles: bool = False) -> str:
del self._record_buffer[:]
return text

def save_text(self, path: str, *, clear: bool = True, styles: bool = False) -> None:
def save_text(self, path: Union[str, PathLike[str]], *, clear: bool = True, styles: bool = False) -> None:
"""Generate text from console and save to a given location (requires record=True argument in constructor).

Args:
path (str): Path to write text files.
path (Union[str, PathLike[str]]): Path to write text files.
clear (bool, optional): Clear record buffer after exporting. Defaults to ``True``.
styles (bool, optional): If ``True``, ansi style codes will be included. ``False`` for plain text.
Defaults to ``False``.
Expand Down Expand Up @@ -2297,7 +2298,7 @@ def export_html(

def save_html(
self,
path: str,
path: Union[str, PathLike[str]],
*,
theme: Optional[TerminalTheme] = None,
clear: bool = True,
Expand All @@ -2307,7 +2308,7 @@ def save_html(
"""Generate HTML from console contents and write to a file (requires record=True argument in constructor).

Args:
path (str): Path to write html file.
path (Union[str, PathLike[str]]): Path to write html file.
theme (TerminalTheme, optional): TerminalTheme object containing console colors.
clear (bool, optional): Clear record buffer after exporting. Defaults to ``True``.
code_format (str, optional): Format string to render HTML. In addition to '{foreground}',
Expand Down Expand Up @@ -2579,7 +2580,7 @@ def stringify(value: object) -> str:

def save_svg(
self,
path: str,
path: Union[str, PathLike[str]],
*,
title: str = "Rich",
theme: Optional[TerminalTheme] = None,
Expand All @@ -2591,7 +2592,7 @@ def save_svg(
"""Generate an SVG file from the console contents (requires record=True in Console constructor).

Args:
path (str): The path to write the SVG to.
path (Union[str, PathLike[str]]): The path to write the SVG to.
title (str, optional): The title of the tab in the output image
theme (TerminalTheme, optional): The ``TerminalTheme`` object to use to style the terminal
clear (bool, optional): Clear record buffer after exporting. Defaults to ``True``
Expand Down