PyPtt 1.2.18__tar.gz → 1.3.0__tar.gz

{pyptt-1.2.18 → pyptt-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPtt
-Version: 1.2.18
+Version: 1.3.0
 Summary: PyPtt
 Home-page: https://pyptt.cc/
 Author: CodingMan

{pyptt-1.2.18 → pyptt-1.3.0}/PyPtt/PTT.py

@@ -15,6 +15,7 @@ from . import _api_get_bottom_post_list
 from . import _api_get_favourite_board
 from . import _api_get_newest_index
 from . import _api_get_post
+from . import _api_get_post_list
 from . import _api_get_time
 from . import _api_get_user
 from . import _api_give_money
@@ -1055,6 +1056,36 @@ class API:
 
         _api_del_post.del_post(self, board, aid, index)
 
+    def get_post_list(self, board: str, limit: int = 20, offset: int = 0) -> list[dict]:
+        """
+        取得文章列表。
+
+        Args:
+            board (str): 看板名稱。
+            limit (int): 取得文章數量，預設為 20。
+            offset (int): 偏移量，預設為 0。
+        Returns:
+            list[dict]，文章列表，詳見 :ref:`post-field`。
+
+        Raises:
+            RequireLogin: 需要登入。
+            NoSuchBoard: 看板不存在。
+
+        範例::
+
+            import PyPtt
+
+            ptt_bot = PyPtt.API()
+            try:
+                # .. login ..
+                post_list = ptt_bot.get_post_list(board='Python', limit=10, offset=0)
+                # .. do something ..
+            finally:
+                ptt_bot.logout()
+        """
+
+        return _api_get_post_list.get_post_list(self, board, limit, offset)
+
     def fast_post_step0(self, board: str, title: str, content: str, post_type: int) -> None:
         _api_post.fast_post_step0(self, board, title, content, post_type)
 

{pyptt-1.2.18 → pyptt-1.3.0}/PyPtt/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '1.2.18'
+__version__ = '1.3.0'
 
 from .PTT import API
 from .data_type import *
@@ -8,4 +8,4 @@ from .service import Service
 
 LOG_LEVEL = LogLevel
 
-_main_version = '1.2'
+_main_version = '1.3'

{pyptt-1.2.18 → pyptt-1.3.0}/PyPtt/_api_comment.py

@@ -130,7 +130,7 @@ def comment(api, board: str, push_type: data_type.CommentType, push_content: str
     check_value.check_type(board, str, 'board')
 
     if not isinstance(push_type, data_type.CommentType):
-        raise TypeError(f'CommentType must be data_type.CommentType')
+        raise TypeError('CommentType must be data_type.CommentType')
 
     check_value.check_type(push_content, str, 'push_content')
     if post_aid is not None:

{pyptt-1.2.18 → pyptt-1.3.0}/PyPtt/_api_get_post.py

@@ -129,7 +129,7 @@ def _get_post(api, board: str, post_aid: Optional[str] = None, post_index: int =
     ]
 
     index = api.connect_core.send(cmd, target_list)
-    ori_screen = api.connect_core.get_screen_queue()[-1]
+    last_screen = api.connect_core.get_screen_queue()[-1]
 
     post = {
         PostField.board: None,
@@ -158,13 +158,13 @@ def _get_post(api, board: str, post_aid: Optional[str] = None, post_index: int =
     if index < 0 or index == 1:
         # 文章被刪除
         log.logger.debug(i18n.post_deleted)
-        log.logger.debug('OriScreen', ori_screen)
+        log.logger.debug('OriScreen', last_screen)
 
-        cursor_line = [line for line in ori_screen.split(
+        cursor_line = [line for line in last_screen.split(
             '\n') if line.startswith(api.cursor)]
 
         if len(cursor_line) != 1:
-            raise exceptions.UnknownError(ori_screen)
+            raise exceptions.UnknownError(last_screen)
 
         cursor_line = cursor_line[0]
         log.logger.debug('CursorLine', cursor_line)
@@ -214,7 +214,7 @@ def _get_post(api, board: str, post_aid: Optional[str] = None, post_index: int =
         lock_post, post_author, post_title, post_aid, post_web, post_money, list_date, push_number, post_index = \
             _api_util.parse_query_post(
                 api,
-                ori_screen)
+                last_screen)
 
         if lock_post:
             post.update({

pyptt-1.3.0/PyPtt/_api_get_post_list.py

@@ -0,0 +1,100 @@
+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 = []
+
+    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:
+                    # add one space in the beginning to align the old cursor line
+                    line = f' {line}'
+
+            cur_index = int(line[:8].strip())
+            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-1.2.18 → pyptt-1.3.0}/PyPtt/_api_mark_post.py

@@ -21,7 +21,7 @@ def mark_post(api, mark_type: int, board: str, post_aid: str, post_index: int, s
         raise exceptions.UnregisteredUser(lib_util.get_current_func_name())
 
     if not isinstance(mark_type, data_type.MarkType):
-        raise TypeError(f'mark_type must be data_type.MarkType')
+        raise TypeError('mark_type must be data_type.MarkType')
 
     check_value.check_type(board, str, 'board')
     if post_aid is not None:
@@ -29,7 +29,7 @@ def mark_post(api, mark_type: int, board: str, post_aid: str, post_index: int, s
     check_value.check_type(post_index, int, 'PostIndex')
 
     if not isinstance(search_type, data_type.SearchType):
-        raise TypeError(f'search_type must be data_type.SearchType')
+        raise TypeError('search_type must be data_type.SearchType')
 
     if search_condition is not None:
         check_value.check_type(search_condition, str, 'SearchCondition')

{pyptt-1.2.18 → pyptt-1.3.0}/PyPtt/_api_reply_post.py

@@ -17,7 +17,7 @@ def reply_post(api, reply_to: data_type.ReplyTo, board: str, content: str, sign_
         raise exceptions.RequireLogin(i18n.require_login)
 
     if not isinstance(reply_to, data_type.ReplyTo):
-        raise TypeError(f'ReplyTo must be data_type.ReplyTo')
+        raise TypeError('ReplyTo must be data_type.ReplyTo')
 
     check_value.check_type(board, str, 'board')
     check_value.check_type(content, str, 'content')

{pyptt-1.2.18 → pyptt-1.3.0}/PyPtt/_api_util.py

@@ -33,8 +33,7 @@ def get_content(api, post_mode: bool = True):
         connect_core.TargetUnit(screens.Target.InPost, log_level=log.DEBUG, break_detect=True),
         connect_core.TargetUnit(screens.Target.PostNoContent, log_level=log.DEBUG, break_detect=True),
         # 動畫文章
-        connect_core.TargetUnit(screens.Target.Animation, response=command.go_main_menu_type_q,
-                                break_detect_after_send=True),
+        connect_core.TargetUnit(screens.Target.Animation, response='n'),
     ]
 
     line_from_pattern = re.compile(r'[\d]+~[\d]+')
@@ -95,7 +94,7 @@ def get_content(api, post_mode: bool = True):
             # 這裡是 PyPtt 最黑暗最墮落的地方，所有你所知的程式碼守則，在這裡都不適用
             # 每除完一次錯誤，我會陷入嚴重的創傷後壓力症候群，而我的腦袋會自動選擇遺忘這裡所有的一切
             # 以確保下一個週一，我可以正常上班
-            # but it works!
+            # but it works!!!
 
             # print(LastScreen)
             # print(f'last_read_line_a_temp [{last_read_line_a_temp}]')
@@ -395,7 +394,7 @@ def goto_board(api, board: str, refresh: bool = False, end: bool = False) -> Non
     # 這裡可能因為發現第一次進入看板會有進版畫面，一般來說都可以在 target_list 找到對應的標的
     # 但某些看板會卡在進版動畫中，但沒有顯示任意鍵繼續或互動是動畫，所以當 index == -1 (表示找不到標的 timeout 了)
     # 可以嘗試修改 cmd_list
-    index = api.connect_core.send(cmd, target_list, refresh=current_refresh)
+    api.connect_core.send(cmd, target_list, refresh=current_refresh)
 
     if end:
         cmd_list = []

{pyptt-1.2.18 → pyptt-1.3.0}/PyPtt/check_value.py

@@ -15,14 +15,20 @@ def check_type(value, value_type, name) -> None:
             raise TypeError(f'[PyPtt] {name} {i18n.must_be} {value_type}, but got {value}')
 
 
-def check_range(value, min_value, max_value, name) -> None:
+def check_range(value, min_value: int = None, max_value: int = None, name: str = None) -> None:
     check_type(value, int, name)
-    check_type(min_value, int, 'min_value')
-    check_type(max_value, int, 'max_value')
 
-    if min_value <= value <= max_value:
-        return
-    raise exceptions.ParameterError(f'{name} {value} {i18n.must_between} {min_value} ~ {max_value}')
+    if min_value is not None:
+        check_type(min_value, int, 'min_value')
+
+        if value < min_value:
+            raise exceptions.ParameterError(f'{name} {value} {i18n.must_between} {min_value} ~ {max_value}')
+
+    if max_value is not None:
+        check_type(max_value, int, 'max_value')
+
+        if value > max_value:
+            raise exceptions.ParameterError(f'{name} {value} {i18n.must_between} {min_value} ~ {max_value}')
 
 
 def check_index(name, index, max_value=None) -> None:

{pyptt-1.2.18 → pyptt-1.3.0}/PyPtt/command.py

@@ -26,3 +26,6 @@ go_main_menu_type_q = 'q' * 5
 refresh = ctrl_l
 control_code = ctrl_u + star
 backspace = ctrl_h
+
+page_up = 'P'
+page_down = 'N'

{pyptt-1.2.18 → pyptt-1.3.0}/PyPtt/connect_core.py

@@ -95,8 +95,13 @@ class TargetUnit:
                 if target == cursor:
                     if not any(line.startswith(target) for line in screen.split('\n')):
                         return False
-                elif target not in screen:
-                    return False
+                elif isinstance(target, str):
+                    if target not in screen:
+                        return False
+                elif isinstance(target, list):
+                    if not any(t in screen for t in target):
+                        return False
+
             self._current_match += 1
             return True
 
@@ -211,7 +216,7 @@ class API(object):
                 if self.config.connect_mode == data_type.ConnectMode.TELNET:
                     self._core = telnetlib.Telnet(telnet_host, self.config.port)
                 else:
-                    if not threading.current_thread() is threading.main_thread():
+                    if threading.current_thread() is not threading.main_thread():
                         loop = asyncio.new_event_loop()
                         asyncio.set_event_loop(loop)
 

{pyptt-1.2.18 → pyptt-1.3.0}/PyPtt/lang_en_US.py

@@ -115,5 +115,6 @@ string_data = {
     "user_offline": "User offline",
     "wait_for_no_fast_comment": "Because no fast comment, wait 5 sec",
     "welcome": "PyPtt v _target0_ developed by CodingMan",
-    "wrong_id_pw": "Wrong id or pw"
+    "wrong_id_pw": "Wrong id or pw",
+    "unknown_error": "Unknown error",
 }

{pyptt-1.2.18 → pyptt-1.3.0}/PyPtt/lang_zh_TW.py

@@ -115,5 +115,6 @@ string_data = {
     "user_offline": "使用者離線",
     "wait_for_no_fast_comment": "因禁止快速連續推文，所以等待五秒",
     "welcome": "PyPtt v _target0_ 由 CodingMan 開發",
-    "wrong_id_pw": "帳號密碼錯誤"
+    "wrong_id_pw": "帳號密碼錯誤",
+    "unknown_error": "未知錯誤",
 }

{pyptt-1.2.18 → pyptt-1.3.0}/PyPtt/screens.py

@@ -23,7 +23,7 @@ class Target:
     PTT1_QueryPost = [
         '請按任意鍵繼續',
         '文章代碼(AID):',
-        '文章網址:'
+        ('文章網址:', '本看板目前不提供文章網址')
     ]
 
     PTT2_QueryPost = [

pyptt-1.3.0/PyPtt/ssl_config.py

@@ -0,0 +1,24 @@
+key = """-----BEGIN EC PARAMETERS-----
+BggqhkjOPQMBBw==
+-----END EC PARAMETERS-----
+-----BEGIN EC PRIVATE KEY-----
+MHcCAQEEIKw/h9H04KLxJfnIkNO3wM2+JjX8VOiAAkv2vK2P4H1HoAoGCCqGSM49
+AwEHoUQDQgAEnRlm+zkKvXUfHbay5w4QYc4GO5X/RVA+b7iPAcJdjapPnXBgdWxd
+nqIJiHX/7a5OIcgZ5rjs8zUtc0UlYe7eEA==
+-----END EC PRIVATE KEY-----
+"""
+
+cert = """-----BEGIN CERTIFICATE-----
+MIIB6jCCAY8CFCNOe3ddTd3VNwEtsYwbTsN8qW5oMAoGCCqGSM49BAMCMHcxCzAJ
+BgNVBAYTAlRXMQ4wDAYDVQQIDAVTdGF0ZTENMAsGA1UEBwwEQ2l0eTEVMBMGA1UE
+CgwMT3JnYW5pemF0aW9uMRwwGgYDVQQLDBNPcmdhbml6YXRpb25hbCBVbml0MRQw
+EgYDVQQDDAtDb21tb24gTmFtZTAeFw0yNTA5MDcwNzMwMTlaFw0zNTA5MDUwNzMw
+MTlaMHcxCzAJBgNVBAYTAlRXMQ4wDAYDVQQIDAVTdGF0ZTENMAsGA1UEBwwEQ2l0
+eTEVMBMGA1UECgwMT3JnYW5pemF0aW9uMRwwGgYDVQQLDBNPcmdhbml6YXRpb25h
+bCBVbml0MRQwEgYDVQQDDAtDb21tb24gTmFtZTBZMBMGByqGSM49AgEGCCqGSM49
+AwEHA0IABJ0ZZvs5Cr11Hx22sucOEGHOBjuV/0VQPm+4jwHCXY2qT51wYHVsXZ6i
+CYh1/+2uTiHIGea47PM1LXNFJWHu3hAwCgYIKoZIzj0EAwIDSQAwRgIhAPoAa/vC
+T5pmcdQRjItJuMvCdbX2AZIE58LZ2azm0rNkAiEA94lVjUIEcC6cZIR3b0ZhtEEc
+fhFBVrfHxjt/rmXT3os=
+-----END CERTIFICATE-----
+"""

{pyptt-1.2.18 → pyptt-1.3.0}/PyPtt.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPtt
-Version: 1.2.18
+Version: 1.3.0
 Summary: PyPtt
 Home-page: https://pyptt.cc/
 Author: CodingMan

{pyptt-1.2.18 → pyptt-1.3.0}/PyPtt.egg-info/SOURCES.txt

@@ -16,6 +16,7 @@ PyPtt/_api_get_favourite_board.py
 PyPtt/_api_get_newest_index.py
 PyPtt/_api_get_post.py
 PyPtt/_api_get_post_index.py
+PyPtt/_api_get_post_list.py
 PyPtt/_api_get_time.py
 PyPtt/_api_get_user.py
 PyPtt/_api_give_money.py

pyptt-1.2.18/PyPtt/ssl_config.py

@@ -1,24 +0,0 @@
-key = """-----BEGIN EC PARAMETERS-----
-BggqhkjOPQMBBw==
------END EC PARAMETERS-----
------BEGIN EC PRIVATE KEY-----
-MHcCAQEEIJbgsRW2TKkVA9Xes0BF+mZmt9xt55PQVkS/5fW7MSGRoAoGCCqGSM49
-AwEHoUQDQgAEovYlaBBO4yItJL4E64G3vnJ/35Y086ZHhasVSBcOHaWZ3gvPfEQ6
-bGzjAHcP0nvIHujHWZ0n+WiKHx5YrNBqdQ==
------END EC PRIVATE KEY-----
-"""
-
-cert = """-----BEGIN CERTIFICATE-----
-MIIB6TCCAY8CFBH32z9ttIrOFfV1B3S83UMpXJ8rMAoGCCqGSM49BAMCMHcxCzAJ
-BgNVBAYTAlRXMQ4wDAYDVQQIDAVTdGF0ZTENMAsGA1UEBwwEQ2l0eTEVMBMGA1UE
-CgwMT3JnYW5pemF0aW9uMRwwGgYDVQQLDBNPcmdhbml6YXRpb25hbCBVbml0MRQw
-EgYDVQQDDAtDb21tb24gTmFtZTAeFw0yNTA2MTEwMTI1NTZaFw0zNTA2MDkwMTI1
-NTZaMHcxCzAJBgNVBAYTAlRXMQ4wDAYDVQQIDAVTdGF0ZTENMAsGA1UEBwwEQ2l0
-eTEVMBMGA1UECgwMT3JnYW5pemF0aW9uMRwwGgYDVQQLDBNPcmdhbml6YXRpb25h
-bCBVbml0MRQwEgYDVQQDDAtDb21tb24gTmFtZTBZMBMGByqGSM49AgEGCCqGSM49
-AwEHA0IABKL2JWgQTuMiLSS+BOuBt75yf9+WNPOmR4WrFUgXDh2lmd4Lz3xEOmxs
-4wB3D9J7yB7ox1mdJ/loih8eWKzQanUwCgYIKoZIzj0EAwIDSAAwRQIhAOptXAaR
-UNGwem1Rrhu3u1xjXjquzYugsE4wEqe4ZtINAiAn8kWuKxsy+BLc3R4VOzzQ33zW
-RVgyl1y5FA4471yinw==
------END CERTIFICATE-----
-"""