telegrinder 1.0.0rc1__py3-none-any.whl

telegrinder/tools/__init__.py

@@ -0,0 +1,183 @@
+from telegrinder.tools.aio import (
+    TaskGroup,
+    cancel_future,
+    get_tasks_results,
+    maybe_awaitable,
+    next_generator,
+    run_task,
+    send_generator_value,
+    stop_generator,
+)
+from telegrinder.tools.formatting import (
+    HTML,
+    blockquote,
+    bold,
+    code_inline,
+    escape,
+    italic,
+    link,
+    mention,
+    monospace,
+    pre_code,
+    spoiler,
+    strike,
+    tg_bot_attach_open_any_chat,
+    tg_bot_attach_open_current_chat,
+    tg_bot_attach_open_specific_chat,
+    tg_bot_start_link,
+    tg_bot_startchannel_link,
+    tg_bot_startgroup_link,
+    tg_chat_folder_link,
+    tg_chat_invite_link,
+    tg_direct_mini_app_link,
+    tg_emoji,
+    tg_emoji_link,
+    tg_emoji_stickerset_link,
+    tg_invoice_link,
+    tg_language_pack_link,
+    tg_main_mini_app_link,
+    tg_mention_link,
+    tg_open_message_link,
+    tg_premium_multigift_link,
+    tg_premium_offer_link,
+    tg_private_channel_boost_link,
+    tg_private_message_link,
+    tg_public_channel_boost_link,
+    tg_public_message_link,
+    tg_public_username_link,
+    tg_share_link,
+    tg_story_link,
+    underline,
+)
+from telegrinder.tools.fullname import fullname
+from telegrinder.tools.global_context import (
+    ABCGlobalContext,
+    CtxVar,
+    GlobalContext,
+    GlobalCtxVar,
+    TelegrinderContext,
+    ctx_var,
+    runtime_init,
+)
+from telegrinder.tools.input_file_directory import InputFileDirectory
+from telegrinder.tools.keyboard import ABCKeyboard, Button, InlineButton, InlineKeyboard, Keyboard, RowButtons
+from telegrinder.tools.lifespan import Lifespan
+from telegrinder.tools.limited_dict import LimitedDict
+from telegrinder.tools.loop_wrapper import DelayedTask, LoopWrapper
+from telegrinder.tools.magic import (
+    Annotations,
+    Bundle,
+    additional_property,
+    bundle,
+    get_default_args,
+    get_func_annotations,
+    get_func_parameters,
+    get_generic_parameters,
+    resolve_arg_names,
+    resolve_kwonly_arg_names,
+    resolve_posonly_arg_names,
+    shortcut,
+)
+from telegrinder.tools.parse_mode import ParseMode
+from telegrinder.tools.serialization import (
+    ABCDataSerializer,
+    JSONSerializer,
+    MsgPackSerializer,
+)
+from telegrinder.tools.singleton import ABCSingleton, ABCSingletonMeta, Singleton, SingletonMeta
+from telegrinder.tools.state_storage import ABCStateStorage, MemoryStateStorage, StateData
+from telegrinder.tools.strings import to_utf16_map, utf16_to_py_index
+
+__all__ = (
+    "HTML",
+    "ABCDataSerializer",
+    "ABCGlobalContext",
+    "ABCKeyboard",
+    "ABCSingleton",
+    "ABCSingletonMeta",
+    "ABCStateStorage",
+    "Annotations",
+    "Bundle",
+    "Button",
+    "CtxVar",
+    "DelayedTask",
+    "GlobalContext",
+    "GlobalCtxVar",
+    "InlineButton",
+    "InlineKeyboard",
+    "InputFileDirectory",
+    "JSONSerializer",
+    "Keyboard",
+    "Lifespan",
+    "LimitedDict",
+    "LoopWrapper",
+    "MemoryStateStorage",
+    "MsgPackSerializer",
+    "ParseMode",
+    "RowButtons",
+    "Singleton",
+    "SingletonMeta",
+    "StateData",
+    "TaskGroup",
+    "TelegrinderContext",
+    "additional_property",
+    "blockquote",
+    "bold",
+    "bundle",
+    "cancel_future",
+    "code_inline",
+    "ctx_var",
+    "escape",
+    "fullname",
+    "get_default_args",
+    "get_func_annotations",
+    "get_func_parameters",
+    "get_generic_parameters",
+    "get_tasks_results",
+    "italic",
+    "link",
+    "maybe_awaitable",
+    "mention",
+    "monospace",
+    "next_generator",
+    "pre_code",
+    "resolve_arg_names",
+    "resolve_kwonly_arg_names",
+    "resolve_posonly_arg_names",
+    "run_task",
+    "runtime_init",
+    "send_generator_value",
+    "shortcut",
+    "spoiler",
+    "stop_generator",
+    "strike",
+    "tg_bot_attach_open_any_chat",
+    "tg_bot_attach_open_current_chat",
+    "tg_bot_attach_open_specific_chat",
+    "tg_bot_start_link",
+    "tg_bot_startchannel_link",
+    "tg_bot_startgroup_link",
+    "tg_chat_folder_link",
+    "tg_chat_invite_link",
+    "tg_direct_mini_app_link",
+    "tg_emoji",
+    "tg_emoji_link",
+    "tg_emoji_stickerset_link",
+    "tg_invoice_link",
+    "tg_language_pack_link",
+    "tg_main_mini_app_link",
+    "tg_mention_link",
+    "tg_open_message_link",
+    "tg_premium_multigift_link",
+    "tg_premium_offer_link",
+    "tg_private_channel_boost_link",
+    "tg_private_message_link",
+    "tg_public_channel_boost_link",
+    "tg_public_message_link",
+    "tg_public_username_link",
+    "tg_share_link",
+    "tg_story_link",
+    "to_utf16_map",
+    "underline",
+    "utf16_to_py_index",
+)

