maxapi-python 2.1.2__py3-none-any.whl → 2.2.0__py3-none-any.whl

pymax/logging.py

@@ -4,6 +4,7 @@ import sys
 from typing import TextIO
 
 DATE_FORMAT = "%H:%M:%S"
+PYMAX_HANDLER_ATTR = "_pymax_pretty_handler"
 
 RESET = "\x1b[0m"
 DIM = "\x1b[2m"
@@ -56,17 +57,22 @@ def configure_logging(
     *,
     stream: TextIO | None = None,
     use_colors: bool | None = None,
+    force: bool = False,
 ) -> None:
     """Настраивает pretty-логи для logger-а ``pymax``.
 
     Обычно уровень логов задают через ``ExtraConfig(log_level="DEBUG")``.
-    Вызывайте эту функцию вручную, если хотите управлять stream или цветами.
+    PyMax ставит свой handler только если приложение еще не настроило logging.
+    Вызывайте эту функцию с ``force=True``, если хотите принудительно включить
+    pretty-логи PyMax.
 
     Args:
         level: Уровень логирования: строка вроде ``"DEBUG"`` или число из
             модуля ``logging``.
         stream: Поток для вывода. По умолчанию ``sys.stderr``.
         use_colors: Включить ANSI-цвета. Если ``None``, определяется по TTY.
+        force: Заменить существующие handler-ы logger-а ``pymax`` на pretty
+            handler PyMax.
 
     Returns:
         ``None``.
@@ -79,22 +85,32 @@ def configure_logging(
            configure_logging("DEBUG", use_colors=False)
     """
     stream = stream or sys.stderr
+    if stream is None:
+        raise RuntimeError("No logging stream is available")
 
     if use_colors is None:
         use_colors = hasattr(stream, "isatty") and stream.isatty()
 
     logger = logging.getLogger("pymax")
+    level_value = _normalize_level(level)
+    logger.setLevel(level_value)
+
+    if not force and _logging_already_configured(logger):
+        if logging.getLogger().handlers and not _has_non_null_handlers(logger):
+            logger.propagate = True
+        return
+
     logger.handlers.clear()
-    logger.setLevel(_normalize_level(level))
     logger.propagate = False
 
     handler = logging.StreamHandler(stream)
-    handler.setLevel(_normalize_level(level))
+    handler.setLevel(level_value)
     handler.setFormatter(
         PrettyFormatter(
             use_colors=use_colors,
         )
     )
+    setattr(handler, PYMAX_HANDLER_ATTR, True)
 
     logger.addHandler(handler)
 
@@ -126,4 +142,20 @@ def _strip_ansi(text: str) -> str:
     return re.sub(r"\x1b\[[0-9;]*m", "", text)
 
 
+def _logging_already_configured(logger: logging.Logger) -> bool:
+    return bool(logging.getLogger().handlers or _has_external_handlers(logger))
+
+
+def _has_non_null_handlers(logger: logging.Logger) -> bool:
+    return any(not isinstance(handler, logging.NullHandler) for handler in logger.handlers)
+
+
+def _has_external_handlers(logger: logging.Logger) -> bool:
+    return any(
+        not isinstance(handler, logging.NullHandler)
+        and not getattr(handler, PYMAX_HANDLER_ATTR, False)
+        for handler in logger.handlers
+    )
+
+
 logging.getLogger("pymax").addHandler(logging.NullHandler())

pymax/protocol/tcp/compression.py

@@ -1,7 +1,5 @@
 class Lz4BlockCompression:
-    def decompress(
-        self, src: bytes, max_output: int = 5 * 1024 * 1024
-    ) -> bytes:
+    def decompress(self, src: bytes, max_output: int = 5 * 1024 * 1024) -> bytes:
         dst = bytearray()
         pos = 0
 

pymax/protocol/tcp/framing.py

@@ -31,9 +31,7 @@ class TcpPacketFramer:
         if len(data) < self.HEADER_SIZE:
             return None
 
