text and markdown formats

.pre-commit-config.yaml

@@ -19,7 +19,7 @@ repos:
     rev: "v3.0.0"
     hooks:
       - id: prettier
-        exclude: \.html$|^docs/
+        exclude: \.html$|^docs/|^tests/unit/messages/formats/markdown/fixtures/
 
   - repo: https://github.com/crate-ci/typos
     rev: v1.16.6

elementary/.prettierignore

@@ -0,0 +1 @@
+tests/unit/messages/formats/markdown/fixtures/*

elementary/messages/blocks.py

@@ -113,7 +113,7 @@ class ActionsBlock(BaseBlock):
     "LineBlock",
 ]
 
-LineBlock.update_forward_refs()
+LineBlock.model_rebuild()
 
 
 class HeaderBlock(BaseBlock):
@@ -184,4 +184,4 @@ class ExpandableBlock(BaseBlock):
 ]
 
 # Update forward references for recursive types
-ExpandableBlock.update_forward_refs()
+ExpandableBlock.model_rebuild()

elementary/messages/formats/adaptive_cards.py

@@ -21,7 +21,7 @@
     TextStyle,
     WhitespaceBlock,
 )
-from elementary.messages.formats.html import ICON_TO_HTML
+from elementary.messages.formats.unicode import ICON_TO_UNICODE
 from elementary.messages.message_body import Color, MessageBlock, MessageBody
 
 COLOR_TO_STYLE = {
@@ -32,7 +32,7 @@
 
 
 def format_icon(icon: Icon) -> str:
-    return ICON_TO_HTML[icon]
+    return ICON_TO_UNICODE[icon]
 
 
 def format_text_block(block: TextBlock) -> str:

elementary/messages/formats/block_kit.py

@@ -29,7 +29,7 @@
     UserSelectActionBlock,
     WhitespaceBlock,
 )
-from elementary.messages.formats.html import ICON_TO_HTML
+from elementary.messages.formats.unicode import ICON_TO_UNICODE
 from elementary.messages.message_body import Color, MessageBlock, MessageBody
 
 COLOR_MAP = {
@@ -61,7 +61,7 @@ def __init__(
         self._resolve_mention = resolve_mention or (lambda x: None)
 
     def _format_icon(self, icon: Icon) -> str:
-        return ICON_TO_HTML[icon]
+        return ICON_TO_UNICODE[icon]
 
     def _format_text_block(self, block: TextBlock) -> str:
         if block.style == TextStyle.BOLD:

elementary/messages/formats/markdown.py

@@ -0,0 +1,148 @@
+import json
+import re
+from enum import Enum
+
+from tabulate import tabulate
+
+from elementary.messages.blocks import (
+    ActionsBlock,
+    CodeBlock,
+    DividerBlock,
+    ExpandableBlock,
+    FactListBlock,
+    HeaderBlock,
+    Icon,
+    IconBlock,
+    InlineBlock,
+    InlineCodeBlock,
+    LineBlock,
+    LinesBlock,
+    LinkBlock,
+    MentionBlock,
+    TableBlock,
+    TextBlock,
+    TextStyle,
+    WhitespaceBlock,
+)
+from elementary.messages.formats.unicode import ICON_TO_UNICODE
+from elementary.messages.message_body import MessageBlock, MessageBody
+
+
+class TableStyle(Enum):
+    TABULATE = "tabulate"
+    JSON = "json"
+
+
+class MarkdownFormatter:
+    def __init__(self, table_style: TableStyle):
+        self._table_style = table_style
+
+    def format_icon(self, icon: Icon) -> str:
+        return ICON_TO_UNICODE[icon]
+
+    def format_text_block(self, block: TextBlock) -> str:
+        if block.style == TextStyle.BOLD:
+            return f"**{block.text}**"
+        elif block.style == TextStyle.ITALIC:
+            return f"_{block.text}_"
+        else:
+            return block.text
+
+    def format_inline_block(self, block: InlineBlock) -> str:
+        if isinstance(block, IconBlock):
+            return self.format_icon(block.icon)
+        elif isinstance(block, TextBlock):
+            return self.format_text_block(block)
+        elif isinstance(block, LinkBlock):
+            return f"[{block.text}]({block.url})"
+        elif isinstance(block, InlineCodeBlock):
+            return f"`{block.code}`"
+        elif isinstance(block, MentionBlock):
+            return block.user
+        elif isinstance(block, LineBlock):
+            return self.format_line_block(block)
+        elif isinstance(block, WhitespaceBlock):
+            return " "
+        else:
+            raise ValueError(f"Unsupported inline block type: {type(block)}")
+
+    def format_line_block(self, block: LineBlock) -> str:
+        return block.sep.join(
+            [self.format_inline_block(inline) for inline in block.inlines]
+        )
+
+    def format_lines_block(self, block: LinesBlock) -> str:
+        formatted_parts = []
+        for index, line_block in enumerate(block.lines):
+            formatted_line = self.format_line_block(line_block)
+            formatted_parts.append(formatted_line)
+            is_bullet = re.match(r"^\s*[*-]", formatted_line)
+            is_last = index == len(block.lines) - 1
+            if not is_bullet and not is_last:
+                # in markdown, single line breaks are not rendered as new lines, except for bullet lists
+                # so we need to add a backslash to force a new line
+                formatted_parts.append("\\")
+            if not is_last:
+                formatted_parts.append("\n")
+        return "".join(formatted_parts)
+
+    def format_fact_list_block(self, block: FactListBlock) -> str:
+        facts = [
+            f"{self.format_line_block(fact.title)}: {self.format_line_block(fact.value)}"
+            for fact in block.facts
+        ]
+        return " | ".join(facts)
+
+    def format_table_block(self, block: TableBlock) -> str:
+        if self._table_style == TableStyle.TABULATE:
+            table = tabulate(block.rows, headers=block.headers, tablefmt="simple")
+            return f"```\n{table}\n```"
+        elif self._table_style == TableStyle.JSON:
+            dicts = [
+                {header: cell for header, cell in zip(block.headers, row)}
+                for row in block.rows
+            ]
+            return f"```\n{json.dumps(dicts, indent=2)}\n```"
+        else:
+            raise ValueError(f"Invalid table style: {self._table_style}")
+
+    def format_expandable_block(self, block: ExpandableBlock) -> str:
+        body = self.format_message_blocks(block.body)
+        quoted_body = "\n> ".join(body.split("\n"))
+        return f"> **{block.title}**\\\n> {quoted_body}"
+
+    def format_message_block(self, block: MessageBlock) -> str:
+        if isinstance(block, HeaderBlock):
+            return f"# {block.text}"
+        elif isinstance(block, CodeBlock):
+            return f"```\n{block.text}\n```"
+        elif isinstance(block, LinesBlock):
+            return self.format_lines_block(block)
+        elif isinstance(block, FactListBlock):
+            return self.format_fact_list_block(block)
+        elif isinstance(block, ExpandableBlock):
+            return self.format_expandable_block(block)
+        elif isinstance(block, TableBlock):
+            return self.format_table_block(block)
+        elif isinstance(block, DividerBlock):
+            return "---"
+        elif isinstance(block, ActionsBlock):
+            # Actions not supported for text
+            return ""
+        else:
+            raise ValueError(f"Unsupported message block type: {type(block)}")
+
+    def format_message_blocks(self, blocks: list[MessageBlock]) -> str:
+        if not blocks:
+            return ""
+        return "\n\n".join([self.format_message_block(block) for block in blocks])
+
+    def format(self, message: MessageBody) -> str:
+        return self.format_message_blocks(message.blocks)
+
+
+def format_markdown(
+    message: MessageBody, table_style: TableStyle = TableStyle.TABULATE
+) -> str:
+    formatter = MarkdownFormatter(table_style)
+    return formatter.format(message)

elementary/messages/formats/text.py

@@ -0,0 +1,140 @@
+import json
+from enum import Enum
+from typing import List
+
+from tabulate import tabulate
+
+from elementary.messages.blocks import (
+    ActionsBlock,
+    CodeBlock,
+    DividerBlock,
+    ExpandableBlock,
+    FactListBlock,
+    HeaderBlock,
+    Icon,
+    IconBlock,
+    InlineBlock,
+    InlineCodeBlock,
+    LineBlock,
+    LinesBlock,
+    LinkBlock,
+    MentionBlock,
+    TableBlock,
+    TextBlock,
+    WhitespaceBlock,
+)
+from elementary.messages.formats.unicode import ICON_TO_UNICODE
+from elementary.messages.message_body import MessageBlock, MessageBody
+
+
+class IconStyle(Enum):
+    UNICODE = "unicode"
+    NAME = "name"
+    OMIT = "omit"
+
+
+class TableStyle(Enum):
+    TABULATE = "tabulate"
+    JSON = "json"
+
+
+class TextFormatter:
+    def __init__(self, icon_style: IconStyle, table_style: TableStyle):
+        self._icon_style = icon_style
+        self._table_style = table_style
+
+    def format_icon(self, icon: Icon) -> str:
+        if self._icon_style == IconStyle.OMIT:
+            return ""
+        elif self._icon_style == IconStyle.UNICODE:
+            return ICON_TO_UNICODE[icon]
+        elif self._icon_style == IconStyle.NAME:
+            return f":{icon.value}:"
+        else:
+            raise ValueError(f"Invalid icon style: {self._icon_style}")
+
+    def format_inline_block(self, block: InlineBlock) -> str:
+        if isinstance(block, IconBlock):
+            return self.format_icon(block.icon)
+        elif isinstance(block, TextBlock):
+            return block.text
+        elif isinstance(block, LinkBlock):
+            return f"{block.text} ({block.url})"
+        elif isinstance(block, InlineCodeBlock):
+            return block.code
+        elif isinstance(block, MentionBlock):
+            return block.user
+        elif isinstance(block, LineBlock):
+            return self.format_line_block(block)
+        elif isinstance(block, WhitespaceBlock):
+            return " "
+        else:
+            raise ValueError(f"Unsupported inline block type: {type(block)}")
+
+    def format_line_block(self, block: LineBlock) -> str:
+        return block.sep.join(
+            [self.format_inline_block(inline) for inline in block.inlines]
+        )
+
+    def format_lines_block(self, block: LinesBlock) -> str:
+        return "\n".join(
+            [self.format_line_block(line_block) for line_block in block.lines]
+        )
+
+    def format_fact_list_block(self, block: FactListBlock) -> str:
+        facts = [
+            f"{self.format_line_block(fact.title)}: {self.format_line_block(fact.value)}"
+            for fact in block.facts
+        ]
+        return " | ".join(facts)
+
+    def format_table_block(self, block: TableBlock) -> str:
+        if self._table_style == TableStyle.TABULATE:
+            return tabulate(block.rows, headers=block.headers, tablefmt="simple")
+        elif self._table_style == TableStyle.JSON:
+            dicts = [
+                {header: cell for header, cell in zip(block.headers, row)}
+                for row in block.rows
+            ]
+            return json.dumps(dicts, indent=2)
+        else:
+            raise ValueError(f"Invalid table style: {self._table_style}")
+
+    def format_expandable_block(self, block: ExpandableBlock) -> str:
+        return f"{block.title}\n{self.format_message_blocks(block.body)}"
+
+    def format_message_block(self, block: MessageBlock) -> str:
+        if isinstance(block, (HeaderBlock, CodeBlock)):
+            return block.text
+        elif isinstance(block, LinesBlock):
+            return self.format_lines_block(block)
+        elif isinstance(block, FactListBlock):
+            return self.format_fact_list_block(block)
+        elif isinstance(block, ExpandableBlock):
+            return self.format_expandable_block(block)
+        elif isinstance(block, TableBlock):
+            return self.format_table_block(block)
+        elif isinstance(block, ActionsBlock):
+            # Actions not supported for text
+            return ""
+        elif isinstance(block, DividerBlock):
+            return "--------------------------------"
+        else:
+            raise ValueError(f"Unsupported message block type: {type(block)}")
+
+    def format_message_blocks(self, blocks: List[MessageBlock]) -> str:
+        if not blocks:
+            return ""
+        return "\n".join([self.format_message_block(block) for block in blocks])
+
+    def format(self, message: MessageBody) -> str:
+        return self.format_message_blocks(message.blocks)
+
+
+def format_text(
+    message: MessageBody,
+    icon_style: IconStyle = IconStyle.UNICODE,
+    table_style: TableStyle = TableStyle.TABULATE,
+) -> str:
+    formatter = TextFormatter(icon_style, table_style)
+    return formatter.format(message)

elementary/messages/formats/html.py → elementary/messages/formats/unicode.py

@@ -1,6 +1,6 @@
 from elementary.messages.blocks import Icon
 
-ICON_TO_HTML = {
+ICON_TO_UNICODE = {
     Icon.RED_TRIANGLE: "🔺",
     Icon.X: "❌",
     Icon.WARNING: "⚠️",
@@ -18,5 +18,5 @@
 }
 
 for icon in Icon:
-    if icon not in ICON_TO_HTML:
-        raise RuntimeError(f"No HTML representation for icon {icon}")
+    if icon not in ICON_TO_UNICODE:
+        raise RuntimeError(f"No unicode representation for icon {icon}")

elementary/messages/message_body.py

@@ -39,4 +39,4 @@ class MessageBody(BaseModel):
     id: Optional[str] = None
 
 
-MessageBody.update_forward_refs()
+MessageBody.model_rebuild()