PyPtt 2.1.1__tar.gz → 2.1.3__tar.gz

{pyptt-2.1.1 → pyptt-2.1.3}/PKG-INFO

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

{pyptt-2.1.1 → pyptt-2.1.3}/PyPtt/PTT.py

@@ -150,6 +150,11 @@ class API:
         check_value.check_type(verify_ssl, bool, 'verify_ssl')
         self.config.verify_ssl = verify_ssl
 
+        screen_height = kwargs.get('screen_height', 24)
+        check_value.check_type(screen_height, int, 'screen_height')
+        check_value.check_range(screen_height, 24, 254, 'screen_height')
+        self.config.screen_height = screen_height
+
         self.connect_core = connect_core.API(self)
         self._exist_board_list = set()
         self._exist_user_list = set()
@@ -1066,7 +1071,7 @@ class API:
 
         return _api_get_bottom_post_list.get_bottom_post_list(self, board)
 
-    def del_post(self, board: str, aid: Optional[str] = None, index: int = 0) -> None:
+    def del_post(self, board: str, aid: Optional[str] = None, index: int = 0, reason: Optional[str] = None) -> None:
         """
         刪除文章。
 
@@ -1074,6 +1079,7 @@ class API:
             board (str): 看板名稱。
             aid (str): 文章編號。
             index (int): 文章編號。
+            reason (str): 板主刪除他人文章時，加註於刪除後標題的理由（僅板主刪除他板友文章時有效）。
 
         Returns:
             None
@@ -1084,6 +1090,7 @@ class API:
             NoSuchBoard: 看板不存在。
             NoSuchPost: 文章不存在。
             NoPermission: 沒有權限。
+            ParameterError: 對自己的文章傳入 reason（加註理由僅適用於版主刪除他人文章）。
 
         範例::
 
@@ -1098,7 +1105,7 @@ class API:
                 ptt_bot.logout()
         """
 
