feat(hb): whitelist ServerTimeoutError (#154)

* feat(hb): whitelist ServerTimeoutError * doc: update docs --------- Co-authored-by: JamzumSum <[email protected]>
aioqzone · Dec 10, 2023 · 22cbd68 · 22cbd68
1 parent 42552a4
commit 22cbd68
Show file tree

Hide file tree

Showing 10 changed files with 493 additions and 139 deletions.
diff --git a/doc/source/api/heartbeat.rst b/doc/source/api/heartbeat.rst
@@ -1,5 +1,5 @@
 Heartbeat API
 ==========================
 
-.. automodule:: aioqzone_feed.api.heartbeat
+.. autoclass:: aioqzone_feed.api.heartbeat.HeartbeatApi
     :members:
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -64,8 +64,12 @@
 # external inventory
 intersphinx_mapping = {
     "aiohttp": ("https://docs.aiohttp.org/en/stable/", None),
+    "tylisten": ("https://JamzumSum.github.io/tylisten", None),
     "aioqzone": ("https://aioqzone.github.io/aioqzone", None),
 }
 
+# autodoc settings
+autodoc_member_order = "bysource"
+
 # autodoc_pydantic settings
 autodoc_pydantic_model_show_json = False
diff --git a/doc/source/locale/zh_CN/LC_MESSAGES/api/heartbeat.po b/doc/source/locale/zh_CN/LC_MESSAGES/api/heartbeat.po
@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: aioqzone-feed \n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2023-08-10 14:10+0800\n"
+"POT-Creation-Date: 2023-12-09 13:55+0800\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language: zh_CN\n"
@@ -17,12 +17,40 @@ msgstr ""
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=utf-8\n"
 "Content-Transfer-Encoding: 8bit\n"
-"Generated-By: Babel 2.12.1\n"
+"Generated-By: Babel 2.13.1\n"
 
 #: ../../source/api/heartbeat.rst:2
 msgid "Heartbeat API"
 msgstr ""
 
+#: aioqzone_feed.api.heartbeat.HeartbeatApi.heartbeat_refresh:1 of
+msgid ""
+"A wrapper function that calls :obj:`hb_api` and handles all kinds of excpetions raised during "
+"heartbeat. :rtype: :sphinx_autodoc_typehints_type:`\\:py\\:obj\\:\\`None\\``"
+msgstr ""
+
+#: aioqzone_feed.api.heartbeat.HeartbeatApi.heartbeat_refresh:7 of
+msgid ""
+"This method calls heartbeat **ONLY ONCE** so it should be called periodically by using other "
+"timer/scheduler."
+msgstr ""
+
+#: aioqzone_feed.api.heartbeat.HeartbeatApi.heartbeat_refresh:12 of
+msgid "do not retry, just call heartbeat once"
+msgstr ""
+
+#: aioqzone_feed.api.heartbeat.HeartbeatApi.stop:1 of
+msgid "Clear **all** registered tasks. All tasks will be CANCELLED if not finished."
+msgstr ""
+
+#: aioqzone_feed.api.heartbeat.HeartbeatApi.stop of
+msgid "返回类型"
+msgstr ""
+
+#: aioqzone_feed.api.heartbeat.HeartbeatApi.stop:4 of
+msgid ":sphinx_autodoc_typehints_type:`\\:py\\:obj\\:\\`None\\``"
+msgstr ""
+
 #~ msgid ""
 #~ "A wrapper function that calls "
 #~ ":external:meth:`aioqzone.api.DummyQapi.get_feeds_count` and handles all "

diff --git a/doc/source/locale/zh_CN/LC_MESSAGES/message/index.po b/doc/source/locale/zh_CN/LC_MESSAGES/message/index.po
@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: aioqzone-feed \n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2023-12-04 17:22+0800\n"
+"POT-Creation-Date: 2023-12-10 10:42+0800\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language: zh_CN\n"
@@ -23,18 +23,132 @@ msgstr ""
 msgid "aioqzone-feed Messages"
 msgstr ""
 
-#: ../../source/message/index.rst:4
+#: ../../source/message/index.rst:6
 msgid "aioqzone-feed uses `tylisten` to dispatch and subscribte messages."
 msgstr ""
 
-#: ../../source/message/index.rst:7
+#: ../../source/message/index.rst:9
 msgid "Feed Messages"
 msgstr ""
 
-#: ../../source/message/index.rst:13
+#: aioqzone_feed.message.feed.processed_feed aioqzone_feed.message.feed.raw_feed
+#: aioqzone_feed.message.heartbeat.heartbeat_failed aioqzone_feed.message.heartbeat.heartbeat_refresh
+#: of
+msgid "参数"
+msgstr ""
+
+#: ../../../docstring aioqzone_feed.message.feed.processed_feed:1
+#: aioqzone_feed.message.feed.raw_feed:1 of
+msgid "Used to identify feed batch (tell from different calling)."
+msgstr ""
+
+#: ../../../docstring aioqzone_feed.message.feed.raw_feed:2 of
+msgid "Used to pass a ref to the feed."
+msgstr ""
+
+#: aioqzone_feed.message.feed.processed_feed aioqzone_feed.message.feed.raw_feed
+#: aioqzone_feed.message.feed.stop_fetch of
+msgid "返回类型"
+msgstr ""
+
+#: ../../../docstring aioqzone_feed.message.feed.processed_feed:4
+#: aioqzone_feed.message.feed.raw_feed:4 of
+msgid ":sphinx_autodoc_typehints_type:`\\:py\\:data\\:\\`\\~typing.Any\\``"
+msgstr ""
+
+#: ../../../docstring aioqzone_feed.message.feed.processed_feed:2 of
+msgid "Used to pass the feed content."
+msgstr ""
+
+#: ../../../docstring aioqzone_feed.message.feed.stop_fetch:1 of
+msgid "An async callback to determine if fetch should be stopped (after processing current batch)."
+msgstr ""
+
+#: ../../../docstring aioqzone_feed.message.feed.stop_fetch:4 of
+msgid ":sphinx_autodoc_typehints_type:`\\:py\\:class\\:\\`bool\\``"
+msgstr ""
+
+#: ../../../docstring aioqzone_feed.message.feed.FeedApiEmitterMixin.feed_dropped:1 of
+msgid "This emitter is triggered when a feed is dropped."
+msgstr ""
+
+#: ../../../docstring aioqzone_feed.message.feed.FeedApiEmitterMixin.feed_processed:1 of
+msgid "This emitter is triggered when a feed is processed."
+msgstr ""
+
+#: ../../../docstring aioqzone_feed.message.feed.FeedApiEmitterMixin.feed_media_updated:1 of
+msgid "This emitter is triggered when a feed's media is updated."
+msgstr ""
+
+#: ../../../docstring aioqzone_feed.message.feed.FeedApiEmitterMixin.stop_fetch:1 of
+msgid "This hook is used to determin whether a fetch should stop."
+msgstr ""
+
+#: ../../../docstring aioqzone_feed.message.feed.FeedApiEmitterMixin.ch_feed_dispatch:1 of
+msgid "A future store serves as feed dispatch channel."
+msgstr ""
+
+#: ../../../docstring aioqzone_feed.message.feed.FeedApiEmitterMixin.ch_feed_notify:1 of
+msgid "A future store serves as message notify channel."
+msgstr ""
+
+#: aioqzone_feed.message.feed.FeedApiEmitterMixin.stop:1
+#: aioqzone_feed.message.heartbeat.HeartbeatEmitterMixin.stop:1 of
+msgid "Clear future stores."
+msgstr ""
+
+#: ../../source/message/index.rst:20
 msgid "Heartbeat Messages"
 msgstr ""
 
+#: ../../../docstring aioqzone_feed.message.heartbeat.heartbeat_refresh:1 of
+msgid ""
+"This message is emitted after a heartbeat succeeded and there are new feeds. Use this event to "
+"wait for all dispatch task to be finished, and send received feeds."
+msgstr ""
+
+#: ../../../docstring aioqzone_feed.message.heartbeat.heartbeat_refresh:4 of
+msgid "number of new feeds"
+msgstr ""
+
+#: ../../../docstring aioqzone_feed.message.heartbeat.heartbeat_failed:1 of
+msgid "This message is emitted when the heartbeat got an error."
+msgstr ""
+
+#: ../../../docstring aioqzone_feed.message.heartbeat.heartbeat_failed:3 of
+msgid "An exception object that can be used to determine the cause of the heartbeat failure."
+msgstr ""
+
+#: ../../../docstring aioqzone_feed.message.heartbeat.heartbeat_failed:7 of
+msgid "Recommended handling strategy:"
+msgstr ""
+
+#: ../../../docstring aioqzone_feed.message.heartbeat.heartbeat_failed:9 of
+msgid ""
+":exc:`~aioqzone.exception.QzoneError` if :obj:`~aioqzone.exception.QzoneError.code` = -3000: "
+"Login expired. Relogin is needed."
+msgstr ""
+
+#: ../../../docstring aioqzone_feed.message.heartbeat.heartbeat_failed:10 of
+msgid ""
+":exc:`~aiohttp.ServerTimeoutError` / :exc:`~aiohttp.ClientResponseError` if "
+":obj:`~aiohttp.ClientResponseError.status` = 500: Qzone server buzy. Ignore it."
+msgstr ""
+
+#: ../../../docstring aioqzone_feed.message.heartbeat.HeartbeatEmitterMixin.hb_failed:1 of
+msgid "This emitter is triggered when the heartbeat fails because of a exception."
+msgstr ""
+
+#: ../../../docstring aioqzone_feed.message.heartbeat.HeartbeatEmitterMixin.hb_refresh:1 of
+msgid ""
+"This emitter is triggered after a heartbeat succeeded and there are new feeds. Use this event to"
+" wait for all dispatch task to be finished, and send received feeds."
+msgstr ""
+
+#: ../../../docstring aioqzone_feed.message.heartbeat.HeartbeatEmitterMixin.ch_heartbeat_notify:1 of
+msgid "A future store serves as heartbeat channel."
+msgstr ""
+
 #~ msgid "aioqzone-feed Events"
 #~ msgstr ""
 
@@ -86,3 +200,37 @@ msgstr ""
 
 #~ msgid "number of new feeds"
 #~ msgstr ""
+
+#~ msgid ":external+aioqzone:exc:`QzoneError`(code=-3000): Login expired. Relogin is needed."
+#~ msgstr ""
+
+#~ msgid ""
+#~ ":external+aioqzone:exc:`QzoneError` if :external:obj:`~QzoneError.code` ="
+#~ " -3000: Login expired. Relogin is needed."
+#~ msgstr ""
+
+#~ msgid ""
+#~ ":external+aiohttp:exc:`ServerTimeoutError` / "
+#~ ":external+aiohttp:exc:`ClientResponseError`(status=500): Qzone server buzy."
+#~ " Ignore it."
+#~ msgstr ""
+
+#~ msgid ":exc:`QzoneError` if :obj:`~QzoneError.code` = -3000: Login expired. Relogin is needed."
+#~ msgstr ""
+
+#~ msgid ""
+#~ ":exc:`ServerTimeoutError` / :exc:`ClientResponseError` if "
+#~ ":obj:`~ClientResponseError.status` = 500: Qzone server buzy."
+#~ " Ignore it."
+#~ msgstr ""
+
+#~ msgid ""
+#~ ":exc:`~aioqzone.exception.QzoneError` if :obj:`~QzoneError.code` = "
+#~ "-3000: Login expired. Relogin is needed."
+#~ msgstr ""
+
+#~ msgid ""
+#~ ":exc:`~aiohttp.ServerTimeoutError` / :exc:`ClientResponseError` if "
+#~ ":obj:`~ClientResponseError.status` = 500: Qzone server buzy."
+#~ " Ignore it."
+#~ msgstr ""
diff --git a/doc/source/message/index.rst b/doc/source/message/index.rst
@@ -1,16 +1,27 @@
 aioqzone-feed Messages
 ====================================
 
+.. currentmodule:: aioqzone_feed.message
+
 aioqzone-feed uses `tylisten` to dispatch and subscribte messages.
 
 Feed Messages
 -------------------------
 
 .. automodule:: aioqzone_feed.message.feed
     :members:
+    :undoc-members:
+
+    .. autodata:: raw_feed
+    .. autodata:: processed_feed
+    .. autodata:: stop_fetch
 
 Heartbeat Messages
 -------------------------
 
 .. automodule:: aioqzone_feed.message.heartbeat
     :members:
+    :undoc-members:
+
+    .. autodata:: heartbeat_refresh
+    .. autodata:: heartbeat_failed