PyPtt 2.2.3__tar.gz → 2.2.5__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPtt
-Version: 2.2.3
+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)
@@ -28,7 +28,6 @@ License-File: LICENSE
 Requires-Dist: progressbar2
 Requires-Dist: websockets>=12
 Requires-Dist: certifi
-Requires-Dist: uao
 Requires-Dist: requests>=2.32
 Requires-Dist: AutoStrEnum
 Requires-Dist: PyYAML

{pyptt-2.2.3 → 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
@@ -611,8 +612,7 @@ class API:
             board (str): 看板名稱。
 
         Returns:
-            Dict: 樂透資訊，包含 price（每張價格）、total（已下注總額）、
-            options（下注選項清單，每個選項包含 index、name、sold）。
+            Dict，樂透資訊，詳見 :ref:`lottery-field`。
 
         Raises:
             RequireLogin: 需要登入。
@@ -646,8 +646,7 @@ class API:
             amount (int): 購買張數，範圍 1~9999，並受限於帳戶內的 Ptt 幣餘額。
 
         Returns:
-            Dict: 下注結果，包含 board、item、name（選項名稱）、amount、
-            cost（本次下注花費的 Ptt 幣總額）。
+            Dict，下注結果，詳見 :ref:`lottery-bet-field`。
 
         Raises:
             RequireLogin: 需要登入。
@@ -808,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:
         """
@@ -1002,6 +1033,22 @@ class API:
             finally:
                 ptt_bot.logout()
 
+        以作者搜尋信件（先用 get_newest_index 取得該作者的信件數，再逐封取得）::
+
+            import PyPtt
+
+            ptt_bot = PyPtt.API()
+
+            search_list = [(PyPtt.SearchType.AUTHOR, 'CodingMan')]
+
+            try:
+                # .. login ..
+                count = ptt_bot.get_newest_index(PyPtt.NewIndex.MAIL, search_list=search_list)
+                mail = ptt_bot.get_mail(index=count, search_list=search_list)
+                # .. do something ..
+            finally:
+                ptt_bot.logout()
+
         參考 :doc:`get_newest_index`
         """
 

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

@@ -1,4 +1,4 @@
-__version__ = '2.2.3'
+__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.5/PyPtt/_uao/LICENSE

@@ -0,0 +1,26 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 eight
+
+Vendored into PyPtt from PttCodingMan/pyUAO (a fork of eight04/pyUAO):
+https://github.com/PttCodingMan/pyUAO
+Commit 9d9a8bf59dbe60800d214b66ce972bc2ddf8da89 (v0.3.0)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

pyptt-2.2.5/PyPtt/_uao/__init__.py

@@ -0,0 +1,207 @@
+"""Vendored Big5-UAO codec.
+
+Vendored (unmodified) from PttCodingMan/pyUAO, a fork of eight04/pyUAO,
+to drop the external `uao` PyPI dependency (unmaintained upstream) and
+pick up this fork's correctness fixes and incremental/stream codec
+support. Vendoring is for dependency control, not performance: PyPtt is
+I/O bound, so codec speed is not the point here.
+
+Source:  https://github.com/PttCodingMan/pyUAO
+Commit:  9d9a8bf59dbe60800d214b66ce972bc2ddf8da89 (v0.3.0)
+License: MIT (c) 2018 eight -- see LICENSE in this directory.
+"""
+
+from codecs import (
+    Codec,
+    CodecInfo,
+    IncrementalDecoder,
+    IncrementalEncoder,
+    StreamReader,
+    StreamWriter,
+    lookup_error,
+    register,
+)
+
+from .b2u import b2u_table
+from .u2b import u2b_table
+
+__version__ = "0.3.0"
+
+# ASCII is not part of the generated table; fill it in once at import time so
+# the hot loops below never have to special-case it or mutate the tables.
+for _i in range(0x80):
+    u2b_table.setdefault(chr(_i), bytes((_i,)))
+del _i
+
+# UAO maps the lone byte 0xFF to U+F8F8. The generated u2b table stores that
+# mapping as a zero-padded pair (b"\x00\xff"), which is not a valid Big5 byte
+# sequence, and the generated b2u table omits it entirely. 0xFF is never a
+# lead byte (b2u lead bytes are 0x81-0xFE), so a single-byte entry is safe.
+u2b_table["\uf8f8"] = b"\xff"
+b2u_table.setdefault(0xFF, "\uf8f8")
+
+_u2b_get = u2b_table.get
+_b2u_get = b2u_table.get
+
+
+def _encode(input, errors):
+    """Encode a str, returning a list of bytes chunks."""
+    try:
+        # fast path: every character is in the table
+        return [u2b_table[c] for c in input]
+    except KeyError:
+        pass
+    out = []
+    append = out.append
+    error_handler = None
+    i = 0
+    n = len(input)
+    while i < n:
+        b = _u2b_get(input[i])
+        if b is not None:
+            append(b)
+            i += 1
+            continue
+        if error_handler is None:
+            error_handler = lookup_error(errors)
+        replacement, i = error_handler(UnicodeEncodeError(
+            "big5-uao", input, i, i + 1, "illegal multibyte sequence"))
+        if i < 0:
+            i += n
+        if isinstance(replacement, str):
+            out += _encode(replacement, "strict")
+        else:
+            append(replacement)
+    return out
+
+
+def _decode(input, errors, final):
+    """Decode bytes, returning (list of str chunks, bytes consumed).
+
+    With final=False, a trailing lead byte is left unconsumed so the
+    incremental decoder can buffer it until more data arrives.
+    """
+    out = []
+    append = out.append
+    error_handler = None
+    i = 0
+    n = len(input)
+    while i < n:
+        c = input[i]
+        if c < 0x80:
+            append(chr(c))
+            i += 1
+            continue
+        if i + 1 < n:
+            u = _b2u_get(c * 0x100 + input[i + 1])
+            if u is not None:
+                append(u)
+                i += 2
+                continue
+            u = _b2u_get(c)
+            if u is not None:
+                append(u)
+                i += 1
+                continue
+            reason = "illegal multibyte sequence"
+            end = i + 1
+        else:
+            # single-byte mappings (0xFF) never start a pair, so they can
+            # be emitted even when more data may follow
+            u = _b2u_get(c)
+            if u is not None:
+                append(u)
+                i += 1
+                continue
+            if not final:
+                break
+            reason = "incomplete multibyte sequence"
+            end = n
+        if error_handler is None:
+            error_handler = lookup_error(errors)
+        replacement, i = error_handler(UnicodeDecodeError(
+            "big5-uao", input, i, end, reason))
+        if i < 0:
+            i += n
+        append(replacement)
+    return out, i
+
+
+class Big5UAOCodec(Codec):
+    def encode(self, input, errors="strict"):
+        """Encode str to bytes with the u2b table."""
+        return b"".join(_encode(input, errors)), len(input)
+
+    def decode(self, input, errors="strict"):
+        """Decode bytes to str with the b2u table."""
+        input = bytes(input)
+        out, consumed = _decode(input, errors, True)
+        return "".join(out), consumed
+
+
+class Big5UAOIncrementalEncoder(IncrementalEncoder):
+    def encode(self, input, final=False):
+        return b"".join(_encode(input, self.errors))
+
+
+class Big5UAOIncrementalDecoder(IncrementalDecoder):
+    def __init__(self, errors="strict"):
+        IncrementalDecoder.__init__(self, errors)
+        self.buffer = b""
+
+    def decode(self, input, final=False):
+        data = self.buffer + bytes(input)
+        out, consumed = _decode(data, self.errors, final)
+        self.buffer = data[consumed:]
+        return "".join(out)
+
+    def reset(self):
+        self.buffer = b""
+
+    def getstate(self):
+        return self.buffer, 0
+
+    def setstate(self, state):
+        self.buffer = state[0]
+
+
+class Big5UAOStreamWriter(Big5UAOCodec, StreamWriter):
+    pass
+
+
+class Big5UAOStreamReader(Big5UAOCodec, StreamReader):
+    def decode(self, input, errors="strict"):
+        # Never treat the chunk as final: StreamReader keeps unconsumed
+        # bytes in its buffer, so a split multibyte sequence is completed
+        # by the next read instead of raising.
+        input = bytes(input)
+        out, consumed = _decode(input, errors, False)
+        return "".join(out), consumed
+
+
+_codec_info = None
+
+def _lookup(name):
+    if name in ("big5-uao", "big5uao", "big5_uao"):
+        global _codec_info
+        if _codec_info is None:
+            codec = Big5UAOCodec()
+            _codec_info = CodecInfo(
+                name="big5-uao",
+                encode=codec.encode,
+                decode=codec.decode,
+                incrementalencoder=Big5UAOIncrementalEncoder,
+                incrementaldecoder=Big5UAOIncrementalDecoder,
+                streamreader=Big5UAOStreamReader,
+                streamwriter=Big5UAOStreamWriter,
+            )
+        return _codec_info
+    return None
+
+REGISTERED = False
+def register_uao():
+    global REGISTERED
+    if REGISTERED:
+        return
+    REGISTERED = True
+    register(_lookup)