aioqzone 1.8.2.dev1__tar.gz → 1.8.3.dev1__tar.gz

{aioqzone-1.8.2.dev1 → aioqzone-1.8.3.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aioqzone
-Version: 1.8.2.dev1
+Version: 1.8.3.dev1
 Summary: A Python wrapper for Qzone login and H5 APIs.
 Home-page: https://github.com/aioqzone/aioqzone
 License: AGPL-3.0
@@ -23,7 +23,7 @@ Provides-Extra: slide-captcha
 Requires-Dist: aiohttp (>=3.8.5,<4.0.0)
 Requires-Dist: exceptiongroup (>=1.1.1,<2.0.0)
 Requires-Dist: pillow (>=10.0.1,<11.0.0)
-Requires-Dist: pychaosvm (>=0.3.4,<0.4.0)
+Requires-Dist: pychaosvm (>=0.3.4,<0.5.0)
 Requires-Dist: pydantic (>=2.0.3,<3.0.0)
 Requires-Dist: pydantic-settings (>=2.0.2,<3.0.0)
 Requires-Dist: rsa (>=4.8,<5.0)
@@ -43,7 +43,7 @@ aioqzone封装了一些Qzone接口。
 [![python](https://img.shields.io/pypi/pyversions/aioqzone?logo=python&logoColor=white)][home]
 [![version](https://img.shields.io/pypi/v/aioqzone?logo=python)][pypi]
 [![style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-[![discuss](https://img.shields.io/badge/dynamic/xml?style=social&logo=telegram&label=Discuss&query=%2F%2Fdiv%5B%40class%3D%22tgme_page_extra%22%5D&url=https%3A%2F%2Ft.me%2Faioqzone_chatroom)](https://t.me/aioqzone_chatrooom)
+[![discuss](https://img.shields.io/badge/dynamic/xml?style=social&logo=telegram&label=Discuss&query=%2F%2Fdiv%5B%40class%3D%22tgme_page_extra%22%5D&url=https%3A%2F%2Ft.me%2Faioqzone_chatroom)](https://t.me/aioqzone_chatroom)
 
 [English](README_en.md) | 简体中文
 

{aioqzone-1.8.2.dev1 → aioqzone-1.8.3.dev1}/README.md

@@ -5,7 +5,7 @@ aioqzone封装了一些Qzone接口。
 [![python](https://img.shields.io/pypi/pyversions/aioqzone?logo=python&logoColor=white)][home]
 [![version](https://img.shields.io/pypi/v/aioqzone?logo=python)][pypi]
 [![style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-[![discuss](https://img.shields.io/badge/dynamic/xml?style=social&logo=telegram&label=Discuss&query=%2F%2Fdiv%5B%40class%3D%22tgme_page_extra%22%5D&url=https%3A%2F%2Ft.me%2Faioqzone_chatroom)](https://t.me/aioqzone_chatrooom)
+[![discuss](https://img.shields.io/badge/dynamic/xml?style=social&logo=telegram&label=Discuss&query=%2F%2Fdiv%5B%40class%3D%22tgme_page_extra%22%5D&url=https%3A%2F%2Ft.me%2Faioqzone_chatroom)](https://t.me/aioqzone_chatroom)
 
 [English](README_en.md) | 简体中文
 

{aioqzone-1.8.2.dev1 → aioqzone-1.8.3.dev1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "aioqzone"
-version = "1.8.2.dev1"
+version = "1.8.3.dev1"
 description = "A Python wrapper for Qzone login and H5 APIs."
 authors = ["aioqzone <zzzzss990315@gmail.com>"]
 license = "AGPL-3.0"
@@ -36,7 +36,7 @@ tenacity = "^8.2.3"
 exceptiongroup = "^1.1.1"
 tylisten = "^2.1.3"
 pillow = "^10.0.1"
-pychaosvm = { version = "~0.3.4", source = "aioqzone-index" }
+pychaosvm = { version = ">=0.3.4,<0.5.0", source = "aioqzone-index" }
 slide-tc = {version = "~0.1.1", optional = true, source = "aioqzone-index" }
 
 [tool.poetry.extras]
@@ -47,8 +47,8 @@ slide-captcha = ["slide-tc"]
 optional = false
 
 [tool.poetry.group.test.dependencies]
-pytest = "^7.4.0"
-pytest-asyncio = "~0.21.0"
+pytest = "^8.2.0"
+pytest-asyncio = "~0.21.2"
 
 [tool.poetry.group.dev]
 optional = true

{aioqzone-1.8.2.dev1 → aioqzone-1.8.3.dev1}/src/aioqzone/model/api/__init__.py

@@ -12,6 +12,8 @@ TyHttpMethod = t.Union[t.Literal["GET"], t.Literal["POST"]]
 
 
 class QzoneApi(BaseModel, t.Generic[TyRequest, TyResponse]):
+    """The base class for all Qzone APIs below."""
+
     host: t.ClassVar[str] = "https://h5.qzone.qq.com"
     http_method: t.ClassVar[TyHttpMethod]
     path: t.ClassVar[str]

{aioqzone-1.8.2.dev1 → aioqzone-1.8.3.dev1}/src/aioqzone/model/api/profile.py

@@ -1,6 +1,7 @@
 """
 Qzone uses different feed schemes for ``/mqzone/profile``. This module patches :mod:`.feed`.
 """
+
 import typing as t
 
 from pydantic import AliasPath, BaseModel, Field, HttpUrl, field_validator, model_validator

{aioqzone-1.8.2.dev1 → aioqzone-1.8.3.dev1}/src/aioqzone/model/protocol/__init__.py

@@ -1,6 +1,7 @@
 """This module defines types that are used internally by aioqzone and its plugins.
 These types are not designed to represent responses from Qzone.
 """
+
 from pydantic import BaseModel
 
 from .config import *

{aioqzone-1.8.2.dev1 → aioqzone-1.8.3.dev1}/src/aioqzone/model/protocol/config.py

@@ -26,3 +26,5 @@ class QrLoginConfig(LoginConfig):
     """Maximum QR code refresh times."""
     poll_freq: float = 3
     """QR status polling interval."""
+    no_push: bool = False
+    """Do not try to push the QR code to user's client."""

{aioqzone-1.8.2.dev1 → aioqzone-1.8.3.dev1}/src/aioqzone/utils/regex.py

@@ -1,6 +1,7 @@
 """
 some patterns for matching html and so on.
 """
+
 import re
 
 # use this to match qzone api response

{aioqzone-1.8.2.dev1 → aioqzone-1.8.3.dev1}/src/aioqzone/utils/retry.py

@@ -14,8 +14,7 @@ class RetryIfCode(retry_if_exception, Generic[_E]):
 
     @classmethod
     @abstractmethod
-    def get_code(cls, exc: _E) -> int:
-        ...
+    def get_code(cls, exc: _E) -> int: ...
 
     def __init__(self, *code: int) -> None:
         super().__init__(lambda exc: isinstance(exc, self._exc_cls) and self.get_code(exc) in code)

aioqzone-1.8.3.dev1/src/qqqr/__init__.py

@@ -0,0 +1,4 @@
+"""
+QQQR is an API-level simulation of Qzone web login process. Currently this package
+includes QR login and password login. A captcha verifier is also contained to pass TDC.
+"""

{aioqzone-1.8.2.dev1 → aioqzone-1.8.3.dev1}/src/qqqr/qr/__init__.py

@@ -28,13 +28,17 @@ PTLOGIN2 = URL("https://ptlogin2.qq.com")
 
 @dataclass(unsafe_hash=True)
 class QR:
+    """Class :class:`QR` represents a QR code."""
+
     png: t.Optional[bytes]
-    """If None, the QR is pushed to user's client."""
+    """QR code content. If None, the QR is pushed to user's client."""
     sig: str
     expired: bool = False
+    """Whether the QR code is expired."""
 
     @property
     def pushed(self):
+        """Whether the QR code is pushed to user's client."""
         return self.png is None
 
 
@@ -49,9 +53,12 @@ class QrSession(LoginSession):
     ) -> None:
         super().__init__(login_sig=login_sig, create_time=create_time)
         self.refreshed = refresh_times
+        """QR code refresh times counter."""
         self.current_qr = first_qr
+        """A :class:`QrSession` keeps a :class:`QR` object as current QR code."""
 
     def new_qr(self, qr: QR):
+        """Add a new QR code to this session."""
         self.current_qr.expired = True
         self.current_qr = qr
         self.refreshed += 1
@@ -61,14 +68,36 @@ class _QrHookMixin:
     def __init__(self, *args, **kwds) -> None:
         super().__init__(*args, **kwds)
         self.qr_fetched = MT.qr_fetched.with_timeout(60)
+        """This emitter is triggered when a QR code is fetched."""
         self.qr_cancelled = MT.qr_cancelled()
+        """This emitter is triggered when QR login is cancelled."""
         self.cancel = asyncio.Event()
+        """Async-event indicating whether the loop should cancel the QR login."""
         self.refresh = asyncio.Event()
+        """Async-event indicating whether the loop should refresh the QR code immediately."""
 
 
 class QrLogin(LoginBase[QrSession], _QrHookMixin):
-    async def new(self) -> QrSession:
+    async def new(self, no_push=False) -> QrSession:
+        """Create a :class:`QrSession`. This method will:
+
+        1. GET ``xlogin`` url to get ``pt_login_sig`` cookie;
+
+        #. Try "quick login" (the QR code is pushed to user's client);
+
+        #. Whether the QR code is pushed or not, a :class:`QR` object is created
+           and is hold by the returned :class:`QrSession`.
+
+        :param no_push: Do not try to push the QR code to user's client.
+        :return: a :class:`QrSession`
+
+        .. versionchanged:: 1.8.3
+
+            Added :obj:`no_push` param.
+        """
         login_sig = await self._pt_login_sig()
+        if no_push:
+            return QrSession(await self.show(), login_sig=login_sig)
 
         cookie = self.client.cookie_jar.filter_cookies(PTLOGIN2).get("pt_guid_sig")
         push_qr = False
@@ -88,6 +117,11 @@ class QrLogin(LoginBase[QrSession], _QrHookMixin):
         return QrSession(await self.show(push_qr), login_sig=login_sig)
 
     async def show(self, push_qr=False) -> QR:
+        """This method will call ``ptqrshow`` api and wrap the response QR bytes into :class:`QR`.
+
+        :param push_qr: push QR to mobile client.
+        :return: a :class:`QR` object.
+        """
         data = {
             "appid": self.app.appid,
             "daid": self.app.daid,
@@ -125,7 +159,7 @@ class QrLogin(LoginBase[QrSession], _QrHookMixin):
     async def poll(self, sess: QrSession) -> PollResp:
         """Poll QR status.
 
-        :raise `httpx.HTTPStatusError`: if response status code != 200
+        :raise `aiohttp.ClientResponseError`: if response status code != 200
 
         :return: a poll response object
         """
@@ -166,26 +200,37 @@ class QrLogin(LoginBase[QrSession], _QrHookMixin):
         *,
         refresh_times: int = 6,
         poll_freq: float = 3,
+        no_push=False,
     ):
-        """Loop until cookie is returned or max `refresh_times` exceeds.
-        - This method will emit :meth:`QrEvent.QrFetched` event if a new qrcode is fetched.
-        - If qr is not scanned after `refresh_times`, it will raise :exc:`asyncio.TimeoutError`.
-        - If :obj:`QrEvent.refresh_flag` is set, it will refresh qrcode at once without increasing expire counter.
-        - If :obj:`QrEvent.cancel_flag` is set, it will raise :exc:`UserBreak` before next polling.
+        """Loop until cookie is returned or max :obj:`refresh_times` exceeds.
+
+        - This method will emit :obj:`.qr_fetched` event if a new qrcode is fetched.
+
+        - If the QR code is not scanned after :obj:`refresh_times`,
+          it will raise :exc:`~qqqr.exception.UserTimeout`.
+
+        - If :obj:`.refresh` is set, it will refresh qrcode at once without increasing expire counter.
+
+        - If :obj:`.cancel` is set, it will raise :exc:`~qqqr.exception.UserBreak` before next polling.
 
         :meta public:
         :param refresh_times: max qr expire times.
         :param poll_freq: interval between two status polling, in seconds, default as 3.
+        :param no_push: Do not try to push the QR code to user's client.
+
+        :raise `UserTimeout`: if the QR code is not scanned after :obj:`refresh_times` expires.
+        :raise `UserBreak`: if :obj:`.cancel` is set.
+
+        .. versionchanged:: 1.8.3
 
-        :raise `UserTimeout`: if qr is not scanned after `refresh_times` expires.
-        :raise `UserBreak`: if :obj:`QrEvent.cancel_flag` is set.
+            Added :obj:`no_push` param.
         """
         self.refresh.clear()
         self.cancel.clear()
 
         cnt_expire = 0
         renew = False
-        sess = await self.new()
+        sess = await self.new(no_push)
 
         while cnt_expire < refresh_times:
             # BUG: should we wrap hook errors here?
@@ -202,6 +247,7 @@ class QrLogin(LoginBase[QrSession], _QrHookMixin):
                 await asyncio.sleep(poll_freq)
                 stat = await self.poll(sess)
                 if stat.code == StatusCode.Expired:
+                    sess.current_qr.expired = True
                     cnt_expire += 1
                     break
                 elif stat.code == StatusCode.Authenticated:

{aioqzone-1.8.2.dev1 → aioqzone-1.8.3.dev1}/src/qqqr/up/captcha/capsess.py

@@ -88,8 +88,7 @@ class BaseTcaptchaSession(ABC):
             )
 
     @abstractmethod
-    async def get_captcha_problem(self, client: ClientAdapter):
-        ...
+    async def get_captcha_problem(self, client: ClientAdapter): ...
 
     @abstractmethod
     async def solve_captcha(self) -> str:

{aioqzone-1.8.2.dev1 → aioqzone-1.8.3.dev1}/src/qqqr/up/web.py

@@ -99,6 +99,7 @@ class _UpHookMixin:
     def __init__(self, *args, **kwds) -> None:
         super().__init__(*args, **kwds)
         self.sms_code_input = MT.sms_code_input.with_timeout(60)
+        """This emitter is triggered when SMS verify code is needed during login."""
 
 
 class UpWebLogin(LoginBase[UpWebSession], _UpHookMixin):
@@ -132,17 +133,21 @@ class UpWebLogin(LoginBase[UpWebSession], _UpHookMixin):
             self.client, self.app.appid, str(self.login_page_url), fake_ip=fake_ip
         )
 
-    async def new(self):
-        """Create a :class:`UpWebSession`. This will call `check` api of Qzone, and receive result
-        about whether this login needs a captcha, sms verification, etc.
+    async def new(self) -> UpWebSession:
+        """Create a :class:`UpWebSession`. This will trigger a GET to ``xlogin`` url.
 
-        :raise `httpx.HTTPStatusError`:
+        :raise `aiohttp.ClientResponseError`: if response status != 200
 
         :return: a up login session
         """
         return UpWebSession(await self._pt_login_sig())
 
     async def check(self, sess: UpWebSession):
+        """This will call ``check`` api of Qzone, and receive result about
+        whether this login needs a captcha, sms verification, etc.
+
+        :param sess: Session got from :meth:`~UpWebLogin.new`.
+        """
         data = {
             "regmaster": "",
             "pt_tea": 2,
@@ -217,7 +222,7 @@ class UpWebLogin(LoginBase[UpWebSession], _UpHookMixin):
         data.update(const)
         return data
 
-    async def try_login(self, sess: UpWebSession):
+    async def try_login(self, sess: UpWebSession) -> LoginResp:
         """
         Check if current session meets the login condition.
         It takes a session object and returns response of this try.

{aioqzone-1.8.2.dev1 → aioqzone-1.8.3.dev1}/src/qqqr/utils/iter.py

@@ -5,8 +5,9 @@ D = t.TypeVar("D")
 
 
 @t.overload
-def first(it: t.Iterable[T], pred: t.Optional[t.Callable[[T], t.Optional[object]]] = None) -> T:
-    ...
+def first(
+    it: t.Iterable[T], pred: t.Optional[t.Callable[[T], t.Optional[object]]] = None
+) -> T: ...
 
 
 @t.overload
@@ -15,8 +16,7 @@ def first(
     pred: t.Optional[t.Callable[[T], t.Optional[object]]] = None,
     *,
     default: D,
-) -> t.Union[T, D]:
-    ...
+) -> t.Union[T, D]: ...
 
 
 def first(

{aioqzone-1.8.2.dev1 → aioqzone-1.8.3.dev1}/src/qqqr/utils/jsjson.py

@@ -10,9 +10,13 @@ JsonValue = Union[bool, int, str, JsonDict, JsonList]
 
 
 class AstLoader:
-    """`AstLoader` uses standard :mod:`ast` module to parse the js/json"""
+    """:class:`AstLoader` uses standard :mod:`ast` module to parse the js/json"""
 
     class RewriteUndef(ast.NodeTransformer):
+        """
+        :meta private:
+        """
+
         const = {
             "undefined": ast.Constant(value=None),
             "null": ast.Constant(value=None),
@@ -28,12 +32,12 @@ class AstLoader:
     @classmethod
     def json_loads(cls, js: str, filename: str = "stdin") -> JsonValue:
         """
-        The json_loads function loads a JSON object from a js/json string. It uses standard
+        The :meth:`~AstLoader.json_loads` function loads a JSON object from a js/json string. It uses standard
         :mod:`ast` module to parse the js/json.
 
         :param js: Used to Pass the js/json string to be parsed.
         :param filename: Used to Specify the name of the file that is being read. This is only for debug use.
-        :return: A jsonvalue object.
+        :return: A :obj:`JsonValue` object.
         """
         js = dedent(js).replace(r"\/", "/")
         node = ast.parse(js, mode="eval")
@@ -43,14 +47,14 @@ class AstLoader:
 
 
 def json_loads(js: str) -> JsonValue:
-    """The json_loads function converts a string representation of JS/JSON data into a Python object.
+    """The :meth:`json_loads` function converts a string representation of JS/JSON data into a Python object.
     Current implementation is using :external+python:mod:`ast`.
 
-    If you need more parameters or another implementation, call `xxxLoader.json_loads` instead.
-
     .. seealso:: :meth:`.AstLoader.json_loads`
 
+    If you need more parameters or another implementation, call ``xxxLoader.json_loads`` instead.
+
     :param js: Used to Pass the JS/JSON string.
-    :return: A jsonvalue object.
+    :return: A :obj:`JsonValue` object.
     """
     return AstLoader.json_loads(js)

{aioqzone-1.8.2.dev1 → aioqzone-1.8.3.dev1}/src/qqqr/utils/net.py

@@ -9,12 +9,12 @@ __all__ = ["raise_for_status", "get_all_cookie", "ClientAdapter"]
 
 
 def raise_for_status(response: Response, *accept_code: int):
-    """A checker more strict than :meth:`~httpx.Response.raise_for_status`.
+    """A checker more strict than :meth:`~aiohttp.ClientResponse.raise_for_status`.
 
     :param response: Client response to check.
     :param accept_code: Overwrite codes that can be accepted, If not given, default is `(200, )`
 
-    :raise `httpx.HTTPStatusError`: if status not in :obj:`accept_code`
+    :raise `aiohttp.ClientResponseError`: if status not in :obj:`accept_code`
     """
     response.raise_for_status
     accept_code = accept_code or (200,)

aioqzone-1.8.2.dev1/src/qqqr/__init__.py

@@ -1,4 +0,0 @@
-"""
-QQQR is a simulation of Qzone web login process. Including QR login and password login.
-A captcha verifier is also contained to pass TDC.
-"""