telegrinder/tools/aio.py

@@ -0,0 +1,147 @@
+import asyncio
+import typing
+from contextlib import suppress
+from inspect import isasyncgen, isawaitable
+
+if typing.TYPE_CHECKING:
+    from contextvars import Context
+
+type Generator[Yield, Send, Return] = typing.AsyncGenerator[Yield, Send] | typing.Generator[Yield, Send, Return]
+
+
+def loop_is_running() -> bool:
+    with suppress(RuntimeError):
+        asyncio.get_running_loop()
+        return True
+
+    return False
+
+
+def get_tasks_results[T](tasks: set[asyncio.Task[T]], /) -> tuple[T, ...]:
+    return tuple(task.result() for task in tasks if not task.cancelled() and not task.exception())
+
+
+def run_task[T](
+    task: typing.Awaitable[T],
+    /,
+    *,
+    loop: asyncio.AbstractEventLoop | None = None,
+) -> T:
+    loop = loop or asyncio.get_event_loop()
+    return loop.run_until_complete(future=task)
+
+
+async def next_generator[T](generator: Generator[T, typing.Any, typing.Any], /) -> T:
+    return await send_generator_value(generator, None)
+
+
+async def send_generator_value[Yield, Send](
+    generator: Generator[Yield, Send, typing.Any],
+    value: Send | None,
+    /,
+) -> Yield:
+    try:
+        return (
+            await generator.asend(value) if isasyncgen(generator) else generator.send(value)  # type: ignore
+        )
+    except StopIteration as exc:
+        raise StopGenerator(exc.value, exc.args) from exc
+
+
+async def stop_generator[Send, Return](
+    generator: Generator[typing.Any, Send, Return],
+    with_value: Send | None = None,
+    /,
+) -> Return | None:
+    try:
+        await send_generator_value(generator, with_value)
+    except (StopGenerator, StopAsyncIteration) as exc:
+        return exc.value if isinstance(exc, StopGenerator) else None
+
+
+async def maybe_awaitable[T](obj: T | typing.Awaitable[T], /) -> T:
+    if isawaitable(obj):
+        return await obj
+    return obj
+
+
+# Source code: https://github.com/facebookincubator/later/blob/main/later/task.py#L68
+async def cancel_future(fut: asyncio.Future[typing.Any], /) -> None:
+    if fut.done():
+        return
+
+    fut.cancel()
+    exc: asyncio.CancelledError | None = None
+
+    while not fut.done():
+        shielded = asyncio.shield(fut)
+        try:
+            await asyncio.wait([shielded])
+        except asyncio.CancelledError as ex:
+            exc = ex
+        finally:
+            # Insure we handle the exception/value that may exist on the shielded task
+            # This will prevent errors logged to the asyncio logger
+            if shielded.done() and not shielded.cancelled() and not shielded.exception():
+                shielded.result()
+
+    if fut.cancelled():
+        if exc is None:
+            return
+        raise exc from None
+
+    ex = fut.exception()
+    if ex is not None:
+        raise ex from None
+
+    raise asyncio.InvalidStateError(
+        f"Task did not raise CancelledError on cancel: {fut!r} had result {fut.result()!r}",
+    )
+
+
+class StopGenerator(Exception):
+    value: typing.Any
+
+    def __init__(self, value: typing.Any, *args: object) -> None:
+        super().__init__(*args)
+        self.value = value
+
+
+class TaskGroup[T](asyncio.TaskGroup):
+    _all_tasks: set[asyncio.Task[typing.Any]]
+
+    def __init__(self, loop: asyncio.AbstractEventLoop | None = None) -> None:
+        super().__init__()
+        self._all_tasks = set()
+        self._loop = loop
+
+    def results(self) -> typing.Iterable[T]:
+        while self._all_tasks:
+            task = self._all_tasks.pop()
+            if not task.cancelled() and task.exception() is None:
+                yield task.result()
+
+    def create_task(
+        self,
+        coro: typing.Coroutine[typing.Any, typing.Any, T],
+        /,
+        name: str | None = None,
+        context: Context | None = None,
+    ) -> asyncio.Task[T]:
+        task = super().create_task(coro)
+        self._all_tasks.add(task)
+        return task
+
+
+__all__ = (
+    "StopGenerator",
+    "TaskGroup",
+    "cancel_future",
+    "get_tasks_results",
+    "loop_is_running",
+    "maybe_awaitable",
+    "next_generator",
+    "run_task",
+    "send_generator_value",
+    "stop_generator",
+)

