Upgrading rich 0.7 to 0.8
Unknown0.7.2 → 0.8.13New9Changed11Fixed8
UnknownUpgrade verdict
DepDelta hasn't looked for the notes of 1 of 15 releases yet, so breaking changes can't be ruled out.
In plain terms
- DepDelta hasn't finished looking for the notes in this range, so it can't rule out breaking changes yet.
Must act Unknown for releases without notes
Releases without notes may still need changes. Check their commits before upgrading.
API changes
Generated by DepDelta from published Python source. Not mixed with prose notes.
- removed:
method Bar.update_progress(completed: float, total: float=…) -> None - added:
method Bar.update(completed: float, total: float=…) -> None
- added:
function cell_len(text: str, _cache: Dict[str, int]=…) -> int - added:
function chop_cells(text: str, max_size: int, position: int=…) -> List[str] - added:
function get_character_cell_size(character: str) -> int - added:
function set_cell_size(text: str, total: int) -> str
- removed:
class RichRenderable - removed:
constructor RichRenderable(rich_cast: Callable[[], ConsoleRenderable]) -> None - removed:
field ConsoleThreadLocals.style_stack: List[Style] - removed:
method Console.pop_styles() -> None - removed:
method Console.push_styles(styles: Dict[str, Style]) -> None - removed:
method Console.render_all(renderables: Iterable[RenderableType], options: Optional[ConsoleOptions]) -> Iterable[Segment] - changed:
constructor Console(color_system: Optional[Literal['auto', 'standard', '256', 'truecolor', 'windows']]=…, theme: Theme=…, file: IO=…, width: int=…, height: int=…, tab_size: int=…, record: bool=…, markup: bool=…, emoji: bool=…, log_time: bool=…, log_path: bool=…, log_time_format: str=…, highlighter: Optional[HighlighterType]=…) → constructor Console(color_system: Optional[Literal['auto', 'standard', '256', 'truecolor', 'windows']]=…, force_terminal: bool=…, theme: Theme=…, file: IO[str]=…, width: int=…, height: int=…, tab_size: int=…, record: bool=…, markup: bool=…, emoji: bool=…, highlight: bool=…, log_time: bool=…, log_path: bool=…, log_time_format: str=…, highlighter: Optional[HighlighterType]=…) - changed:
constructor RenderGroup(renderables: Iterable[RenderableType], fit: bool=…) -> None → constructor RenderGroup(*renderables: RenderableType, fit: bool=…) -> None - changed:
method Console.print_exception(width: Optional[int]=…, extra_lines: int=…, theme: Optional[str]=…) -> None → method Console.print_exception(width: Optional[int]=…, extra_lines: int=…, theme: Optional[str]=…, word_wrap: bool=…) -> None - changed:
method ConsoleOptions.update(width: int=…, min_width: int=…, max_width: int=…, justify: JustifyValues=…) → method ConsoleOptions.update(width: int=…, min_width: int=…, max_width: int=…, justify: JustifyValues=…) -> ConsoleOptions
- removed:
variable PYTHON_STYLES
- removed:
function binary(size: int) -> str - removed:
function traditional(size: int) -> str
- added:
class Console(BaseConsole) - added:
class JupyterRenderable - added:
constructor Console(**kwargs) -> None - added:
constructor JupyterRenderable(text: str, html: str) -> None - added:
method Console.is_terminal() -> bool - added:
method Console.print(*objects: Any, sep=…, end=…, file: IO[str]=…, style: Union[str, Style]=…, emoji: bool=…, markup: bool=…, highlight: bool=…, flush: bool=…) -> JupyterRenderable - added:
variable JUPYTER_HTML_FORMAT - added:
variable console - added:
variable print
- changed:
constructor RichHandler(level: int=…) -> None → constructor RichHandler(level: int=…, console: Console=…) -> None
- removed:
property MarkdownContext.width -> int
- changed:
function render(markup: str, style: Union[str, Style]=…) -> Text → function render(markup: str, style: Union[str, Style]=…, emoji: bool=…) -> Text
- removed:
property Palette.hex -> List[str]
- changed:
constructor Panel(renderable: RenderableType, box=…, expand: bool=…, style: Union[str, Style]=…, width: Optional[int]=…) -> None → constructor Panel(renderable: RenderableType, box: box.Box=…, expand: bool=…, style: Union[str, Style]=…, width: Optional[int]=…) -> None
- removed:
property Progress.tasks_ids -> List[TaskID] - changed:
function track(sequence: Sequence[ProgressType], description=…) -> Iterable[ProgressType] → function track(sequence: Union[Sequence[ProgressType], Iterable[ProgressType]], description=…, total: int=…, auto_refresh=…) -> Iterable[ProgressType] - changed:
method Progress.track(sequence: Sequence[ProgressType], description=…) -> Iterable[ProgressType] → method Progress.track(sequence: Union[Iterable[ProgressType], Sequence[ProgressType]], total: int=…, task_id: Optional[TaskID]=…, description=…) -> Iterable[ProgressType] - changed:
method Progress.update(task_id: TaskID, refresh=…, *, total: float=…, completed: float=…, advance: float=…, visible: bool=…, **fields: Any) -> None → method Progress.update(task_id: TaskID, *, total: float=…, completed: float=…, advance: float=…, visible: bool=…, refresh: bool=…, **fields: Any) -> None - added:
class DownloadColumn(ProgressColumn) - added:
class TotalFileSizeColumn(ProgressColumn) - added:
method DownloadColumn.render(task: Task) -> Text - added:
method Progress.advance(task_id: TaskID, advance: float=…) -> None - added:
method TotalFileSizeColumn.render(task: Task) -> Text - added:
property Progress.task_ids -> List[TaskID]
- removed:
class Python - removed:
constructor Python(code: str, dedent: bool=…, line_numbers: bool=…, start_line_no: int=…, line_range: Tuple[int, int]=…) - removed:
variable code - removed:
variable console - removed:
variable py
- added:
variable text
- changed:
constructor Syntax(code: str, lexer_name: str, *, theme: Union[str, PygmentsStyle]=…, dedent: bool=…, line_numbers: bool=…, start_line: int=…, line_range: Tuple[int, int]=…, highlight_lines: Set[int]=…, code_width: Optional[int]=…, tab_size: int=…) -> None → constructor Syntax(code: str, lexer_name: str, *, theme: Union[str, PygmentsStyle]=…, dedent: bool=…, line_numbers: bool=…, start_line: int=…, line_range: Tuple[int, int]=…, highlight_lines: Set[int]=…, code_width: Optional[int]=…, tab_size: int=…, word_wrap: bool=…) -> None - changed:
static method Syntax.from_path(path: str, theme: Union[str, PygmentsStyle]=…, dedent: bool=…, line_numbers: bool=…, line_range: Tuple[int, int]=…, start_line: int=…, highlight_lines: Set[int]=…, code_width: Optional[int]=…, tab_size: int=…) -> Syntax → static method Syntax.from_path(path: str, encoding: str=…, theme: Union[str, PygmentsStyle]=…, dedent: bool=…, line_numbers: bool=…, line_range: Tuple[int, int]=…, start_line: int=…, highlight_lines: Set[int]=…, code_width: Optional[int]=…, tab_size: int=…, word_wrap: bool=…) -> Syntax
- changed:
constructor Table(*headers: Union[Column, str], title: Union[str, Text]=…, caption: Union[str, Text]=…, width: int=…, box: Optional[box.Box]=…, padding: PaddingDimensions=…, pad_edge: bool=…, expand: bool=…, show_header: bool=…, show_footer: bool=…, show_edge: bool=…, style: Union[str, Style]=…, header_style: Union[str, Style]=…, footer_style: Union[str, Style]=…, border_style: Union[str, Style]=… → constructor Table(*headers: Union[Column, str], title: Union[str, Text]=…, caption: Union[str, Text]=…, width: int=…, box: Optional[box.Box]=…, padding: PaddingDimensions=…, pad_edge: bool=…, expand: bool=…, show_header: bool=…, show_footer: bool=…, show_edge: bool=…, show_lines: bool=…, style: StyleType=…, row_styles: Iterable[StyleType]=…, header_style: StyleType=…, footer_style: StyleType=…, b… - changed:
field Column.footer_style: Union[str, Style] → field Column.footer_style: StyleType - changed:
field Column.header_style: Union[str, Style] → field Column.header_style: StyleType - changed:
field Column.style: Union[str, Style] → field Column.style: StyleType - changed:
method Table.add_column(header: RenderableType=…, footer: RenderableType=…, header_style: Union[str, Style]=…, footer_style: Union[str, Style]=…, style: Union[str, Style]=…, justify: JustifyValues=…, width: int=…, ratio: int=…, no_wrap: bool=…) → method Table.add_column(header: RenderableType=…, footer: RenderableType=…, header_style: StyleType=…, footer_style: StyleType=…, style: StyleType=…, justify: JustifyValues=…, width: int=…, ratio: int=…, no_wrap: bool=…) -> None - changed:
static method Table.grid() -> Table → static method Table.grid(padding: PaddingDimensions=…) -> Table - added:
method Table.get_row_style(index: int) -> StyleType - added:
property Table.row_count -> int
- changed:
constructor Text(text: str=…, style: Union[str, Style]=…, justify: JustifyValues=…, end: str=…, tab_size: int=…) -> None → constructor Text(text: str=…, style: Union[str, Style]=…, justify: JustifyValues=…, end: str=…, tab_size: Optional[int]=…) -> None - changed:
static method Text.from_markup(text: str, style: Union[str, Style]=…) -> Text → static method Text.from_markup(text: str, style: Union[str, Style]=…, emoji: bool=…, justify: JustifyValues=…) -> Text - added:
method Text.render(console: Console, end: str=…) -> Iterable[Segment] - added:
property Text.spans -> List[Span]
- changed:
constructor Traceback(trace: Trace=…, width: Optional[int]=…, extra_lines: int=…, theme: Optional[str]=…) → constructor Traceback(trace: Trace=…, width: Optional[int]=…, extra_lines: int=…, theme: Optional[str]=…, word_wrap: bool=…) - changed:
function install(width: Optional[int]=…, extra_lines: int=…, theme: Optional[str]=…) -> None → function install(*, console: Console=…, width: Optional[int]=…, line_numbers: bool=…, extra_lines: int=…, theme: Optional[str]=…, word_wrap: bool=…) -> Callable - changed:
static method Traceback.from_exception(exc_type: Type[BaseException], exc_value: BaseException, traceback: TracebackType, width: Optional[int]=…, extra_lines: int=…, theme: Optional[str]=…) → static method Traceback.from_exception(exc_type: Type[BaseException], exc_value: BaseException, traceback: TracebackType, width: Optional[int]=…, extra_lines: int=…, theme: Optional[str]=…, word_wrap: bool=…) -> Traceback