-        _api_del_post.del_post(self, board, aid, index)
+        _api_del_post.del_post(self, board, aid, index, reason)
 
     def get_post_list(self, board: str, limit: int = 20, offset: int = 0) -> list[dict]:
         """

{pyptt-2.1.1 → pyptt-2.1.3}/PyPtt/__init__.py

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

{pyptt-2.1.1 → pyptt-2.1.3}/PyPtt/_api_del_post.py

@@ -14,7 +14,7 @@ from . import log
 from . import screens
 
 
-def del_post(api, board: str, post_aid: Optional[str] = None, post_index: int = 0) -> None:
+def del_post(api, board: str, post_aid: Optional[str] = None, post_index: int = 0, reason: Optional[str] = None) -> None:
     _api_util.one_thread(api)
 
     if not api.is_registered_user:
@@ -27,6 +27,8 @@ def del_post(api, board: str, post_aid: Optional[str] = None, post_index: int =
     if post_aid is not None:
         check_value.check_type(post_aid, str, 'PostAID')
     check_value.check_type(post_index, int, 'PostIndex')
+    if reason is not None:
+        check_value.check_type(reason, str, 'reason')
 
     if len(board) == 0:
         raise exceptions.ParameterError(f'board error parameter: {board}')
@@ -64,6 +66,13 @@ def del_post(api, board: str, post_aid: Optional[str] = None, post_index: int =
         log.logger.info(i18n.delete_post, '...', i18n.success)
         return
 
+    # PTT only offers the "R加註理由" annotation when a moderator deletes
+    # another user's post. On your own post the reason can never be applied,
+    # so reject it rather than silently dropping it.
+    if reason and api.ptt_id.lower() == post_info[data_type.PostField.author].lower():
+        raise exceptions.ParameterError(
+            'reason is only valid when a moderator deletes another user\'s post')
+
     if check_author:
         if api.ptt_id.lower() != post_info[data_type.PostField.author].lower():
             log.logger.info(i18n.delete_post, '...', i18n.fail)
@@ -90,20 +99,40 @@ def del_post(api, board: str, post_aid: Optional[str] = None, post_index: int =
     def confirm_delete_handler(screen):
         api.confirm = True
 
+    # A board moderator deleting another user's post gets an extra
+    # "R加註理由" option that lets us annotate the title shown after deletion.
+    use_reason = bool(reason) and not check_author
+
+    def confirm_delete_response(screen):
+        if use_reason and '加註理由' in screen:
+            return 'r' + command.enter
+        return 'y' + command.enter
+
     target_list = [
         connect_core.TargetUnit('請按任意鍵繼續', response=' '),
-        connect_core.TargetUnit('請確定刪除(Y/N)?[N]', response='y' + command.enter, handler=confirm_delete_handler,
-                                max_match=1),
-        connect_core.TargetUnit(screens.Target.InBoard, break_detect=True),
+        connect_core.TargetUnit('請確定刪除(Y/N', response=confirm_delete_response,
+                                handler=confirm_delete_handler, max_match=1),
     ]
 
-    index = api.connect_core.send(
-        cmd,
-        target_list)
-
-    if index == 1:
-        if not api.confirm:
-            log.logger.info(i18n.delete_post, '...', i18n.fail)
-            raise exceptions.NoPermission(i18n.no_permission)
+    if use_reason:
+        target_list.append(
+            connect_core.TargetUnit(
+                '請輸入刪除後要顯示的標題',
+                response=command.ctrl_e + ' ' + reason + command.enter,
+                max_match=1))
+        target_list.append(
+            connect_core.TargetUnit(
+                '請再次確定是否要用上述理由刪除(Y/N',
+                response='y' + command.enter,
+                max_match=1))
+
+    target_list.append(
+        connect_core.TargetUnit(screens.Target.InBoard, break_detect=True))
+
+    api.connect_core.send(cmd, target_list)
+
+    if not api.confirm:
+        log.logger.info(i18n.delete_post, '...', i18n.fail)
+        raise exceptions.NoPermission(i18n.no_permission)
 
     log.logger.info(i18n.delete_post, '...', i18n.success)

{pyptt-2.1.1 → pyptt-2.1.3}/PyPtt/_api_get_board_list.py

@@ -65,6 +65,10 @@ def get_board_list(api) -> list:
     cmd = ''.join(cmd_list)
 
     board_list = []
+    # NOTE: expanded_screen is intentionally NOT used here.
+    # get_board_list traverses all boards sequentially; a mid-session NAWS resize
+    # causes PTT to render the first page at the old size before the resize takes
+    # effect, producing inconsistent page boundaries and skipping boards.
     while True:
 
         api.connect_core.send(

{pyptt-2.1.1 → pyptt-2.1.3}/PyPtt/_api_get_favourite_board.py

@@ -24,6 +24,7 @@ def get_favourite_board(api) -> list:
 
     board_list = []
     favourite_board_list = []
+    # NOTE: expanded_screen intentionally not used — same risk as get_board_list.
     while True:
 
         api.connect_core.send(

pyptt-2.1.3/PyPtt/_api_get_post_list.py

@@ -0,0 +1,111 @@
+from typing import Dict, List
+
+from . import _api_util
+from . import check_value
+from . import command
+from . import connect_core
+from . import data_type
+from . import exceptions
+from . import i18n
+from . import log
+from . import screens
+
+
+def get_post_list(api, board: str, limit: int = 20, offset: int = 0) -> List[Dict]:
+    _api_util.one_thread(api)
+
+    if not api._is_login:
+        raise exceptions.RequireLogin(i18n.require_login)
+
+    check_value.check_type(board, str, 'board')
+    if limit is not None:
+        check_value.check_type(limit, int, 'limit')
+    if offset is not None:
+        check_value.check_type(offset, int, 'offset')
+
+    max_index = api.get_newest_index(data_type.NewIndex.BOARD, board=board)
+
+    check_value.check_range(limit, min_value=1, max_value=max_index, name='limit')
+    check_value.check_range(offset, min_value=0, max_value=max_index - 1, name='offset')
+
+    start_index = max_index - limit - offset + 1
+    end_index = start_index + limit - 1
+
+    # the first page shows 10 posts, each next page shows 20 posts
+    if limit <= 10:
+        max_round = 1
+    else:
+        # 1 is for the first page, +1 is for rounding up
+        # so +2
+        max_round = (limit - 10) // 20 + 2
+
+    cmd_list = []
+
+    cmd_list.append(str(max(1, start_index - 100)))
+    cmd_list.append(command.enter)
+    cmd_list.append(str(start_index))
+    cmd_list.append(command.enter)
+
+    cmd = ''.join(cmd_list)
+
+    target_list = [
+        connect_core.TargetUnit(screens.Target.InBoard, log_level=log.DEBUG, break_detect=True)
+    ]
+
+    post_list = []
+
+    with _api_util.expanded_screen(api):
+        for _ in range(max_round):
+
+            index = api.connect_core.send(cmd, target_list)
+            cmd = command.page_down
+            last_screen = api.connect_core.get_screen_queue()[-1]
+
+            is_parse_area = False
+
+            for line in last_screen.splitlines()[3:-1]:
+
+                if not line.startswith(api.cursor) and not is_parse_area:
+                    continue
+                is_parse_area = True
+
+                if line.strip().startswith(api.cursor):
+                    # replace the first cursor in the line
+                    line = line.replace(api.cursor, ' ' * len(api.cursor.encode('big5uao')), 1)
+
+                if api.cursor == data_type.Cursor.NEW:
+                    # Pad one leading space so the fixed-column offsets below
+                    # apply equally to cursor and non-cursor rows. Before the
+                    # VT100Parser cell-tracking fix, the parser inserted this
+                    # padding implicitly via its off-by-one column quirk; the
+                    # offsets here were tuned to that padded layout.
+                    line = f' {line}'
+
+                try:
+                    cur_index = int(line[:8].strip())
+                except ValueError:
+                    # Pinned/announcement posts use '★' instead of a numeric
+                    # index — they have no sequential index and cannot be
+                    # fetched by index, so skip them.
+                    continue
+                status = line[8:10].strip()
+                comment = line[10:12].strip()
+                list_date = line[12:17].strip()
+                author = line[18:31].strip()
+                title = line[31:]
+
+                cur_post = {
+                    data_type.PostField.board: board,
+                    data_type.PostField.index: cur_index,
+                    data_type.PostField.list_date: list_date,
+                    data_type.PostField.author: author,
+                    data_type.PostField.title: title,
+                    data_type.PostField.push_number: comment
+                }
+
+                post_list.append(cur_post)
+
+                if cur_index >= end_index:
+                    return post_list
+
+        raise exceptions.UnknownError(i18n.unknown_error)

{pyptt-2.1.1 → pyptt-2.1.3}/PyPtt/_api_get_waterball.py

@@ -101,51 +101,52 @@ def get_waterball(api, post_action: WaterballPostAction = WaterballPostAction.KE
     seen_lines = set()
     all_content_parts = []
 
-    while True:
-        target_list = [
-            connect_core.TargetUnit('◆ 暫無訊息記錄', log_level=log.DEBUG, break_detect=True),
-            connect_core.TargetUnit(screens.Target.WaterBallListEnd, log_level=log.DEBUG, break_detect=True),
-            connect_core.TargetUnit(screens.Target.InWaterBallList, log_level=log.DEBUG, break_detect=True),
-        ]
-
-        index = api.connect_core.send(cmd, target_list)
-
-        if index == 0:
-            # no waterball records
-            api.connect_core.send('q' + command.go_main_menu, [
-                connect_core.TargetUnit(screens.Target.MainMenu, log_level=log.DEBUG, break_detect=True),
-            ])
-            log.logger.info(i18n.get_waterball, '...', i18n.success)
-            return []
-
-        if index < 0:
-            break
-
-        screen = api.connect_core.get_screen_queue()[-1]
-        for line in screen.split('\n'):
-            line = line.strip()
-            if line and line not in seen_lines:
-                seen_lines.add(line)
-                all_content_parts.append(line)
-
-        if index == 1:
-            # WaterBallListEnd — collect done, exit viewer; handle post-action prompt
-            action_cmd = _post_action_cmd[post_action]
-            target_list_exit = [
-                connect_core.TargetUnit(screens.Target.WaterBallPostAction, log_level=log.DEBUG,
-                                        response=action_cmd + command.enter),
-                connect_core.TargetUnit(screens.Target.WaterballCleanup, log_level=log.DEBUG,
-                                        response='y' + command.enter),
-                connect_core.TargetUnit(screens.Target.MainMenu, log_level=log.DEBUG, break_detect=True),
+    with _api_util.expanded_screen(api):
+        while True:
+            target_list = [
+                connect_core.TargetUnit('◆ 暫無訊息記錄', log_level=log.DEBUG, break_detect=True),
+                connect_core.TargetUnit(screens.Target.WaterBallListEnd, log_level=log.DEBUG, break_detect=True),
+                connect_core.TargetUnit(screens.Target.InWaterBallList, log_level=log.DEBUG, break_detect=True),
             ]
-            api.connect_core.send('q', target_list_exit)
-            api.connect_core.send(command.go_main_menu, [
-                connect_core.TargetUnit(screens.Target.MainMenu, log_level=log.DEBUG, break_detect=True),
-            ])
-            break
-
-        # index == 2: InWaterBallList — next page
-        cmd = command.ctrl_f
+
+            index = api.connect_core.send(cmd, target_list)
+
+            if index == 0:
+                # no waterball records
+                api.connect_core.send('q' + command.go_main_menu, [
+                    connect_core.TargetUnit(screens.Target.MainMenu, log_level=log.DEBUG, break_detect=True),
+                ])
+                log.logger.info(i18n.get_waterball, '...', i18n.success)
+                return []
+
+            if index < 0:
+                break
+
+            screen = api.connect_core.get_screen_queue()[-1]
+            for line in screen.split('\n'):
+                line = line.strip()
+                if line and line not in seen_lines:
+                    seen_lines.add(line)
+                    all_content_parts.append(line)
+
+            if index == 1:
+                # WaterBallListEnd — collect done, exit viewer; handle post-action prompt
+                action_cmd = _post_action_cmd[post_action]
+                target_list_exit = [
+                    connect_core.TargetUnit(screens.Target.WaterBallPostAction, log_level=log.DEBUG,
+                                            response=action_cmd + command.enter),
+                    connect_core.TargetUnit(screens.Target.WaterballCleanup, log_level=log.DEBUG,
+                                            response='y' + command.enter),
+                    connect_core.TargetUnit(screens.Target.MainMenu, log_level=log.DEBUG, break_detect=True),
+                ]
+                api.connect_core.send('q', target_list_exit)
+                api.connect_core.send(command.go_main_menu, [
+                    connect_core.TargetUnit(screens.Target.MainMenu, log_level=log.DEBUG, break_detect=True),
+                ])
+                break
+
+            # index == 2: InWaterBallList — next page
+            cmd = command.ctrl_f
 
     result = []
     for line in _merge_continuation_lines(all_content_parts):

pyptt-2.1.3/PyPtt/_api_has_new_mail.py

@@ -0,0 +1,77 @@
+import re
+
+from . import _api_util
+from . import command
+from . import connect_core
+from . import log
+from . import screens
+
+
+def has_new_mail(api) -> int:
+    cmd_list = []
+    cmd_list.append(command.go_main_menu)
+    cmd_list.append(command.ctrl_z)
+    cmd_list.append('m')
+    # cmd_list.append('1')
+    # cmd_list.append(command.enter)
+    cmd = ''.join(cmd_list)
+    current_capacity = None
+    plus_count = 0
+    index_pattern = re.compile(r'(\d+)')
+    checked_index_list = []
+    break_detect = False
+
+    target_list = [
+        connect_core.TargetUnit(screens.Target.InMailBox, log_level=log.DEBUG, break_detect=True)
+    ]
+
+    api.connect_core.send(
+        cmd,
+        target_list,
+    )
+    current_capacity, _ = _api_util.get_mailbox_capacity(api)
+    if current_capacity > 20:
+        cmd_list = []
+        cmd_list.append(command.go_main_menu)
+        cmd_list.append(command.ctrl_z)
+        cmd_list.append('m')
+        cmd_list.append('1')
+        cmd_list.append(command.enter)
+        cmd = ''.join(cmd_list)
+
+    with _api_util.expanded_screen(api):
+        while True:
+            if current_capacity > 20:
+                api.connect_core.send(
+                    cmd,
+                    target_list,
+                )
+            last_screen = api.connect_core.get_screen_queue()[-1]
+
+            last_screen_list = last_screen.split('\n')
+            last_screen_list = last_screen_list[3:-1]
+            last_screen_list = [x[:10] for x in last_screen_list]
+
+            current_plus_count = 0
+            for line in last_screen_list:
+                if str(current_capacity) in line:
+                    break_detect = True
+
+                index_result = index_pattern.search(line)
+                if index_result is None:
+                    continue
+                current_index = index_result.group(0)
+                if current_index in checked_index_list:
+                    continue
+                checked_index_list.append(current_index)
+                if '+' not in line:
+                    continue
+
+                current_plus_count += 1
+
+            plus_count += current_plus_count
+            if break_detect:
+                break
+            cmd = command.ctrl_f
+
+    return plus_count