python-plugins 0.1.5__tar.gz → 0.1.6__tar.gz

{python_plugins-0.1.5 → python_plugins-0.1.6}/CHANGES.rst

@@ -1,3 +1,10 @@
+v0.1.6
+------
+
+Released 2024-10-01
+
+- weixin.wechat support news
+
 v0.1.5
 ------
 

{python_plugins-0.1.5 → python_plugins-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: python-plugins
-Version: 0.1.5
+Version: 0.1.6
 Summary: A collection of Python functions and classes.
 Project-URL: Documentation, https://python-plugins.readthedocs.io
 Project-URL: Source, https://github.com/ojso/python-plugins

python_plugins-0.1.6/src/python_plugins/__about__.py

@@ -0,0 +1 @@
+__version__ = "0.1.6"

python_plugins-0.1.6/src/python_plugins/weixin/format_response.py

@@ -0,0 +1,148 @@
+import time
+
+# see https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Passive_user_reply_message.html
+
+# 文本消息
+# Content 回复的消息内容（换行：在content中能够换行\n,支持超链接<a href="url">xxx</a>）,
+XML_TEXT_TEMPLATE = """<xml>
+<ToUserName><![CDATA[{toUser}]]></ToUserName>
+<FromUserName><![CDATA[{fromUser}]]></FromUserName>
+<CreateTime>{createtime}</CreateTime>
+<MsgType><![CDATA[text]]></MsgType>
+<Content><![CDATA[{content}]]></Content>
+</xml>"""
+
+
+# 图片消息
+# MediaId 是 通过素材管理中的接口上传多媒体文件，得到的id
+XML_IMAGE_TEMPLATE = """<xml>
+<ToUserName><![CDATA [{toUser}]]></ToUserName>
+<FromUserName><![CDATA[{fromUser}]]></FromUserName>
+<CreateTime>{createtime}</CreateTime>
+<MsgType><![CDATA[image]]></MsgType>
+<Image>
+<MediaId><![CDATA[{media_id}]]></MediaId>
+</Image>
+</xml>"""
+
+
+# 语音消息
+# MediaId 是 通过素材管理中的接口上传多媒体文件，得到的id
+
+XML_VOICE_TEMPLATE = """<xml>
+<ToUserName><![CDATA [{toUser}]]></ToUserName>
+<FromUserName><![CDATA[{fromUser}]]></FromUserName>
+<CreateTime>{createtime}</CreateTime>
+<MsgType><![CDATA[voice]]></MsgType>
+<Voice>
+<MediaId><![CDATA[{media_id}]]></MediaId>
+</Voice>
+</xml>"""
+
+# 视频消息
+# MediaId 是 通过素材管理中的接口上传多媒体文件，得到的id
+# Title 否 视频消息的标题
+# Description 否 视频消息的描述
+
+XML_VIDEO_TEMPLATE = """<xml>
+<ToUserName><![CDATA [{toUser}]]></ToUserName>
+<FromUserName><![CDATA[{fromUser}]]></FromUserName>
+<CreateTime>{createtime}</CreateTime>
+<MsgType><![CDATA[video]]></MsgType>
+<Video>
+<MediaId><![CDATA[{media_id}]]></MediaId>
+<Title><![CDATA[{title}]]></Title>
+<Description><![CDATA[{description}]]></Description>
+</Video>
+</xml>"""
+
+# 音乐消息
+
+# Title 否 音乐标题
+# Description 否 音乐描述
+# MusicURL 否 音乐链接
+# HQMusicUrl 否 高质量音乐链接，WIFI环境优先使用该链接播放音乐
+# ThumbMediaId 是 缩略图的媒体id，通过素材管理中的接口上传多媒体文件，得到的id
+
+XML_MUSIC_TEMPLATE = """<xml>
+<ToUserName><![CDATA [{toUser}]]></ToUserName>
+<FromUserName><![CDATA[{fromUser}]]></FromUserName>
+<CreateTime>{createtime}</CreateTime>
+<MsgType><![CDATA[music]]></MsgType>
+<Music>
+<Title><![CDATA[{title}]]></Title>
+<Description><![CDATA[{description}]]></Description>
+<MusicUrl><![CDATA[{music_url}]]></MusicUrl>
+<HQMusicUrl><![CDATA[{hq_music_url}]]></HQMusicUrl>
+<ThumbMediaId><![CDATA[{media_id}]]></ThumbMediaId>
+</Music>
+</xml>"""
+
+# 图文消息
+
+# ArticleCount  是 图文消息个数；当用户发送文本、图片、语音、视频、图文、地理位置这六种消息时，开发者只能回复1条图文消息；其余场景最多可回复8条图文消息
+# Articles      是 图文消息信息，注意，如果图文数超过限制，则将只发限制内的条数
+# Title         是 图文消息标题
+# Description   是 图文消息描述
+# PicUrl        是 图片链接，支持JPG、PNG格式，较好的效果为大图360*200，小图200*200
+# Url           是 点击图文消息跳转链接
+
+XML_NEWS_TEMPLATE_OLD = """<xml>
+  <ToUserName><![CDATA [{toUser}]]></ToUserName>
+  <FromUserName><![CDATA[{fromUser}]]></FromUserName>
+  <CreateTime>{createtime}</CreateTime>
+  <MsgType><![CDATA[news]]></MsgType>
+  <ArticleCount>{article_count}</ArticleCount>
+  <Articles>
+    <item>
+      <Title><![CDATA[{title}]]></Title>
+      <Description><![CDATA[{description}]]></Description>
+      <PicUrl><![CDATA[{pic_url}]]></PicUrl>
+      <Url><![CDATA[{url}]]></Url>
+    </item>
+  </Articles>
+</xml>"""
+
+XML_ARTICLE_ITEM = """<item>
+<Title><![CDATA[{title}]]></Title>
+<Description><![CDATA[{description}]]></Description>
+<PicUrl><![CDATA[{pic_url}]]></PicUrl>
+<Url><![CDATA[{url}]]></Url>
+</item>"""
+
+XML_NEWS_TEMPLATE = """<xml>
+<ToUserName><![CDATA [{toUser}]]></ToUserName>
+<FromUserName><![CDATA[{fromUser}]]></FromUserName>
+<CreateTime>{createtime}</CreateTime>
+<MsgType><![CDATA[news]]></MsgType>
+<ArticleCount>{article_count}</ArticleCount>
+<Articles>
+{xml_articles_items}
+</Articles>
+</xml>"""
+
+
+def get_wechat_xml_response(data):
+    if "createtime" not in data:
+        data["createtime"] = int(time.time())
+
+    match data["type"]:
+        case "text":
+            xml = XML_TEXT_TEMPLATE.format(**data)
+        case "image":
+            xml = XML_IMAGE_TEMPLATE.format(**data)
+        case "voice":
+            xml = XML_VOICE_TEMPLATE.format(**data)
+        case "video":
+            xml = XML_VIDEO_TEMPLATE.format(**data)
+        case "music":
+            xml = XML_MUSIC_TEMPLATE.format(**data)
+        case "news":
+            xml_articles_items = ""
+            for article in data["articles"]:
+                xml_articles_items += XML_ARTICLE_ITEM.format(**article)
+            data["article_count"] = len(data["articles"])
+            data["xml_articles_items"] = xml_articles_items
+            xml = XML_NEWS_TEMPLATE.format(**data)
+
+    return xml

{python_plugins-0.1.5 → python_plugins-0.1.6}/src/python_plugins/weixin/wechat.py

@@ -1,15 +1,7 @@
 import hashlib
-import time
 from python_plugins.convert import xml2dict
 from .wechat_crypt import MessageCrypt
-
-XML_TEXT_TEMPLATE = """<xml>
-<ToUserName><![CDATA[{touser}]]></ToUserName>
-<FromUserName><![CDATA[{fromuser}]]></FromUserName>
-<CreateTime>{createtime}</CreateTime>
-<MsgType><![CDATA[text]]></MsgType>
-<Content><![CDATA[{content}]]></Content>
-</xml>"""
+from .format_response import get_wechat_xml_response
 
 
 class Wechat:
@@ -32,7 +24,7 @@ class Wechat:
         nonce = args["nonce"]
         echostr = args["echostr"]
         token = self.app["token"]
-        tmpstr = "".join(sorted([token, timestamp, nonce])).encode("utf8")
+        tmpstr = "".join(sorted([token, timestamp, nonce])).encode()
         if hashlib.sha1(tmpstr).hexdigest() == signature:
             return echostr
         else:
@@ -48,41 +40,37 @@ class Wechat:
         xml_dict = xml2dict(content)
 
         if not encrypt_type:
-            # 未加密
-            result = self.dispatch(xml_dict)
-            xml_reponse = self.responseText(result)
+            self.input = xml_dict
+            self.dispatch()
+            self.get_xml_response()
+            xml_reponse = self.xml_response
         else:
-            # 解密
+            # decrypt
             mc = MessageCrypt(self.app["appid"], self.app["token"], self.app["aeskey"])
             xml_decrypted = mc.decrypt_msg(
                 timestamp, nonce, xml_dict["Encrypt"], msg_signature
             )
-            decrypted_dict = xml2dict(xml_decrypted)
-            result = self.dispatch(decrypted_dict)
-            unencrypted_xml = self.responseText(result)
-            # 加密
-            xml_reponse = mc.encrypt_msg(unencrypted_xml, timestamp, nonce)
+            self.input = xml2dict(xml_decrypted)
+            self.dispatch()
+            self.get_xml_response()
+            # encrypt
+            xml_reponse = mc.encrypt_msg(self.xml_response, timestamp, nonce)
 
-        return xml_reponse
+        # 返回前记录下日志，如果实现记录日志的话
+        self.log_data()
 
-    def responseText(self, content):
-        data = {
-            "touser": self.fromUser,
-            "fromuser": self.toUser,
-            "createtime": int(time.time()),
-            "content": content,
-        }
-        return XML_TEXT_TEMPLATE.format(**data)
+        return xml_reponse
 
-    def dispatch(self, data):
-        self.toUser = data["ToUserName"]
-        self.fromUser = data["FromUserName"]
-        msgType = data["MsgType"]
+    def dispatch(self):
+        self.default_answer()
+        self.toUser = self.input["ToUserName"]
+        self.fromUser = self.input["FromUserName"]
+        msgType = self.input["MsgType"]
 
         if msgType == "text":
-            keyword = data["Content"]
+            keyword = self.input["Content"]
         elif msgType == "event":
-            event = data["Event"]
+            event = self.input["Event"]
             if event == "subscribe":
                 # self.onSubscribe()
                 keyword = "subscribe"
@@ -90,7 +78,7 @@ class Wechat:
                 # self.onUnsubscribe()
                 keyword = "unsubscribe"
             elif event == "CLICK":
-                eventKey = data["EventKey"]
+                eventKey = self.input["EventKey"]
                 keyword = eventKey
             else:
                 keyword = "<event:{event}>"
@@ -103,8 +91,8 @@ class Wechat:
         elif msgType == "shortvideo":
             keyword = f"<{msgType}>"
         elif msgType == "location":
-            location_x = data["location_x"]
-            location_y = data["location_y"]
+            location_x = self.input["location_x"]
+            location_y = self.input["location_y"]
             keyword = f"<{msgType}({location_x},{location_y})>"
         elif msgType == "link":
             keyword = f"<{msgType}>"
@@ -112,17 +100,36 @@ class Wechat:
             keyword = f"<{msgType}>"
 
         self.keyword = keyword
-        answer = self.answer()
 
-        # 返回前记录下日志，如果实现记录日志的话
-        self.log_data()
+        self.get_answer()
+        return
 
-        return self.responseText(answer)
+    def default_answer(self):
+        self.answer = {"type": "text", "content": "I'm sorry, I don't understand."}
+        return
 
-    def answer(self):
-        q = self.keyword
-        if q == "subscribe":
-            r = f"您好,欢迎关注[{self.app['name']}]!"
-        else:
-            r = q
-        return r
+    def get_answer(self):
+        match self.keyword:
+            case "subscribe":
+                r = f"Hello, welcome to {self.app['name']}!"
+                self.answer = {"type": "text", "content": r}
+            case _:
+                self.answer = {"type": "text", "content": "a:" + self.keyword}
+        return
+
+    def get_xml_response(self):
+        self.data_response = {
+            "type" : self.answer["type"],
+            "toUser": self.fromUser,
+            "fromUser": self.toUser,
+        }
+        
+        match self.answer["type"]:
+            case "text":                
+                self.data_response["content"] = self.answer["content"]
+            case "news":
+                self.data_response["articles"] = self.answer["articles"]
+                
+        self.xml_response = get_wechat_xml_response(self.data_response)
+        
+        return

python_plugins-0.1.5/src/python_plugins/__about__.py

@@ -1 +0,0 @@
-__version__ = "0.1.5"