telegrinder/tools/final.py

@@ -0,0 +1,21 @@
+import typing
+
+from telegrinder.tools.fullname import fullname
+
+
+class Final:
+    if not typing.TYPE_CHECKING:
+
+        def __new__(cls, *args, **kwargs):
+            if cls is Final:
+                raise TypeError("Class Final cannot be instantiate.")
+            return super().__new__(cls, *args, **kwargs)
+
+    @typing.final
+    def __init_subclass__(cls, **kwargs: typing.Any) -> None:
+        for base in cls.__bases__:
+            if base is not Final and issubclass(base, Final):
+                raise TypeError(f"Final class `{fullname(base)}` cannot be subclassed.")
+
+
+__all__ = ("Final",)

telegrinder/tools/formatting/__init__.py

@@ -0,0 +1,85 @@
+from telegrinder.tools.formatting.deep_links import (
+    tg_bot_attach_open_any_chat,
+    tg_bot_attach_open_current_chat,
+    tg_bot_attach_open_specific_chat,
+    tg_bot_start_link,
+    tg_bot_startchannel_link,
+    tg_bot_startgroup_link,
+    tg_chat_folder_link,
+    tg_chat_invite_link,
+    tg_direct_mini_app_link,
+    tg_emoji_link,
+    tg_emoji_stickerset_link,
+    tg_invoice_link,
+    tg_language_pack_link,
+    tg_main_mini_app_link,
+    tg_mention_link,
+    tg_open_message_link,
+    tg_premium_multigift_link,
+    tg_premium_offer_link,
+    tg_private_channel_boost_link,
+    tg_private_message_link,
+    tg_public_channel_boost_link,
+    tg_public_message_link,
+    tg_public_username_link,
+    tg_share_link,
+    tg_story_link,
+)
+from telegrinder.tools.formatting.html import (
+    HTML,
+    blockquote,
+    bold,
+    code_inline,
+    escape,
+    italic,
+    link,
+    mention,
+    monospace,
+    pre_code,
+    spoiler,
+    strike,
+    tg_emoji,
+    underline,
+)
+
+__all__ = (
+    "HTML",
+    "blockquote",
+    "bold",
+    "code_inline",
+    "escape",
+    "italic",
+    "link",
+    "mention",
+    "monospace",
+    "pre_code",
+    "spoiler",
+    "strike",
+    "tg_bot_attach_open_any_chat",
+    "tg_bot_attach_open_current_chat",
+    "tg_bot_attach_open_specific_chat",
+    "tg_bot_start_link",
+    "tg_bot_startchannel_link",
+    "tg_bot_startgroup_link",
+    "tg_chat_folder_link",
+    "tg_chat_invite_link",
+    "tg_direct_mini_app_link",
+    "tg_emoji",
+    "tg_emoji_link",
+    "tg_emoji_stickerset_link",
+    "tg_invoice_link",
+    "tg_language_pack_link",
+    "tg_main_mini_app_link",
+    "tg_mention_link",
+    "tg_open_message_link",
+    "tg_premium_multigift_link",
+    "tg_premium_offer_link",
+    "tg_private_channel_boost_link",
+    "tg_private_message_link",
+    "tg_public_channel_boost_link",
+    "tg_public_message_link",
+    "tg_public_username_link",
+    "tg_share_link",
+    "tg_story_link",
+    "underline",
+)

telegrinder/tools/formatting/deep_links/__init__.py

@@ -0,0 +1,39 @@
+from telegrinder.tools.formatting.deep_links.links import *
+from telegrinder.tools.formatting.deep_links.parsing import *
+from telegrinder.tools.formatting.deep_links.validators import *
+
+__all__ = (
+    "NO_VALUE",
+    "NoValue",
+    "Parameter",
+    "get_parameter_metadata",
+    "get_query_params",
+    "parse_deep_link",
+    "parse_query_params",
+    "separate_by_plus_char",
+    "tg_bot_attach_open_any_chat",
+    "tg_bot_attach_open_current_chat",
+    "tg_bot_attach_open_specific_chat",
+    "tg_bot_start_link",
+    "tg_bot_startchannel_link",
+    "tg_bot_startgroup_link",
+    "tg_chat_folder_link",
+    "tg_chat_invite_link",
+    "tg_direct_mini_app_link",
+    "tg_emoji_link",
+    "tg_emoji_stickerset_link",
+    "tg_invoice_link",
+    "tg_language_pack_link",
+    "tg_main_mini_app_link",
+    "tg_mention_link",
+    "tg_open_message_link",
+    "tg_premium_multigift_link",
+    "tg_premium_offer_link",
+    "tg_private_channel_boost_link",
+    "tg_private_message_link",
+    "tg_public_channel_boost_link",
+    "tg_public_message_link",
+    "tg_public_username_link",
+    "tg_share_link",
+    "tg_story_link",
+)