PyPtt 2.3.5__tar.gz → 2.3.7__tar.gz

{pyptt-2.3.5 → pyptt-2.3.7}/PKG-INFO

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

{pyptt-2.3.5 → pyptt-2.3.7}/PyPtt/PTT.py

@@ -230,6 +230,7 @@ class API:
 
         Raises:
             LoginError: 登入失敗。
+            TwoFactorAuthRequired: 偵測到兩階段驗證畫面，PyPtt 無法自動完成驗證。
             WrongIDorPassword: 帳號或密碼錯誤。
             OnlySecureConnection: 只能使用安全連線。
             ResetYourContactEmail: 請先至信箱設定連絡信箱。
@@ -242,6 +243,8 @@ class API:
             try:
                 ptt_bot.login(
                     ptt_id='ptt_id', ptt_pw='ptt_pw', kick_other_session=True)
+            except PyPtt.TwoFactorAuthRequired:
+                print('偵測到兩階段驗證，請先手動登入完成驗證')
             except PyPtt.LoginError:
                 print('登入失敗')
             except PyPtt.WrongIDorPassword:

{pyptt-2.3.5 → pyptt-2.3.7}/PyPtt/__init__.py

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

{pyptt-2.3.5 → pyptt-2.3.7}/PyPtt/_api_call_status.py

@@ -1,3 +1,5 @@
+import re
+
 from . import command
 from . import connect_core
 from . import data_type
@@ -6,6 +8,18 @@ from . import log
 from . import screens
 
 
+# 狀態列有 '[呼叫器]打開' 與 '呼叫器關閉' 兩種寫法, 中括號不保證存在。
+_call_status_pattern = re.compile(r'呼叫器[\]\s]*(打開|拔掉|防水|好友|關閉)')
+
+_call_status_map = {
+    '打開': data_type.CallStatus.ON,
+    '拔掉': data_type.CallStatus.UNPLUG,
+    '防水': data_type.CallStatus.WATERPROOF,
+    '好友': data_type.CallStatus.FRIEND,
+    '關閉': data_type.CallStatus.OFF,
+}
+
+
 def get_call_status(api) -> data_type.CallStatus:
 
     cmd_list = []
@@ -17,34 +31,21 @@ def get_call_status(api) -> data_type.CallStatus:
     cmd = ''.join(cmd_list)
 
     target_list = [
-        connect_core.TargetUnit('[呼叫器]打開', log_level=log.DEBUG, break_detect=True),
-        connect_core.TargetUnit('[呼叫器]拔掉', log_level=log.DEBUG, break_detect=True),
-        connect_core.TargetUnit('[呼叫器]防水', log_level=log.DEBUG, break_detect=True),
-        connect_core.TargetUnit('[呼叫器]好友', log_level=log.DEBUG, break_detect=True),
-        connect_core.TargetUnit('[呼叫器]關閉', log_level=log.DEBUG, break_detect=True),
+        connect_core.TargetUnit(screens.Target.MainMenu, log_level=log.DEBUG, break_detect=True),
         connect_core.TargetUnit('★', log_level=log.DEBUG, response=cmd),
     ]
 
-    for i in range(2):
-        index = api.connect_core.send(cmd, target_list)
-        if index < 0:
-            if i == 0:
-                continue
-            raise exceptions.UnknownError('UnknownError')
-
-    if index == 0:
-        return data_type.CallStatus.ON
-    if index == 1:
-        return data_type.CallStatus.UNPLUG
-    if index == 2:
-        return data_type.CallStatus.WATERPROOF
-    if index == 3:
-        return data_type.CallStatus.FRIEND
-    if index == 4:
-        return data_type.CallStatus.OFF
+    for _ in range(2):
+        if api.connect_core.send(cmd, target_list) == 0:
+            break
+    else:
+        raise exceptions.UnknownError('UnknownError')
 
     ori_screen = api.connect_core.get_screen_queue()[-1]