-        ver, cmd, seq, opcode, packed_len = self.HEADER_STRUCT.unpack_from(
-            data, 0
-        )
+        ver, cmd, seq, opcode, packed_len = self.HEADER_STRUCT.unpack_from(data, 0)
         flags = (packed_len >> 24) & 0xFF
         payload_len = packed_len & 0x00FFFFFF
 

pymax/protocol/tcp/payload.py

@@ -15,10 +15,7 @@ class MsgpackPayloadCodec:
         if isinstance(value, Enum):
             return value.value
         if isinstance(value, dict):
-            return {
-                self._to_msgpack_value(k): self._to_msgpack_value(v)
-                for k, v in value.items()
-            }
+            return {self._to_msgpack_value(k): self._to_msgpack_value(v) for k, v in value.items()}
         if isinstance(value, list):
             return [self._to_msgpack_value(item) for item in value]
         if isinstance(value, tuple):
@@ -28,56 +25,42 @@ class MsgpackPayloadCodec:
     def encode(self, payload: object) -> bytes:
         if payload is None:
             return b""
-        return (
-            msgpack.packb(self._to_msgpack_value(payload), use_bin_type=True)
-            or b""
-        )
+        return msgpack.packb(self._to_msgpack_value(payload), use_bin_type=True) or b""
 
-    def _unpack_stream(self, payload_bytes: bytes, *, raw: bool) -> list[Any]:
+    def _unpack_stream(
+        self, payload_bytes: bytes, *, raw: bool
+    ) -> list[Any]:  # TODO: deprecate? idk
         unpacker = msgpack.Unpacker(raw=raw, strict_map_key=False)
         unpacker.feed(payload_bytes)
         return list(unpacker)
 
-    def decode(self, payload_bytes: bytes) -> dict[Any, Any]:
+    def decode(self, payload_bytes: bytes) -> Any:
         if not payload_bytes:
             return {}
 
         try:
             return msgpack.unpackb(
-                payload_bytes, raw=False, strict_map_key=False
+                payload_bytes,
+                raw=False,
+                strict_map_key=False,
             )
-        except msgpack.exceptions.ExtraData as e:
-            if isinstance(e.unpacked, dict):
-                logger.debug(
-                    "msgpack payload has trailing data unpacked_type=%s extra_bytes=%s extra_head=%s",
-                    type(e.unpacked).__name__,
-                    len(e.extra),
-                    e.extra[:16].hex(),
-                )
-                return e.unpacked
 
-            try:
-                values = self._unpack_stream(payload_bytes, raw=False)
-            except UnicodeDecodeError:
-                values = self._unpack_stream(payload_bytes, raw=True)
+        except msgpack.exceptions.ExtraData as e:
             logger.debug(
-                "msgpack payload has extra data objects=%s extra_bytes=%s",
-                [type(value).__name__ for value in values],
+                "msgpack extra data: unpacked_type=%s extra_len=%s extra_head=%s payload_head=%s",
+                type(e.unpacked).__name__,
                 len(e.extra),
+                e.extra[:64].hex(),
+                payload_bytes[:128].hex(),
             )
-            for value in values:
-                if isinstance(value, dict):
-                    return value
-            raise
-        except UnicodeDecodeError:
-            values = self._unpack_stream(payload_bytes, raw=True)
-            logger.debug(
-                "msgpack payload decoded with raw bytes objects=%s",
-                [type(value).__name__ for value in values],
+            return e.unpacked
+
+        except Exception:
+            logger.exception(
+                "msgpack decode failed: payload_len=%s payload_head=%s",
+                len(payload_bytes),
+                payload_bytes[:128].hex(),
             )
-            for value in values:
-                if isinstance(value, dict):
-                    return value
             raise
 
 
@@ -93,10 +76,7 @@ class TcpPayloadDecoder:
 
     def _normalize_keys(self, obj: Any) -> Any:
         if isinstance(obj, dict):
-            return {
-                self._normalize_key(k): self._normalize_keys(v)
-                for k, v in obj.items()
-            }
+            return {self._normalize_key(k): self._normalize_keys(v) for k, v in obj.items()}
         if isinstance(obj, list):
             return [self._normalize_keys(item) for item in obj]
         if isinstance(obj, tuple):

pymax/protocol/tcp/protocol.py

@@ -25,11 +25,7 @@ class TcpProtocol(BaseProtocol):
         )
 
     def encode(self, frame: OutboundFrame) -> bytes:
