aioqzone 1.9.5.dev4__tar.gz → 1.9.5.dev6__tar.gz

{aioqzone-1.9.5.dev4 → aioqzone-1.9.5.dev6}/.github/workflows/sphinx.yml

@@ -1,12 +1,11 @@
 name: Sphinx Build and Deploy
 
 on:
+  workflow_dispatch:
   pull_request:
     types:
       - review_requested
-    branches:
-      - beta
-  push:
+      - closed
     branches:
       - beta
     paths:
@@ -46,13 +45,17 @@ jobs:
           done
 
       - name: Upload artifact
-        if: github.event_name == 'push'
+        if: |
+          github.event_name == 'workflow_dispatch' ||
+          (github.event_name == 'pull_request' && github.event.action == 'closed')
         uses: actions/upload-pages-artifact@v4
         with:
           path: doc/build/html
 
   deploy:
-    if: github.event_name == 'push'
+    if: |
+      github.event_name == 'workflow_dispatch' ||
+      (github.event_name == 'pull_request' && github.event.action == 'closed')
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}

{aioqzone-1.9.5.dev4 → aioqzone-1.9.5.dev6}/.pre-commit-config.yaml

@@ -17,19 +17,19 @@ repos:
     hooks:
       - id: isort
         name: sort imports
-        entry: uv run ruff check --select I --fix
+        entry: uv run --active ruff check --select I --fix
         pass_filenames: false
         language: system
         types: [python]
       - id: black
         name: format
-        entry: uv run ruff format
+        entry: uv run --active ruff format
         pass_filenames: false
         language: system
         types: [python]
       - id: pytest
         name: pytest-check
-        entry: uv run pytest test
+        entry: uv run --active pytest test
         language: system
         pass_filenames: false
         types: [python, toml]

