PyPtt 1.2.19__tar.gz → 1.3.0__tar.gz

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

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

{pyptt-1.2.19 → 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.19 → pyptt-1.3.0}/PyPtt/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '1.2.19'
+__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.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.19 → pyptt-1.3.0}/PyPtt/_api_util.py

@@ -94,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}]')

{pyptt-1.2.19 → 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.19 → 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.19 → 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.19 → 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.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.19 → pyptt-1.3.0}/PyPtt.egg-info/PKG-INFO

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

{pyptt-1.2.19 → 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.19/PyPtt/ssl_config.py

@@ -1,24 +0,0 @@
-key = """-----BEGIN EC PARAMETERS-----
-BggqhkjOPQMBBw==
------END EC PARAMETERS-----
------BEGIN EC PRIVATE KEY-----
-MHcCAQEEIG4BOpPiAtfiRgc2DydA/wkdxOGaxwH+exd4MXa4Cja8oAoGCCqGSM49
-AwEHoUQDQgAEDS/OWw/BDHH2l2pZO6LPmWqNUKmuPNSJ7xbtVxsIpuJwNxntrch6
-qbU2VrVjYuzRAjQvjff9rgC9kJLGi+Z2OQ==
------END EC PRIVATE KEY-----
-"""
-
-cert = """-----BEGIN CERTIFICATE-----
-MIIB6DCCAY8CFAnIVb8H7lNPfebaSJJTQ0vn9OfhMAoGCCqGSM49BAMCMHcxCzAJ
-BgNVBAYTAlRXMQ4wDAYDVQQIDAVTdGF0ZTENMAsGA1UEBwwEQ2l0eTEVMBMGA1UE
-CgwMT3JnYW5pemF0aW9uMRwwGgYDVQQLDBNPcmdhbml6YXRpb25hbCBVbml0MRQw
-EgYDVQQDDAtDb21tb24gTmFtZTAeFw0yNTA3MTAwNjM3MDNaFw0zNTA3MDgwNjM3
-MDNaMHcxCzAJBgNVBAYTAlRXMQ4wDAYDVQQIDAVTdGF0ZTENMAsGA1UEBwwEQ2l0
-eTEVMBMGA1UECgwMT3JnYW5pemF0aW9uMRwwGgYDVQQLDBNPcmdhbml6YXRpb25h
-bCBVbml0MRQwEgYDVQQDDAtDb21tb24gTmFtZTBZMBMGByqGSM49AgEGCCqGSM49
-AwEHA0IABA0vzlsPwQxx9pdqWTuiz5lqjVCprjzUie8W7VcbCKbicDcZ7a3Ieqm1
-Nla1Y2Ls0QI0L433/a4AvZCSxovmdjkwCgYIKoZIzj0EAwIDRwAwRAIgWFa5O1DU
-knIrEdqRN1AoSccEbIVQM9q3W+IC0xFHeU8CIDOfBI4Tn40oE+85IslFMVLZaXGK
-eD4SF5N8kWIN6UxT
------END CERTIFICATE-----
-"""