使用requests-oauthlib设置HTTP User-Agent标头

时间:2015-10-29 23:56:45

标签: python python-requests

我正在使用requests-oauthlib库从OAuth(v1)提供程序获取请求令牌。

oauth = OAuth1Session(CONSUMER_KEY, client_secret=CONSUMER_SECRET,
                      signature_method=SIGNATURE_HMAC,
                      signature_type=SIGNATURE_TYPE_AUTH_HEADER)

resp = oauth.fetch_request_token(url=REQUEST_TOKEN_URL)

我想发送一个带有请求令牌获取请求的自定义User-Agent标头,并包含一些联系信息,以防我的脚本出现任何问题。可以这样做吗?

1 个答案:

答案 0 :(得分:2)

可以将客户端类传递给OAuth1Session构造函数。来自相关文件中的docblock:

"""
    :param client_class: A subclass of `oauthlib.oauth1.Client` to use with
                         `requests_oauthlib.OAuth1` instead of the default
"""

在oauthlib.oauth1.Client类中,_render(self, request, formencode=False, realm=None)方法似乎负责准备请求。由于不相关的标头don't impact是创建请求签名的基本字符串,因此添加新标头/更改现有的User-Agent标头不应导致签名以任何方式更改。

因此,我们可以创建一个自定义客户端类,覆盖_render方法并在我们添加标头后调用父类中的实现:

class CustomClient(Client):
    def _render(self, request, formencode=False, realm=None):
        request.headers['User-Agent'] = "FooClient/1.0"
        return super()._render(request, formencode, realm)

实例化OAuth1Session的代码只需要引用上面的类:

oauth = OAuth1Session(CONSUMER_KEY, client_secret=CONSUMER_SECRET,
                          signature_method=SIGNATURE_HMAC,
                          signature_type=SIGNATURE_TYPE_AUTH_HEADER, client_class=CustomClient)