telegrinder 0.2.0.post2__tar.gz → 0.2.1__tar.gz

{telegrinder-0.2.0.post2 → telegrinder-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: telegrinder
-Version: 0.2.0.post2
+Version: 0.2.1
 Summary: Modern visionary telegram bot framework.
 Home-page: https://github.com/timoniq/telegrinder
 License: MIT

{telegrinder-0.2.0.post2 → telegrinder-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "telegrinder"
-version = "0.2.0.post2"
+version = "0.2.1"
 description = "Modern visionary telegram bot framework."
 authors = ["timoniq <tesseradecades@mail.ru>"]
 maintainers = ["luwqz1 <howluwqz1@gmail.com>"]

{telegrinder-0.2.0.post2 → telegrinder-0.2.1}/telegrinder/__init__.py

@@ -79,6 +79,7 @@ from .bot import (
     WaiterMachine,
     register_manager,
 )
+from .bot.rules import StateMeta
 from .client import ABCClient, AiohttpClient
 from .model import Model
 from .modules import logger
@@ -86,6 +87,7 @@ from .tools import (
     ABCErrorHandler,
     ABCGlobalContext,
     ABCLoopWrapper,
+    ABCStateStorage,
     ABCTranslator,
     ABCTranslatorMiddleware,
     AnyMarkup,
@@ -104,10 +106,12 @@ from .tools import (
     KeyboardSetYAML,
     Lifespan,
     LoopWrapper,
+    MemoryStateStorage,
     ParseMode,
     RowButtons,
     SimpleI18n,
     SimpleTranslator,
+    StateData,
     ctx_var,
     magic_bundle,
 )
@@ -207,4 +211,8 @@ __all__ = (
     "logger",
     "magic_bundle",
     "register_manager",
+    "ABCStateStorage",
+    "MemoryStateStorage",
+    "StateData",
+    "StateMeta",
 )

{telegrinder-0.2.0.post2 → telegrinder-0.2.1}/telegrinder/bot/dispatch/waiter_machine/machine.py

@@ -45,13 +45,13 @@ class WaiterMachine:
 
     async def drop(
         self,
-        state_view: "ABCStateView[EventModel]",
+        state_view: "ABCStateView[EventModel] | str",
         id: Identificator,
         event: EventModel,
         update: Update,
         **context: typing.Any,
     ) -> None:
-        view_name = state_view.__class__.__name__
+        view_name = state_view if isinstance(state_view, str) else state_view.__class__.__name__
         if view_name not in self.storage:
             raise LookupError("No record of view {!r} found.".format(view_name))
 
@@ -61,13 +61,26 @@ class WaiterMachine:
 
         short_state.cancel()
         await self.call_behaviour(
-            state_view,
             event,
             update,
             behaviour=short_state.on_drop_behaviour,
             **context,
         )
 
+    async def drop_all(self) -> None:
+        """Drops all waiters in storage"""
+        for view_name in self.storage:
+            for ident, short_state in self.storage[view_name].items():
+                if short_state.context:
+                    await self.drop(
+                        view_name,
+                        ident,
+                        short_state.context.event,
+                        short_state.context.context.raw_update
+                    )
+                else:
+                    short_state.cancel()
+
     async def wait(
         self,
         state_view: "BaseStateView[EventModel]",
@@ -114,7 +127,6 @@ class WaiterMachine:
 
     async def call_behaviour(
         self,
-        view: "ABCStateView[EventModel]",
         event: EventModel,
         update: Update,
         behaviour: Behaviour[EventModel] | None = None,
@@ -147,7 +159,7 @@ class WaiterMachine:
             now = datetime.datetime.now()
             for ident, short_state in self.storage.get(view_name, {}).copy().items():
                 if short_state.expiration_date is not None and now > short_state.expiration_date:
-                    assert short_state.context
+                    assert short_state.context  # FIXME: why???
                     await self.drop(
                         view,
                         ident,

{telegrinder-0.2.0.post2 → telegrinder-0.2.1}/telegrinder/bot/dispatch/waiter_machine/middleware.py

@@ -59,7 +59,6 @@ class WaiterMiddleware(ABCMiddleware[EventType]):
 
         # before running the handler we check if the user wants to exit waiting
         if short_state.exit_behaviour is not None and await self.machine.call_behaviour(
-            self.view,
             event,
             ctx.raw_update,
             behaviour=short_state.exit_behaviour,
@@ -87,7 +86,6 @@ class WaiterMiddleware(ABCMiddleware[EventType]):
 
         elif short_state.default_behaviour is not None:
             await self.machine.call_behaviour(
-                self.view,
                 event,
                 ctx.raw_update,
                 behaviour=short_state.default_behaviour,

{telegrinder-0.2.0.post2 → telegrinder-0.2.1}/telegrinder/bot/rules/__init__.py

@@ -53,6 +53,7 @@ from telegrinder.bot.rules.node import NodeRule
 from telegrinder.bot.rules.regex import Regex
 from telegrinder.bot.rules.rule_enum import RuleEnum
 from telegrinder.bot.rules.start import StartCommand
+from telegrinder.bot.rules.state import State, StateMeta
 from telegrinder.bot.rules.text import HasText, Text
 from telegrinder.bot.rules.update import IsUpdateType
 
@@ -113,4 +114,6 @@ __all__ = (
     "StartCommand",
     "Text",
     "NodeRule",
+    "State",
+    "StateMeta",
 )

telegrinder-0.2.1/telegrinder/bot/rules/state.py

@@ -0,0 +1,34 @@
+import enum
+import typing
+
+from telegrinder.bot.dispatch.context import Context
+from telegrinder.bot.rules.abc import ABCRule
+from telegrinder.node import Source
+
+if typing.TYPE_CHECKING:
+    from telegrinder.tools.state_storage import ABCStateStorage
+
+
+class StateMeta(enum.Enum):
+    NO_STATE = enum.auto()
+    ANY = enum.auto()
+
+
+class State(ABCRule):
+    def __init__(self, storage: "ABCStateStorage", key: str | StateMeta = StateMeta.ANY):
+        self.storage = storage
+        self.key = key
+
+    async def check(self, source: Source, ctx: Context) -> bool:
+        state = await self.storage.get(source.from_user.id)
+        if not state:
+            return self.key == StateMeta.NO_STATE
+
+        if self.key != StateMeta.ANY and self.key != state.unwrap().key:
+            return False
+
+        ctx["state"] = state.unwrap()
+        return True
+
+
+__all__ = ("State", "StateMeta")

{telegrinder-0.2.0.post2 → telegrinder-0.2.1}/telegrinder/tools/__init__.py

@@ -67,6 +67,7 @@ from .limited_dict import LimitedDict
 from .loop_wrapper import ABCLoopWrapper, DelayedTask, Lifespan, LoopWrapper
 from .magic import impl, magic_bundle, resolve_arg_names
 from .parse_mode import ParseMode
+from .state_storage import ABCStateStorage, MemoryStateStorage, StateData
 
 __all__ = (
     "ABCErrorHandler",
@@ -139,4 +140,7 @@ __all__ = (
     "block_quote",
     "impl",
     "resolve_arg_names",
+    "ABCStateStorage",
+    "MemoryStateStorage",
+    "StateData",
 )

{telegrinder-0.2.0.post2 → telegrinder-0.2.1}/telegrinder/tools/keyboard.py

@@ -26,11 +26,6 @@ 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]]
@@ -78,7 +73,7 @@ class ABCMarkup(ABC, typing.Generic[ButtonT]):
         return copy_keyboard
 
     def merge(self, other: typing.Self) -> typing.Self:
-        self.keyboard.extend(copy_keyboard(other.keyboard))
+        self.keyboard.extend(other.keyboard)
         return self
 
 

telegrinder-0.2.1/telegrinder/tools/state_storage/__init__.py

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

telegrinder-0.2.1/telegrinder/tools/state_storage/abc.py

@@ -0,0 +1,33 @@
+import abc
+import typing
+from dataclasses import dataclass
+
+from fntypes import Option
+
+from telegrinder.bot.rules.state import State, StateMeta
+
+Payload = typing.TypeVar("Payload")
+
+
+@dataclass
+class StateData(typing.Generic[Payload]):
+    key: str
+    payload: Payload
+
+
+class ABCStateStorage(abc.ABC, typing.Generic[Payload]):
+    @abc.abstractmethod
+    async def get(self, user_id: int) -> Option[StateData[Payload]]:
+        ...
+
+    @abc.abstractmethod
+    async def delete(self, user_id: int) -> None:
+        ...
+
+    @abc.abstractmethod
+    async def set(self, user_id: int, key: str, payload: Payload) -> None:
+        ...
+
+    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)

telegrinder-0.2.1/telegrinder/tools/state_storage/memory.py

@@ -0,0 +1,22 @@
+import typing
+
+from fntypes import Nothing, Option, Some
+
+from .abc import ABCStateStorage, StateData
+
+Payload = dict[str, typing.Any]
+
+
+class MemoryStateStorage(ABCStateStorage[Payload]):
+    def __init__(self):
+        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()
+
+    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)

{telegrinder-0.2.0.post2 → telegrinder-0.2.1}/telegrinder/types/methods.py

@@ -4178,7 +4178,7 @@ class APIMethods:
         :param description: Product description, 1-255 characters.
 
         :param payload: Bot-defined invoice payload, 1-128 bytes. This will not be displayed to \
-        the user, use for your internal processes.
+        the user, use it for your internal processes.
 
         :param provider_token: Payment provider token, obtained via @BotFather. Pass an empty string \
         for payments in Telegram Stars.
@@ -4296,7 +4296,7 @@ class APIMethods:
         :param description: Product description, 1-255 characters.
 
         :param payload: Bot-defined invoice payload, 1-128 bytes. This will not be displayed to \
-        the user, use for your internal processes.
+        the user, use it for your internal processes.
 
         :param provider_token: Payment provider token, obtained via @BotFather. Pass an empty string \
         for payments in Telegram Stars.

{telegrinder-0.2.0.post2 → telegrinder-0.2.1}/telegrinder/types/objects.py

@@ -2795,6 +2795,15 @@ class ChatInviteLink(Model):
     pending_join_request_count: Option[int] = Nothing
     """Optional. Number of pending join requests created using this link."""
 
+    subscription_period: Option[int] = Nothing
+    """Optional. The number of seconds the subscription will be active for before
+    the next payment."""
+
+    subscription_price: Option[int] = Nothing
+    """Optional. The amount of Telegram Stars a user must pay initially and after
+    each subsequent subscription period to be a member of the chat using the
+    link."""
+
 
 class ChatAdministratorRights(Model):
     """Object `ChatAdministratorRights`, see the [documentation](https://core.telegram.org/bots/api#chatadministratorrights).
@@ -5393,7 +5402,7 @@ class InputInvoiceMessageContent(InputMessageContent):
 
     payload: str
     """Bot-defined invoice payload, 1-128 bytes. This will not be displayed to
-    the user, use for your internal processes."""
+    the user, use it for your internal processes."""
 
     currency: Currency
     """Three-letter ISO 4217 currency code, see more on currencies. Pass `XTR`