http.py 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  1. # -*- coding: utf-8 -*-
  2. """
  3. oss2.http
  4. ~~~~~~~~
  5. 这个模块包含了HTTP Adapters。尽管OSS Python SDK内部使用requests库进行HTTP通信,但是对使用者是透明的。
  6. 该模块中的 `Session` 、 `Request` 、`Response` 对requests的对应的类做了简单的封装。
  7. """
  8. import platform
  9. import requests
  10. from requests.structures import CaseInsensitiveDict
  11. from . import __version__, defaults
  12. from .compat import to_bytes
  13. from .exceptions import RequestError
  14. from .utils import file_object_remaining_bytes, SizedFileAdapter
  15. import logging
  16. USER_AGENT = 'aliyun-sdk-python/{0}({1}/{2}/{3};{4})'.format(
  17. __version__, platform.system(), platform.release(), platform.machine(), platform.python_version())
  18. logger = logging.getLogger(__name__)
  19. class Session(object):
  20. """属于同一个Session的请求共享一组连接池,如有可能也会重用HTTP连接。"""
  21. def __init__(self):
  22. self.session = requests.Session()
  23. psize = defaults.connection_pool_size
  24. self.session.mount('http://', requests.adapters.HTTPAdapter(pool_connections=psize, pool_maxsize=psize))
  25. self.session.mount('https://', requests.adapters.HTTPAdapter(pool_connections=psize, pool_maxsize=psize))
  26. def do_request(self, req, timeout):
  27. try:
  28. logger.debug("Send request, method: {0}, url: {1}, params: {2}, headers: {3}, timeout: {4}, proxies: {5}".format(
  29. req.method, req.url, req.params, req.headers, timeout, req.proxies))
  30. return Response(self.session.request(req.method, req.url,
  31. data=req.data,
  32. params=req.params,
  33. headers=req.headers,
  34. stream=True,
  35. timeout=timeout,
  36. proxies=req.proxies))
  37. except requests.RequestException as e:
  38. raise RequestError(e)
  39. class Request(object):
  40. def __init__(self, method, url,
  41. data=None,
  42. params=None,
  43. headers=None,
  44. app_name='',
  45. proxies=None):
  46. self.method = method
  47. self.url = url
  48. self.data = _convert_request_body(data)
  49. self.params = params or {}
  50. self.proxies = proxies
  51. if not isinstance(headers, CaseInsensitiveDict):
  52. self.headers = CaseInsensitiveDict(headers)
  53. else:
  54. self.headers = headers
  55. # tell requests not to add 'Accept-Encoding: gzip, deflate' by default
  56. if 'Accept-Encoding' not in self.headers:
  57. self.headers['Accept-Encoding'] = None
  58. if 'User-Agent' not in self.headers:
  59. if app_name:
  60. self.headers['User-Agent'] = USER_AGENT + '/' + app_name
  61. else:
  62. self.headers['User-Agent'] = USER_AGENT
  63. logger.debug("Init request, method: {0}, url: {1}, params: {2}, headers: {3}".format(method, url, params,
  64. headers))
  65. _CHUNK_SIZE = 8 * 1024
  66. class Response(object):
  67. def __init__(self, response):
  68. self.response = response
  69. self.status = response.status_code
  70. self.headers = response.headers
  71. self.request_id = response.headers.get('x-oss-request-id', '')
  72. # When a response contains no body, iter_content() cannot
  73. # be run twice (requests.exceptions.StreamConsumedError will be raised).
  74. # For details of the issue, please see issue #82
  75. #
  76. # To work around this issue, we simply return b'' when everything has been read.
  77. #
  78. # Note you cannot use self.response.raw.read() to implement self.read(), because
  79. # raw.read() does not uncompress response body when the encoding is gzip etc., and
  80. # we try to avoid depends on details of self.response.raw.
  81. self.__all_read = False
  82. logger.debug("Get response headers, req-id:{0}, status: {1}, headers: {2}".format(self.request_id, self.status,
  83. self.headers))
  84. def read(self, amt=None):
  85. if self.__all_read:
  86. return b''
  87. if amt is None:
  88. content_list = []
  89. for chunk in self.response.iter_content(_CHUNK_SIZE):
  90. content_list.append(chunk)
  91. content = b''.join(content_list)
  92. self.__all_read = True
  93. return content
  94. else:
  95. try:
  96. return next(self.response.iter_content(amt))
  97. except StopIteration:
  98. self.__all_read = True
  99. return b''
  100. def __iter__(self):
  101. return self.response.iter_content(_CHUNK_SIZE)
  102. # requests对于具有fileno()方法的file object,会用fileno()的返回值作为Content-Length。
  103. # 这对于已经读取了部分内容,或执行了seek()的file object是不正确的。
  104. #
  105. # _convert_request_body()对于支持seek()和tell() file object,确保是从
  106. # 当前位置读取,且只读取当前位置到文件结束的内容。
  107. def _convert_request_body(data):
  108. data = to_bytes(data)
  109. if hasattr(data, '__len__'):
  110. return data
  111. if hasattr(data, 'seek') and hasattr(data, 'tell'):
  112. return SizedFileAdapter(data, file_object_remaining_bytes(data))
  113. return data