from typing import Iterable, List, TYPE_CHECKING from . import get_console from .segment import Segment from .terminal_theme import DEFAULT_TERMINAL_THEME if TYPE_CHECKING: from .console import RenderableType JUPYTER_HTML_FORMAT = """\
{code}
"""
class JupyterRenderable:
"""A shim to write html to Jupyter notebook."""
def __init__(self, html: str) -> None:
self.html = html
@classmethod
def render(cls, rich_renderable: "RenderableType") -> str:
console = get_console()
segments = console.render(rich_renderable, console.options)
html = _render_segments(segments)
return html
def _repr_html_(self) -> str:
return self.html
class JupyterMixin:
"""Add to an Rich renderable to make it render in Jupyter notebook."""
def _repr_html_(self) -> str:
console = get_console()
segments = list(console.render(self, console.options)) # type: ignore
html = _render_segments(segments)
return html
def _render_segments(segments: Iterable[Segment]) -> str:
def escape(text: str) -> str:
"""Escape html."""
return text.replace("&", "&").replace("<", "<").replace(">", ">")
fragments: List[str] = []
append_fragment = fragments.append
theme = DEFAULT_TERMINAL_THEME
for text, style, is_control in Segment.simplify(segments):
if is_control:
continue
text = escape(text)
if style:
rule = style.get_html_style(theme)
text = f'{text}' if rule else text
if style.link:
text = f'{text}'
append_fragment(text)
code = "".join(fragments)
html = JUPYTER_HTML_FORMAT.format(code=code)
return html
def display(segments: Iterable[Segment]) -> None:
"""Render segments to Jupyter."""
from IPython.display import display as ipython_display
html = _render_segments(segments)
jupyter_renderable = JupyterRenderable(html)
ipython_display(jupyter_renderable)
def print(*args, **kwargs) -> None:
"""Proxy for Console print."""
console = get_console()
return console.print(*args, **kwargs)