{aioqzone-1.9.5.dev4 → aioqzone-1.9.5.dev6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aioqzone
-Version: 1.9.5.dev4
+Version: 1.9.5.dev6
 Summary: A Python wrapper for Qzone login and H5 APIs.
 Project-URL: Homepage, https://github.com/aioqzone/aioqzone
 Project-URL: Repository, https://github.com/aioqzone/aioqzone
@@ -52,14 +52,14 @@ aioqzone封装了一些Qzone接口。
 
 - [x] [二维码登录](src/qqqr/qr/)
 - [x] [密码登录](src/qqqr/up/) (受限)
-- [x] [通过滑动验证码](src/qqqr/up/captcha/slide)
+- [x] [通过滑动验证码](src/qqqr/up/captcha/slide) ([slide-tc][slide-tc])
 - [x] [解析图片选择验证码](src/qqqr/up/captcha/select)
 - [ ] [通过网络环境检测][pychaosvm]
 - [x] 爬取HTML说说
 - [x] 爬取说说详细内容
 - [x] 点赞/取消赞
-- [x] 发布(仅文字)/修改/删除说说
-- [x] 发评论
+- [x] 发布/修改/删除说说（图文）
+- [x] 发评论/删评论（图文）
 
 ### 为什么选择 aioqzone
 
@@ -72,6 +72,7 @@ aioqzone封装了一些Qzone接口。
 __在做了:__
 
 - [ ] 完善的测试覆盖
+- [x] [示例代码](https://aioqzone.github.io/aioqzone/examples.html)
 
 ## 包描述
 
@@ -114,5 +115,6 @@ along with this program.  If not, see <https://www.gnu.org/licenses/>.
 [home]: https://github.com/aioqzone/aioqzone "Python wrapper for Qzone web login and Qzone http api"
 [aioqzone-feed]: https://github.com/aioqzone/aioqzone-feed "aioqzone plugin providing higher level api for processing feed"
 [pychaosvm]: https://github.com/aioqzone/pychaosvm "A Python envirionment for Tencent ChaosVM."
+[slide-tc]: https://github.com/aioqzone/slide-tc "An aioqzone plugin for solving slide captcha."
 [pypi]: https://pypi.org/project/aioqzone
 [org]: https://github.com/aioqzone

{aioqzone-1.9.5.dev4 → aioqzone-1.9.5.dev6}/README.md

@@ -21,14 +21,14 @@ aioqzone封装了一些Qzone接口。
 
 - [x] [二维码登录](src/qqqr/qr/)
 - [x] [密码登录](src/qqqr/up/) (受限)
-- [x] [通过滑动验证码](src/qqqr/up/captcha/slide)
+- [x] [通过滑动验证码](src/qqqr/up/captcha/slide) ([slide-tc][slide-tc])
 - [x] [解析图片选择验证码](src/qqqr/up/captcha/select)
 - [ ] [通过网络环境检测][pychaosvm]
 - [x] 爬取HTML说说
 - [x] 爬取说说详细内容
 - [x] 点赞/取消赞
-- [x] 发布(仅文字)/修改/删除说说
-- [x] 发评论
+- [x] 发布/修改/删除说说（图文）
+- [x] 发评论/删评论（图文）
 
 ### 为什么选择 aioqzone
 
@@ -41,6 +41,7 @@ aioqzone封装了一些Qzone接口。
 __在做了:__
 
 - [ ] 完善的测试覆盖
+- [x] [示例代码](https://aioqzone.github.io/aioqzone/examples.html)
 
 ## 包描述
 
@@ -83,5 +84,6 @@ along with this program.  If not, see <https://www.gnu.org/licenses/>.
 [home]: https://github.com/aioqzone/aioqzone "Python wrapper for Qzone web login and Qzone http api"
 [aioqzone-feed]: https://github.com/aioqzone/aioqzone-feed "aioqzone plugin providing higher level api for processing feed"
 [pychaosvm]: https://github.com/aioqzone/pychaosvm "A Python envirionment for Tencent ChaosVM."
+[slide-tc]: https://github.com/aioqzone/slide-tc "An aioqzone plugin for solving slide captcha."
 [pypi]: https://pypi.org/project/aioqzone
 [org]: https://github.com/aioqzone

{aioqzone-1.9.5.dev4 → aioqzone-1.9.5.dev6}/README_en.md

@@ -18,14 +18,14 @@ English | [简体中文](README.md)
 
 - [x] [QR login](src/qqqr/qr/)
 - [x] [password login](src/qqqr/up/) (limited)
-- [x] [solve slide captcha](src/qqqr/up/captcha/slide)
+- [x] [solve slide captcha](src/qqqr/up/captcha/slide) ([slide-tc][slide-tc])
 - [x] [parse select captcha](src/qqqr/up/captcha/select)
 - [ ] [pass network environment verification][pychaosvm]
 - [x] get complete html feeds
 - [x] get feed details
 - [x] like/unlike app
-- [x] publish/update/delete text feeds
-- [x] add comment
+- [x] publish/update/delete feeds (w/ photos)
+- [x] add/delete comment (w/ photos)
 
 ### Why using this package?
 
@@ -38,6 +38,7 @@ English | [简体中文](README.md)
 __Working On:__
 
 - [ ] test coverage
+- [x] [example snippets](https://aioqzone.github.io/aioqzone/examples.html)
 
 ## Description
 
@@ -81,4 +82,5 @@ along with this program.  If not, see <https://www.gnu.org/licenses/>.
 [home]: https://github.com/aioqzone/aioqzone "Python wrapper for Qzone web login and Qzone http api"
 [aioqzone-feed]: https://github.com/aioqzone/aioqzone-feed "aioqzone plugin providing higher level api for processing feed"
 [pychaosvm]: https://github.com/aioqzone/pychaosvm "A Python envirionment for Tencent ChaosVM."
-[pypi]: https://pypi.org/project/aioqzone
+[pypi]: https://pypi.org[slide-tc]: https://github.com/aioqzone/slide-tc "An aioqzone plugin for solving slide captcha."
+/project/aioqzone

{aioqzone-1.9.5.dev4 → aioqzone-1.9.5.dev6}/doc/source/conf.py

@@ -36,6 +36,8 @@ extensions = [
     "sphinx.ext.autodoc",
     "sphinx_autodoc_typehints",
     "sphinx.ext.githubpages",
+    "sphinx_inline_tabs",
+    "sphinx.ext.todo",
 ]
 
 # Add any paths that contain templates here, relative to this directory.

aioqzone-1.9.5.dev6/doc/source/examples.rst

@@ -0,0 +1,327 @@
+============================
+Examples
+============================
+
+This page provides a collection of examples of aioqzone usage.
+
+Login
+============================
+
+.. tab:: QR code login
+
+    .. code-block:: python
+
+        from aioqzone.api import QrLoginConfig, QrLoginManager
+        from qqqr.utils.net import ClientAdapter
+
+        with ClientAdapter() as client:
+            mgr = QrLoginManager(client, config=QrLoginConfig(uin=env.uin))
+
+    User-Agent is automatically set when login.
+
+.. tab:: uin-password login
+
+    .. code-block:: python
+
+        from aioqzone.api import UpLoginConfig, UpLoginManager
+        from qqqr.utils.net import ClientAdapter
+
+        with ClientAdapter() as client:
+            mgr = UpLoginManager(
+                client,
+                config=UpLoginConfig.model_validate(
+                    dict(uin=env.uin, pwd=env.password, fake_ip="8.8.8.8")
+                ),
+            )
+
+    User-Agent is automatically set when login.
+
+.. tab:: external cookie login
+
+    You can surely disable auto login and use external cookie:
+
+    .. code-block:: python
+
+        import json
+        from os import environ
+
+        from aioqzone.api.login import ConstLoginMan
+        from qqqr.utils.net import ClientAdapter
+
+        with open("your_external_cookie.json") as f:
+            cookie = json.load(f)
+        with ClientAdapter() as client:
+            mgr = ConstLoginMan(cookie)
+
+    User-Agent is **NOT** automatically set, remember to change it:
+
+    .. code-block:: python
+
+        from qqqr.utils.net import ClientAdapter
+        from qqqr.utils.net import use_mobile_ua
+
+        with ClientAdapter() as client:
+            use_mobile_ua(client)
+
+        ...
+
+    If you'd like to use external cookie with auto login, just assign cookie dict to login manager:
+
+    .. code-block:: python
+
+        import json
+        from os import environ
+
+        from aioqzone.api.login import QrLoginManager
+        from qqqr.utils.net import ClientAdapter
+
+        with open("your_external_cookie.json") as f:
+            cookie = json.load(f)
+        with ClientAdapter() as client:
+            mgr = QrLoginManager(client, config=QrLoginConfig(uin=env.uin))
+            mgr.cookie = cookie  # assign external cookie to login manager
+
+Receiving Messages from Login Manager
+----------------------------------------------
+
+.. seealso:: :doc:`/aioqzone/messages`
+
+You can receive QR code image from QR code login manager:
+
+.. code-block:: python
+
+    import io
+
+    from PIL import Image as image
+
+    man = QrLoginManager(client, config=QrLoginConfig(uin=env.uin))
+    man.qr_fetched.add_impl(
+        lambda png, times, qr_renew=False: image.open(io.BytesIO(png)).show() if png else None
+    )
+
+.. todo:: other messages
+
+Create Qzone H5 API
+============================
+
+.. tab:: QR code login
+
+    .. code-block:: python
+
+        from aioqzone.api import QzoneH5Api
+        from aioqzone.api.login import QrLoginManager
+        from qqqr.utils.net import ClientAdapter
+
+        with ClientAdapter() as client:
+            mgr = QrLoginManager(client, config=QrLoginConfig(uin=env.uin))
+            api = QzoneH5Api(client, mgr)
+
+.. tab:: uin-password login
+
+    .. code-block:: python
+
+        from aioqzone.api import UpLoginConfig, UpLoginManager
+        from qqqr.utils.net import ClientAdapter
+
+        with ClientAdapter() as client:
+            mgr = UpLoginManager(
+                client,
+                config=UpLoginConfig.model_validate(
+                    dict(uin=env.uin, pwd=env.password, fake_ip="8.8.8.8")
+                ),
+            )
+            api = QzoneH5Api(client, mgr)
+
+fetch feed flow
+=========================================
+
+.. tab:: from self index page
+
+    .. code-block:: python
+
+        feed_flow = await api.index()
+
+.. tab:: from specific profile page
+
+    .. code-block:: python
+
+        feed_flow = await api.profile(uin=123456789)
+
+Fetching (self) feed flow is a preliminary step for most operations, as it gets ``qzonetoken`` from Qzone server,
+which is used in most operations.
+
+fetch next page of feed flow
+=========================================
+
+As feed flow is paginated, you can fetch next page of feed flow:
+
+.. tab:: self index page
+
+    .. code-block:: python
+
+        attach_info = None
+        while True:
+            resp = await api.get_active_feeds(attach_info=attach_info)
+            attach_info = resp.attach_info
+            if not resp.has_more:
+                break
+
+.. tab:: specific profile page
+
+    .. code-block:: python
+
+        attach_info = None
+        while True:
+            resp = await api.get_feeds(uin=123456789, attach_info=attach_info)
+            attach_info = resp.attach_info
+            if not resp.has_more:
+                break
+
+.. seealso::
+
+    `aioqzone-feed <https://github.com/aioqzone/aioqzone-feed>`_ provides a high-level
+    interface for fetching feed flow.
+
+fetch avatar from uin
+=========================================
+
+This is a no-login API, you can fetch avatar without login state.
+
+.. code-block:: python
+
+    size = 100  # avatar size, can be 100, 640
+    resp = await api.avatar(123456789, size)
+    with open("out/avatar.png", "wb") as f:
+        f.write(resp.avatar)
+
+upload photo
+=========================================
+
+Uploading photo is a two-step process. The first is :meth:`QzoneH5API.upload_pic`, which should
+be called per-image. The response is file length and md5. The second is `:meth:`QzoneH5API.preupload_photos` ,
+which is called once for multiple images, and the response is a list of :class:`PicInfo`, including
+image url, image id, etc.
+
+.. code-block:: python
+
+    import asyncio
+
+    images = ["image_a.jpg", "image_b.jpg", "image_c.jpg"]
+    hashes = await asyncio.gather(
+        *map(api.upload_pic, images)
+    )
+    pic_infos = await api.preupload_photos(hashes)
+
+.. hint::
+
+    You can specify quality of uploaded image by setting ``quality`` parameter of :meth:`QzoneH5API.upload_pic`.
+
+Mood operation
+=========================
+
+upload mood
+-------------------------
+
+.. code-block:: python
+
+    from aioqzone.model import UgcRight
+
+    MOOD_TEXT = "Hello, world!"
+    picinfo = [...]  # list of PicInfo, can be empty
+    feed = await api.publish_mood(
+        MOOD_TEXT, photos=picinfo, sync_weibo=False, ugc_right=UgcRight.self
+    )
+
+.. hint::
+
+    You can specify mood visibility by setting ``ugc_right`` parameter of :meth:`QzoneH5API.publish_mood` .
+
+delete mood
+-------------------------
+
+.. code-block:: python
+
+    # get appid from fetch feed. common appid of mood without sharing is 311.
+    delete_response = await api.delete_ugc(feed.fid, appid)
+
+get mood detail
+-------------------------
+
+.. code-block:: python
+
+    # fetching feed
+    feed_flow = await api.get_active_feeds()
+    feed_dict = {i.fid: i for i in feed_flow.vFeeds}
+    fetched_feed = feed_dict[feed.fid]
+
+    detail = await api.shuoshuo(
+        fetched_feed.fid, fetched_feed.userinfo.uin, fetched_feed.common.appid
+    )
+
+like/unlike mood
+=========================
+
+.. code-block:: python
+
+    from aioqzone.model import LikeData
+
+    # get appid, curkey and unikey from fetch feed
+    # common appid of mood without sharing is 311.
+
+    # for feeds without forward, curkey and unikey are the same.
+    # you can construct them by host uin and fid:
+    # unikey = LikeData.persudo_unikey(appid, hostuin, feed.fid)
+
+    await api.internal_dolike_app(appid, unikey, curkey=unikey, like=True)  # like
+    await api.internal_dolike_app(appid, unikey, curkey=unikey, like=False) # unlike
+
+mood comment
+=========================
+
+add comment
+-------------------------
+
+.. tab:: w/o picture
+
+    .. code-block:: python
+
+        COMMENT_TEXT = "Nice mood!"
+        comment = await api.add_comment(
+            hostuin, feed.fid, appid, COMMENT_TEXT, busi_param=fetched_feed.operation.busi_param
+        )
+
+    .. tip:: ``busi_param`` is optional, but recommended.
+
+.. tab:: w/ picture
+
+    .. code-block:: python
+
+        COMMENT_TEXT = "Nice mood!"
+        picinfo = [...]  # list of PicInfo
+        comment_pic = await api.add_comment(
+            hostuin, feed.fid, appid, COMMENT_TEXT, [i.url for i in picinfo]
+        )
+
+    .. attention::
+
+        Picture comment uses legacy html Qzone API, which has a html response.
+        Currently ``commentId`` cannot be parsed from the response.
+
+delete comment
+-------------------------
+
+.. code-block:: python
+
+    await api.delete_comment(ownuin, fetched_feed.topicId, comment.commentid)
+
+check feed update
+============================
+
+.. admonition:: Speculation
+
+    Call this api every 5 minutes might keep your login cookie alive within one day (or several days).
+    Otherwise the login state will expire in several hours.
+
+.. code-block:: python
+
+    await api.mfeeds_get_count()

{aioqzone-1.9.5.dev4 → aioqzone-1.9.5.dev6}/doc/source/index.rst

@@ -18,6 +18,7 @@ aioqzone provides python interface to
 
    aioqzone/index
    qqqr/index
+   examples
 
 .. toctree::
    :caption: Links