-    raise exceptions.UnknownError(ori_screen)
+    result = _call_status_pattern.search(ori_screen)
+    if result is None:
+        raise exceptions.UnknownError(ori_screen)
+    return _call_status_map[result.group(1)]
 
 
 def set_call_status(api, call_status) -> None:

{pyptt-2.3.5 → pyptt-2.3.7}/PyPtt/_api_get_time.py

@@ -38,7 +38,8 @@ def get_time(api) -> str:
     # 0:00
 
     for line in line_list:
-        if '星期' in line and '線上' in line and '我是' in line:
+        # 短格式的狀態列寫 '週三' 不是 '星期六', 所以不能比對 '星期'。
+        if '線上' in line and '我是' in line:
             result = pattern.search(line)
             if result is not None:
                 return result.group(0)

{pyptt-2.3.5 → pyptt-2.3.7}/PyPtt/_api_loginout.py

@@ -97,6 +97,8 @@ def login(api, ptt_id: str, ptt_pw: str, kick_other_session: bool) -> None:
         connect_core.TargetUnit('密碼正確'),
         connect_core.TargetUnit('您想刪除其他重複登入的連線嗎', response=kick_other_login_response),
         connect_core.TargetUnit('◆ 您的註冊申請單尚在處理中', response=command.enter, handler=register_processing),
+        # 需排在「任意鍵」等泛用 catch-all 之前, 否則會被搶先命中而吃不到這條。
+        connect_core.TargetUnit('兩階段', break_detect=True, exceptions_=exceptions.TwoFactorAuthRequired()),
         connect_core.TargetUnit('任意鍵', response=' '),
         connect_core.TargetUnit('正在更新與同步線上使用者及好友名單'),
         connect_core.TargetUnit('【分類看板】', response=command.go_main_menu),

{pyptt-2.3.5 → pyptt-2.3.7}/PyPtt/exceptions.py

@@ -38,6 +38,16 @@ class LoginError(Error):
         return self.message
 
 
+# 繼承 LoginError 以維持既有 `except LoginError` 呼叫端的相容性。
+# PyPtt 不實作 TOTP 自動輸入, 這裡只負責偵測畫面並指路。
+class TwoFactorAuthRequired(LoginError):
+    def __init__(self):
+        self.message = i18n.two_factor_auth_required
+
+    def __str__(self):
+        return self.message
+
+
 class NoFastComment(Error):
     def __init__(self):
         self.message = i18n.no_fast_comment

{pyptt-2.3.5 → pyptt-2.3.7}/PyPtt/lang_en_US.py

