Module tinytroupe.utils.rendering
Expand source code
import json
import textwrap
from datetime import datetime
from typing import Union
import inspect
from tinytroupe.utils import logger
################################################################################
# Rendering and markup
################################################################################
def inject_html_css_style_prefix(html, style_prefix_attributes):
"""
Injects a style prefix to all style attributes in the given HTML string.
For example, if you want to add a style prefix to all style attributes in the HTML string
``<div style="color: red;">Hello</div>``, you can use this function as follows:
inject_html_css_style_prefix('<div style="color: red;">Hello</div>', 'font-size: 20px;')
"""
return html.replace('style="', f'style="{style_prefix_attributes};')
def break_text_at_length(text: Union[str, dict], max_length: int=None) -> str:
"""
Breaks the text (or JSON) at the specified length, inserting a "(...)" string at the break point.
If the maximum length is `None`, the content is returned as is.
"""
if isinstance(text, dict):
text = json.dumps(text, indent=4)
if max_length is None or len(text) <= max_length:
return text
else:
return text[:max_length] + " (...)"
def pretty_datetime(dt: datetime) -> str:
"""
Returns a pretty string representation of the specified datetime object.
"""
return dt.strftime("%Y-%m-%d %H:%M")
def dedent(text: str) -> str:
"""
Dedents the specified text, removing any leading whitespace and identation.
"""
return textwrap.dedent(text).strip()
def wrap_text(text: str, width: int=100) -> str:
"""
Wraps the text at the specified width.
"""
return textwrap.fill(text, width=width)
def indent_at_current_level(text: str) -> str:
"""
Indents the specified text at the current indentation level, determined dynamically.
"""
frame = inspect.currentframe().f_back
line = frame.f_lineno
filename = frame.f_code.co_filename
with open(filename, 'r') as f:
lines = f.readlines()
current_line = lines[line - 1]
indent= len(current_line) - len(current_line.lstrip())
# first dedent the text to remove any leading whitespace
text = dedent(text)
# then indent it to the specified level
return textwrap.indent(text, ' ' * indent)
class RichTextStyle:
# Consult color options here: https://rich.readthedocs.io/en/stable/appendix/colors.html
STIMULUS_CONVERSATION_STYLE = "bold italic cyan1"
STIMULUS_THOUGHT_STYLE = "dim italic cyan1"
STIMULUS_DEFAULT_STYLE = "italic"
ACTION_DONE_STYLE = "grey82"
ACTION_TALK_STYLE = "bold green3"
ACTION_THINK_STYLE = "green"
ACTION_DEFAULT_STYLE = "purple"
INTERVENTION_DEFAULT_STYLE = "bright_magenta"
@classmethod
def get_style_for(cls, kind:str, event_type:str=None):
if kind == "stimulus" or kind=="stimuli":
if event_type == "CONVERSATION":
return cls.STIMULUS_CONVERSATION_STYLE
elif event_type == "THOUGHT":
return cls.STIMULUS_THOUGHT_STYLE
else:
return cls.STIMULUS_DEFAULT_STYLE
elif kind == "action":
if event_type == "DONE":
return cls.ACTION_DONE_STYLE
elif event_type == "TALK":
return cls.ACTION_TALK_STYLE
elif event_type == "THINK":
return cls.ACTION_THINK_STYLE
else:
return cls.ACTION_DEFAULT_STYLE
elif kind == "intervention":
return cls.INTERVENTION_DEFAULT_STYLE
Functions
def break_text_at_length(text: Union[str, dict], max_length: int = None) ‑> str
-
Breaks the text (or JSON) at the specified length, inserting a "(…)" string at the break point. If the maximum length is
None
, the content is returned as is.Expand source code
def break_text_at_length(text: Union[str, dict], max_length: int=None) -> str: """ Breaks the text (or JSON) at the specified length, inserting a "(...)" string at the break point. If the maximum length is `None`, the content is returned as is. """ if isinstance(text, dict): text = json.dumps(text, indent=4) if max_length is None or len(text) <= max_length: return text else: return text[:max_length] + " (...)"
def dedent(text: str) ‑> str
-
Dedents the specified text, removing any leading whitespace and identation.
Expand source code
def dedent(text: str) -> str: """ Dedents the specified text, removing any leading whitespace and identation. """ return textwrap.dedent(text).strip()
def indent_at_current_level(text: str) ‑> str
-
Indents the specified text at the current indentation level, determined dynamically.
Expand source code
def indent_at_current_level(text: str) -> str: """ Indents the specified text at the current indentation level, determined dynamically. """ frame = inspect.currentframe().f_back line = frame.f_lineno filename = frame.f_code.co_filename with open(filename, 'r') as f: lines = f.readlines() current_line = lines[line - 1] indent= len(current_line) - len(current_line.lstrip()) # first dedent the text to remove any leading whitespace text = dedent(text) # then indent it to the specified level return textwrap.indent(text, ' ' * indent)
def inject_html_css_style_prefix(html, style_prefix_attributes)
-
Injects a style prefix to all style attributes in the given HTML string.
For example, if you want to add a style prefix to all style attributes in the HTML string
<div style="color: red;">Hello</div>
, you can use this function as follows: inject_html_css_style_prefix('Hello', 'font-size: 20px;')Expand source code
def inject_html_css_style_prefix(html, style_prefix_attributes): """ Injects a style prefix to all style attributes in the given HTML string. For example, if you want to add a style prefix to all style attributes in the HTML string ``<div style="color: red;">Hello</div>``, you can use this function as follows: inject_html_css_style_prefix('<div style="color: red;">Hello</div>', 'font-size: 20px;') """ return html.replace('style="', f'style="{style_prefix_attributes};')
def pretty_datetime(dt: datetime.datetime) ‑> str
-
Returns a pretty string representation of the specified datetime object.
Expand source code
def pretty_datetime(dt: datetime) -> str: """ Returns a pretty string representation of the specified datetime object. """ return dt.strftime("%Y-%m-%d %H:%M")
def wrap_text(text: str, width: int = 100) ‑> str
-
Wraps the text at the specified width.
Expand source code
def wrap_text(text: str, width: int=100) -> str: """ Wraps the text at the specified width. """ return textwrap.fill(text, width=width)
Classes
class RichTextStyle
-
Expand source code
class RichTextStyle: # Consult color options here: https://rich.readthedocs.io/en/stable/appendix/colors.html STIMULUS_CONVERSATION_STYLE = "bold italic cyan1" STIMULUS_THOUGHT_STYLE = "dim italic cyan1" STIMULUS_DEFAULT_STYLE = "italic" ACTION_DONE_STYLE = "grey82" ACTION_TALK_STYLE = "bold green3" ACTION_THINK_STYLE = "green" ACTION_DEFAULT_STYLE = "purple" INTERVENTION_DEFAULT_STYLE = "bright_magenta" @classmethod def get_style_for(cls, kind:str, event_type:str=None): if kind == "stimulus" or kind=="stimuli": if event_type == "CONVERSATION": return cls.STIMULUS_CONVERSATION_STYLE elif event_type == "THOUGHT": return cls.STIMULUS_THOUGHT_STYLE else: return cls.STIMULUS_DEFAULT_STYLE elif kind == "action": if event_type == "DONE": return cls.ACTION_DONE_STYLE elif event_type == "TALK": return cls.ACTION_TALK_STYLE elif event_type == "THINK": return cls.ACTION_THINK_STYLE else: return cls.ACTION_DEFAULT_STYLE elif kind == "intervention": return cls.INTERVENTION_DEFAULT_STYLE
Class variables
var ACTION_DEFAULT_STYLE
var ACTION_DONE_STYLE
var ACTION_TALK_STYLE
var ACTION_THINK_STYLE
var INTERVENTION_DEFAULT_STYLE
var STIMULUS_CONVERSATION_STYLE
var STIMULUS_DEFAULT_STYLE
var STIMULUS_THOUGHT_STYLE
Static methods
def get_style_for(kind: str, event_type: str = None)
-
Expand source code
@classmethod def get_style_for(cls, kind:str, event_type:str=None): if kind == "stimulus" or kind=="stimuli": if event_type == "CONVERSATION": return cls.STIMULUS_CONVERSATION_STYLE elif event_type == "THOUGHT": return cls.STIMULUS_THOUGHT_STYLE else: return cls.STIMULUS_DEFAULT_STYLE elif kind == "action": if event_type == "DONE": return cls.ACTION_DONE_STYLE elif event_type == "TALK": return cls.ACTION_TALK_STYLE elif event_type == "THINK": return cls.ACTION_THINK_STYLE else: return cls.ACTION_DEFAULT_STYLE elif kind == "intervention": return cls.INTERVENTION_DEFAULT_STYLE