Automated sync from GitHub

bot/app.py

@@ -489,7 +489,7 @@ class App:
         await self._reply(
             event,
             f"<b>Current template:</b>\n<code>{esc(s['template'])}</code>\n\n{preview_template(s['template'])}\n\n"
-            "Variables: <code>{title} {season} {episode} {quality} {year} {codec} {filename} {ext}</code>\n"
+            f"Variables: {panels.TEMPLATE_VARIABLES}\n"
             "A [bracket] group is dropped when a variable inside it is empty.\n\n"
             "Change it: <code>/template [S{season}E{episode}] {title} [{quality}]</code>",
         )
@@ -505,7 +505,7 @@ class App:
         await self._reply(
             event,
             f"<b>Current caption template:</b>\n<code>{esc(s['caption'])}</code>\n\n"
-            "Variables: <code>{filename} {original} {title} {season} {episode} {quality} {year} {codec} {size} {duration}</code>\n"
+            f"Variables: {panels.CAPTION_VARIABLES}\n"
             "Change it: <code>/caption &lt;b&gt;{filename}&lt;/b&gt;</code> · restore: <code>/caption reset</code>",
         )
 

bot/panels.py

@@ -9,13 +9,18 @@ from __future__ import annotations
 from typing import Any, Dict, Iterable, List, Sequence, Tuple
 
 from .media import LANGUAGES, canonical_lang
-from .utils import clip, esc
+from .parser import CAPTION_VARS, TEMPLATE_VARS
+from .utils import clip, code_each, esc
 
 Row = List[Tuple[str, str]]
 Panel = Tuple[str, List[Row]]
 
 DOT = "◈"
 
+# The variable lists shown in the panels and prompts: every variable is its own <code> block, so tapping one copies only it.
+TEMPLATE_VARIABLES = code_each("{%s}" % name for name in TEMPLATE_VARS)
+CAPTION_VARIABLES = code_each("{%s}" % name for name in CAPTION_VARS if name != "ext")  # {ext} was never listed for captions
+
 
 def to_buttons(rows: Sequence[Row]):
     from telethon.tl.custom import Button
@@ -96,7 +101,7 @@ def caption(s: Dict[str, Any], has_thumb: bool) -> Panel:
     text = (
         "<b>CAPTION &amp; THUMBNAIL</b>\n\n"
         f"<b>Caption template:</b> {_code(s['caption'], 160)}\n"
-        "Variables: <code>{filename} {original} {title} {season} {episode} {quality} {year} {codec} {size} {duration}</code>\n"
+        f"Variables: {CAPTION_VARIABLES}\n"
         "Telegram HTML works, e.g. <code>&lt;b&gt;{filename}&lt;/b&gt;</code>\n\n"
         f"<b>Thumbnail:</b> {'✅ saved' if has_thumb else '❌ none (a frame of the video is used)'}\n"
         "Send me a photo to set your thumbnail."
@@ -193,7 +198,7 @@ def help_panel() -> Panel:
         "8. /sequence then /sort — put files in episode order.\n"
         "9. /check, /mediainfo, /ethumb, /resize, /speed — inspect files and images.\n"
         "10. /queue and /cancel — manage running jobs.\n\n"
-        "Template variables: <code>{title} {season} {episode} {quality} {year} {codec} {filename} {ext}</code>\n"
+        f"Template variables: {TEMPLATE_VARIABLES}\n"
         "A [bracket] group is dropped when a variable inside it is empty."
     )
     return text, nav("home")