@@ -110,6 +110,14 @@ string_data = {
     "success": "Success",
     "title": "Title",
     "transaction_cancelled": "The transaction is cancelled!",
+    "two_factor_auth_required": (
+        "This account has two-factor authentication (2FA) enabled, and PyPtt cannot "
+        "complete the verification automatically. PTT's 2FA can be configured to only "
+        "require verification from new IPs, so logging in again from the same IP will "
+        "skip it. Please first manually log in to PTT from this machine using a regular "
+        "BBS client and complete one 2FA verification; afterwards this machine's IP will "
+        "be considered verified, and you can then log in with PyPtt."
+    ),
     "unregistered_user_cant_use_all_api": "Unregistered UserField Can't Use All API",
     "unregistered_user_cant_use_this_api": "Unregistered UserField Can't Use This API",
     "update_remote_version": "Fetching latest version",

{pyptt-2.3.5 → pyptt-2.3.7}/PyPtt/lang_zh_TW.py

@@ -110,6 +110,12 @@ string_data = {
     "success": "成功",
     "title": "標題",
     "transaction_cancelled": "交易取消!",
+    "two_factor_auth_required": (
+        "此帳號已啟用兩階段驗證(2FA), PyPtt 無法自動完成驗證。"
+        "PTT 的兩階段驗證可設定為「僅新 IP 需要驗證」, 同一 IP 再次登入時會跳過驗證。"
+        "請先在這台機器上使用一般 BBS 客戶端手動登入 PTT 並完成一次兩階段驗證, "
+        "之後這台機器的 IP 即可被視為已驗證, 再用 PyPtt 登入。"
+    ),
     "unregistered_user_cant_use_all_api": "未註冊使用者，將無法使用全部功能",
     "unregistered_user_cant_use_this_api": "未註冊使用者，無法使用此功能",
     "update_remote_version": "確認最新版本",

{pyptt-2.3.5 → pyptt-2.3.7}/PyPtt/screens.py

@@ -63,10 +63,14 @@ def _str_pos_at_cells(line: str, cells: int) -> int:
 
 
 class Target:
+    # 正式站狀態列有兩種寫法, 短的那種會把逗號後的空格與中括號吃掉:
+    #   [5/23 星期六 16:40] [ 射手時 ]  線上27866人, 我是CodingMan   [呼叫器]打開
+    #   8/19週三22:35   [ 七夕 ]   線上30721人,我是DeepLearning 呼叫器關閉  (h)說明
+    # 只比對兩種格式共同的最短關鍵詞。
     MainMenu = [
         '離開，再見',
-        '人, 我是',
-        '[呼叫器]',
+        '我是',
+        '呼叫器',
     ]
 
     MainMenu_Exiting = [

{pyptt-2.3.5 → pyptt-2.3.7}/PyPtt.egg-info/PKG-INFO

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

{pyptt-2.3.5 → pyptt-2.3.7}/PyPtt.egg-info/SOURCES.txt

@@ -97,5 +97,6 @@ tests/test_search_user.py
 tests/test_service.py
 tests/test_set_board_title.py
 tests/test_set_signature_file.py
+tests/test_status_line.py
 tests/test_uao_codec.py
 tests/test_vt100_parser.py

pyptt-2.3.7/tests/test_status_line.py

@@ -0,0 +1,41 @@
+"""PTT 主選單狀態列有長短兩種寫法, 兩種都必須認得。
+
+長: [5/23 星期六 16:40] [ 射手時 ]    線上27866人, 我是CodingMan      [呼叫器]打開
+短: 8/19週三22:35   [ 七夕 ]    線上30721人,我是DeepLearning 呼叫器關閉     (h)說明
+
+短的那種把逗號後的空格與呼叫器的中括號都吃掉了, 日期也從 '星期六' 縮成 '週三'。
+"""
+import re
+
+from PyPtt import data_type
+from PyPtt._api_call_status import _call_status_map, _call_status_pattern
+from PyPtt._api_get_time import pattern as time_pattern
+from PyPtt.screens import Target
+
+LONG = '[5/23 星期六 16:40] [ 射手時 ]    線上27866人, 我是CodingMan      [呼叫器]打開 '
+SHORT = '8/19週三22:35   [ 七夕 ]    線上30721人,我是DeepLearning 呼叫器關閉     (h)說明'
+
+MENU_BODY = '                      (G)oodbye         離開，再見…'
+
+
+def test_main_menu_markers_match_both_status_lines():
+    for status in (LONG, SHORT):
+        screen = MENU_BODY + '\n' + status
+        assert all(t in screen for t in Target.MainMenu), status
+
+
+def test_get_time_line_filter_and_pattern():
+    for status, expected in ((LONG, '16:40'), (SHORT, '22:35')):
+        assert '線上' in status and '我是' in status
+        assert time_pattern.search(status).group(0) == expected
+
+
+def test_call_status_pattern():
+    assert _call_status_map[_call_status_pattern.search(LONG).group(1)] == data_type.CallStatus.ON
+    assert _call_status_map[_call_status_pattern.search(SHORT).group(1)] == data_type.CallStatus.OFF
+
+
+def test_call_status_pattern_covers_every_state():
+    for word, expected in _call_status_map.items():
+        for form in (f'[呼叫器]{word}', f'呼叫器{word}'):
+            assert _call_status_map[_call_status_pattern.search(form).group(1)] == expected