-        payload_bytes = (
-            self.serializer.encode(frame.payload)
-            if frame.payload is not None
-            else b""
-        )
+        payload_bytes = self.serializer.encode(frame.payload) if frame.payload is not None else b""
 
         flags = 0
 
@@ -52,9 +48,7 @@ class TcpProtocol(BaseProtocol):
 
         packed_packet = self.framer.unpack(raw)
         if not packed_packet:
-            return InboundFrame(
-                opcode=0, cmd=0, seq=None, payload=None, raw=None
-            )
+            return InboundFrame(opcode=0, cmd=0, seq=None, payload=None, raw=None)
 
         logger.debug(
             "tcp frame decoded header ver=%s cmd=%s seq=%s opcode=%s flags=%s payload_len=%s",

pymax/protocol/ws/protocol.py

@@ -20,14 +20,8 @@ class WsProtocol(BaseProtocol):
             data = json.loads(raw)
             return InboundFrame.model_validate(data)
         except json.JSONDecodeError:
-            logger.debug(
-                "failed to decode websocket frame json", exc_info=True
-            )
-            return InboundFrame(
-                opcode=0, cmd=0, seq=None, payload=None, raw=None
-            )
+            logger.debug("failed to decode websocket frame json", exc_info=True)
+            return InboundFrame(opcode=0, cmd=0, seq=None, payload=None, raw=None)
         except ValidationError:
             logger.debug("failed to validate websocket frame", exc_info=True)
-            return InboundFrame(
-                opcode=0, cmd=0, seq=None, payload=None, raw=None
-            )
+            return InboundFrame(opcode=0, cmd=0, seq=None, payload=None, raw=None)

pymax/session/protocol.py

@@ -8,11 +8,7 @@ class StoreProtocol(Protocol):
     async def save_session(self, session_info: SessionInfo) -> None: ...
     async def update_token(self, old_token: str, new_token: str) -> None: ...
     async def load_session(self) -> SessionInfo | None: ...
-    async def load_session_by_device_id(
-        self, device_id: str
-    ) -> SessionInfo | None: ...
-    async def load_session_by_phone(
-        self, phone: str
-    ) -> SessionInfo | None: ...
+    async def load_session_by_device_id(self, device_id: str) -> SessionInfo | None: ...
+    async def load_session_by_phone(self, phone: str) -> SessionInfo | None: ...
     async def delete_session(self, token: str) -> None: ...
     async def close(self) -> None: ...

pymax/session/store.py

@@ -55,24 +55,12 @@ class SessionStore:
             )
             """
         )
-        await self._ensure_column(
-            conn, "mt_instance_id", "TEXT NOT NULL DEFAULT ''"
-        )
-        await self._ensure_column(
-            conn, "chats_sync", "INTEGER NOT NULL DEFAULT -1"
-        )
-        await self._ensure_column(
-            conn, "contacts_sync", "INTEGER NOT NULL DEFAULT -1"
-        )
-        await self._ensure_column(
-            conn, "drafts_sync", "INTEGER NOT NULL DEFAULT -1"
-        )
-        await self._ensure_column(
-            conn, "presence_sync", "INTEGER NOT NULL DEFAULT -1"
-        )
-        await self._ensure_column(
-            conn, "config_hash", "TEXT NOT NULL DEFAULT ''"
-        )
+        await self._ensure_column(conn, "mt_instance_id", "TEXT NOT NULL DEFAULT ''")
+        await self._ensure_column(conn, "chats_sync", "INTEGER NOT NULL DEFAULT -1")
+        await self._ensure_column(conn, "contacts_sync", "INTEGER NOT NULL DEFAULT -1")
+        await self._ensure_column(conn, "drafts_sync", "INTEGER NOT NULL DEFAULT -1")
+        await self._ensure_column(conn, "presence_sync", "INTEGER NOT NULL DEFAULT -1")
+        await self._ensure_column(conn, "config_hash", "TEXT NOT NULL DEFAULT ''")
         await conn.execute(
             """
             UPDATE sessions
