Upgrading rich 10 to 11
Breaking10.16.2 → 11.2.0Breaking2New7Changed1Fixed6
BreakingUpgrade verdict
2 breaking changes.
In plain terms
- Renames the Syntax.__init__ parameter lexer_name to lexer.
- Deprecates rich.console.RenderGroup, now named rich.console.Group.
Must act 2 items need code or config changes
What you must change
Breaking2
Renames the Syntax.__init__ parameter lexer_name to lexer.
Syntax.__init__lexer_namelexerDeprecates rich.console.RenderGroup, now named rich.console.Group.
rich.console.RenderGrouprich.console.GroupAPI changes
Generated by DepDelta from published Python source. Not mixed with prose notes.
- removed:
variable RenderGroup - removed:
variable render_group
- added:
variable args - added:
variable console - added:
variable html: bool - added:
variable parser - added:
variable table
- removed:
variable console - added:
function report() -> None
- changed:
constructor Pretty(_object: Any, highlighter: Optional[HighlighterType]=…, *, indent_size: int=…, justify: Optional[JustifyMethod]=…, overflow: Optional[OverflowMethod]=…, no_wrap: Optional[bool]=…, indent_guides: bool=…, max_length: Optional[int]=…, max_string: Optional[int]=…, expand_all: bool=…, margin: int=…, insert_line: bool=…) -> None → constructor Pretty(_object: Any, highlighter: Optional[HighlighterType]=…, *, indent_size: int=…, justify: Optional[JustifyMethod]=…, overflow: Optional[OverflowMethod]=…, no_wrap: Optional[bool]=…, indent_guides: bool=…, max_length: Optional[int]=…, max_string: Optional[int]=…, max_depth: Optional[int]=…, expand_all: bool=…, margin: int=…, insert_line: bool=…) -> None - changed:
function pprint(_object: Any, *, console: Optional[Console]=…, indent_guides: bool=…, max_length: Optional[int]=…, max_string: Optional[int]=…, expand_all: bool=…) -> None → function pprint(_object: Any, *, console: Optional[Console]=…, indent_guides: bool=…, max_length: Optional[int]=…, max_string: Optional[int]=…, max_depth: Optional[int]=…, expand_all: bool=…) -> None - changed:
function pretty_repr(_object: Any, *, max_width: int=…, indent_size: int=…, max_length: Optional[int]=…, max_string: Optional[int]=…, expand_all: bool=…) -> str → function pretty_repr(_object: Any, *, max_width: int=…, indent_size: int=…, max_length: Optional[int]=…, max_string: Optional[int]=…, max_depth: Optional[int]=…, expand_all: bool=…) -> str - changed:
function traverse(_object: Any, max_length: Optional[int]=…, max_string: Optional[int]=…) -> Node → function traverse(_object: Any, max_length: Optional[int]=…, max_string: Optional[int]=…, max_depth: Optional[int]=…) -> Node
- added:
static method Progress.get_default_columns() -> Tuple[ProgressColumn, ...]
- added:
static method Segment.align_bottom(lines: List[List[Segment]], width: int, height: int, style: Style, new_lines: bool=…) -> List[List[Segment]] - added:
static method Segment.align_middle(lines: List[List[Segment]], width: int, height: int, style: Style, new_lines: bool=…) -> List[List[Segment]] - added:
static method Segment.align_top(lines: List[List[Segment]], width: int, height: int, style: Style, new_lines: bool=…) -> List[List[Segment]]
- changed:
constructor Syntax(code: str, lexer_name: str, *, theme: Union[str, SyntaxTheme]=…, dedent: bool=…, line_numbers: bool=…, start_line: int=…, line_range: Optional[Tuple[int, int]]=…, highlight_lines: Optional[Set[int]]=…, code_width: Optional[int]=…, tab_size: int=…, word_wrap: bool=…, background_color: Optional[str]=…, indent_guides: bool=…) -> None → constructor Syntax(code: str, lexer: Union[Lexer, str], *, theme: Union[str, SyntaxTheme]=…, dedent: bool=…, line_numbers: bool=…, start_line: int=…, line_range: Optional[Tuple[Optional[int], Optional[int]]]=…, highlight_lines: Optional[Set[int]]=…, code_width: Optional[int]=…, tab_size: int=…, word_wrap: bool=…, background_color: Optional[str]=…, indent_guides: bool=…) -> None - changed:
method Syntax.highlight(code: str, line_range: Optional[Tuple[int, int]]=…) -> Text → method Syntax.highlight(code: str, line_range: Optional[Tuple[Optional[int], Optional[int]]]=…) -> Text - changed:
static method Syntax.from_path(path: str, encoding: str=…, theme: Union[str, SyntaxTheme]=…, dedent: bool=…, line_numbers: bool=…, line_range: Optional[Tuple[int, int]]=…, start_line: int=…, highlight_lines: Optional[Set[int]]=…, code_width: Optional[int]=…, tab_size: int=…, word_wrap: bool=…, background_color: Optional[str]=…, indent_guides: bool=…) -> Syntax → static method Syntax.from_path(path: str, encoding: str=…, lexer: Optional[Union[Lexer, str]]=…, theme: Union[str, SyntaxTheme]=…, dedent: bool=…, line_numbers: bool=…, line_range: Optional[Tuple[int, int]]=…, start_line: int=…, highlight_lines: Optional[Set[int]]=…, code_width: Optional[int]=…, tab_size: int=…, word_wrap: bool=…, background_color: Optional[str]=…, indent_guides: bool=…) -> Syntax - added:
property Syntax.lexer -> Optional[Lexer] - added:
static method Syntax.guess_lexer(path: str, code: Optional[str]=…) -> str
- changed:
method Table.add_column(header: RenderableType=…, footer: RenderableType=…, *, header_style: Optional[StyleType]=…, footer_style: Optional[StyleType]=…, style: Optional[StyleType]=…, justify: JustifyMethod=…, 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]=…, 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 - added:
field Column.vertical: VerticalAlignMethod