def __init__(self, **kwargs):
"""
:param kwargs: 配置信息字典, 可用字典 key 值及对应解释如下:
'token': 微信 Token
'appid': App ID
'appsecret': App Secret
'encrypt_mode': 加解密模式 ('normal': 明文模式, 'compatible': 兼容模式, 'safe': 安全模式(默认))
'encoding_aes_key': EncodingAESKey 值 (传入此值必须保证同时传入 token, appid, 否则抛出异常)
'access_token_getfunc': access token 获取函数 (用于单机及分布式环境下, 具体格式参见文档)
'access_token_setfunc': access token 写入函数 (用于单机及分布式环境下, 具体格式参见文档)
'access_token_refreshfunc': access token 刷新函数 (用于单机及分布式环境下, 具体格式参见文档)
'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 获取函数 (用于单机及分布式环境下, 具体格式参见文档)
'jsapi_ticket_setfunc': jsapi ticket 写入函数 (用于单机及分布式环境下, 具体格式参见文档)
'jsapi_ticket_refreshfunc': jsapi ticket 刷新函数 (用于单机及分布式环境下, 具体格式参见文档)
'jsapi_ticket': 直接导入的 jsapi ticket 值, 该值需要在上一次该类实例化之后手动进行缓存并在此处传入, 如果不
传入, 将会在需要时自动重新获取 (传入 jsapi_ticket_getfunc 和 jsapi_ticket_setfunc 函数
后将会自动忽略此处的传入值)
'jsapi_ticket_expires_at': 直接导入的 jsapi ticket 的过期日期, 该值需要在上一次该类实例化之后手动进行缓存
并在此处传入, 如果不传入, 将会在需要时自动重新获取 (传入 jsapi_ticket_getfunc
和 jsapi_ticket_setfunc 函数后将会自动忽略此处的传入值)
'partnerid': 财付通商户身份标识, 支付权限专用
'partnerkey': 财付通商户权限密钥 Key, 支付权限专用
'paysignkey': 商户签名密钥 Key, 支付权限专用
'checkssl': 是否检查 SSL, 默认不检查 (False), 可避免 urllib3 的 InsecurePlatformWarning 警告
'timeout': 设置 requests 的 timeout, 默认 (20, 60)
:return:
"""
self.__request = WechatRequest()
if kwargs.get('checkssl') is not True:
disable_urllib3_warning() # 可解决 InsecurePlatformWarning 警告
self.__token = kwargs.get('token')
self.__appid = kwargs.get('appid')
self.__appsecret = kwargs.get('appsecret')
self.__encrypt_mode = kwargs.get('encrypt_mode', 'safe')
self.__encoding_aes_key = kwargs.get('encoding_aes_key')
self.__crypto = None
self._update_crypto()
self.__access_token_getfunc = kwargs.get('access_token_getfunc')
self.__access_token_setfunc = kwargs.get('access_token_setfunc')
self.__access_token_refreshfunc = kwargs.get(
'access_token_refreshfunc')
self.__access_token = kwargs.get('access_token')
self.__access_token_expires_at = kwargs.get('access_token_expires_at')
self.__jsapi_ticket_getfunc = kwargs.get('jsapi_ticket_getfunc')
self.__jsapi_ticket_setfunc = kwargs.get('jsapi_ticket_setfunc')
self.__jsapi_ticket_refreshfunc = kwargs.get(
'jsapi_ticket_refreshfunc')
self.__jsapi_ticket = kwargs.get('jsapi_ticket')
self.__jsapi_ticket_expires_at = kwargs.get('jsapi_ticket_expires_at')
self.__partnerid = kwargs.get('partnerid')
self.__partnerkey = kwargs.get('partnerkey')
self.__paysignkey = kwargs.get('paysignkey')
self.__timeout = kwargs.get('timeout', (20, 60))
def __init__(self, **kwargs):
"""
:param kwargs: 配置信息字典, 可用字典 key 值及对应解释如下:
'token': 微信 Token
'appid': App ID
'appsecret': App Secret
'encrypt_mode': 加解密模式 ('normal': 明文模式, 'compatible': 兼容模式, 'safe': 安全模式(默认))
'encoding_aes_key': EncodingAESKey 值 (传入此值必须保证同时传入 token, appid, 否则抛出异常)
'access_token_getfunc': access token 获取函数 (用于单机及分布式环境下, 具体格式参见文档)
'access_token_setfunc': access token 写入函数 (用于单机及分布式环境下, 具体格式参见文档)
'access_token_refreshfunc': access token 刷新函数 (用于单机及分布式环境下, 具体格式参见文档)
'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 获取函数 (用于单机及分布式环境下, 具体格式参见文档)
'jsapi_ticket_setfunc': jsapi ticket 写入函数 (用于单机及分布式环境下, 具体格式参见文档)
'jsapi_ticket_refreshfunc': jsapi ticket 刷新函数 (用于单机及分布式环境下, 具体格式参见文档)
'jsapi_ticket': 直接导入的 jsapi ticket 值, 该值需要在上一次该类实例化之后手动进行缓存并在此处传入, 如果不
传入, 将会在需要时自动重新获取 (传入 jsapi_ticket_getfunc 和 jsapi_ticket_setfunc 函数
后将会自动忽略此处的传入值)
'jsapi_ticket_expires_at': 直接导入的 jsapi ticket 的过期日期, 该值需要在上一次该类实例化之后手动进行缓存
并在此处传入, 如果不传入, 将会在需要时自动重新获取 (传入 jsapi_ticket_getfunc
和 jsapi_ticket_setfunc 函数后将会自动忽略此处的传入值)
'partnerid': 财付通商户身份标识, 支付权限专用
'partnerkey': 财付通商户权限密钥 Key, 支付权限专用
'paysignkey': 商户签名密钥 Key, 支付权限专用
'checkssl': 是否检查 SSL, 默认不检查 (False), 可避免 urllib3 的 InsecurePlatformWarning 警告
:return:
"""
self.__request = WechatRequest()
if kwargs.get('checkssl') is not True:
disable_urllib3_warning() # 可解决 InsecurePlatformWarning 警告
self.__token = kwargs.get('token')
self.__appid = kwargs.get('appid')
self.__appsecret = kwargs.get('appsecret')
self.__encrypt_mode = kwargs.get('encrypt_mode', 'safe')
self.__encoding_aes_key = kwargs.get('encoding_aes_key')
self.__crypto = None
self._update_crypto()
self.__access_token_getfunc = kwargs.get('access_token_getfunc')
self.__access_token_setfunc = kwargs.get('access_token_setfunc')
self.__access_token_refreshfunc = kwargs.get('access_token_refreshfunc')
self.__access_token = kwargs.get('access_token')
self.__access_token_expires_at = kwargs.get('access_token_expires_at')
self.__jsapi_ticket_getfunc = kwargs.get('jsapi_ticket_getfunc')
self.__jsapi_ticket_setfunc = kwargs.get('jsapi_ticket_setfunc')
self.__jsapi_ticket_refreshfunc = kwargs.get('jsapi_ticket_refreshfunc')
self.__jsapi_ticket = kwargs.get('jsapi_ticket')
self.__jsapi_ticket_expires_at = kwargs.get('jsapi_ticket_expires_at')
self.__partnerid = kwargs.get('partnerid')
self.__partnerkey = kwargs.get('partnerkey')
self.__paysignkey = kwargs.get('paysignkey')
class WechatConf(object):
""" WechatConf 配置类
该类将会存储所有和微信开发相关的配置信息, 同时也会维护配置信息的有效性.
"""
def __init__(self, **kwargs):
"""
:param kwargs: 配置信息字典, 可用字典 key 值及对应解释如下:
'token': 微信 Token
'appid': App ID
'appsecret': App Secret
'encrypt_mode': 加解密模式 ('normal': 明文模式, 'compatible': 兼容模式, 'safe': 安全模式(默认))
'encoding_aes_key': EncodingAESKey 值 (传入此值必须保证同时传入 token, appid, 否则抛出异常)
'access_token_getfunc': access token 获取函数 (用于单机及分布式环境下, 具体格式参见文档)
'access_token_setfunc': access token 写入函数 (用于单机及分布式环境下, 具体格式参见文档)
'access_token_refreshfunc': access token 刷新函数 (用于单机及分布式环境下, 具体格式参见文档)
'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 获取函数 (用于单机及分布式环境下, 具体格式参见文档)
'jsapi_ticket_setfunc': jsapi ticket 写入函数 (用于单机及分布式环境下, 具体格式参见文档)
'jsapi_ticket_refreshfunc': jsapi ticket 刷新函数 (用于单机及分布式环境下, 具体格式参见文档)
'jsapi_ticket': 直接导入的 jsapi ticket 值, 该值需要在上一次该类实例化之后手动进行缓存并在此处传入, 如果不
传入, 将会在需要时自动重新获取 (传入 jsapi_ticket_getfunc 和 jsapi_ticket_setfunc 函数
后将会自动忽略此处的传入值)
'jsapi_ticket_expires_at': 直接导入的 jsapi ticket 的过期日期, 该值需要在上一次该类实例化之后手动进行缓存
并在此处传入, 如果不传入, 将会在需要时自动重新获取 (传入 jsapi_ticket_getfunc
和 jsapi_ticket_setfunc 函数后将会自动忽略此处的传入值)
'partnerid': 财付通商户身份标识, 支付权限专用
'partnerkey': 财付通商户权限密钥 Key, 支付权限专用
'paysignkey': 商户签名密钥 Key, 支付权限专用
'checkssl': 是否检查 SSL, 默认不检查 (False), 可避免 urllib3 的 InsecurePlatformWarning 警告
'timeout': 设置 requests 的 timeout, 默认 (20, 60)
:return:
"""
self.__request = WechatRequest()
if kwargs.get('checkssl') is not True:
disable_urllib3_warning() # 可解决 InsecurePlatformWarning 警告
self.__token = kwargs.get('token')
self.__appid = kwargs.get('appid')
self.__appsecret = kwargs.get('appsecret')
self.__encrypt_mode = kwargs.get('encrypt_mode', 'safe')
self.__encoding_aes_key = kwargs.get('encoding_aes_key')
self.__crypto = None
self._update_crypto()
self.__access_token_getfunc = kwargs.get('access_token_getfunc')
self.__access_token_setfunc = kwargs.get('access_token_setfunc')
self.__access_token_refreshfunc = kwargs.get(
'access_token_refreshfunc')
self.__access_token = kwargs.get('access_token')
self.__access_token_expires_at = kwargs.get('access_token_expires_at')
self.__jsapi_ticket_getfunc = kwargs.get('jsapi_ticket_getfunc')
self.__jsapi_ticket_setfunc = kwargs.get('jsapi_ticket_setfunc')
self.__jsapi_ticket_refreshfunc = kwargs.get(
'jsapi_ticket_refreshfunc')
self.__jsapi_ticket = kwargs.get('jsapi_ticket')
self.__jsapi_ticket_expires_at = kwargs.get('jsapi_ticket_expires_at')
self.__partnerid = kwargs.get('partnerid')
self.__partnerkey = kwargs.get('partnerkey')
self.__paysignkey = kwargs.get('paysignkey')
self.__timeout = kwargs.get('timeout', (20, 60))
@property
def timeout(self):
return self.__timeout
@property
def token(self):
""" 获取当前 Token """
self._check_token()
return self.__token
@token.setter
def token(self, token):
""" 设置当前 Token """
self.__token = token
self._update_crypto() # 改动 Token 需要重新更新 Crypto
@property
def appid(self):
""" 获取当前 App ID """
return self.__appid
@property
def appsecret(self):
""" 获取当前 App Secret """
return self.__appsecret
def set_appid_appsecret(self, appid, appsecret):
""" 设置当前 App ID 及 App Secret"""
self.__appid = appid
self.__appsecret = appsecret
self._update_crypto() # 改动 App ID 后需要重新更新 Crypto
@property
def encoding_aes_key(self):
""" 获取当前 EncodingAESKey """
return self.__encoding_aes_key
@encoding_aes_key.setter
def encoding_aes_key(self, encoding_aes_key):
""" 设置当前 EncodingAESKey """
self.__encoding_aes_key = encoding_aes_key
self._update_crypto() # 改动 EncodingAESKey 需要重新更新 Crypto
@property
def encrypt_mode(self):
return self.__encrypt_mode
@encrypt_mode.setter
def encrypt_mode(self, encrypt_mode):
""" 设置当前加密模式 """
self.__encrypt_mode = encrypt_mode
self._update_crypto()
@property
def crypto(self):
""" 获取当前 Crypto 实例 """
return self.__crypto
@property
def access_token(self):
""" 获取当前 access token 值, 本方法会自行维护 access token 有效性 """
self._check_appid_appsecret()
if callable(self.__access_token_getfunc):
self.__access_token, self.__access_token_expires_at = self.__access_token_getfunc(
)
if self.__access_token:
now = time.time()
if self.__access_token_expires_at - now > 60:
return self.__access_token
self.grant_access_token() # 从腾讯服务器获取 access token 并更新
return self.__access_token
@property
def jsapi_ticket(self):
""" 获取当前 jsapi ticket 值, 本方法会自行维护 jsapi ticket 有效性 """
self._check_appid_appsecret()
if callable(self.__jsapi_ticket_getfunc):
self.__jsapi_ticket, self.__jsapi_ticket_expires_at = self.__jsapi_ticket_getfunc(
)
if self.__jsapi_ticket:
now = time.time()
if self.__jsapi_ticket_expires_at - now > 60:
return self.__jsapi_ticket
self.grant_jsapi_ticket() # 从腾讯服务器获取 jsapi ticket 并更新
return self.__jsapi_ticket
@property
def partnerid(self):
""" 获取当前财付通商户身份标识 """
return self.__partnerid
@property
def partnerkey(self):
""" 获取当前财付通商户权限密钥 Key """
return self.__partnerkey
@property
def paysignkey(self):
""" 获取商户签名密钥 Key """
return self.__paysignkey
def grant_access_token(self):
"""
获取 access token 并更新当前配置
:return: 返回的 JSON 数据包 (传入 access_token_refreshfunc 参数后返回 None)
"""
self._check_appid_appsecret()
if callable(self.__access_token_refreshfunc):
self.__access_token, self.__access_token_expires_at = self.__access_token_refreshfunc(
)
return
response_json = self.__request.get(
url="https://api.weixin.qq.com/cgi-bin/token",
params={
"grant_type": "client_credential",
"appid": self.__appid,
"secret": self.__appsecret,
},
access_token=self.__access_token)
self.__access_token = response_json['access_token']
self.__access_token_expires_at = int(
time.time()) + response_json['expires_in']
if callable(self.__access_token_setfunc):
self.__access_token_setfunc(self.__access_token,
self.__access_token_expires_at)
return response_json
def grant_jsapi_ticket(self):
"""
获取 jsapi ticket 并更新当前配置
:return: 返回的 JSON 数据包 (传入 jsapi_ticket_refreshfunc 参数后返回 None)
"""
self._check_appid_appsecret()
if callable(self.__jsapi_ticket_refreshfunc):
self.__jsapi_ticket, self.__jsapi_ticket_expires_at = self.__jsapi_ticket_refreshfunc(
)
return
response_json = self.__request.get(
url="https://api.weixin.qq.com/cgi-bin/ticket/getticket",
params={
"type": "jsapi",
},
access_token=self.access_token,
)
self.__jsapi_ticket = response_json['ticket']
self.__jsapi_ticket_expires_at = int(
time.time()) + response_json['expires_in']
if callable(self.__jsapi_ticket_setfunc):
self.__jsapi_ticket_setfunc(self.__jsapi_ticket,
self.__jsapi_ticket_expires_at)
return response_json
def get_access_token(self):
"""
获取 Access Token 及 Access Token 过期日期, 仅供缓存使用, 如果希望得到原生的 Access Token 请求数据请使用 :func:`grant_token`
**仅为兼容 v0.6.0 以前版本使用, 自行维护 access_token 请使用 access_token_setfunc 和 access_token_getfunc 进行操作**
:return: dict 对象, key 包括 `access_token` 及 `access_token_expires_at`
"""
self._check_appid_appsecret()
return {
'access_token': self.access_token,
'access_token_expires_at': self.__access_token_expires_at,
}
def get_jsapi_ticket(self):
"""
获取 Jsapi Ticket 及 Jsapi Ticket 过期日期, 仅供缓存使用, 如果希望得到原生的 Jsapi Ticket 请求数据请使用 :func:`grant_jsapi_ticket`
**仅为兼容 v0.6.0 以前版本使用, 自行维护 jsapi_ticket 请使用 jsapi_ticket_setfunc 和 jsapi_ticket_getfunc 进行操作**
:return: dict 对象, key 包括 `jsapi_ticket` 及 `jsapi_ticket_expires_at`
"""
self._check_appid_appsecret()
return {
'jsapi_ticket': self.jsapi_ticket,
'jsapi_ticket_expires_at': self.__jsapi_ticket_expires_at,
}
def _check_token(self):
"""
检查 Token 是否存在
:raises NeedParamError: Token 参数没有在初始化的时候提供
"""
if not self.__token:
raise NeedParamError(
'Please provide Token parameter in the construction of class.')
def _check_appid_appsecret(self):
"""
检查 AppID 和 AppSecret 是否存在
:raises NeedParamError: AppID 或 AppSecret 参数没有在初始化的时候完整提供
"""
if not self.__appid or not self.__appsecret:
raise NeedParamError(
'Please provide app_id and app_secret parameters in the construction of class.'
)
def _update_crypto(self):
"""
根据当前配置内容更新 Crypto 类
"""
if self.__encrypt_mode in ['compatible', 'safe'
] and self.__encoding_aes_key is not None:
if self.__token is None or self.__appid is None:
raise NeedParamError(
'Please provide token and appid parameters in the construction of class.'
)
self.__crypto = BasicCrypto(self.__token, self.__encoding_aes_key,
self.__appid)
else:
self.__crypto = None
class WechatConf(object):
""" WechatConf 配置类
该类将会存储所有和微信开发相关的配置信息, 同时也会维护配置信息的有效性.
"""
def __init__(self, **kwargs):
"""
:param kwargs: 配置信息字典, 可用字典 key 值及对应解释如下:
'token': 微信 Token
'appid': App ID
'appsecret': App Secret
'encrypt_mode': 加解密模式 ('normal': 明文模式, 'compatible': 兼容模式, 'safe': 安全模式(默认))
'encoding_aes_key': EncodingAESKey 值 (传入此值必须保证同时传入 token, appid, 否则抛出异常)
'access_token_getfunc': access token 获取函数 (用于单机及分布式环境下, 具体格式参见文档)
'access_token_setfunc': access token 写入函数 (用于单机及分布式环境下, 具体格式参见文档)
'access_token_refreshfunc': access token 刷新函数 (用于单机及分布式环境下, 具体格式参见文档)
'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 获取函数 (用于单机及分布式环境下, 具体格式参见文档)
'jsapi_ticket_setfunc': jsapi ticket 写入函数 (用于单机及分布式环境下, 具体格式参见文档)
'jsapi_ticket_refreshfunc': jsapi ticket 刷新函数 (用于单机及分布式环境下, 具体格式参见文档)
'jsapi_ticket': 直接导入的 jsapi ticket 值, 该值需要在上一次该类实例化之后手动进行缓存并在此处传入, 如果不
传入, 将会在需要时自动重新获取 (传入 jsapi_ticket_getfunc 和 jsapi_ticket_setfunc 函数
后将会自动忽略此处的传入值)
'jsapi_ticket_expires_at': 直接导入的 jsapi ticket 的过期日期, 该值需要在上一次该类实例化之后手动进行缓存
并在此处传入, 如果不传入, 将会在需要时自动重新获取 (传入 jsapi_ticket_getfunc
和 jsapi_ticket_setfunc 函数后将会自动忽略此处的传入值)
'partnerid': 财付通商户身份标识, 支付权限专用
'partnerkey': 财付通商户权限密钥 Key, 支付权限专用
'paysignkey': 商户签名密钥 Key, 支付权限专用
'checkssl': 是否检查 SSL, 默认不检查 (False), 可避免 urllib3 的 InsecurePlatformWarning 警告
:return:
"""
self.__request = WechatRequest()
if kwargs.get('checkssl') is not True:
disable_urllib3_warning() # 可解决 InsecurePlatformWarning 警告
self.__token = kwargs.get('token')
self.__appid = kwargs.get('appid')
self.__appsecret = kwargs.get('appsecret')
self.__encrypt_mode = kwargs.get('encrypt_mode', 'safe')
self.__encoding_aes_key = kwargs.get('encoding_aes_key')
self.__crypto = None
self._update_crypto()
self.__access_token_getfunc = kwargs.get('access_token_getfunc')
self.__access_token_setfunc = kwargs.get('access_token_setfunc')
self.__access_token_refreshfunc = kwargs.get('access_token_refreshfunc')
self.__access_token = kwargs.get('access_token')
self.__access_token_expires_at = kwargs.get('access_token_expires_at')
self.__jsapi_ticket_getfunc = kwargs.get('jsapi_ticket_getfunc')
self.__jsapi_ticket_setfunc = kwargs.get('jsapi_ticket_setfunc')
self.__jsapi_ticket_refreshfunc = kwargs.get('jsapi_ticket_refreshfunc')
self.__jsapi_ticket = kwargs.get('jsapi_ticket')
self.__jsapi_ticket_expires_at = kwargs.get('jsapi_ticket_expires_at')
self.__partnerid = kwargs.get('partnerid')
self.__partnerkey = kwargs.get('partnerkey')
self.__paysignkey = kwargs.get('paysignkey')
@property
def token(self):
""" 获取当前 Token """
self._check_token()
return self.__token
@token.setter
def token(self, token):
""" 设置当前 Token """
self.__token = token
self._update_crypto() # 改动 Token 需要重新更新 Crypto
@property
def appid(self):
""" 获取当前 App ID """
return self.__appid
@property
def appsecret(self):
""" 获取当前 App Secret """
return self.__appsecret
def set_appid_appsecret(self, appid, appsecret):
""" 设置当前 App ID 及 App Secret"""
self.__appid = appid
self.__appsecret = appsecret
self._update_crypto() # 改动 App ID 后需要重新更新 Crypto
@property
def encoding_aes_key(self):
""" 获取当前 EncodingAESKey """
return self.__encoding_aes_key
@encoding_aes_key.setter
def encoding_aes_key(self, encoding_aes_key):
""" 设置当前 EncodingAESKey """
self.__encoding_aes_key = encoding_aes_key
self._update_crypto() # 改动 EncodingAESKey 需要重新更新 Crypto
@property
def encrypt_mode(self):
return self.__encrypt_mode
@encrypt_mode.setter
def encrypt_mode(self, encrypt_mode):
""" 设置当前加密模式 """
self.__encrypt_mode = encrypt_mode
self._update_crypto()
@property
def crypto(self):
""" 获取当前 Crypto 实例 """
return self.__crypto
@property
def access_token(self):
""" 获取当前 access token 值, 本方法会自行维护 access token 有效性 """
self._check_appid_appsecret()
if callable(self.__access_token_getfunc):
self.__access_token, self.__access_token_expires_at = self.__access_token_getfunc()
if self.__access_token:
now = time.time()
if self.__access_token_expires_at - now > 60:
return self.__access_token
self.grant_access_token() # 从腾讯服务器获取 access token 并更新
return self.__access_token
@property
def jsapi_ticket(self):
""" 获取当前 jsapi ticket 值, 本方法会自行维护 jsapi ticket 有效性 """
self._check_appid_appsecret()
if callable(self.__jsapi_ticket_getfunc):
self.__jsapi_ticket, self.__jsapi_ticket_expires_at = self.__jsapi_ticket_getfunc()
if self.__jsapi_ticket:
now = time.time()
if self.__jsapi_ticket_expires_at - now > 60:
return self.__jsapi_ticket
self.grant_jsapi_ticket() # 从腾讯服务器获取 jsapi ticket 并更新
return self.__jsapi_ticket
@property
def partnerid(self):
""" 获取当前财付通商户身份标识 """
return self.__partnerid
@property
def partnerkey(self):
""" 获取当前财付通商户权限密钥 Key """
return self.__partnerkey
@property
def paysignkey(self):
""" 获取商户签名密钥 Key """
return self.__paysignkey
def grant_access_token(self):
"""
获取 access token 并更新当前配置
:return: 返回的 JSON 数据包 (传入 access_token_refreshfunc 参数后返回 None)
"""
self._check_appid_appsecret()
if callable(self.__access_token_refreshfunc):
self.__access_token, self.__access_token_expires_at = self.__access_token_refreshfunc()
return
response_json = self.__request.get(
url="https://api.weixin.qq.com/cgi-bin/token",
params={
"grant_type": "client_credential",
"appid": self.__appid,
"secret": self.__appsecret,
},
access_token=self.__access_token
)
self.__access_token = response_json['access_token']
self.__access_token_expires_at = int(time.time()) + response_json['expires_in']
if callable(self.__access_token_setfunc):
self.__access_token_setfunc(self.__access_token, self.__access_token_expires_at)
return response_json
def grant_jsapi_ticket(self):
"""
获取 jsapi ticket 并更新当前配置
:return: 返回的 JSON 数据包 (传入 jsapi_ticket_refreshfunc 参数后返回 None)
"""
self._check_appid_appsecret()
if callable(self.__jsapi_ticket_refreshfunc):
self.__jsapi_ticket, self.__jsapi_ticket_expires_at = self.__jsapi_ticket_refreshfunc()
return
response_json = self.__request.get(
url="https://api.weixin.qq.com/cgi-bin/ticket/getticket",
params={
"type": "jsapi",
},
access_token=self.access_token,
)
self.__jsapi_ticket = response_json['ticket']
self.__jsapi_ticket_expires_at = int(time.time()) + response_json['expires_in']
if callable(self.__jsapi_ticket_setfunc):
self.__jsapi_ticket_setfunc(self.__jsapi_ticket, self.__jsapi_ticket_expires_at)
return response_json
def get_access_token(self):
"""
获取 Access Token 及 Access Token 过期日期, 仅供缓存使用, 如果希望得到原生的 Access Token 请求数据请使用 :func:`grant_token`
**仅为兼容 v0.6.0 以前版本使用, 自行维护 access_token 请使用 access_token_setfunc 和 access_token_getfunc 进行操作**
:return: dict 对象, key 包括 `access_token` 及 `access_token_expires_at`
"""
self._check_appid_appsecret()
return {
'access_token': self.access_token,
'access_token_expires_at': self.__access_token_expires_at,
}
def get_jsapi_ticket(self):
"""
获取 Jsapi Ticket 及 Jsapi Ticket 过期日期, 仅供缓存使用, 如果希望得到原生的 Jsapi Ticket 请求数据请使用 :func:`grant_jsapi_ticket`
**仅为兼容 v0.6.0 以前版本使用, 自行维护 jsapi_ticket 请使用 jsapi_ticket_setfunc 和 jsapi_ticket_getfunc 进行操作**
:return: dict 对象, key 包括 `jsapi_ticket` 及 `jsapi_ticket_expires_at`
"""
self._check_appid_appsecret()
return {
'jsapi_ticket': self.jsapi_ticket,
'jsapi_ticket_expires_at': self.__jsapi_ticket_expires_at,
}
def _check_token(self):
"""
检查 Token 是否存在
:raises NeedParamError: Token 参数没有在初始化的时候提供
"""
if not self.__token:
raise NeedParamError('Please provide Token parameter in the construction of class.')
def _check_appid_appsecret(self):
"""
检查 AppID 和 AppSecret 是否存在
:raises NeedParamError: AppID 或 AppSecret 参数没有在初始化的时候完整提供
"""
if not self.__appid or not self.__appsecret:
raise NeedParamError('Please provide app_id and app_secret parameters in the construction of class.')
def _update_crypto(self):
"""
根据当前配置内容更新 Crypto 类
"""
if self.__encrypt_mode in ['compatible', 'safe'] and self.__encoding_aes_key is not None:
if self.__token is None or self.__appid is None:
raise NeedParamError('Please provide token and appid parameters in the construction of class.')
self.__crypto = BasicCrypto(self.__token, self.__encoding_aes_key, self.__appid)
else:
self.__crypto = None
