notionary 0.1.25__py3-none-any.whl → 0.1.27__py3-none-any.whl

notionary/elements/table_element.py

@@ -2,7 +2,10 @@ import re
 from typing import Dict, Any, Optional, List, Tuple
 from notionary.elements.notion_block_element import NotionBlockElement
 from notionary.elements.text_inline_formatter import TextInlineFormatter
-from notionary.elements.prompts.element_prompt_content import ElementPromptContent
+from notionary.elements.prompts.element_prompt_content import (
+    ElementPromptBuilder,
+    ElementPromptContent,
+)
 
 
 class TableElement(NotionBlockElement):
@@ -21,8 +24,8 @@ class TableElement(NotionBlockElement):
     ROW_PATTERN = re.compile(r"^\s*\|(.+)\|\s*$")
     SEPARATOR_PATTERN = re.compile(r"^\s*\|([\s\-:|]+)\|\s*$")
 
-    @staticmethod
-    def match_markdown(text: str) -> bool:
+    @classmethod
+    def match_markdown(cls, text: str) -> bool:
         """Check if text contains a markdown table."""
         lines = text.split("\n")
 
@@ -39,13 +42,13 @@ class TableElement(NotionBlockElement):
 
         return False
 
-    @staticmethod
-    def match_notion(block: Dict[str, Any]) -> bool:
+    @classmethod
+    def match_notion(cls, block: Dict[str, Any]) -> bool:
         """Check if block is a Notion table."""
         return block.get("type") == "table"
 
-    @staticmethod
-    def markdown_to_notion(text: str) -> Optional[Dict[str, Any]]:
+    @classmethod
+    def markdown_to_notion(cls, text: str) -> Optional[Dict[str, Any]]:
         """Convert markdown table to Notion table block."""
         if not TableElement.match_markdown(text):
             return None
@@ -76,8 +79,8 @@ class TableElement(NotionBlockElement):
             },
         }
 
-    @staticmethod
-    def notion_to_markdown(block: Dict[str, Any]) -> Optional[str]:
+    @classmethod
+    def notion_to_markdown(cls, block: Dict[str, Any]) -> Optional[str]:
         """Convert Notion table block to markdown table."""
         if block.get("type") != "table":
             return None
@@ -138,13 +141,13 @@ class TableElement(NotionBlockElement):
 
         return "\n".join(table_rows)
 
-    @staticmethod
-    def is_multiline() -> bool:
+    @classmethod
+    def is_multiline(cls) -> bool:
         """Indicates if this element handles content that spans multiple lines."""
         return True
 