@@ -427,14 +432,14 @@ def sequence_status(count: int, limit: int) -> Panel:
 PROMPTS: Dict[str, str] = {
     "template": (
         "<b>Send the new filename template.</b>\n\n"
-        "Variables: <code>{title} {season} {episode} {quality} {year} {codec} {filename} {ext}</code>\n"
+        f"Variables: {TEMPLATE_VARIABLES}\n"
         "A [bracket] or (paren) group disappears when a variable inside it is empty.\n"
         "If only an episode number is found, the season defaults to 01.\n\n"
         "Example: <code>[S{season}E{episode}] {title} [{quality}]</code>"
     ),
     "caption": (
         "<b>Send the new caption template.</b>\n\n"
-        "Variables: <code>{filename} {original} {title} {season} {episode} {quality} {year} {codec} {size} {duration}</code>\n"
+        f"Variables: {CAPTION_VARIABLES}\n"
         "Telegram HTML works (<code>&lt;b&gt;</code>, <code>&lt;i&gt;</code>, <code>&lt;code&gt;</code>)."
     ),
     "remove": (

bot/utils.py

@@ -2,12 +2,19 @@
 from __future__ import annotations
 
 import html
+from typing import Iterable
 
 
 def esc(value: object) -> str:
     return html.escape(str(value), quote=False)
 
 
+def code_each(items: Iterable[object]) -> str:
+    """``<code>a</code> <code>b</code>``: one block per item.  Telegram copies a whole ``<code>`` block when it is tapped,
+    so a list inside a single block can't be copied item by item."""
+    return " ".join(f"<code>{esc(item)}</code>" for item in items)
+
+
 def human_size(num: float) -> str:
     num = float(num)
     for unit in ("B", "KB", "MB", "GB", "TB"):

tests/test_app.py

@@ -17,7 +17,7 @@ from bot.queue import JobQueue
 from .conftest import needs_ffmpeg
 from .appkit import ADMIN_CFG, ADMIN_DB, EPISODE, EPISODE_NEW, LOG, OWNER, STRANGER, click, data_of, env_for, jpeg, prefs, say, send_doc
 from .tgfakes import (
-    FakeCallback, FakeClient, FakeEvent, FakeMessage, dispatch, document_message, flat_buttons, make_file,
+    FakeCallback, FakeClient, FakeEvent, FakeMessage, dispatch, document_message, flat_buttons, make_file, variables_line,
 )
 
 # ---------------------------------------------------------------------------
@@ -180,6 +180,13 @@ async def test_template_caption_and_removewords_commands(ctx):
     assert (await prefs(ctx))["remove_words"] == []
 
 
+async def test_template_and_caption_commands_list_each_variable_as_its_own_copyable_block(ctx):
+    line, blocks = variables_line((await say(ctx, OWNER, "/template")).texts[0])
+    assert blocks == line.split(": ", 1)[1].split() and "{quality}" in blocks and len(blocks) == 8
+    line, blocks = variables_line((await say(ctx, OWNER, "/caption")).texts[0])
+    assert blocks == line.split(": ", 1)[1].split() and "{size}" in blocks and len(blocks) == 10
+
+
 async def test_settings_are_per_user(ctx):
     await say(ctx, OWNER, "/mode caption")
     await say(ctx, ADMIN_CFG, "/filetype audio")

tests/test_panels.py

@@ -8,10 +8,13 @@ from bot import panels
 from bot.app import BACK, PANEL_NAMES
 from bot.db import DEFAULT_SETTINGS
 from bot.media import LANGUAGES
+from bot.utils import code_each
 
-from .tgfakes import button_rows
+from .tgfakes import button_rows, variables_line
 
 CAPTION_LIMIT = 1000  # Telegram allows 1024 for a caption; keep a margin
+TEMPLATE_LIST = "{title} {season} {episode} {quality} {year} {codec} {filename} {ext}"
+CAPTION_LIST = "{filename} {original} {title} {season} {episode} {quality} {year} {codec} {size} {duration}"
 
 
 def visible(text: str) -> str:
@@ -76,6 +79,25 @@ def test_every_panel_html_is_balanced():
             assert text.count(f"<{tag}>") == text.count(f"</{tag}>"), (name, tag)
 
 
+@pytest.mark.parametrize("name, text, shown", [
+    ("template prompt", panels.PROMPTS["template"], TEMPLATE_LIST),
+    ("caption prompt", panels.PROMPTS["caption"], CAPTION_LIST),
+    ("help panel", panels.help_panel()[0], TEMPLATE_LIST),
+    ("caption panel", panels.caption(settings(), True)[0], CAPTION_LIST),
+])
+def test_every_variable_is_its_own_tap_to_copy_block(name, text, shown):
+    # Tapping a <code> block in Telegram copies all of it, so "{quality}" must not share a block with the other variables.
+    line, blocks = variables_line(text)
+    assert line.split(": ", 1)[1] == shown, name  # the list reads the same as it always did
+    assert blocks == shown.split(), name  # ...with one block per variable
+    assert "<code>{quality}</code>" in text, name
+
+
+def test_code_each_makes_one_escaped_block_per_item():
+    assert code_each(["{a}", "<b>", 3]) == "<code>{a}</code> <code>&lt;b&gt;</code> <code>3</code>"
+    assert code_each([]) == ""
+
+
 def test_every_input_button_has_a_prompt_and_a_back_target():
     assert set(panels.PROMPTS) == set(BACK)
     assert set(BACK.values()) <= PANEL_NAMES

tests/tgfakes.py

@@ -7,10 +7,14 @@ the real event builders, patterns and ``func`` filters are exercised too.
 from __future__ import annotations
 
 import inspect
+import re
 from types import SimpleNamespace
-from typing import Any, List, Optional
+from typing import Any, List, Optional, Tuple
 
 from telethon import events
+from telethon.extensions import html as telegram_html
+from telethon.helpers import add_surrogate, del_surrogate
+from telethon.tl.types import MessageEntityCode
 
 
 def make_file(name: Optional[str] = "Movie.mkv", size: int = 5 * 1024 * 1024, mime: str = "video/x-matroska",
@@ -218,3 +222,18 @@ def button_rows(buttons: Any) -> List[List[tuple]]:
 
 def flat_buttons(buttons: Any) -> List[tuple]:
     return [b for row in button_rows(buttons) for b in row]
+
+
+def variables_line(html_text: str) -> Tuple[str, List[str]]:
+    """The "Variables: …" line of a message as Telegram receives it (parsed by Telethon's own HTML parser): its text, and
+    the ``<code>`` blocks on it.  Tapping a block copies exactly its text, so these are the things a user can copy."""
+    plain, entities = telegram_html.parse(html_text)
+    units, start = add_surrogate(plain), 0  # entity offsets count UTF-16 units
+    for line in units.split("\n"):
+        end = start + len(line)
+        if re.match(r"(?:Template v|V)ariables: ", line):
+            blocks = [del_surrogate(units[e.offset:e.offset + e.length]) for e in entities
+                      if isinstance(e, MessageEntityCode) and start <= e.offset < end]
+            return del_surrogate(line), blocks
+        start = end + 1
+    raise AssertionError("no Variables line in: " + plain)