Upgrading rich 12 to 13
Breaking12.6.0 → 13.9.4Platform1New11Changed16Fixed58Other1
BreakingUpgrade verdict
A platform requirement change.
In plain terms
- This version no longer works on Python 3.6; you need Python 3.7 or newer.
Must act 1 item needs code or config changes
Python requirement changed in 13.9.0: >=3.6.3,<4.0.0 → >=3.8.0.
Adds markdown-it-py >=2.2.0.
Drops commonmark.
Installs 3 packages in all (was 2).
Also installs mdurl.
What you must change
Platform1
Bumps the minimum Python version to 3.7, dropping Python 3.6 support.
API changes
Generated by DepDelta from published Python source. Not mixed with prose notes.
- changed:
function chop_cells(text: str, max_size: int, position: int=…) -> List[str] → function chop_cells(text: str, width: int) -> list[str]
- changed:
method Console.status(status: RenderableType, *, spinner: str=…, spinner_style: str=…, speed: float=…, refresh_per_second: float=…) -> Status → method Console.status(status: RenderableType, *, spinner: str=…, spinner_style: StyleType=…, speed: float=…, refresh_per_second: float=…) -> Status - added:
method Console.on_broken_pipe() -> None
- added:
method FileProxy.fileno() -> int
- changed:
constructor RichHandler(level: Union[int, str]=…, console: Optional[Console]=…, *, show_time: bool=…, omit_repeated_times: bool=…, show_level: bool=…, show_path: bool=…, enable_link_path: bool=…, highlighter: Optional[Highlighter]=…, markup: bool=…, rich_tracebacks: bool=…, tracebacks_width: Optional[int]=…, tracebacks_extra_lines: int=…, tracebacks_theme: Optional[str]=…, tracebacks_word_wrap: b… → constructor RichHandler(level: Union[int, str]=…, console: Optional[Console]=…, *, show_time: bool=…, omit_repeated_times: bool=…, show_level: bool=…, show_path: bool=…, enable_link_path: bool=…, highlighter: Optional[Highlighter]=…, markup: bool=…, rich_tracebacks: bool=…, tracebacks_width: Optional[int]=…, tracebacks_code_width: int=…, tracebacks_extra_lines: int=…, tracebacks_theme: Optional[s…
- changed:
constructor Heading(level: int) -> None → constructor Heading(tag: str) -> None - changed:
constructor ListElement(list_type: str, list_start: Optional[int]) -> None → constructor ListElement(list_type: str, list_start: int | None) -> None - changed:
constructor Markdown(markup: str, code_theme: str=…, justify: Optional[JustifyMethod]=…, style: Union[str, Style]=…, hyperlinks: bool=…, inline_code_lexer: Optional[str]=…, inline_code_theme: Optional[str]=…) -> None → constructor Markdown(markup: str, code_theme: str=…, justify: JustifyMethod | None=…, style: str | Style=…, hyperlinks: bool=…, inline_code_lexer: str | None=…, inline_code_theme: str | None=…) -> None - changed:
constructor MarkdownContext(console: Console, options: ConsoleOptions, style: Style, inline_code_lexer: Optional[str]=…, inline_code_theme: str=…) -> None → constructor MarkdownContext(console: Console, options: ConsoleOptions, style: Style, inline_code_lexer: str | None=…, inline_code_theme: str=…) -> None - changed:
field Markdown.elements: ClassVar[Dict[str, Type[MarkdownElement]]] → field Markdown.elements: ClassVar[dict[str, type[MarkdownElement]]] - changed:
method MarkdownContext.enter_style(style_name: Union[str, Style]) -> Style → method MarkdownContext.enter_style(style_name: str | Style) -> Style - changed:
static method CodeBlock.create(markdown: Markdown, node: Any) -> CodeBlock → static method CodeBlock.create(markdown: Markdown, token: Token) -> CodeBlock - changed:
static method Heading.create(markdown: Markdown, node: Any) -> Heading → static method Heading.create(markdown: Markdown, token: Token) -> Heading - changed:
static method ImageItem.create(markdown: Markdown, node: Any) -> MarkdownElement → static method ImageItem.create(markdown: Markdown, token: Token) -> MarkdownElement - changed:
static method ListElement.create(markdown: Markdown, node: Any) -> ListElement → static method ListElement.create(markdown: Markdown, token: Token) -> ListElement - changed:
static method MarkdownElement.create(markdown: Markdown, node: Any) -> MarkdownElement → static method MarkdownElement.create(markdown: Markdown, token: Token) -> MarkdownElement - changed:
static method Paragraph.create(markdown: Markdown, node: MarkdownElement) -> Paragraph → static method Paragraph.create(markdown: Markdown, token: Token) -> Paragraph - added:
class Link(TextElement) - added:
class TableBodyElement(MarkdownElement) - added:
class TableDataElement(MarkdownElement) - added:
class TableElement(MarkdownElement) - added:
class TableHeaderElement(MarkdownElement) - added:
class TableRowElement(MarkdownElement) - added:
constructor Link(text: str, href: str) - added:
constructor TableBodyElement() -> None - added:
constructor TableDataElement(justify: JustifyMethod) -> None - added:
constructor TableElement() -> None - added:
constructor TableHeaderElement() -> None - added:
constructor TableRowElement() -> None - added:
method TableBodyElement.on_child_close(context: MarkdownContext, child: MarkdownElement) -> bool - added:
method TableDataElement.on_text(context: MarkdownContext, text: TextType) -> None - added:
method TableElement.on_child_close(context: MarkdownContext, child: MarkdownElement) -> bool - added:
method TableHeaderElement.on_child_close(context: MarkdownContext, child: MarkdownElement) -> bool - added:
method TableRowElement.on_child_close(context: MarkdownContext, child: MarkdownElement) -> bool - added:
static method Link.create(markdown: Markdown, token: Token) -> MarkdownElement - added:
static method TableDataElement.create(markdown: Markdown, token: Token) -> MarkdownElement
- changed:
static method Panel.fit(renderable: RenderableType, box: Box=…, *, title: Optional[TextType]=…, title_align: AlignMethod=…, subtitle: Optional[TextType]=…, subtitle_align: AlignMethod=…, safe_box: Optional[bool]=…, style: StyleType=…, border_style: StyleType=…, width: Optional[int]=…, padding: PaddingDimensions=…) -> Panel → static method Panel.fit(renderable: RenderableType, box: Box=…, *, title: Optional[TextType]=…, title_align: AlignMethod=…, subtitle: Optional[TextType]=…, subtitle_align: AlignMethod=…, safe_box: Optional[bool]=…, style: StyleType=…, border_style: StyleType=…, width: Optional[int]=…, height: Optional[int]=…, padding: PaddingDimensions=…, highlight: bool=…) -> Panel
- removed:
variable JUPYTER_CLASSES_TO_NOT_RENDER - changed:
field Node.key_separator → field Node.key_separator: str
- changed:
function track(sequence: Union[Sequence[ProgressType], Iterable[ProgressType]], description: str=…, total: Optional[float]=…, auto_refresh: bool=…, console: Optional[Console]=…, transient: bool=…, get_time: Optional[Callable[[], float]]=…, refresh_per_second: float=…, style: StyleType=…, complete_style: StyleType=…, finished_style: StyleType=…, pulse_style: StyleType=…, update_period: float=…, di… → function track(sequence: Union[Sequence[ProgressType], Iterable[ProgressType]], description: str=…, total: Optional[float]=…, completed: int=…, auto_refresh: bool=…, console: Optional[Console]=…, transient: bool=…, get_time: Optional[Callable[[], float]]=…, refresh_per_second: float=…, style: StyleType=…, complete_style: StyleType=…, finished_style: StyleType=…, pulse_style: StyleType=…, update_p… - changed:
method Progress.track(sequence: Union[Iterable[ProgressType], Sequence[ProgressType]], total: Optional[float]=…, task_id: Optional[TaskID]=…, description: str=…, update_period: float=…) -> Iterable[ProgressType] → method Progress.track(sequence: Union[Iterable[ProgressType], Sequence[ProgressType]], total: Optional[float]=…, completed: int=…, task_id: Optional[TaskID]=…, description: str=…, update_period: float=…) -> Iterable[ProgressType]
- changed:
class FloatPrompt(PromptBase[int]) → class FloatPrompt(PromptBase[float]) - changed:
constructor PromptBase(prompt: TextType=…, *, console: Optional[Console]=…, password: bool=…, choices: Optional[List[str]]=…, show_default: bool=…, show_choices: bool=…) -> None → constructor PromptBase(prompt: TextType=…, *, console: Optional[Console]=…, password: bool=…, choices: Optional[List[str]]=…, case_sensitive: bool=…, show_default: bool=…, show_choices: bool=…) -> None - changed:
static method PromptBase.ask(prompt: TextType=…, *, console: Optional[Console]=…, password: bool=…, choices: Optional[List[str]]=…, show_default: bool=…, show_choices: bool=…, default: DefaultType, stream: Optional[TextIO]=…) -> Union[DefaultType, PromptType] | (prompt: TextType=…, *, console: Optional[Console]=…, password: bool=…, choices: Optional[List[str]]=…, show_default: bool=…, show_choice… → static method PromptBase.ask(prompt: TextType=…, *, console: Optional[Console]=…, password: bool=…, choices: Optional[List[str]]=…, case_sensitive: bool=…, show_default: bool=…, show_choices: bool=…, default: DefaultType, stream: Optional[TextIO]=…) -> Union[DefaultType, PromptType] | (prompt: TextType=…, *, console: Optional[Console]=…, password: bool=…, choices: Optional[List[str]]=…, case_sens… - added:
variable doggie
- added:
method Style.clear_meta_and_links() -> Style
- changed:
method Syntax.stylize_range(style: StyleType, start: SyntaxPosition, end: SyntaxPosition) -> None → method Syntax.stylize_range(style: StyleType, start: SyntaxPosition, end: SyntaxPosition, style_before: bool=…) -> None - added:
property Syntax.default_lexer -> Lexer
- changed:
method Table.add_column(header: RenderableType=…, footer: RenderableType=…, *, header_style: Optional[StyleType]=…, footer_style: Optional[StyleType]=…, style: Optional[StyleType]=…, justify: JustifyMethod=…, vertical: VerticalAlignMethod=…, overflow: OverflowMethod=…, width: Optional[int]=…, min_width: Optional[int]=…, max_width: Optional[int]=…, ratio: Optional[int]=…, no_wrap: bool=…) -> None → method Table.add_column(header: RenderableType=…, footer: RenderableType=…, *, header_style: Optional[StyleType]=…, highlight: Optional[bool]=…, footer_style: Optional[StyleType]=…, style: Optional[StyleType]=…, justify: JustifyMethod=…, vertical: VerticalAlignMethod=…, overflow: OverflowMethod=…, width: Optional[int]=…, min_width: Optional[int]=…, max_width: Optional[int]=…, ratio: Optional[int]… - added:
field Column.highlight: bool
- changed:
method Text.highlight_regex(re_highlight: str, style: Optional[Union[GetStyleCallable, StyleType]]=…, *, style_prefix: str=…) -> int → method Text.highlight_regex(re_highlight: Union[Pattern[str], str], style: Optional[Union[GetStyleCallable, StyleType]]=…, *, style_prefix: str=…) -> int - added:
method Span.extend(cells: int) -> Span - added:
method Text.extend_style(spaces: int) -> None
- changed:
static method Theme.read(path: str, inherit: bool=…) -> Theme → static method Theme.read(path: str, inherit: bool=…, encoding: Optional[str]=…) -> Theme
- removed:
variable console - changed:
constructor Traceback(trace: Optional[Trace]=…, width: Optional[int]=…, extra_lines: int=…, theme: Optional[str]=…, word_wrap: bool=…, show_locals: bool=…, indent_guides: bool=…, locals_max_length: int=…, locals_max_string: int=…, suppress: Iterable[Union[str, ModuleType]]=…, max_frames: int=…) → constructor Traceback(trace: Optional[Trace]=…, *, width: Optional[int]=…, code_width: Optional[int]=…, extra_lines: int=…, theme: Optional[str]=…, word_wrap: bool=…, show_locals: bool=…, locals_max_length: int=…, locals_max_string: int=…, locals_hide_dunder: bool=…, locals_hide_sunder: bool=…, indent_guides: bool=…, suppress: Iterable[Union[str, ModuleType]]=…, max_frames: int=…) - changed:
function install(*, console: Optional[Console]=…, width: Optional[int]=…, extra_lines: int=…, theme: Optional[str]=…, word_wrap: bool=…, show_locals: bool=…, indent_guides: bool=…, suppress: Iterable[Union[str, ModuleType]]=…, max_frames: int=…) -> Callable[[Type[BaseException], BaseException, Optional[TracebackType]], Any] → function install(*, console: Optional[Console]=…, width: Optional[int]=…, code_width: Optional[int]=…, extra_lines: int=…, theme: Optional[str]=…, word_wrap: bool=…, show_locals: bool=…, locals_max_length: int=…, locals_max_string: int=…, locals_hide_dunder: bool=…, locals_hide_sunder: Optional[bool]=…, indent_guides: bool=…, suppress: Iterable[Union[str, ModuleType]]=…, max_frames: int=…) -> Cal… - changed:
static method Traceback.extract(exc_type: Type[BaseException], exc_value: BaseException, traceback: Optional[TracebackType], show_locals: bool=…, locals_max_length: int=…, locals_max_string: int=…) -> Trace → static method Traceback.extract(exc_type: Type[BaseException], exc_value: BaseException, traceback: Optional[TracebackType], *, show_locals: bool=…, locals_max_length: int=…, locals_max_string: int=…, locals_hide_dunder: bool=…, locals_hide_sunder: bool=…) -> Trace - changed:
static method Traceback.from_exception(exc_type: Type[Any], exc_value: BaseException, traceback: Optional[TracebackType], width: Optional[int]=…, extra_lines: int=…, theme: Optional[str]=…, word_wrap: bool=…, show_locals: bool=…, indent_guides: bool=…, locals_max_length: int=…, locals_max_string: int=…, suppress: Iterable[Union[str, ModuleType]]=…, max_frames: int=…) -> Traceback → static method Traceback.from_exception(exc_type: Type[Any], exc_value: BaseException, traceback: Optional[TracebackType], *, width: Optional[int]=…, code_width: Optional[int]=…, extra_lines: int=…, theme: Optional[str]=…, word_wrap: bool=…, show_locals: bool=…, locals_max_length: int=…, locals_max_string: int=…, locals_hide_dunder: bool=…, locals_hide_sunder: bool=…, indent_guides: bool=…, suppre… - added:
field Frame.last_instruction: Optional[Tuple[Tuple[int, int], Tuple[int, int]]]
- added:
field Tree.ASCII_GUIDES - added:
field Tree.TREE_GUIDES - added:
variable GuideType