Merge branch 'release/v0.6.2'

doraemonext · doraemonext · commit 9b3a4d4ba6ed · 2016-04-09T19:59:38.000+08:00
diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt
@@ -7,4 +7,5 @@ Ace Kwok / @doraemonext
 @lvxudong
 @colesmith
 @paicha
-@torpedoallen
+@torpedoallen
+@jiajunhuang
diff --git a/README.rst b/README.rst
@@ -3,7 +3,7 @@
 
 .. image:: docs/docs/img/logo.png
 
-当前最新版本：v0.6.1
+当前最新版本：v0.6.2
 
 wechat-python-sdk 希望能帮你解决微信公众平台开发中的种种不便，让你可以专注于业务逻辑本身，而不是浪费精力在与微信服务器复杂的交互中。
 
@@ -82,6 +82,11 @@ wechat-python-sdk 于 2016 年 2 月份进行了一次较大规模升级，升
 ChangeLog
 ----------------------------
 
+v0.6.2
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+* 增加了 Python 3 的支持
+
 v0.6.1
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
diff --git a/docs/docs/about/author.md b/docs/docs/about/author.md
@@ -28,4 +28,4 @@
 * zxygentoo ([https://github.com/zxygentoo](https://github.com/zxygentoo))
 * paicha ([https://github.com/paicha](https://github.com/paicha))
 * torpedoallen ([https://github.com/torpedoallen](https://github.com/torpedoallen))
-
+* jiajunhuang ([https://github.com/jiajunhuang](https://github.com/jiajunhuang))
diff --git a/docs/docs/api/wechatconf.md b/docs/docs/api/wechatconf.md
@@ -10,9 +10,9 @@ WechatConf 是 **微信配置类**，你需要将在公众平台开发者选项
 
 ```python
 WechatConf(token=None, appid=None, appsecret=None, encrypt_mode='safe', encoding_aes_key=None,
-           access_token_getfunc=None, access_token_setfunc=None, access_token=None, 
+           access_token_getfunc=None, access_token_setfunc=None, access_token_refreshfunc=None, access_token=None, 
            access_token_expires_at=None, jsapi_ticket_getfunc=None, jsapi_ticket_setfunc=None, 
-           jsapi_ticket=None, jsapi_ticket_expires_at=None, checkssl=False)
+           jsapi_ticket_refreshfunc=None, jsapi_ticket=None, jsapi_ticket_expires_at=None, checkssl=False)
 ```
 
 |参数名称|参数解释|
@@ -22,12 +22,14 @@ WechatConf(token=None, appid=None, appsecret=None, encrypt_mode='safe', encoding
 |`appsecret`|公众平台开发者选项中的 App Secret|
 |`encrypt_mode`|消息加解密方式。可选项 `normal`（明文模式）、`compatible`（兼容模式）、`safe`（安全模式）|
 |`encoding_aes_key`|公众平台开发者选项中的 EncodingAESKey|
-|`access_token_getfunc`|access_token 获取函数。如果传入该参数，WechatConf 内部将会在需要使用 access_token 时直接调用该函数，该函数不应接受任何参数。|
-|`access_token_setfunc`|access_token 设置函数。如果传入该参数，WechatConf 内部将会在需要更新 access_token 时直接调用该函数，该函数应接受两个参数，为 access_token 的字符串值和 access_token 的过期时间。|
+|`access_token_getfunc`|access_token 获取函数。如果传入该参数，WechatConf 内部将会在需要使用 access_token 时直接调用该函数，该函数不应接受任何参数，该函数应返回一个 Tuple，里面包含两个元素，分别是 access_token 和 access_token_expires_at。|
+|`access_token_setfunc`|access_token 设置函数。如果传入该参数，WechatConf 内部将会在需要更新 access_token 时直接调用该函数，该函数应接受两个参数，为 access_token 的字符串值和 access_token 的过期时间。该函数无返回值。|
+|`access_token_refreshfunc`|access_token 刷新函数。如果传入该参数，WechatConf 内部将会在需要更新 access_token 时直接调用该函数而不会请求官方 API，该函数不应接收任何参数，用于分布式环境下的业务逻辑服务器。该函数应返回一个 Tuple，里面包含两个元素,分别是 access_token 和 access_token_expires_at。|
 |`access_token`|直接导入的 access token 值, 该值需要在上一次该类实例化之后手动进行缓存并在此处传入, 如果不传入, 将会在需要时自动重新获取 **(传入 access_token_getfunc 和 access_token_setfunc 函数后将会自动忽略此处的传入值)**|
 |`access_token_expires_at`|直接导入的 access token 的过期日期, 该值需要在上一次该类实例化之后手动进行缓存并在此处传入, 如果不传入, 将会在需要时自动重新获取 **(传入 access_token_getfunc 和 access_token_setfunc 函数后将会自动忽略此处的传入值)**|
-|`jsapi_ticket_getfunc`|jsapi_ticket 获取函数。如果传入该参数，WechatConf 内部将会在需要使用 jsapi_ticket 时直接调用该函数，该函数不应接受任何参数。|
-|`jsapi_ticket_setfunc`|jsapi_ticket 设置函数。如果传入该参数，WechatConf 内部将会在需要更新 jsapi_ticket 时直接调用该函数，该函数应接受两个参数，为 jsapi_ticket 的字符串值和 jsapi_ticket 的过期时间。|
+|`jsapi_ticket_getfunc`|jsapi_ticket 获取函数。如果传入该参数，WechatConf 内部将会在需要使用 jsapi_ticket 时直接调用该函数，该函数不应接受任何参数。该函数应返回一个 Tuple，里面包含两个元素，分别是 jsapi_ticket 和 jsapi_ticket_expires_at。|
+|`jsapi_ticket_setfunc`|jsapi_ticket 设置函数。如果传入该参数，WechatConf 内部将会在需要更新 jsapi_ticket 时直接调用该函数，该函数应接受两个参数，为 jsapi_ticket 的字符串值和 jsapi_ticket 的过期时间。该函数无返回值。|
+|`jsapi_ticket_refreshfunc`|jsapi_ticket 刷新函数。如果传入该参数，WechatConf 内部将会在需要更新 jsapi_ticket 时直接调用该函数而不会请求官方 API，该函数不应接收任何参数，用于分布式环境下的业务逻辑服务器。该函数应返回一个 Tuple，里面包含两个元素,分别是 jsapi_ticket 和 jsapi_ticket_expires_at。|
 |`jsapi_ticket`|直接导入的 jsapi ticket 值, 该值需要在上一次该类实例化之后手动进行缓存并在此处传入, 如果不传入, 将会在需要时自动重新获取 **(传入 jsapi_ticket_getfunc 和 jsapi_ticket_setfunc 函数后将会自动忽略此处的传入值)**|
 |`jsapi_ticket_expires_at`|直接导入的 jsapi ticket 的过期日期, 该值需要在上一次该类实例化之后手动进行缓存并在此处传入, 如果不传入, 将会在需要时自动重新获取 **(传入 jsapi_ticket_getfunc 和 jsapi_ticket_setfunc 函数后将会自动忽略此处的传入值)**|
 |`checkssl`|是否检查 SSL, 默认不检查 (False), 可避免 urllib3 的 InsecurePlatformWarning 警告|
diff --git a/docs/docs/extra.css b/docs/docs/extra.css
@@ -34,10 +34,6 @@ h4 {
     overflow-y: auto;
 }
 
-.navbar-right {
-    display: none;
-}
-
 blockquote p {
     font-size: 13px;
 }
diff --git a/docs/docs/index.md b/docs/docs/index.md
@@ -61,6 +61,10 @@ wechat-python-sdk 于 2016 年 2 月份进行了一次较大规模升级，升
 
 ## 更新历史
 
+### v0.6.2
+
+* 增加了 Python 3 的支持 
+
 ### v0.6.1
 
 * 修正了 jsapi_ticket 的获取出错问题
diff --git a/docs/docs/official/material.md b/docs/docs/official/material.md
@@ -9,8 +9,10 @@
 **参数说明：**
 
 * `media_type`: 媒体文件类型字符串，分别有图片（`image`）、语音（`voice`）、视频（`video`）和缩略图（`thumb`）
-* `media_file`: 要上传的文件，一个 File object 或 StringIO object
-* `extension`: 如果 media_file 传入的为 StringIO object，那么必须传入 extension 显示指明该媒体文件扩展名，如 `mp3`, `amr`；如果 media_file 传入的为 File object，那么该参数请留空
+* `media_file`: 要上传的文件
+    * Python 2: 一个 `file` object 或 `StringIO.StringIO` object
+    * Python 3: 一个 `io.BufferedIOBase` object（open 文件时使用 `rb` 模式） 或 `io.BytesIO` object
+* `extension`: 如果 media_file 传入的为 `StringIO.StringIO` object（PY2）或 `io.BytesIO` object（PY3)，那么必须传入 extension 显示指明该媒体文件扩展名，如 `mp3`, `amr`；如果 media_file 传入的为 `file` object（PY2）或 `io.BufferedIOBase` object，那么该参数请留空
 
 **调用前检查：**App ID / App Secret
 
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -9,7 +9,7 @@ markdown_extensions:
         permalink: True
 
 extra:
-  'version': 'v0.6.0 (20160204)'
+  'version': 'v0.6.2 (20160409)'
 
 pages:
   - '首页': 'index.md'
diff --git a/old_docs/basic.rst b/old_docs/basic.rst
@@ -2,7 +2,7 @@
 =================================
 
 文档已经转移到新地址: `http://wechat-python-sdk.com/ <http://wechat-python-sdk.com/>`_
-=======================================================================================================================
+---------------------------------------------------------------------------------------
 
 .. py:class:: wechat_sdk.basic.WechatBasic(token=None, appid=None, appsecret=None, partnerid=None, partnerkey=None, paysignkey=None, access_token=None, access_token_expires_at=None, jsapi_ticket=None, jsapi_ticket_expires_at=None, checkssl=False)
 
diff --git a/old_docs/context.rst b/old_docs/context.rst
@@ -3,7 +3,7 @@
 ==============================
 
 文档已经转移到新地址: `http://wechat-python-sdk.com/ <http://wechat-python-sdk.com/>`_
-=======================================================================================================================
+---------------------------------------------------------------------------------------
 
 为了实现用户状态的维持与记录， ``wechat-python-sdk`` 实现了上下文对话功能。
 
diff --git a/old_docs/exceptions.rst b/old_docs/exceptions.rst
@@ -2,7 +2,7 @@
 =====================
 
 文档已经转移到新地址: `http://wechat-python-sdk.com/ <http://wechat-python-sdk.com/>`_
-=======================================================================================================================
+---------------------------------------------------------------------------------------
 
 .. py:class:: wechat_sdk.exceptions.NeedParamError()
 
diff --git a/old_docs/ext.rst b/old_docs/ext.rst
@@ -3,7 +3,7 @@
 ==============================
 
 文档已经转移到新地址: `http://wechat-python-sdk.com/ <http://wechat-python-sdk.com/>`_
-=======================================================================================================================
+---------------------------------------------------------------------------------------
 
 .. py:class:: wechat_sdk.ext.WechatExt(username, password [, token=None, cookies=None, appid=None, plugin_token=None, ifencodepwd=False, login=True, checkssl=False])
 
diff --git a/old_docs/faq.rst b/old_docs/faq.rst
@@ -3,7 +3,7 @@
 ==========================
 
 文档已经转移到新地址: `http://wechat-python-sdk.com/ <http://wechat-python-sdk.com/>`_
-=======================================================================================================================
+---------------------------------------------------------------------------------------
 
 1. 当使用 == 操作符比较两边内容时出现警告：
 
diff --git a/old_docs/index.rst b/old_docs/index.rst
@@ -2,7 +2,7 @@
 ====================================
 
 文档已经转移到新地址: `http://wechat-python-sdk.com/ <http://wechat-python-sdk.com/>`_
-=======================================================================================================================
+---------------------------------------------------------------------------------------
 
 非官方微信公众平台 Python 开发包，包括官方接口和非官方接口。
 
diff --git a/old_docs/install.rst b/old_docs/install.rst
@@ -2,7 +2,7 @@
 =================
 
 文档已经转移到新地址: `http://wechat-python-sdk.com/ <http://wechat-python-sdk.com/>`_
-=======================================================================================================================
+---------------------------------------------------------------------------------------
 
 自动安装
 -----------------
diff --git a/old_docs/messages.rst b/old_docs/messages.rst
@@ -2,7 +2,7 @@
 ===========================
 
 文档已经转移到新地址: `http://wechat-python-sdk.com/ <http://wechat-python-sdk.com/>`_
-=======================================================================================================================
+---------------------------------------------------------------------------------------
 
 目前此开发包提供以下几种消息类：``TextMessage`` (文本消息类), ``ImageMessage`` (图片消息类), ``VideoMessage`` (视频消息类), ``LocationMessage`` (位置消息类), ``LinkMessage`` (链接消息类), ``EventMessage`` (事件消息类), ``VoiceMessage`` (语音消息类)，它们都继承自 ``WechatMessage`` (公共消息类)
 
diff --git a/old_docs/tutorial.rst b/old_docs/tutorial.rst
@@ -2,7 +2,7 @@
 =========================
 
 文档已经转移到新地址: `http://wechat-python-sdk.com/ <http://wechat-python-sdk.com/>`_
-=======================================================================================================================
+---------------------------------------------------------------------------------------
 
 本页内容提供了一些可以快速上手的短小示例代码，并假设你已经安装了 ``wechat-sdk`` 。如果还没有，请返回安装一节进行安装。
 
diff --git a/setup.py b/setup.py
@@ -5,7 +5,7 @@
 
 setup(
     name='wechat-sdk',
-    version='0.6.1',
+    version='0.6.2',
     keywords=('wechat', 'sdk', 'wechat sdk'),
     description=u'微信公众平台Python开发包',
     long_description=open("README.rst").read(),
@@ -17,7 +17,7 @@
 
     packages=find_packages(),
     include_package_data=True,
-    install_requires=map(lambda x: x.replace('==', '>='), open("requirements.txt").readlines()),
+    install_requires=list(map(lambda x: x.replace('==', '>=') and x.rstrip('\n'), open("requirements.txt").readlines())),
 
     tests_require=['nose', 'httmock'],
     test_suite='tests',
diff --git a/tests/core/test_conf.py b/tests/core/test_conf.py
@@ -1,9 +1,5 @@
 # -*- coding: utf-8 -*-
 
-from __future__ import unicode_literals
-
-import os
-import json
 import time
 import unittest
 
diff --git a/tests/test_basic.py b/tests/test_basic.py
@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 
-from __future__ import absolute_import, unicode_literals
+from __future__ import unicode_literals
+
 import os
 import json
 import unittest
diff --git a/wechat_sdk/__init__.py b/wechat_sdk/__init__.py
@@ -1,10 +1,7 @@
 # -*- coding: utf-8 -*-
 
-__all__ = ['WechatConf', 'WechatBasic', 'WechatExt']
+from wechat_sdk.core.conf import WechatConf
+from wechat_sdk.basic import WechatBasic
+from wechat_sdk.ext import WechatExt
 
-try:
-    from wechat_sdk.core.conf import WechatConf
-    from wechat_sdk.basic import WechatBasic
-    from wechat_sdk.ext import WechatExt
-except ImportError:
-    pass
+__all__ = ['WechatConf', 'WechatBasic', 'WechatExt']
diff --git a/wechat_sdk/basic.py b/wechat_sdk/basic.py
@@ -1,13 +1,10 @@
 # -*- coding: utf-8 -*-
 
+import io
 import hashlib
 import requests
 import cgi
-    
-try:
-    from StringIO import StringIO  # Python 2
-except ImportError:
-    from io import StringIO  # Python 3
+import six
 
 from .base import WechatBase
 from .core.conf import WechatConf
@@ -19,7 +16,7 @@
     ArticleReply, GroupTransferReply)
 from .lib.parser import XMLStore
 from .lib.request import WechatRequest
-from .utils import to_binary, to_text, generate_nonce, generate_timestamp
+from .utils import to_binary, to_text, generate_nonce, generate_timestamp, convert_ext_to_mime, is_allowed_extension
 
 
 class WechatBasic(WechatBase):
@@ -128,7 +125,7 @@ def generate_jsapi_signature(self, timestamp, noncestr, url, jsapi_ticket=None):
             'timestamp': timestamp,
             'url': url,
         }
-        keys = data.keys()
+        keys = list(data.keys())
         keys.sort()
         data_str = '&'.join(['%s=%s' % (key, data[key]) for key in keys])
         signature = hashlib.sha1(data_str.encode('utf-8')).hexdigest()
@@ -144,10 +141,8 @@ def parse_data(self, data, msg_signature=None, timestamp=None, nonce=None):
         :raises ParseError: 解析微信服务器数据错误, 数据不合法
         """
         result = {}
-        if type(data) not in [str, unicode]:
-            raise ParseError()
-
-        data = data.encode('utf-8')
+        if isinstance(data, six.text_type):  # unicode to str(PY2), str to bytes(PY3)
+            data = data.encode('utf-8')
 
         if self.conf.encrypt_mode == 'safe':
             if not (msg_signature and timestamp and nonce):
@@ -211,7 +206,11 @@ def response_text(self, content, escape=False):
         self._check_parse()
         content = self._transcoding(content)
         if escape:
-            content = cgi.escape(content)
+            if six.PY2:
+                content = cgi.escape(content)
+            else:
+                import html
+                content = html.escape(content)
 
         response = TextReply(message=self.__message, content=content).render()
         return self._encrypt_response(response)
@@ -397,34 +396,57 @@ def upload_media(self, media_type, media_file, extension=''):
         :param extension: 如果 media_file 传入的为 StringIO object，那么必须传入 extension 显示指明该媒体文件扩展名，如 ``mp3``, ``amr``；如果 media_file 传入的为 File object，那么该参数请留空
         :return: 返回的 JSON 数据包
         """
-        if not isinstance(media_file, file) and not isinstance(media_file, StringIO):
+        if six.PY2:
+            return self._upload_media_py2(media_type, media_file, extension)
+        else:
+            return self._upload_media_py3(media_type, media_file, extension)
+
+    def _upload_media_py2(self, media_type, media_file, extension=''):
+        if not isinstance(media_file, file) and not isinstance(media_file, six.StringIO):
             raise ValueError('Parameter media_file must be file object or StringIO.StringIO object.')
-        if isinstance(media_file, StringIO) and extension.lower() not in ['jpg', 'jpeg', 'amr', 'mp3', 'mp4']:
+        if isinstance(media_file, six.StringIO) and not is_allowed_extension(extension.lower()):
             raise ValueError('Please provide \'extension\' parameters when the type of \'media_file\' is \'StringIO.StringIO\'.')
+
         if isinstance(media_file, file):
-            extension = media_file.name.split('.')[-1]
-            if extension.lower() not in ['jpg', 'jpeg', 'amr', 'mp3', 'mp4']:
+            extension = media_file.name.split('.')[-1].lower()
+            if not is_allowed_extension(extension):
                 raise ValueError('Invalid file type.')
+            filename = media_file.name
+        else:
+            extension = extension.lower()
+            filename = 'temp.' + extension
 
-        ext = {
-            'jpg': 'image/jpeg',
-            'jpeg': 'image/jpeg',
-            'amr': 'audio/amr',
-            'mp3': 'audio/mpeg',
-            'mp4': 'video/mp4',
-        }
-        if isinstance(media_file, StringIO):
+        return self.request.post(
+            url='https://api.weixin.qq.com/cgi-bin/media/upload',
+            params={
+                'type': media_type,
+            },
+            files={
+                'media': (filename, media_file, convert_ext_to_mime(extension))
+            }
+        )
+
+    def _upload_media_py3(self, media_type, media_file, extension=''):
+        if isinstance(media_file, io.IOBase) and hasattr(media_file, 'name'):
+            extension = media_file.name.split('.')[-1].lower()
+            if not is_allowed_extension(extension):
+                raise ValueError('Invalid file type.')
+            filename = media_file.name
+        elif isinstance(media_file, io.BytesIO):
+            extension = extension.lower()
+            if not is_allowed_extension(extension):
+                raise ValueError('Please provide \'extension\' parameters when the type of \'media_file\' is \'io.BytesIO\'.')
             filename = 'temp.' + extension
         else:
-            filename = media_file.name
+            raise ValueError('Parameter media_file must be io.BufferedIOBase(open a file with \'rb\') or io.BytesIO object.')
 
         return self.request.post(
             url='https://api.weixin.qq.com/cgi-bin/media/upload',
             params={
                 'type': media_type,
             },
             files={
-                'media': (filename, media_file, ext[extension])
+                'media': (filename, media_file, convert_ext_to_mime(extension))
             }
         )
 
diff --git a/wechat_sdk/exceptions.py b/wechat_sdk/exceptions.py
@@ -60,7 +60,10 @@ class NeedParseError(WechatSDKException):
 
 class OfficialAPIError(WechatAPIException):
     """微信官方API请求出错异常"""
-    def __init__(self, errcode, errmsg):
+    def __init__(self, errcode, errmsg=None):
+        if errmsg is None:  # 对旧版本 OfficialAPIError 的兼容代码
+            super(OfficialAPIError, self).__init__(99999, errmsg=errcode)
+            return
         super(OfficialAPIError, self).__init__(errcode, errmsg)
 
 
diff --git a/wechat_sdk/lib/crypto/base.py b/wechat_sdk/lib/crypto/base.py
diff --git a/wechat_sdk/lib/crypto/crypto.py b/wechat_sdk/lib/crypto/crypto.py
diff --git a/wechat_sdk/lib/crypto/pkcs7.py b/wechat_sdk/lib/crypto/pkcs7.py
diff --git a/wechat_sdk/lib/crypto/utils.py b/wechat_sdk/lib/crypto/utils.py
diff --git a/wechat_sdk/lib/request.py b/wechat_sdk/lib/request.py
diff --git a/wechat_sdk/utils.py b/wechat_sdk/utils.py

Original file line number	Diff line number	Diff line change
`@@ -34,10 +34,6 @@ h4 {`
`34`	`34`	`overflow-y: auto;`
`35`	`35`	`}`
`36`	`36`
`37`		`-.navbar-right {`
`38`		`- display: none;`
`39`		`-}`
`40`		`-`
`41`	`37`	`blockquote p {`
`42`	`38`	`font-size: 13px;`
`43`	`39`	`}`