telegramify-markdown 1.2.0__tar.gz → 1.3.0__tar.gz

{telegramify_markdown-1.2.0 → telegramify_markdown-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: telegramify-markdown
-Version: 1.2.0
+Version: 1.3.0
 Summary: Convert Markdown to Telegram plain text + MessageEntity pairs
 Author-Email: sudoskys <coldlando@hotmail.com>
 License: MIT
@@ -340,7 +340,7 @@ This handles all MarkdownV2 escaping rules correctly (different escaping for nor
 
 ## ⚙️ Configuration
 
-Customize heading symbols, link symbols, expandable citation behavior, and Mermaid rendering:
+Customize heading symbols, link symbols, list markers, expandable citation behavior, and Mermaid rendering:
 
 ```python
 from telegramify_markdown.config import get_runtime_config
@@ -348,6 +348,8 @@ from telegramify_markdown.config import get_runtime_config
 cfg = get_runtime_config()
 cfg.markdown_symbol.heading_level_1 = "📌"
 cfg.markdown_symbol.link = "🔗"
+cfg.markdown_symbol.unordered_list_item = "-"   # default "⦁"; try "•", "*", …
+cfg.markdown_symbol.ordered_list_suffix = "."   # renders "1. item"; ")" gives "1) item"
 cfg.cite_expandable = True  # Long quotes become expandable_blockquote
 cfg.mermaid.width = 1280
 cfg.mermaid.scale = 2
@@ -361,6 +363,31 @@ cfg.mermaid.image_type = "webp"
 # cfg.markdown_symbol.heading_level_4 = ""
 ```
 
+List markers are plain text and carry no entity. Task list items keep using
+`task_completed` / `task_uncompleted` and replace the list marker entirely.
+
+`get_runtime_config()` returns a **process-global** config. Setting it once at
+startup is the common case. It is shared mutable state, so a bot that varies
+symbols per chat must not mutate it inside a handler — concurrent requests would
+read each other's values. Use an independent config instead and pass it in:
+
+```python
+from telegramify_markdown import RenderConfig, telegramify
+
+cfg = RenderConfig.isolated()          # library defaults, independent
+# cfg = get_runtime_config().copy()    # or: start from the current global values
+cfg.markdown_symbol.unordered_list_item = "-"
+
+boxes = await telegramify(markdown, config=cfg)
+```
+
+`config=` is accepted by `convert()`, `convert_with_segments()`, `markdownify()`,
+`standardize()`, and `telegramify()` (which also applies `cfg.mermaid` to
+rendered diagrams). `richify()` and `telegramify_rich()` take no config —
+Rich HTML emits structural tags and reads no symbols.
+
+See [docs/prd/render-config.md](./docs/prd/render-config.md) for the full contract.
+
 `telegramify()` picks up Mermaid settings from the runtime config. The default Mermaid width is `1000`.
 
 ## 📖 API Reference
@@ -509,7 +536,7 @@ Returns the length of a string in UTF-16 code units (what Telegram uses for offs
 ## 🔨 Supported Markdown Features
 
 - [x] Headings (Levels 1-6: H1-H2 bold+underline, H3-H4 bold, H5-H6 italic; H1-H4 with emoji prefix)
-- [x] `**Bold**`, `*Italic*`, `~~Strikethrough~~`
+- [x] `**Bold**`, `*Italic*`, `~~Strikethrough~~` (a single `~`, as in `~5 min`, stays literal)
 - [x] `||Spoiler||`
 - [x] `[Links](url)` and `![Images](url)`
 - [x] Telegram custom emoji `![emoji](tg://emoji?id=...)`

{telegramify_markdown-1.2.0 → telegramify_markdown-1.3.0}/README.md

@@ -320,7 +320,7 @@ This handles all MarkdownV2 escaping rules correctly (different escaping for nor
 
 ## ⚙️ Configuration
 
-Customize heading symbols, link symbols, expandable citation behavior, and Mermaid rendering:
+Customize heading symbols, link symbols, list markers, expandable citation behavior, and Mermaid rendering:
 
 ```python
 from telegramify_markdown.config import get_runtime_config
@@ -328,6 +328,8 @@ from telegramify_markdown.config import get_runtime_config
 cfg = get_runtime_config()
 cfg.markdown_symbol.heading_level_1 = "📌"
 cfg.markdown_symbol.link = "🔗"
+cfg.markdown_symbol.unordered_list_item = "-"   # default "⦁"; try "•", "*", …
+cfg.markdown_symbol.ordered_list_suffix = "."   # renders "1. item"; ")" gives "1) item"
 cfg.cite_expandable = True  # Long quotes become expandable_blockquote
 cfg.mermaid.width = 1280
 cfg.mermaid.scale = 2
@@ -341,6 +343,31 @@ cfg.mermaid.image_type = "webp"
 # cfg.markdown_symbol.heading_level_4 = ""
 ```
 
+List markers are plain text and carry no entity. Task list items keep using
+`task_completed` / `task_uncompleted` and replace the list marker entirely.
+
+`get_runtime_config()` returns a **process-global** config. Setting it once at
+startup is the common case. It is shared mutable state, so a bot that varies
+symbols per chat must not mutate it inside a handler — concurrent requests would
+read each other's values. Use an independent config instead and pass it in:
+
+```python
+from telegramify_markdown import RenderConfig, telegramify
+
+cfg = RenderConfig.isolated()          # library defaults, independent
+# cfg = get_runtime_config().copy()    # or: start from the current global values
+cfg.markdown_symbol.unordered_list_item = "-"
+
+boxes = await telegramify(markdown, config=cfg)
+```
+
+`config=` is accepted by `convert()`, `convert_with_segments()`, `markdownify()`,
+`standardize()`, and `telegramify()` (which also applies `cfg.mermaid` to
+rendered diagrams). `richify()` and `telegramify_rich()` take no config —
+Rich HTML emits structural tags and reads no symbols.
+
+See [docs/prd/render-config.md](./docs/prd/render-config.md) for the full contract.
+
 `telegramify()` picks up Mermaid settings from the runtime config. The default Mermaid width is `1000`.
 
 ## 📖 API Reference
@@ -489,7 +516,7 @@ Returns the length of a string in UTF-16 code units (what Telegram uses for offs
 ## 🔨 Supported Markdown Features
 
 - [x] Headings (Levels 1-6: H1-H2 bold+underline, H3-H4 bold, H5-H6 italic; H1-H4 with emoji prefix)
-- [x] `**Bold**`, `*Italic*`, `~~Strikethrough~~`
+- [x] `**Bold**`, `*Italic*`, `~~Strikethrough~~` (a single `~`, as in `~5 min`, stays literal)
 - [x] `||Spoiler||`
 - [x] `[Links](url)` and `![Images](url)`
 - [x] Telegram custom emoji `![emoji](tg://emoji?id=...)`

{telegramify_markdown-1.2.0 → telegramify_markdown-1.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "telegramify-markdown"
-version = "1.2.0"
+version = "1.3.0"
 description = "Convert Markdown to Telegram plain text + MessageEntity pairs"
 authors = [
     { name = "sudoskys", email = "coldlando@hotmail.com" },

{telegramify_markdown-1.2.0 → telegramify_markdown-1.3.0}/src/telegramify_markdown/__init__.py

@@ -6,6 +6,7 @@ import warnings
 from typing import Union
 
 from telegramify_markdown import config
+from telegramify_markdown.config import RenderConfig
 from telegramify_markdown.converter import convert as convert
 from telegramify_markdown.entity import MessageEntity, split_entities, utf16_len
 from telegramify_markdown.content import ContentType, ContentTypes, ContentTrace, File, Photo, RichMessage, Text
@@ -23,6 +24,7 @@ __all__ = [
     "split_rich",
     "telegramify_rich",
     "config",
+    "RenderConfig",
     "MessageEntity",
     "InputRichMessage",
     "RichMessage",
@@ -43,6 +45,7 @@ def markdownify(
     max_line_length: int | None = None,
     normalize_whitespace: bool = False,
     latex_escape: bool = True,
+    config: RenderConfig | None = None,
 ) -> str:
     """Convert Markdown to a Telegram MarkdownV2 string.
 
@@ -51,6 +54,7 @@ def markdownify(
 
     :param max_line_length: Deprecated (ignored). Kept for 0.x compatibility.
     :param normalize_whitespace: Deprecated (ignored). Kept for 0.x compatibility.
+    :param config: Render configuration. Uses the global config if None.
     """
     if max_line_length is not None:
         warnings.warn(
@@ -66,7 +70,7 @@ def markdownify(
             DeprecationWarning,
             stacklevel=2,
         )
-    return entities_to_markdownv2(*convert(content, latex_escape=latex_escape))
+    return entities_to_markdownv2(*convert(content, latex_escape=latex_escape, config=config))
 
 
 def standardize(
@@ -75,6 +79,7 @@ def standardize(
     max_line_length: int | None = None,
     normalize_whitespace: bool = False,
     latex_escape: bool = True,
+    config: RenderConfig | None = None,
 ) -> str:
     """Alias for :func:`markdownify`, kept for 0.x compatibility."""
     return markdownify(
@@ -82,6 +87,7 @@ def standardize(
         max_line_length=max_line_length,
         normalize_whitespace=normalize_whitespace,
         latex_escape=latex_escape,
+        config=config,
     )
 
 
@@ -95,6 +101,7 @@ async def telegramify(
     latex_escape: bool = True,
     render_mermaid: bool = True,
     min_file_lines: int = 1,
+    config: RenderConfig | None = None,
 ) -> list[Union[Text, File, Photo]]:
     """Convert markdown to Telegram-ready content segments.
 
@@ -110,6 +117,9 @@ async def telegramify(
     :param min_file_lines: Minimum line count for a code block to be extracted
         as a separate file.  Set to ``0`` to disable file extraction entirely
         (all code blocks stay inline as ``pre`` entities).
+    :param config: Render configuration. Uses the global config if None.
+        Pass ``RenderConfig.isolated()`` to keep concurrent requests from
+        sharing symbol settings.
     :return: Ordered list of Text, File, or Photo objects ready for the Telegram Bot API.
     """
     if max_word_count is not None:
@@ -119,6 +129,7 @@ async def telegramify(
             DeprecationWarning,
             stacklevel=2,
         )
+        max_message_length = max_word_count
     if max_line_length is not None:
         warnings.warn(
             "max_line_length is deprecated and ignored in 1.x. "
@@ -133,7 +144,6 @@ async def telegramify(
             DeprecationWarning,
             stacklevel=2,
         )
-        max_message_length = max_word_count
 
     from telegramify_markdown.pipeline import process_markdown
 
@@ -143,4 +153,5 @@ async def telegramify(
         latex_escape=latex_escape,
         render_mermaid=render_mermaid,
         min_file_lines=min_file_lines,
+        config=config,
     )

telegramify_markdown-1.3.0/src/telegramify_markdown/config.py

@@ -0,0 +1,105 @@
+"""Render configuration.
+
+``get_runtime_config()`` returns the process-global config; setting it once at
+startup is the common case. When rendering must vary per session or per thread,
+take an independent config with ``RenderConfig.isolated()`` and pass it to
+``convert(config=...)`` / ``telegramify(config=...)`` / ``markdownify(config=...)``.
+
+The global instance is shared mutable state: writing to it inside a handler is
+visible to every concurrent conversion that does not carry its own config.
+pyTelegramBotAPI runs handlers on multiple threads by default, and on the
+asyncio side "mutate global -> await -> render" always yields control in
+between. Per-request configuration requires isolated().
+"""
+
+from __future__ import annotations
+
+import copy
+
+
+class Symbol:
+    def __init__(self):
+        self.heading_level_1: str = "\N{PUSHPIN}"                   # 📌
+        self.heading_level_2: str = "\N{PENCIL}"                    # ✏️
+        self.heading_level_3: str = "\N{BOOKS}"                     # 📚
+        self.heading_level_4: str = "\N{BOOKMARK}"                  # 🔖
+        self.heading_level_5: str = ""
+        self.heading_level_6: str = ""
+        self.image: str = "\N{FRAME WITH PICTURE}"               # 🖼
+        self.link: str = "\N{LINK SYMBOL}"                       # 🔗
+        self.task_completed: str = "\N{WHITE HEAVY CHECK MARK}"  # ✅
+        self.task_uncompleted: str = "\N{BALLOT BOX WITH CHECK}" # ☑️
+        self.horizontal_rule: str = "————————"
+        # List markers: written after the indent, before the item text.
+        # Always plain text, never covered by an entity.
+        # @see https://github.com/sudoskys/telegramify-markdown/issues/116
+        self.unordered_list_item: str = "\N{Z NOTATION SPOT}"    # ⦁
+        self.ordered_list_suffix: str = "."
+
+
+class Mermaid:
+    def __init__(self):
+        self.theme: str = "default"
+        self.width: int = 1000
+        self.scale: int = 2
+        self.image_type: str = "webp"
+
+
+class RenderConfig:
+    """Render configuration.
+
+    Bare construction returns the global instance, equivalent to
+    ``get_runtime_config()`` and matching 1.x behaviour. For configs that do not
+    affect each other, use :meth:`isolated`.
+    """
+
+    _global: RenderConfig  # created at import, below the class
+    _markdown_symbol: Symbol
+    _mermaid: Mermaid
+    _cite_expandable: bool
+
+    # No __init__ on purpose: repeated construction must not reset settings
+    # that have already been applied to the global instance.
+    def __new__(cls) -> RenderConfig:
+        return cls._global
+
+    def __reduce__(self) -> tuple:
+        # copy and pickle would otherwise rebuild through __new__, i.e. the global
+        return type(self).isolated, (), self.__dict__
+
+    @classmethod
+    def isolated(cls) -> RenderConfig:
+        """Build an independent config, sharing nothing with the global one."""
+        instance = super().__new__(cls)
+        instance._markdown_symbol = Symbol()
+        instance._mermaid = Mermaid()
+        instance._cite_expandable = True
+        return instance
+
+    def copy(self) -> RenderConfig:
+        """Copy this config into an independent one, symbol tables included."""
+        return copy.deepcopy(self)
+
+    @property
+    def markdown_symbol(self) -> Symbol:
+        return self._markdown_symbol
+
+    @property
+    def mermaid(self) -> Mermaid:
+        return self._mermaid
+
+    @property
+    def cite_expandable(self) -> bool:
+        return self._cite_expandable
+
+    @cite_expandable.setter
+    def cite_expandable(self, value: bool):
+        self._cite_expandable = value
+
+
+RenderConfig._global = RenderConfig.isolated()
+
+
+# Global accessor function for accessing the RenderConfig singleton
+def get_runtime_config() -> RenderConfig:
+    return RenderConfig()