update docs & add True as an option for wechat logging arg receiver

wxpy/__init__.py

@@ -52,7 +52,7 @@ def reply_my_friend(msg):
 from .utils import dont_raise_response_error, embed, ensure_one, mutual_friends
 
 __title__ = 'wxpy'
-__version__ = '0.2.3'
+__version__ = '0.2.4'
 __author__ = 'Youfou'
 __license__ = 'MIT'
 __copyright__ = '2017, Youfou'

wxpy/api/bot.py

@@ -24,14 +24,14 @@ def __init__(
     ):
         """
         :param cache_path:
-            | 当前会话的缓存路径，不指定则不使用缓存功能。
-            | 可在短时间内避免重复扫码，缓存失效时会重新要求登陆。
-            | 若将该参数设为 `True`，则缓存到默认的路径 'wxpy.pkl'。
+            * 设置当前会话的缓存路径，并开启缓存功能；为 `None` (默认) 则不开启缓存功能。
+            * 开启缓存后可在短时间内避免重复扫码，缓存失效时会重新要求登陆。
+            * 设为 `True` 时，使用默认的缓存路径 'wxpy.pkl'。
         :param console_qr:
-            | 在终端中显示登陆二维码。该功能需要安装 pillow 模块 (`pip3 install pillow`)。
-            | 该参数可为整数(int)，表示二维码单元格的宽度，通常为 2。当该参数被设为 `True` 时，也将在内部当作 2。
-            | 该参数也可为负数，表示以反色显示二维码，适用于浅底深字的命令行界面。
-            | 例如: 在大部分 Linux 系统中可设为 `True` 或 2，而在 macOS Terminal 的默认白底配色中，应设为 -2。
+            * 在终端中显示登陆二维码，需要安装 pillow 模块 (`pip3 install pillow`)。
+            * 可为整数(int)，表示二维码单元格的宽度，通常为 2 (当被设为 `True` 时，也将在内部当作 2)。
+            * 也可为负数，表示以反色显示二维码，适用于浅底深字的命令行界面。
+            * 例如: 在大部分 Linux 系统中可设为 `True` 或 2，而在 macOS Terminal 的默认白底配色中，应设为 -2。
         :param qr_path: 保存二维码的路径
         :param qr_callback: 获得二维码后的回调，接收参数: uuid, status, qrcode
         :param login_callback: 登陆成功后的回调，接收参数同上

wxpy/api/chats/chat.py

@@ -63,10 +63,10 @@ def send(self, msg, media_id=None):
         动态发送不同类型的消息，具体类型取决于 `msg` 的前缀。
 
         :param msg:
-            | 由 **前缀** 和 **内容** 两个部分组成，若 **省略前缀**，将作为纯文本消息发送
-            | **前缀** 部分可为: '@fil@', '@img@', '@msg@', '@vid@' (不含引号)
-            | 分别表示: 文件，图片，纯文本，视频
-            | **内容** 部分可为: 文件、图片、视频的路径，或纯文本的内容
+            * 由 **前缀** 和 **内容** 两个部分组成，若 **省略前缀**，将作为纯文本消息发送
+            * **前缀** 部分可为: '@fil@', '@img@', '@msg@', '@vid@' (不含引号)
+            * 分别表示: 文件，图片，纯文本，视频
+            * **内容** 部分可为: 文件、图片、视频的路径，或纯文本的内容
         :param media_id: 填写后可省略上传过程
         """
         return self.bot.core.send(msg=str(msg), toUserName=self.user_name, mediaId=media_id)

wxpy/ext/logging_with_wechat.py

@@ -11,10 +11,10 @@ def get_receiver(receiver=None):
         return receiver
     elif isinstance(receiver, Bot):
         return receiver.file_helper
-    elif receiver is None or isinstance(receiver, str):
+    elif receiver in (None, True) or isinstance(receiver, str):
         return Bot(cache_path=receiver).file_helper
     else:
-        raise TypeError('expected Chat, Bot, str or None')
+        raise TypeError('expected Chat, Bot, str, True or None')
 
 
 class WeChatLoggingHandler(logging.Handler):
@@ -23,10 +23,9 @@ def __init__(self, receiver=None):
         可向指定微信聊天对象发送日志的 Logging Handler
 
         :param receiver:
-            | 当为 `None` 时，将启动一个新的机器人，并发送到该机器人的"文件传输助手"
-            | 当为 字符串时，将以该字符串作为缓存路径启动一个新的机器人，并发送到该机器人的"文件传输助手"
-            | 当为 :class:`机器人 <Bot>` 时，将发送到该机器人的"文件传输助手"
-            | 当为 :class:`聊天对象 <Chat>` 时，将发送到该聊天对象
+            * 当为 `None`, `True` 或字符串时，将以该值作为 `cache_path` 参数启动一个新的机器人，并发送到该机器人的"文件传输助手"
+            * 当为 :class:`机器人 <Bot>` 时，将发送到该机器人的"文件传输助手"
+            * 当为 :class:`聊天对象 <Chat>` 时，将发送到该聊天对象
         """
 
         super(WeChatLoggingHandler, self).__init__()
@@ -46,10 +45,9 @@ def get_wechat_logger(receiver=None, name=None, level=logging.WARNING):
     获得一个可向指定微信聊天对象发送日志的 Logger
 
     :param receiver:
-        | 当为 `None` 时，将启动一个新的机器人，并发送到该机器人的"文件传输助手"
-        | 当为 字符串时，将以该字符串作为缓存路径启动一个新的机器人，并发送到该机器人的"文件传输助手"
-        | 当为 :class:`机器人 <Bot>` 时，将发送到该机器人的"文件传输助手"
-        | 当为 :class:`聊天对象 <Chat>` 时，将发送到该聊天对象
+        * 当为 `None`, `True` 或字符串时，将以该值作为 `cache_path` 参数启动一个新的机器人，并发送到该机器人的"文件传输助手"
+        * 当为 :class:`机器人 <Bot>` 时，将发送到该机器人的"文件传输助手"
+        * 当为 :class:`聊天对象 <Chat>` 时，将发送到该聊天对象
     :param name: Logger 名称
     :param level: Logger 等级，默认为 `logging.WARNING`
     :return: Logger

wxpy/ext/tuling.py

@@ -10,9 +10,9 @@
 
 class Tuling(object):
     """
-    | 与 wxpy 深度整合的图灵机器人
-    | 内置 API KEY 可能存在调用限制，建议自行申请一枚新的。
-    | 获取 API KEY: http://www.tuling123.com/
+    * 与 wxpy 深度整合的图灵机器人
+    * 内置 API KEY 可能存在调用限制，建议自行申请一枚新的。
+    * 获取 API KEY: http://www.tuling123.com/
     """
 
     'API 文档: http://tuling123.com/help/h_cent_webapi.jhtml'