PyPtt 2.2.4__tar.gz → 2.2.5__tar.gz

{pyptt-2.2.4 → pyptt-2.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPtt
-Version: 2.2.4
+Version: 2.2.5
 Summary: PyPtt github: https://github.com/PyPtt/PyPtt
 Author-email: CodingMan <pttcodingman@gmail.com>
 License: GNU Lesser General Public License v3 (LGPLv3)

{pyptt-2.2.4 → pyptt-2.2.5}/PyPtt/PTT.py

@@ -28,6 +28,7 @@ from . import _api_post
 from . import _api_reply_post
 from . import _api_search_user
 from . import _api_set_board_title
+from . import _api_set_signature_file
 from . import check_value
 from . import config
 from . import connect_core
@@ -806,6 +807,38 @@ class API:
 
         _api_set_board_title.set_board_title(self, board, new_title)
 
+    def set_signature_file(self, content: str) -> None:
+
+        """
+        更新登入帳號的名片檔（PTT 的 plan），對應【個人設定】->【個人檔案】
+        ->(Q)ueryEdit 編輯名片檔的功能。`get_user()` 回傳的 `signature_file`
+        欄位讀的就是這份內容。
+
+        Args:
+            content (str): 新的名片檔內容，會整份取代原本的內容。
+
+        Returns:
+            None
+
+        Raises:
+            RequireLogin: 需要登入。
+
+        範例::
+
+            import PyPtt
+
+            ptt_bot = PyPtt.API()
+            try:
+                # .. login ..
+                ptt_bot.set_signature_file(content='你好，我是 PyPtt')
+                # .. do something ..
+            finally:
+                ptt_bot.logout()
+
+        """
+
+        _api_set_signature_file.set_signature_file(self, content)
+
     def mark_post(self, mark_type: int, board: str, aid: Optional[str] = None, index: int = 0, search_type: int = 0,
                   search_condition: Optional[str] = None) -> None:
         """

{pyptt-2.2.4 → pyptt-2.2.5}/PyPtt/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '2.2.4'
+__version__ = '2.2.5'
 __author__ = 'CodingMan'
 __email__ = 'pttcodingman@gmail.com'
 

pyptt-2.2.5/PyPtt/_api_set_signature_file.py

@@ -0,0 +1,86 @@
+from . import _api_util
+from . import check_value
+from . import command
+from . import connect_core
+from . import exceptions
+from . import i18n
+from . import lib_util
+from . import log
+
+
+def set_signature_file(api, content: str) -> None:
+    _api_util.one_thread(api)
+
+    if not api._is_login:
+        raise exceptions.RequireLogin(i18n.require_login)
+
+    check_value.check_type(content, str, 'content')
+
+    log.logger.info(i18n.set_signature_file)
+
+    cmd_list = []
+    cmd_list.append(command.go_main_menu)
+    cmd_list.append('U')
+    cmd_list.append(command.enter)
+    cmd_list.append('M')
+    cmd_list.append(command.enter)
+    cmd_list.append('Q')
+    cmd_list.append(command.enter)
+    cmd = ''.join(cmd_list)
+
+    target_list = [
+        # Existing signature file -> getans asks Delete/Edit/Cancel first.
+        # max_match=1: the echoed prompt text can linger on the next
+        # screen refresh while waiting for the editor to draw (same
+        # quirk documented for '確定要儲存檔案嗎' in _api_post.py); without
+        # it this would re-fire 'E' + Enter into the editor buffer.
+        connect_core.TargetUnit('名片 (D)刪除', response='E' + command.enter, max_match=1),
+        # Empty signature file skips the getans prompt and opens the
+        # editor directly.
+        connect_core.TargetUnit('編輯文章', break_detect=True),
+    ]
+    index = api.connect_core.send(
+        cmd,
+        target_list,
+        screen_timeout=api.config.screen_long_timeout)
+    if index < 0:
+        ori_screen = api.connect_core.get_screen_queue()[-1]
+        raise exceptions.UnknownError(ori_screen)
+
+    content = lib_util.uniform_new_line(content)
+
+    cmd_list = []
+    # ponytail: unlike post's blank template, the card-file editor preloads
+    # the account's existing signature file, so it has to be cleared line by
+    # line before writing the new content. ctrl_y*60 is a "clear up to 60
+    # pre-loaded lines" ceiling -- bump it if a real card file ever runs
+    # longer than that.
+    cmd_list.append(command.ctrl_y * 60)
+    cmd_list.append(content)
+    cmd_list.append(command.ctrl_x)
+    cmd = ''.join(cmd_list)
+
+    target_list = [
+        connect_core.TargetUnit('確定要儲存檔案嗎', response='s' + command.enter, max_match=1),
+        connect_core.TargetUnit('名片更新完畢', break_detect=True),
+    ]
+    index = api.connect_core.send(
+        cmd,
+        target_list,
+        screen_timeout=api.config.screen_long_timeout)
+    if index < 0:
+        ori_screen = api.connect_core.get_screen_queue()[-1]
+        raise exceptions.UnknownError(ori_screen)
+
+    # The leading space in go_main_menu dismisses the "請按任意鍵繼續" banner
+    # left by the save; the trailing left-arrows walk back out of the
+    # 個人設定/個人檔案 submenus to the main menu.
+    target_list = [
+        connect_core.TargetUnit('主功能表', break_detect=True),
+    ]
+    api.connect_core.send(
+        command.go_main_menu,
+        target_list,
+        screen_timeout=api.config.screen_long_timeout)
+
+    log.logger.info(i18n.set_signature_file, '...', i18n.success)

{pyptt-2.2.4 → pyptt-2.2.5}/PyPtt/lang_en_US.py

@@ -106,6 +106,7 @@ string_data = {
     "set_connect_host": "Set up the connect host",
     "set_connect_mode": "Set up the connect mode",
     "set_contact_mail_first": "Password can only be changed after setting the contact mailbox",
+    "set_signature_file": "Update signature file",
     "set_up_lang_module": "Set up language module",
     "spend_time": "Spend time",
     "substandard_post": "Substandard post",

{pyptt-2.2.4 → pyptt-2.2.5}/PyPtt/lang_zh_TW.py

@@ -106,6 +106,7 @@ string_data = {
     "set_connect_host": "設定連線主機",
     "set_connect_mode": "設定連線模式",
     "set_contact_mail_first": "請先設定聯絡信箱後才能修改密碼",
+    "set_signature_file": "更新名片檔",
     "set_up_lang_module": "設定語言模組",
     "spend_time": "花費時間",
     "substandard_post": "不合規範文章",

{pyptt-2.2.4 → pyptt-2.2.5}/PyPtt.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPtt
-Version: 2.2.4
+Version: 2.2.5
 Summary: PyPtt github: https://github.com/PyPtt/PyPtt
 Author-email: CodingMan <pttcodingman@gmail.com>
 License: GNU Lesser General Public License v3 (LGPLv3)

{pyptt-2.2.4 → pyptt-2.2.5}/PyPtt.egg-info/SOURCES.txt

@@ -30,6 +30,7 @@ PyPtt/_api_post.py
 PyPtt/_api_reply_post.py
 PyPtt/_api_search_user.py
 PyPtt/_api_set_board_title.py
+PyPtt/_api_set_signature_file.py
 PyPtt/_api_util.py
 PyPtt/api_server.py
 PyPtt/check_value.py
@@ -92,4 +93,5 @@ tests/test_reply_post.py
 tests/test_search_user.py
 tests/test_service.py
 tests/test_set_board_title.py
+tests/test_set_signature_file.py
 tests/test_vt100_parser.py

pyptt-2.2.5/tests/test_set_signature_file.py

@@ -0,0 +1,32 @@
+"""Integration test for set_signature_file (the PTT "名片檔"/plan).
+
+Self-restoring round-trip: capture the account's current signature file via
+`get_user`, overwrite it with an identifiable marker, verify the marker shows
+up on a fresh `get_user` read, then set it back to the original content so
+the test doesn't leave a permanent change on the account.
+"""
+import time
+
+from PyPtt import UserField
+
+
+def test_set_signature_file_round_trip(ptt_bots):
+    for ptt_bot in ptt_bots:
+        original = ptt_bot.get_user(ptt_bot.ptt_id)[UserField.signature_file]
+
+        marker = f'PyPtt set_signature_file test {int(time.time())}'
+        try:
+            ptt_bot.set_signature_file(marker)
+            time.sleep(1)
+
+            updated = ptt_bot.get_user(ptt_bot.ptt_id)[UserField.signature_file]
+            assert marker in updated.strip()
+        finally:
+            # Restore -- must always run, even if the assertion above fails.
+            ptt_bot.set_signature_file(original)
+            time.sleep(1)
+
+            restored = ptt_bot.get_user(ptt_bot.ptt_id)[UserField.signature_file]
+            # Tolerate trailing whitespace/blank-line drift from the
+            # editor round-trip; compare on stripped content.
+            assert restored.strip() == original.strip()