@@ -93,9 +81,7 @@ class SessionStore:
             columns = {row["name"] for row in await cursor.fetchall()}
 
         if name not in columns:
-            await conn.execute(
-                f"ALTER TABLE sessions ADD COLUMN {name} {definition}"
-            )
+            await conn.execute(f"ALTER TABLE sessions ADD COLUMN {name} {definition}")
 
     async def save_session(self, session_info: SessionInfo) -> None:
         conn = await self._get_connection()
@@ -158,9 +144,7 @@ class SessionStore:
         )
         return self._row_to_session(row)
 
-    async def load_session_by_device_id(
-        self, device_id: str
-    ) -> SessionInfo | None:
+    async def load_session_by_device_id(self, device_id: str) -> SessionInfo | None:
         conn = await self._get_connection()
         logger.debug("loading session by device_id=%s", device_id)
         async with conn.execute(

pymax/telemetry/navigation.py

@@ -155,9 +155,7 @@ class NavigationPlanner:
             self.current_screen = self.history.pop()
             return self.current_screen
 
-        next_screen = self._weighted_choice(
-            self.rules.graph[self.current_screen]
-        )
+        next_screen = self._weighted_choice(self.rules.graph[self.current_screen])
         if next_screen != self.current_screen:
             self.history.append(self.current_screen)
             if len(self.history) > 4:

pymax/telemetry/service.py

@@ -82,20 +82,14 @@ class TelemetryService:
     async def _run(self) -> None:
         try:
             await asyncio.sleep(self._between(self._timing.startup_delay))
-            await self._send_events(
-                [self._payloads.login(self._user_id, self._session_id)]
-            )
+            await self._send_events([self._payloads.login(self._user_id, self._session_id)])
 
             while True:
                 self._session_id += 1
-                events = await self._collect_session_events(
-                    self._planner.new_profile()
-                )
+                events = await self._collect_session_events(self._planner.new_profile())
                 await self._send_events(events)
                 self._planner.reset_to_background()
-                await asyncio.sleep(
-                    self._between(self._timing.session_idle_delay)
-                )
+                await asyncio.sleep(self._between(self._timing.session_idle_delay))
 
         except asyncio.CancelledError:
             raise
@@ -163,9 +157,7 @@ class TelemetryService:
         except Exception:
             logger.debug("telemetry send failed", exc_info=True)
 
-    def _nav_event(
-        self, screen_from: Screen, screen_to: Screen
-    ) -> TelemetryEvent:
+    def _nav_event(self, screen_from: Screen, screen_to: Screen) -> TelemetryEvent:
         event = self._payloads.navigation(
             user_id=self._user_id,
             session_id=self._session_id,
@@ -212,11 +204,7 @@ class TelemetryService:
 
     @property
     def _ready(self) -> bool:
-        return (
-            self.app.started
-            and self.app.me is not None
-            and self.app.connection.is_open
-        )
+        return self.app.started and self.app.me is not None and self.app.connection.is_open
 
     @property
     def _user_id(self) -> int:

pymax/transport/tcp.py

@@ -10,9 +10,7 @@ logger = get_logger(__name__)
 
 
 class TCPTransport(Transport):
-    def __init__(
-        self, host: str, port: int, proxy: str | None, use_ssl: bool = True
-    ) -> None:
+    def __init__(self, host: str, port: int, proxy: str | None, use_ssl: bool = True) -> None:
         self._host = host
         self._port = port
         self._proxy = proxy

pymax/types/domain/attachments/__init__.py

@@ -8,4 +8,5 @@ from .keyboards import InlineKeyboardAttachment
 from .photo import PhotoAttachment
 from .share import ShareAttachment
 from .sticker import StickerAttachment
+from .unknown import UnknownAttachment
 from .video import VideoAttachment, VideoRequest

pymax/types/domain/attachments/audio.py

@@ -11,9 +11,9 @@ class AudioAttachment(CamelModel):
     """Аудио-вложение сообщения.
 
     :ivar duration: Длительность аудио.
-    :vartype duration: int
+    :vartype duration: int | None
     :ivar audio_id: ID аудио.
-    :vartype audio_id: int
+    :vartype audio_id: int | None
     :ivar wave: Данные waveform.
     :vartype wave: str | None
     :ivar transcription_status: Статус транскрибации.
@@ -26,8 +26,8 @@ class AudioAttachment(CamelModel):
     :vartype token: str | None
     """
 
-    duration: int
-    audio_id: int
+    duration: int | None = None
+    audio_id: int | None = None
     wave: str | None = None
     transcription_status: TranscriptionStatus | None = None
     url: str | None = None

pymax/types/domain/attachments/enums.py

@@ -14,6 +14,7 @@ class AttachmentType(str, Enum):
     CALL = "CALL"
     SHARE = "SHARE"
     INLINE_KEYBOARD = "INLINE_KEYBOARD"
+    UNKNOWN = "UNKNOWN"
 
 
 class TranscriptionStatus(str, Enum):

pymax/types/domain/attachments/unknown.py

@@ -0,0 +1,35 @@
+from typing import Any
+
+from pydantic import Field, model_validator
+
+from pymax.types.domain.base import CamelModel
+
+from .enums import AttachmentType
+
+KNOWN_ATTACHMENT_TYPES = {
+    attachment_type.value
+    for attachment_type in AttachmentType
+    if attachment_type != AttachmentType.UNKNOWN
+}
+
+
+class UnknownAttachment(CamelModel):
+    """Вложение неизвестного типа.
+
+    :ivar type: Тип вложения.
+    :vartype type: str
+    """
+
+    type: str = Field(alias="_type")
+
+    @model_validator(mode="before")
+    @classmethod
+    def reject_known_attachment_type(cls, value: Any) -> Any:
+        if not isinstance(value, dict):
+            return value
+
+        attachment_type = value.get("_type", value.get("type"))
+        if attachment_type in KNOWN_ATTACHMENT_TYPES:
+            raise ValueError("Known attachment type should be parsed by its own model")
+
+        return value

pymax/types/domain/attachments/video.py

@@ -31,7 +31,7 @@ class VideoAttachment(CamelModel):
     :ivar video_id: ID видео.
     :vartype video_id: int
     :ivar duration: Длительность видео.
-    :vartype duration: int
+    :vartype duration: int | None
     :ivar preview_data: Данные превью.
     :vartype preview_data: bytes
     :ivar type: Тип вложения.
@@ -47,7 +47,7 @@ class VideoAttachment(CamelModel):
     height: int
     width: int
     video_id: int
-    duration: int
+    duration: int | None = None
     preview_data: bytes
     type: Literal[AttachmentType.VIDEO] = Field(alias="_type")
     thumbnail: str

pymax/types/domain/auth.py

@@ -1,7 +1,10 @@
 from pydantic import BaseModel, Field
 
+from pymax.api.auth.enums import AuthType
 from pymax.api.models import CamelModel
 
+from .profile import Profile
+
 
 class StartAuthResponse(CamelModel):
     """Ответ на начало авторизации.
@@ -70,7 +73,7 @@ class CheckCodeResponse(CamelModel):
     :vartype password_challenge: PasswordChallenge | None
     """
 
-    token_attrs: TokenAttrs = Field(default_factory=TokenAttrs)
+    token_attrs: TokenAttrs = Field(default_factory=lambda: TokenAttrs.model_validate({}))
     password_challenge: PasswordChallenge | None = None
 
     @property
@@ -103,7 +106,7 @@ class CheckPasswordResponse(CamelModel):
     :vartype error: str | None
     """
 
-    token_attrs: TokenAttrs = Field(default_factory=TokenAttrs)
+    token_attrs: TokenAttrs = Field(default_factory=lambda: TokenAttrs.model_validate({}))
     error: str | None = None
 
     @property
@@ -159,3 +162,22 @@ class CheckQrResponse(CamelModel):
     """
 
     status: QrStatus
+
+
+class ConfirmRegistrationResponse(CamelModel):
+    """Ответ Max после регистрации нового аккаунта.
+
+    :ivar user_token: Внутренний ID зарегистрированного пользователя.
+    :vartype user_token: int
+    :ivar profile: Профиль зарегистрированного аккаунта.
+    :vartype profile: Profile
+    :ivar token_type: Тип выданного токена.
+    :vartype token_type: AuthType
+    :ivar token: Токен входа для новой сессии.
+    :vartype token: str
+    """
+
+    user_token: int
+    profile: Profile
+    token_type: AuthType
+    token: str

pymax/types/domain/chat.py

@@ -19,7 +19,8 @@ class Chat(CamelModel):
 
     Объекты чатов, полученные через клиент, обычно уже привязаны к сервисам
     сообщений и чатов. После этого можно вызывать удобные методы объекта:
-    :meth:`answer`, :meth:`history`, :meth:`leave`, :meth:`invite`,
+    :meth:`answer`, :meth:`history`, :meth:`get_message`,
+    :meth:`get_messages`, :meth:`leave`, :meth:`invite`,
     :meth:`remove_users`, :meth:`pin_message`, :meth:`update_settings` и
     :meth:`rework_invite_link`.
 
@@ -147,6 +148,10 @@ class Chat(CamelModel):
         """
         self._message_actions = message_actions
         self._chat_actions = chat_actions
+        if self.last_message is not None:
+            self.last_message.bind(message_actions)
+        if self.pinned_message is not None:
+            self.pinned_message.bind(message_actions)
         return self
 
     async def answer(
@@ -242,6 +247,38 @@ class Chat(CamelModel):
             interactive=interactive,
         )
 
+    async def get_message(self, message_id: int) -> Message | None:
+        """Возвращает сообщение этого чата по ID.
+
+        :param message_id: ID сообщения.
+        :type message_id: int
+        :returns: Сообщение или ``None``, если сервер его не вернул.
+        :rtype: Message | None
+        :raises RuntimeError: Если чат не привязан к клиенту.
+        """
+        actions, _ = self._bound()
+
+        return await actions.get_message(
+            chat_id=self.id,
+            message_id=message_id,
+        )
+
+    async def get_messages(self, message_ids: list[int]) -> list[Message]:
+        """Возвращает сообщения этого чата по ID.
+
+        :param message_ids: ID сообщений.
+        :type message_ids: list[int]
+        :returns: Список найденных сообщений.
+        :rtype: list[Message]
+        :raises RuntimeError: Если чат не привязан к клиенту.
+        """
+        actions, _ = self._bound()
+
+        return await actions.get_messages(
+            chat_id=self.id,
+            message_ids=message_ids,
+        )
+
     async def leave(self) -> None:
         """Выходит из группы или канала.
 

pymax/types/domain/element.py

@@ -4,7 +4,7 @@ from .base import CamelModel
 
 
 class ElementAttributes(CamelModel):
-    url: str
+    url: str | None = None
 
 
 class Element(CamelModel):
@@ -15,10 +15,10 @@ class Element(CamelModel):
     :ivar from_: Начальная позиция элемента.
     :vartype from_: int | None
     :ivar length: Длина элемента.
-    :vartype length: int
+    :vartype length: int | None
     """
 
     type: str
     from_: int | None = Field(serialization_alias="from", default=None)
-    length: int
+    length: int | None = None
     attributes: ElementAttributes | None = None