telegrinder 0.2.1__py3-none-any.whl → 0.3.0__py3-none-any.whl

telegrinder/tools/__init__.py

@@ -74,6 +74,7 @@ __all__ = (
     "ABCGlobalContext",
     "ABCI18n",
     "ABCLoopWrapper",
+    "ABCStateStorage",
     "ABCTranslator",
     "ABCTranslatorMiddleware",
     "AnyMarkup",
@@ -101,6 +102,7 @@ __all__ = (
     "LimitedDict",
     "Link",
     "LoopWrapper",
+    "MemoryStateStorage",
     "Mention",
     "ParseMode",
     "PreCode",
@@ -111,8 +113,14 @@ __all__ = (
     "SpecialFormat",
     "StartBotLink",
     "StartGroupLink",
+    "StateData",
     "TelegrinderContext",
     "TgEmoji",
+    "block_quote",
+    "bold",
+    "channel_boost_link",
+    "code_inline",
+    "ctx_var",
     "escape",
     "get_channel_boost_link",
     "get_invite_chat_link",
@@ -120,12 +128,14 @@ __all__ = (
     "get_resolve_domain_link",
     "get_start_bot_link",
     "get_start_group_link",
+    "impl",
     "invite_chat_link",
     "italic",
     "link",
     "magic_bundle",
     "mention",
     "pre_code",
+    "resolve_arg_names",
     "resolve_domain",
     "spoiler",
     "start_bot_link",
@@ -133,14 +143,4 @@ __all__ = (
     "strike",
     "tg_emoji",
     "underline",
-    "bold",
-    "channel_boost_link",
-    "code_inline",
-    "ctx_var",
-    "block_quote",
-    "impl",
-    "resolve_arg_names",
-    "ABCStateStorage",
-    "MemoryStateStorage",
-    "StateData",
 )

telegrinder/tools/functional.py

@@ -0,0 +1,9 @@
+import typing
+
+from fntypes import Nothing, Option, Some
+
+T = typing.TypeVar("T")
+
+
+def from_optional(value: T | None) -> Option[T]:
+    return Some(value) if value is not None else Nothing()

telegrinder/tools/keyboard.py

@@ -26,6 +26,11 @@ class KeyboardModel:
     keyboard: list[list[DictStrAny]]
 
 
+
+def copy_keyboard(keyboard: list[list[DictStrAny]]) -> list[list[DictStrAny]]:
+    return [row.copy() for row in keyboard]
+
+
 class ABCMarkup(ABC, typing.Generic[ButtonT]):
     BUTTON: type[ButtonT]
     keyboard: list[list[DictStrAny]]
@@ -73,7 +78,7 @@ class ABCMarkup(ABC, typing.Generic[ButtonT]):
         return copy_keyboard
 
     def merge(self, other: typing.Self) -> typing.Self:
-        self.keyboard.extend(other.keyboard)
+        self.keyboard.extend(copy_keyboard(other.keyboard))
         return self
 
 

telegrinder/tools/loop_wrapper/loop_wrapper.py

@@ -44,17 +44,16 @@ class DelayedTask(typing.Generic[CoroFunc]):
     def is_cancelled(self) -> bool:
         return self._cancelled
 
-    async def __call__(self, *args, **kwargs) -> None:
+    async def __call__(self, *args: typing.Any, **kwargs: typing.Any) -> None:
         while not self.is_cancelled:
             await asyncio.sleep(self.seconds)
             if self.is_cancelled:
                 break
             try:
                 await self.handler(*args, **kwargs)
-            except Exception as e:
-                logger.exception("Error in delayed task: {}", str(e))
-            if not self.repeat:
-                break
+            finally:
+                if not self.repeat:
+                    break
 
     def cancel(self) -> None:
         if not self._cancelled:

telegrinder/tools/magic.py

@@ -6,7 +6,7 @@ from functools import wraps
 
 if typing.TYPE_CHECKING:
     from telegrinder.bot.rules.abc import ABCRule
-    from telegrinder.node.base import Node
+    from telegrinder.node.polymorphic import Polymorphic
 
     T = typing.TypeVar("T", bound=ABCRule)
     F = typing.TypeVar(
@@ -23,7 +23,6 @@ IMPL_MARK: typing.Final[str] = "_is_impl"
 
 def cache_magic_value(mark_key: str, /):
     def inner(func: "F") -> "F":
-
         @wraps(func)
         def wrapper(*args: typing.Any, **kwargs: typing.Any) -> typing.Any:
             if mark_key not in args[0].__dict__:
@@ -31,6 +30,7 @@ def cache_magic_value(mark_key: str, /):
             return args[0].__dict__[mark_key]
 
         return wrapper  # type: ignore
+
     return inner
 
 
@@ -43,13 +43,13 @@ def get_default_args(func: FuncType) -> dict[str, typing.Any]:
     fspec = inspect.getfullargspec(func)
     if not fspec.defaults:
         return {}
-    return dict(zip(fspec.args[-len(fspec.defaults):], fspec.defaults))
+    return dict(zip(fspec.args[-len(fspec.defaults) :], fspec.defaults))
 
 
 def get_annotations(func: FuncType, *, return_type: bool = False) -> dict[str, typing.Any]:
     annotations = func.__annotations__
     if not return_type and "return" in func.__annotations__:
-       annotations.pop("return")
+        annotations.pop("return")
     return annotations
 
 
@@ -60,13 +60,11 @@ def to_str(s: str | enum.Enum) -> str:
 
 
 @typing.overload
-def magic_bundle(handler: FuncType, kw: dict[str, typing.Any]) -> dict[str, typing.Any]:
-    ...
+def magic_bundle(handler: FuncType, kw: dict[str, typing.Any]) -> dict[str, typing.Any]: ...
 
 
 @typing.overload
-def magic_bundle(handler: FuncType, kw: dict[enum.Enum, typing.Any]) -> dict[str, typing.Any]:
-    ...
+def magic_bundle(handler: FuncType, kw: dict[enum.Enum, typing.Any]) -> dict[str, typing.Any]: ...
 
 
 @typing.overload
@@ -76,8 +74,7 @@ def magic_bundle(
     *,
     start_idx: int = 1,
     bundle_ctx: bool = True,
-) -> dict[str, typing.Any]:
-    ...
+) -> dict[str, typing.Any]: ...
 
 
 @typing.overload
@@ -87,8 +84,7 @@ def magic_bundle(
     *,
     start_idx: int = 1,
     bundle_ctx: bool = True,
-) -> dict[str, typing.Any]:
-    ...
+) -> dict[str, typing.Any]: ...
 
 
 @typing.overload
@@ -97,8 +93,7 @@ def magic_bundle(
     kw: dict[type, typing.Any],
     *,
     typebundle: typing.Literal[True] = True,
-) -> dict[str, typing.Any]:
-    ...
+) -> dict[str, typing.Any]: ...
 
 
 def magic_bundle(
@@ -109,7 +104,6 @@ def magic_bundle(
     bundle_ctx: bool = True,
     typebundle: bool = False,
 ) -> dict[str, typing.Any]:
-
     if typebundle:
         types = get_annotations(handler, return_type=False)
         bundle: dict[str, typing.Any] = {}
@@ -141,13 +135,17 @@ def impl(method: typing.Callable[..., typing.Any]):
     return classmethod(method)
 
 
-def get_impls(cls: type["Node"]) -> list[typing.Callable[..., typing.Any]]:
-    return [
+def get_impls(cls: type["Polymorphic"]) -> list[typing.Callable[..., typing.Any]]:
+    moprh_impls = getattr(cls, "__morph_impls__", None)
+    if moprh_impls is not None:
+        return moprh_impls
+    impls = [
         func.__func__
         for func in vars(cls).values()
         if isinstance(func, classmethod) and getattr(func.__func__, IMPL_MARK, False)
     ]
-
+    setattr(cls, "__morph_impls__", impls)
+    return impls
 
 
 __all__ = (
@@ -158,8 +156,8 @@ __all__ = (
     "get_cached_translation",
     "get_default_args",
     "get_default_args",
-    "impl",
     "get_impls",
+    "impl",
     "magic_bundle",
     "resolve_arg_names",
     "to_str",

telegrinder/tools/state_storage/__init__.py

@@ -1,4 +1,4 @@
-from .abc import ABCStateStorage, StateData
-from .memory import MemoryStateStorage
+from telegrinder.tools.state_storage.abc import ABCStateStorage, StateData
+from telegrinder.tools.state_storage.memory import MemoryStateStorage
 
-__all__ = ("ABCStateStorage", "StateData", "MemoryStateStorage")
+__all__ = ("ABCStateStorage", "MemoryStateStorage", "StateData")

telegrinder/tools/state_storage/abc.py

@@ -1,4 +1,5 @@
 import abc
+import enum
 import typing
 from dataclasses import dataclass
 
@@ -9,25 +10,26 @@ from telegrinder.bot.rules.state import State, StateMeta
 Payload = typing.TypeVar("Payload")
 
 
-@dataclass
+@dataclass(frozen=True, slots=True)
 class StateData(typing.Generic[Payload]):
-    key: str
+    key: str | enum.Enum
     payload: Payload
 
 
 class ABCStateStorage(abc.ABC, typing.Generic[Payload]):
     @abc.abstractmethod
-    async def get(self, user_id: int) -> Option[StateData[Payload]]:
-        ...
+    async def get(self, user_id: int) -> Option[StateData[Payload]]: ...
 
     @abc.abstractmethod
-    async def delete(self, user_id: int) -> None:
-        ...
+    async def delete(self, user_id: int) -> None: ...
 
     @abc.abstractmethod
-    async def set(self, user_id: int, key: str, payload: Payload) -> None:
-        ...
+    async def set(self, user_id: int, key: str | enum.Enum, payload: Payload) -> None: ...
+
+    def State(self, key: str | StateMeta | enum.Enum = StateMeta.ANY, /) -> State[Payload]:  # noqa: N802
+        """Can be used as a shortcut to get a state rule dependant on current storage."""
 
-    def State(self, key: str | StateMeta = StateMeta.ANY) -> State:  # noqa: N802
-        """Can be used as a shortcut to get a state rule dependant on current storage"""
         return State(storage=self, key=key)
+
+
+__all__ = ("ABCStateStorage", "StateData")

telegrinder/tools/state_storage/memory.py

@@ -1,22 +1,25 @@
 import typing
 
-from fntypes import Nothing, Option, Some
+from fntypes.option import Option
 
-from .abc import ABCStateStorage, StateData
+from telegrinder.tools.functional import from_optional
+from telegrinder.tools.state_storage.abc import ABCStateStorage, StateData
 
-Payload = dict[str, typing.Any]
+Payload: typing.TypeAlias = dict[str, typing.Any]
 
 
 class MemoryStateStorage(ABCStateStorage[Payload]):
-    def __init__(self):
+    def __init__(self) -> None:
         self.storage: dict[int, StateData[Payload]] = {}
 
     async def get(self, user_id: int) -> Option[StateData[Payload]]:
-        state = self.storage.get(user_id)
-        return Some(state) if state is not None else Nothing()
+        return from_optional(self.storage.get(user_id))
 
     async def set(self, user_id: int, key: str, payload: Payload) -> None:
         self.storage[user_id] = StateData(key, payload)
 
     async def delete(self, user_id: int) -> None:
         self.storage.pop(user_id)
+
+
+__all__ = ("MemoryStateStorage",)

telegrinder/types/__init__.py

@@ -178,6 +178,7 @@ __all__ = (
     "PaidMediaInfo",
     "PaidMediaPhoto",
     "PaidMediaPreview",
+    "PaidMediaPurchased",
     "PaidMediaVideo",
     "PassportData",
     "PassportElementError",

telegrinder/types/methods.py

@@ -13,7 +13,7 @@ if typing.TYPE_CHECKING:
 
 
 class APIMethods:
-    """Telegram Bot API 7.9 methods, released `August 14, 2024`."""
+    """Telegram Bot API methods version 7.10, released `September 6, 2024`."""
 
     default_params = ProxiedDict(
         typing.TypedDict(
@@ -1054,6 +1054,7 @@ class APIMethods:
         star_count: int,
         media: list[InputPaidMedia],
         business_connection_id: str | None = None,
+        payload: str | None = None,
         caption: str | None = None,
         parse_mode: str | None = default_params["parse_mode"],
         caption_entities: list[MessageEntity] | None = None,
@@ -1080,10 +1081,14 @@ class APIMethods:
         Star proceeds from this media will be credited to the chat's balance. Otherwise, \
         they will be credited to the bot's balance.
 
-        :param star_count: The number of Telegram Stars that must be paid to buy access to the media. \
+        :param star_count: The number of Telegram Stars that must be paid to buy access to the media; \
+        1-2500.
 
         :param media: A JSON-serialized array describing the media to be sent; up to 10 items. \
 
+        :param payload: Bot-defined paid media payload, 0-128 bytes. This will not be displayed \
+        to the user, use it for your internal processes.
+
         :param caption: Media caption, 0-1024 characters after entities parsing.
 
         :param parse_mode: Mode for parsing entities in the media caption. See formatting options \
@@ -4623,3 +4628,6 @@ class APIMethods:
             get_params(locals()),
         )
         return full_result(method_response, list[GameHighScore])
+
+
+__all__ = ("APIMethods",)

telegrinder/types/objects.py

@@ -292,6 +292,10 @@ class Update(Model):
     """Optional. New incoming pre-checkout query. Contains full information
     about checkout."""
 
+    purchased_paid_media: Option["PaidMediaPurchased"] = Nothing
+    """Optional. A user purchased paid media with a non-empty payload sent by the
+    bot in a non-channel chat."""
+
     poll: Option["Poll"] = Nothing
     """Optional. New poll state. Bots receive only updates about manually stopped
     polls and polls, which are sent by the bot."""
@@ -2179,9 +2183,13 @@ class VideoChatParticipantsInvited(Model):
 class GiveawayCreated(Model):
     """Object `GiveawayCreated`, see the [documentation](https://core.telegram.org/bots/api#giveawaycreated).
 
-    This object represents a service message about the creation of a scheduled giveaway. Currently holds no information.
+    This object represents a service message about the creation of a scheduled giveaway.
     """
 
+    prize_star_count: Option[int] = Nothing
+    """Optional. The number of Telegram Stars to be split between giveaway winners;
+    for Telegram Star giveaways only."""
+
 
 class Giveaway(Model):
     """Object `Giveaway`, see the [documentation](https://core.telegram.org/bots/api#giveaway).
@@ -2214,9 +2222,13 @@ class Giveaway(Model):
     then all users can participate in the giveaway. Users with a phone number
     that was bought on Fragment can always participate in giveaways."""
 
+    prize_star_count: Option[int] = Nothing
+    """Optional. The number of Telegram Stars to be split between giveaway winners;
+    for Telegram Star giveaways only."""
+
     premium_subscription_month_count: Option[int] = Nothing
     """Optional. The number of months the Telegram Premium subscription won from
-    the giveaway will be active for."""
+    the giveaway will be active for; for Telegram Premium giveaways only."""
 
 
 class GiveawayWinners(Model):
@@ -2244,9 +2256,13 @@ class GiveawayWinners(Model):
     """Optional. The number of other chats the user had to join in order to be eligible
     for the giveaway."""
 
+    prize_star_count: Option[int] = Nothing
+    """Optional. The number of Telegram Stars that were split between giveaway
+    winners; for Telegram Star giveaways only."""
+
     premium_subscription_month_count: Option[int] = Nothing
     """Optional. The number of months the Telegram Premium subscription won from
-    the giveaway will be active for."""
+    the giveaway will be active for; for Telegram Premium giveaways only."""
 
     unclaimed_prize_count: Option[int] = Nothing
     """Optional. Number of undistributed prizes."""
@@ -2278,6 +2294,10 @@ class GiveawayCompleted(Model):
     giveaway_message: Option["Message"] = Nothing
     """Optional. Message with the giveaway that was completed, if it wasn't deleted."""
 
+    is_star_giveaway: Option[bool] = Nothing
+    """Optional. True, if the giveaway is a Telegram Star giveaway. Otherwise,
+    currently, the giveaway is a Telegram Premium giveaway."""
+
 
 class LinkPreviewOptions(Model):
     """Object `LinkPreviewOptions`, see the [documentation](https://core.telegram.org/bots/api#linkpreviewoptions).
@@ -3634,7 +3654,7 @@ class ChatBoostSourceGiftCode(ChatBoostSource):
 class ChatBoostSourceGiveaway(ChatBoostSource):
     """Object `ChatBoostSourceGiveaway`, see the [documentation](https://core.telegram.org/bots/api#chatboostsourcegiveaway).
 
-    The boost was obtained by the creation of a Telegram Premium giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription.
+    The boost was obtained by the creation of a Telegram Premium or a Telegram Star giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription for Telegram Premium giveaways and prize_star_count / 500 times for one year for Telegram Star giveaways.
     """
 
     source: typing.Literal["giveaway"]
@@ -3645,7 +3665,12 @@ class ChatBoostSourceGiveaway(ChatBoostSource):
     have been deleted already. May be 0 if the message isn't sent yet."""
 
     user: Option["User"] = Nothing
-    """Optional. User that won the prize in the giveaway if any."""
+    """Optional. User that won the prize in the giveaway if any; for Telegram Premium
+    giveaways only."""
+
+    prize_star_count: Option[int] = Nothing
+    """Optional. The number of Telegram Stars to be split between giveaway winners;
+    for Telegram Star giveaways only."""
 
     is_unclaimed: Option[bool] = Nothing
     """Optional. True, if the giveaway was completed, but there was no user to win
@@ -5725,6 +5750,19 @@ class PreCheckoutQuery(Model):
     """Optional. Order information provided by the user."""
 
 
+class PaidMediaPurchased(Model):
+    """Object `PaidMediaPurchased`, see the [documentation](https://core.telegram.org/bots/api#paidmediapurchased).
+
+    This object contains information about a paid media purchase.
+    """
+
+    from_: "User"
+    """User who purchased the media."""
+
+    paid_media_payload: str
+    """Bot-specified paid media payload."""
+
+
 class RevenueWithdrawalStatePending(RevenueWithdrawalState):
     """Object `RevenueWithdrawalStatePending`, see the [documentation](https://core.telegram.org/bots/api#revenuewithdrawalstatepending).
 
@@ -5779,6 +5817,9 @@ class TransactionPartnerUser(TransactionPartner):
     paid_media: Option[list[Variative["PaidMediaPreview", "PaidMediaPhoto", "PaidMediaVideo"]]] = Nothing
     """Optional. Information about the paid media bought by the user."""
 
+    paid_media_payload: Option[str] = Nothing
+    """Optional. Bot-specified paid media payload."""
+
 
 class TransactionPartnerFragment(TransactionPartner):
     """Object `TransactionPartnerFragment`, see the [documentation](https://core.telegram.org/bots/api#transactionpartnerfragment).
@@ -6428,6 +6469,7 @@ __all__ = (
     "PaidMediaInfo",
     "PaidMediaPhoto",
     "PaidMediaPreview",
+    "PaidMediaPurchased",
     "PaidMediaVideo",
     "PassportData",
     "PassportElementError",

{telegrinder-0.2.1.dist-info → telegrinder-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: telegrinder
-Version: 0.2.1
+Version: 0.3.0
 Summary: Modern visionary telegram bot framework.
 Home-page: https://github.com/timoniq/telegrinder
 License: MIT
@@ -43,8 +43,9 @@ Still in development.
 * Type hinted
 * Customizable and extensible
 * Ready to use scenarios and rules
-* Fast models built on msgspec
+* Fast models built on [msgspec](https://github.com/jcrist/msgspec)
 * Both low-level and high-level API
+* Support [optional dependecies](https://github.com/timoniq/telegrinder/blob/dev/docs/guide/optional_dependencies.md)
 
 # Getting started
 
@@ -85,9 +86,7 @@ logger.set_level("INFO")
 @bot.on.message(Text("/start"))
 async def start(message: Message):
     me = (await api.get_me()).unwrap()
-    await message.answer(
-        f"Hello, {message.from_user.full_name}! I'm {me.full_name}."
-    )
+    await message.answer(f"Hello, {message.from_user.full_name}! I'm {me.full_name}.")
 
 
 bot.run_forever()