-    @staticmethod
-    def _find_table_start(lines: List[str]) -> Optional[int]:
+    @classmethod
+    def _find_table_start(cls, lines: List[str]) -> Optional[int]:
         """Find the start index of a table in the lines."""
         for i in range(len(lines) - 2):
             if (
@@ -155,16 +158,16 @@ class TableElement(NotionBlockElement):
                 return i
         return None
 
-    @staticmethod
-    def _find_table_end(lines: List[str], start_idx: int) -> int:
+    @classmethod
+    def _find_table_end(cls, lines: List[str], start_idx: int) -> int:
         """Find the end index of a table, starting from start_idx."""
         end_idx = start_idx + 3  # Minimum: Header, Separator, one data row
         while end_idx < len(lines) and TableElement.ROW_PATTERN.match(lines[end_idx]):
             end_idx += 1
         return end_idx
 
-    @staticmethod
-    def _extract_table_rows(table_lines: List[str]) -> List[List[str]]:
+    @classmethod
+    def _extract_table_rows(cls, table_lines: List[str]) -> List[List[str]]:
         """Extract row contents from table lines, excluding separator line."""
         rows = []
         for i, line in enumerate(table_lines):
@@ -174,8 +177,8 @@ class TableElement(NotionBlockElement):
                     rows.append(cells)
         return rows
 
-    @staticmethod
-    def _normalize_row_lengths(rows: List[List[str]], column_count: int) -> None:
+    @classmethod
+    def _normalize_row_lengths(cls, rows: List[List[str]], column_count: int) -> None:
         """Normalize row lengths to the specified column count."""
         for row in rows:
             if len(row) < column_count:
@@ -183,8 +186,8 @@ class TableElement(NotionBlockElement):
             elif len(row) > column_count:
                 del row[column_count:]
 
-    @staticmethod
-    def _parse_table_row(row_text: str) -> List[str]:
+    @classmethod
+    def _parse_table_row(cls, row_text: str) -> List[str]:
         """Convert table row text to cell contents."""
         row_content = row_text.strip()
 
@@ -195,8 +198,8 @@ class TableElement(NotionBlockElement):
 
         return [cell.strip() for cell in row_content.split("|")]
 
-    @staticmethod
-    def _create_table_rows(rows: List[List[str]]) -> List[Dict[str, Any]]:
+    @classmethod
+    def _create_table_rows(cls, rows: List[List[str]]) -> List[Dict[str, Any]]:
         """Create Notion table rows from cell contents."""
         table_rows = []
 
@@ -230,8 +233,8 @@ class TableElement(NotionBlockElement):
 
         return table_rows
 
-    @staticmethod
-    def find_matches(text: str) -> List[Tuple[int, int, Dict[str, Any]]]:
+    @classmethod
+    def find_matches(cls, text: str) -> List[Tuple[int, int, Dict[str, Any]]]:
         """
         Find all tables in the text and return their positions.
 
@@ -272,8 +275,8 @@ class TableElement(NotionBlockElement):
 
         return matches
 
-    @staticmethod
-    def _calculate_position(lines: List[str], start: int, end: int) -> int:
+    @classmethod
+    def _calculate_position(cls, lines: List[str], start: int, end: int) -> int:
         """Calculate the text position in characters from line start to end."""
         position = 0
         for i in range(start, end):
@@ -283,12 +286,22 @@ class TableElement(NotionBlockElement):
     @classmethod
     def get_llm_prompt_content(cls) -> ElementPromptContent:
         """Returns information for LLM prompts about this element."""
-        return {
-            "description": "Creates formatted tables with rows and columns for structured data.",
-            "when_to_use": "Use tables to organize and present structured data in a grid format, making information easier to compare and analyze. Tables are ideal for data sets, comparison charts, pricing information, or any content that benefits from columnar organization.",
-            "syntax": "| Header 1 | Header 2 | Header 3 |\n| -------- | -------- | -------- |\n| Cell 1   | Cell 2   | Cell 3   |",
-            "examples": [
-                "| Product | Price | Stock |\n| ------- | ----- | ----- |\n| Widget A | $10.99 | 42 |\n| Widget B | $14.99 | 27 |",
-                "| Name | Role | Department |\n| ---- | ---- | ---------- |\n| John Smith | Manager | Marketing |\n| Jane Doe | Director | Sales |",
-            ],
-        }
+        return (
+            ElementPromptBuilder()
+            .with_description(
+                "Creates formatted tables with rows and columns for structured data."
+            )
+            .with_usage_guidelines(
+                "Use tables to organize and present structured data in a grid format, making information easier to compare and analyze. Tables are ideal for data sets, comparison charts, pricing information, or any content that benefits from columnar organization."
+            )
+            .with_syntax(
+                "| Header 1 | Header 2 | Header 3 |\n| -------- | -------- | -------- |\n| Cell 1   | Cell 2   | Cell 3   |"
+            )
+            .with_examples(
+                [
+                    "| Product | Price | Stock |\n| ------- | ----- | ----- |\n| Widget A | $10.99 | 42 |\n| Widget B | $14.99 | 27 |",
+                    "| Name | Role | Department |\n| ---- | ---- | ---------- |\n| John Smith | Manager | Marketing |\n| Jane Doe | Director | Sales |",
+                ]
+            )
+            .build()
+        )

notionary/elements/text_inline_formatter.py

@@ -1,7 +1,10 @@
 from typing import Dict, Any, List, Tuple
 import re
 
-from notionary.elements.prompts.element_prompt_content import ElementPromptContent
+from notionary.elements.prompts.element_prompt_content import (
+    ElementPromptBuilder,
+    ElementPromptContent,
+)
 
 
 class TextInlineFormatter:
@@ -15,7 +18,6 @@ class TextInlineFormatter:
     - Strikethrough: ~~text~~
     - Code: `text`
     - Links: [text](url)
-    - Highlights: ==text== (default yellow) or ==color:text== (custom color)
     """
 
     # Format patterns for matching Markdown formatting
@@ -214,18 +216,24 @@ class TextInlineFormatter:
         """
         Returns structured LLM prompt metadata for inline formatting.
         """
-        return {
-            "description": "Enables inline formatting like bold, italics, strikethrough, code, links, and underlining for enhanced readability and emphasis.",
-            "when_to_use": (
+        return (
+            ElementPromptBuilder()
+            .with_description(
+                "Enables inline formatting like bold, italics, strikethrough, code, links, and underlining for enhanced readability and emphasis."
+            )
+            .with_usage_guidelines(
                 "Use inline formatting to highlight important words, provide emphasis, show code or paths, or add hyperlinks. "
                 "Helps create a visual hierarchy and improves scanability of long texts."
-            ),
-            "syntax": "**bold**, *italic*, `code`, [text](url)",
-            "examples": [
-                "This is a **bold** word.",
-                "Use *italics* for emphasis.",
-                "Mark outdated content like ~~this~~.",
-                "Write `config.json` to reference a file.",
-                "Visit [Notion](https://notion.so) for more info.",
-            ],
-        }
+            )
+            .with_syntax("**bold**, *italic*, `code`, [text](url)")
+            .with_examples(
+                [
+                    "This is a **bold** word.",
+                    "Use *italics* for emphasis.",
+                    "Mark outdated content like ~~this~~.",
+                    "Write `config.json` to reference a file.",
+                    "Visit [Notion](https://notion.so) for more info.",
+                ]
+            )
+            .build()
+        )

notionary/elements/{todo_lists.py → todo_element.py}

@@ -1,7 +1,10 @@
 import re
 from typing import Dict, Any, Optional
 from notionary.elements.notion_block_element import NotionBlockElement
-from notionary.elements.prompts.element_prompt_content import ElementPromptContent
+from notionary.elements.prompts.element_prompt_content import (
+    ElementPromptBuilder,
+    ElementPromptContent,
+)
 from notionary.elements.text_inline_formatter import TextInlineFormatter
 
 
@@ -20,20 +23,20 @@ class TodoElement(NotionBlockElement):
     TODO_PATTERN = re.compile(r"^\s*[-*+]\s+\[\s?\]\s+(.+)$")
     DONE_PATTERN = re.compile(r"^\s*[-*+]\s+\[x\]\s+(.+)$")
 
-    @staticmethod
-    def match_markdown(text: str) -> bool:
+    @classmethod
+    def match_markdown(cls, text: str) -> bool:
         """Check if text is a markdown todo item."""
         return bool(
             TodoElement.TODO_PATTERN.match(text) or TodoElement.DONE_PATTERN.match(text)
         )
 
-    @staticmethod
-    def match_notion(block: Dict[str, Any]) -> bool:
+    @classmethod
+    def match_notion(cls, block: Dict[str, Any]) -> bool:
         """Check if block is a Notion to_do block."""
         return block.get("type") == "to_do"
 
-    @staticmethod
-    def markdown_to_notion(text: str) -> Optional[Dict[str, Any]]:
+    @classmethod
+    def markdown_to_notion(cls, text: str) -> Optional[Dict[str, Any]]:
         """Convert markdown todo item to Notion to_do block."""
         done_match = TodoElement.DONE_PATTERN.match(text)
         if done_match:
@@ -47,8 +50,8 @@ class TodoElement(NotionBlockElement):
 
         return None
 
-    @staticmethod
-    def notion_to_markdown(block: Dict[str, Any]) -> Optional[str]:
+    @classmethod
+    def notion_to_markdown(cls, block: Dict[str, Any]) -> Optional[str]:
         """Convert Notion to_do block to markdown todo item."""
         if block.get("type") != "to_do":
             return None
@@ -64,8 +67,8 @@ class TodoElement(NotionBlockElement):
         checkbox = "[x]" if checked else "[ ]"
         return f"- {checkbox} {content}"
 
-    @staticmethod
-    def _create_todo_block(content: str, checked: bool) -> Dict[str, Any]:
+    @classmethod
+    def _create_todo_block(cls, content: str, checked: bool) -> Dict[str, Any]:
         """
         Create a Notion to_do block.
 
@@ -85,8 +88,8 @@ class TodoElement(NotionBlockElement):
             },
         }
 
-    @staticmethod
-    def is_multiline() -> bool:
+    @classmethod
+    def is_multiline(cls) -> bool:
         return False
 
     @classmethod
@@ -94,17 +97,23 @@ class TodoElement(NotionBlockElement):
         """
         Returns structured LLM prompt metadata for the todo element.
         """
-        return {
-            "description": "Creates interactive to-do items with checkboxes that can be marked as complete.",
-            "when_to_use": (
+        return (
+            ElementPromptBuilder()
+            .with_description(
+                "Creates interactive to-do items with checkboxes that can be marked as complete."
+            )
+            .with_usage_guidelines(
                 "Use to-do items for task lists, checklists, or tracking progress on items that need to be completed. "
                 "Todo items are interactive in Notion and can be checked/unchecked directly."
-            ),
-            "syntax": "- [ ] Task to complete",
-            "examples": [
-                "- [ ] Draft project proposal",
-                "- [x] Create initial timeline",
-                "* [ ] Review code changes",
-                "+ [x] Finalize handoff checklist",
-            ],
-        }
+            )
+            .with_syntax("- [ ] Task to complete")
+            .with_examples(
+                [
+                    "- [ ] Draft project proposal",
+                    "- [x] Create initial timeline",
+                    "* [ ] Review code changes",
+                    "+ [x] Finalize handoff checklist",
+                ]
+            )
+            .build()
+        )