maxapi-python 2.0.1__tar.gz → 2.1.1__tar.gz

{maxapi_python-2.0.1 → maxapi_python-2.1.1}/.github/workflows/publish.yml

@@ -9,22 +9,52 @@ permissions:
   contents: read
 
 jobs:
+  release-checks:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          python-version: "3.10"
+          enable-cache: true
+
+      - name: Check lint
+        run: uv run ruff check src tests
+
+      - name: Check formatting
+        run: uv run ruff format --check src tests
+
+      - name: Run tests
+        run: uv run pytest
+
+      - name: Build docs
+        run: uv run sphinx-build -b html docs /tmp/pymax-docs
+
   release-build:
     runs-on: ubuntu-latest
+    needs: release-checks
 
     steps:
       - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
 
       - name: Set up uv
         uses: astral-sh/setup-uv@v4
         with:
           python-version: "3.10"
+          enable-cache: true
 
       - name: Build release distributions
         run: uv build
 
       - name: Check distributions
-        run: uvx twine check dist/*
+        run: uv run twine check dist/*
 
       - name: Upload distributions
         uses: actions/upload-artifact@v4

maxapi_python-2.1.1/.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+  - repo: local
+    hooks:
+      - id: ruff-check
+        name: ruff check
+        entry: uv run ruff check --fix
+        language: system
+        types_or: [python, pyi]
+
+      - id: ruff-format
+        name: ruff format
+        entry: uv run ruff format
+        language: system
+        types_or: [python, pyi]

{maxapi_python-2.0.1 → maxapi_python-2.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maxapi-python
-Version: 2.0.1
+Version: 2.1.1
 Summary: Python wrapper для API мессенджера Max
 Project-URL: Homepage, https://github.com/MaxApiTeam/PyMax
 Project-URL: Repository, https://github.com/MaxApiTeam/PyMax
@@ -196,6 +196,9 @@ client.include_router(router)
 
 ```bash
 uv sync --all-groups
+uv run pre-commit install
+uv run pre-commit run --all-files
+uv run pytest
 uv run python -c "import pymax; print(pymax.__all__)"
 uv run sphinx-build -b html docs docs/_build/html
 ```

{maxapi_python-2.0.1 → maxapi_python-2.1.1}/README.md

@@ -153,6 +153,9 @@ client.include_router(router)
 
 ```bash
 uv sync --all-groups
+uv run pre-commit install
+uv run pre-commit run --all-files
+uv run pytest
 uv run python -c "import pymax; print(pymax.__all__)"
 uv run sphinx-build -b html docs docs/_build/html
 ```

{maxapi_python-2.0.1 → maxapi_python-2.1.1}/docs/account.rst

@@ -32,21 +32,26 @@ Account
 Фотография профиля
 ------------------
 
-Сейчас ``change_profile(photo=...)`` не загружает файл напрямую. Для фото
-нужен ``photo_token`` от API Max:
+Передайте ``Photo`` в ``change_profile(photo=...)``, чтобы PyMax сам загрузил
+файл и применил новый токен фотографии:
 
 .. code-block:: python
 
-   upload_url = await client.request_profile_photo_upload_url()
-   print(upload_url)
+   from pymax import Photo
 
    await client.change_profile(
        first_name="Alex",
-       photo_token="PHOTO_TOKEN",
+       photo=Photo(path="avatar.jpg"),
    )
 
-Если передать ``photo`` вместо ``photo_token``, PyMax выбросит
-``NotImplementedError``.
+Если у вас уже есть токен фотографии от API Max, его можно передать напрямую:
+
+.. code-block:: python
+
+   await client.change_profile(
+       first_name="Alex",
+       photo_token="PHOTO_TOKEN",
+   )
 
 Папки чатов
 -----------
@@ -118,9 +123,9 @@ Account
    ``on_start`` или после успешного ``await client.start()`` в собственном
    lifecycle.
 
-``NotImplementedError`` при ``change_profile(photo=...)``
-   Прямая загрузка фото через параметр ``photo`` пока не реализована.
-   Используйте ``photo_token``.
+Фото профиля не обновилось
+   Если переданы и ``photo``, и ``photo_token``, PyMax загрузит ``photo`` и
+   использует новый токен загруженной фотографии.
 
 Папка создалась, но список старый
    Используйте ``get_folders()`` после изменения и сохраняйте новый

{maxapi_python-2.0.1 → maxapi_python-2.1.1}/docs/index.rst

@@ -18,6 +18,13 @@ PyMax - асинхронная Python-библиотека для Max API. Он
 минимальный рабочий пример с авторизацией, обработчиком сообщений и запуском
 клиента.
 
+.. toctree::
+   :maxdepth: 1
+   :caption: Новости
+
+   release-2-1-1
+   release-2-1-0
+
 .. toctree::
    :maxdepth: 2
    :caption: Руководство

maxapi_python-2.1.1/docs/release-2-1-0.rst

@@ -0,0 +1,43 @@
+PyMax 2.1.0
+===========
+
+Изменения относительно ``2.0.1``.
+
+Добавлено
+---------
+
+* Заявки на вступление в группы и каналы: ``get_join_requests()``,
+  ``confirm_join_request()`` /
+  ``confirm_join_requests()`` и отклонить их через ``decline_join_request()`` /
+  ``decline_join_requests()``.
+* Доменные типы ``Member`` и ``Presence`` для заявок.
+* 2FA: ``check_2fa()`` и ``change_password()``.
+* QR-вход: ``authorize_qr_login(qr_link)``.
+* Web app-боты: ``get_bot_init_data(bot_id, chat_id, start_param=None)``.
+
+Исправлено
+----------
+
+* TCP-заголовок приведен к схеме Max: ``ver:1``, ``cmd:1``, ``seq:2``,
+  ``opcode:2``, ``len/cof:4``. ``seq`` больше не падает после ``255``.
+* Upload фото, видео и файлов использует ``ExtraConfig.proxy`` для HTTP-отправки
+  на upload URL.
+* ``MaxApiError.title`` и ``MaxApiError.localized_message`` могут быть ``None``.
+
+Изменилось
+----------
+
+* ``check_2fa()`` возвращает ``False``, если профиль еще не загружен или сервер
+  не прислал ``profile_options``.
+* При заданном ``ExtraConfig.proxy`` upload-запросы тоже идут через proxy.
+  Proxy должен выдерживать большие HTTP POST-запросы.
+* ``Capability`` разделен на ``ProfileOptions`` и ``TwoFactorAction``.
+* ``ApiFacade`` получил ``bots``-сервис.
+
+Миграция
+--------
+
+* Код на ``Client`` и ``WebClient`` обычно менять не нужно.
+* Импорт ``pymax.api.auth.enums.Capability`` замените на ``TwoFactorAction`` или
+  ``ProfileOptions``.
+* Если код ждал строку в ``MaxApiError.title``, теперь нужно учитывать ``None``.

maxapi_python-2.1.1/docs/release-2-1-1.rst

@@ -0,0 +1,16 @@
+PyMax 2.1.1
+===========
+
+Изменения относительно ``2.1.0``.
+
+Добавлено
+---------
+
+* ``change_profile(photo=...)`` теперь загружает фотографию профиля напрямую.
+
+Исправлено
+----------
+
+* TLS-handshake при TCP-подключении через proxy передает ``server_hostname``.
+* Локальный токен обновляется после ``close_all_sessions()`` и при получении
+  нового токена во время handshake.

{maxapi_python-2.0.1 → maxapi_python-2.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "maxapi-python"
-version = "2.0.1"
+version = "2.1.1"
 description = "Python wrapper для API мессенджера Max"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -89,24 +89,32 @@ dev = [
   {include-group = "docs"},
   {include-group = "test"},
   "build>=1.2.0",
+  "pre-commit>=4.0.0",
   "twine>=5.0.0",
   "pyright>=1.1.390",
-  "black>=24.0.0",
-  "isort>=5.13.0",
-  "flake8>=7.0.0",
+  "ruff>=0.8.0",
 ]
 
 [tool.pyright]
 venv = ".venv"
 venvPath = "."
 
-[tool.black]
+[tool.ruff]
 line-length = 79
-target-version = ["py310"]
+target-version = "py310"
 
-[tool.flake8]
-max-line-length = 79
-max-complexity = 10
+[tool.ruff.lint]
+select = ["E", "F", "I"]
+ignore = ["E501"]
+
+[tool.ruff.lint.per-file-ignores]
+"src/pymax/**/__init__.py" = ["F401", "F403"]
+"tests/**" = ["F401"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+line-ending = "auto"
 
 [tool.mypy]
 python_version = "3.10"
@@ -114,12 +122,6 @@ warn_return_any = true
 warn_unused_configs = true
 plugins = ["pydantic.mypy"]
 
-[tool.isort]
-profile = "black"
-line_length = 79
-multi_line_output = 3
-include_trailing_comma = true
-
 [tool.pytest.ini_options]
 asyncio_mode = "auto"
 testpaths = ["tests"]

{maxapi_python-2.0.1 → maxapi_python-2.1.1}/src/pymax/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "2.0.1"
+__version__ = "2.1.1"
 
 
 from .auth import (

maxapi_python-2.1.1/src/pymax/api/auth/enums.py

@@ -0,0 +1,28 @@
+from enum import Enum
+
+
+class AuthType(str, Enum):
+    START_AUTH = "START_AUTH"
+    CHECK_CODE = "CHECK_CODE"
+    REGISTER = "REGISTER"
+    RESEND = "RESEND"
+
+
+class ProfileOptions(int, Enum):
+    """Битовые/числовые признаки профиля, связанные с 2FA."""
+
+    ESIA_VERIFIED_FLAG = 1
+    SECOND_FACTOR_PASSWORD_ENABLED = 2
+    SECOND_FACTOR_HAS_EMAIL = 3
+    SECOND_FACTOR_HAS_HINT = 4
+
+
+class TwoFactorAction(int, Enum):
+    """Действия 2FA, передаваемые в expectedCapabilities."""
+
+    SET_PASSWORD = 0
+    UPDATE_PASSWORD = 1
+    RESTORE_PASSWORD = 2
+    HINT = 3
+    EMAIL = 4
+    REMOVE_2FA = 5

{maxapi_python-2.0.1 → maxapi_python-2.1.1}/src/pymax/api/auth/payloads.py

@@ -1,10 +1,10 @@
-from pydantic import Field, field_serializer
+from pydantic import Field
 
 from pymax.api.models import CamelModel
 from pymax.api.session.payloads import MobileUserAgentPayload
 from pymax.types.domain.sync import DEFAULT_CONFIG_HASH, ConfigHash, SyncState
 
-from .enums import AuthType, Capability
+from .enums import AuthType, TwoFactorAction
 
 
 class RequestCodePayload(CamelModel):
@@ -115,7 +115,7 @@ class SetHintPayload(CamelModel):
 
 
 class SetTwoFactorPayload(CamelModel):
-    expected_capabilities: list[Capability]
+    expected_capabilities: list[TwoFactorAction]
     track_id: str
     password: str
     hint: str | None = None
@@ -123,7 +123,11 @@ class SetTwoFactorPayload(CamelModel):
 
 class RemoveTwoFactorPayload(CamelModel):
     track_id: str
-    remove2fa: bool = True
-    expected_capabilities: list[Capability] = Field(
-        default_factory=lambda: [Capability.REMOVE_2FA]
+    remove2fa: bool = Field(default=True, alias="remove2fa")
+    expected_capabilities: list[TwoFactorAction] = Field(
+        default_factory=lambda: [TwoFactorAction.REMOVE_2FA]
     )
+
+
+class ApproveQrLoginPayload(CamelModel):
+    qr_link: str

{maxapi_python-2.0.1 → maxapi_python-2.1.1}/src/pymax/api/auth/service.py

@@ -2,7 +2,11 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING
 
-from pymax.api.response import payload_item, payload_keys, require_payload_model
+from pymax.api.response import (
+    payload_item,
+    payload_keys,
+    require_payload_model,
+)
 from pymax.api.session.enums import DeviceType
 from pymax.auth import EmailCodeProvider
 from pymax.auth.providers import ConsoleEmailCodeProvider
@@ -17,8 +21,9 @@ from pymax.types.domain.auth import (
 )
 from pymax.types.domain.login import LoginResponse
 
-from .enums import Capability
+from .enums import ProfileOptions, TwoFactorAction
 from .payloads import (
+    ApproveQrLoginPayload,
     CheckPasswordChallengePayload,
     CheckQrPayload,
     ConfirmQrPayload,
@@ -51,14 +56,18 @@ class AuthService:
     async def request_code(self, phone: str) -> StartAuthResponse:
         logger.info("requesting sms code phone_set=%s", bool(phone))
         frame = RequestCodePayload(phone=phone)
-        response = await self.app.invoke(Opcode.AUTH_REQUEST, frame.to_payload())
+        response = await self.app.invoke(
+            Opcode.AUTH_REQUEST, frame.to_payload()
+        )
         logger.debug(
             "sms code request accepted payload_keys=%s",
             payload_keys(response),
         )
         return require_payload_model(response, StartAuthResponse)
 
-    async def send_code(self, token: str, verify_code: str) -> CheckCodeResponse:
+    async def send_code(
+        self, token: str, verify_code: str
+    ) -> CheckCodeResponse:
         logger.info(
             "sending sms code token_set=%s code_set=%s",
             bool(token),
@@ -152,14 +161,18 @@ class AuthService:
     async def check_qr(self, track_id: str) -> CheckQrResponse:
         frame = CheckQrPayload(track_id=track_id)
 
-        response = await self.app.invoke(Opcode.GET_QR_STATUS, frame.to_payload())
+        response = await self.app.invoke(
+            Opcode.GET_QR_STATUS, frame.to_payload()
+        )
 
         return require_payload_model(response, CheckQrResponse)
 
     async def confirm_qr(self, track_id: str) -> CheckCodeResponse:
         frame = ConfirmQrPayload(track_id=track_id)
 
-        response = await self.app.invoke(Opcode.LOGIN_BY_QR, frame.to_payload())
+        response = await self.app.invoke(
+            Opcode.LOGIN_BY_QR, frame.to_payload()
+        )
 
         return require_payload_model(response, CheckCodeResponse)
 
@@ -182,11 +195,15 @@ class AuthService:
         logger.debug("creating auth track")
         frame = CreateAuthTrackPayload()
 
-        response = await self.app.invoke(Opcode.AUTH_CREATE_TRACK, frame.to_payload())
+        response = await self.app.invoke(
+            Opcode.AUTH_CREATE_TRACK, frame.to_payload()
+        )
 
         return payload_item(response, "trackId", str)
 
-    async def _set_email(self, track_id: str, email: str, provider: EmailCodeProvider) -> bool:
+    async def _set_email(
+        self, track_id: str, email: str, provider: EmailCodeProvider
+    ) -> bool:
         logger.info("setting 2fa email email_set=%s", bool(email))
 
         frame = RequestEmailCodePayload(
@@ -225,7 +242,9 @@ class AuthService:
             track_id=track_id,
             password=password,
         )
-        await self.app.invoke(Opcode.AUTH_VALIDATE_PASSWORD, frame.to_payload())
+        await self.app.invoke(
+            Opcode.AUTH_VALIDATE_PASSWORD, frame.to_payload()
+        )
 
         return True
 
@@ -263,13 +282,13 @@ class AuthService:
             await self._set_hint(track_id, str(hint))
             has_hint = True
 
-        expected_capabilities = [Capability.DEFAULT]
+        expected_capabilities = [TwoFactorAction.SET_PASSWORD]
 
         if has_hint:
-            expected_capabilities.append(Capability.SECOND_FACTOR_HAS_HINT)
+            expected_capabilities.append(TwoFactorAction.HINT)
 
         if has_email:
-            expected_capabilities.append(Capability.SECOND_FACTOR_HAS_EMAIL)
+            expected_capabilities.append(TwoFactorAction.EMAIL)
 
         frame = SetTwoFactorPayload(
             track_id=track_id,
@@ -311,3 +330,47 @@ class AuthService:
         await self.app.invoke(Opcode.AUTH_SET_2FA, frame.to_payload())
 
         return True
+
+    async def authorize_qr_login(self, qr_link: str) -> bool:
+        logger.info("approving qr login qr_link_set=%s", bool(qr_link))
+
+        frame = ApproveQrLoginPayload(qr_link=qr_link)
+
+        await self.app.invoke(Opcode.AUTH_QR_APPROVE, frame.to_payload())
+
+        return True
+
+    async def check_2fa(self) -> bool:
+        if not self.app.me or not self.app.me.profile_options:
+            return False
+
+        return (
+            ProfileOptions.SECOND_FACTOR_PASSWORD_ENABLED
+            in self.app.me.profile_options
+        )
+
+    async def change_password(
+        self, password_old: str, password_new: str
+    ) -> bool:
+        track_id = await self._get_track_id()
+
+        if not track_id:
+            logger.error("missing track_id in auth create track response")
+            raise RuntimeError("Failed to create auth track")
+
+        await self._check_2fa_password(track_id, password_old)
+
+        await self._set_password(track_id, password_new)
+
+        expected_capabilities = [TwoFactorAction.UPDATE_PASSWORD]
+
+        frame = SetTwoFactorPayload(
+            track_id=track_id,
+            password=password_new,
+            hint=None,
+            expected_capabilities=expected_capabilities,
+        )
+
+        await self.app.invoke(Opcode.AUTH_SET_2FA, frame.to_payload())
+        logger.info("2fa password set successfully")
+        return True

maxapi_python-2.1.1/src/pymax/api/bots/__init__.py

@@ -0,0 +1 @@
+from .service import BotsService

maxapi_python-2.1.1/src/pymax/api/bots/payloads.py

@@ -0,0 +1,7 @@
+from pymax.api.models import CamelModel
+
+
+class RequestInitDataPayload(CamelModel):
+    bot_id: int
+    chat_id: int
+    start_param: str | None = None

maxapi_python-2.1.1/src/pymax/api/bots/service.py

@@ -0,0 +1,35 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from pymax.api.response import require_payload_model
+from pymax.logging import get_logger
+from pymax.protocol import Opcode
+from pymax.types.domain import InitData
+
+from .payloads import RequestInitDataPayload
+
+if TYPE_CHECKING:
+    from pymax.app import App
+
+
+logger = get_logger(__name__)
+
+
+class BotsService:
+    def __init__(self, app: App) -> None:
+        self.app = app
+
+    async def get_init_data(
+        self,
+        bot_id: int,
+        chat_id: int,
+        start_param: str | None = None,
+    ) -> InitData:
+        frame = RequestInitDataPayload(
+            bot_id=bot_id, chat_id=chat_id, start_param=start_param
+        )
+        response = await self.app.invoke(
+            Opcode.WEB_APP_INIT_DATA, frame.to_payload()
+        )
+        return require_payload_model(response, InitData)

{maxapi_python-2.0.1 → maxapi_python-2.1.1}/src/pymax/api/chats/enums.py

@@ -21,6 +21,7 @@ class ChatOption(str, Enum):
 class ChatPayloadKey(str, Enum):
     CHAT = "chat"
     CHATS = "chats"
+    MEMBERS = "members"
 
 
 class ChatLinkPrefix(str, Enum):

{maxapi_python-2.0.1 → maxapi_python-2.1.1}/src/pymax/api/chats/payloads.py

@@ -101,3 +101,17 @@ class LeaveChatPayload(CamelModel):
 
 class FetchChatsPayload(CamelModel):
     marker: int
+
+
+class FetchJoinRequests(CamelModel):
+    chat_id: int
+    type: str = "JOIN_REQUEST"  # ENUM!!!!!
+    count: int = 100
+
+
+class JoinRequestActionPayload(CamelModel):
+    chat_id: int
+    user_ids: list[int]
+    type: str = "JOIN_REQUEST"  # TODO: ENUMM!!!
+    show_history: bool | None = True
+    operation: ChatMemberOperation