You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1111 lines
34 KiB

4 years ago
  1. Metadata-Version: 2.1
  2. Name: urllib3
  3. Version: 1.24.1
  4. Summary: HTTP library with thread-safe connection pooling, file post, and more.
  5. Home-page: https://urllib3.readthedocs.io/
  6. Author: Andrey Petrov
  7. Author-email: andrey.petrov@shazow.net
  8. License: MIT
  9. Keywords: urllib httplib threadsafe filepost http https ssl pooling
  10. Platform: UNKNOWN
  11. Classifier: Environment :: Web Environment
  12. Classifier: Intended Audience :: Developers
  13. Classifier: License :: OSI Approved :: MIT License
  14. Classifier: Operating System :: OS Independent
  15. Classifier: Programming Language :: Python
  16. Classifier: Programming Language :: Python :: 2
  17. Classifier: Programming Language :: Python :: 2.7
  18. Classifier: Programming Language :: Python :: 3
  19. Classifier: Programming Language :: Python :: 3.4
  20. Classifier: Programming Language :: Python :: 3.5
  21. Classifier: Programming Language :: Python :: 3.6
  22. Classifier: Programming Language :: Python :: Implementation :: CPython
  23. Classifier: Programming Language :: Python :: Implementation :: PyPy
  24. Classifier: Topic :: Internet :: WWW/HTTP
  25. Classifier: Topic :: Software Development :: Libraries
  26. Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, <4
  27. Provides-Extra: socks
  28. Provides-Extra: secure
  29. Provides-Extra: secure
  30. Requires-Dist: pyOpenSSL (>=0.14); extra == 'secure'
  31. Requires-Dist: cryptography (>=1.3.4); extra == 'secure'
  32. Requires-Dist: idna (>=2.0.0); extra == 'secure'
  33. Requires-Dist: certifi; extra == 'secure'
  34. Requires-Dist: ipaddress; extra == 'secure'
  35. Provides-Extra: socks
  36. Requires-Dist: PySocks (!=1.5.7,<2.0,>=1.5.6); extra == 'socks'
  37. urllib3
  38. =======
  39. .. image:: https://travis-ci.org/urllib3/urllib3.svg?branch=master
  40. :alt: Build status on Travis
  41. :target: https://travis-ci.org/urllib3/urllib3
  42. .. image:: https://img.shields.io/appveyor/ci/urllib3/urllib3/master.svg
  43. :alt: Build status on AppVeyor
  44. :target: https://ci.appveyor.com/project/urllib3/urllib3
  45. .. image:: https://readthedocs.org/projects/urllib3/badge/?version=latest
  46. :alt: Documentation Status
  47. :target: https://urllib3.readthedocs.io/en/latest/
  48. .. image:: https://img.shields.io/codecov/c/github/urllib3/urllib3.svg
  49. :alt: Coverage Status
  50. :target: https://codecov.io/gh/urllib3/urllib3
  51. .. image:: https://img.shields.io/pypi/v/urllib3.svg?maxAge=86400
  52. :alt: PyPI version
  53. :target: https://pypi.org/project/urllib3/
  54. .. image:: https://www.bountysource.com/badge/tracker?tracker_id=192525
  55. :alt: Bountysource
  56. :target: https://www.bountysource.com/trackers/192525-urllib3?utm_source=192525&utm_medium=shield&utm_campaign=TRACKER_BADGE
  57. .. image:: https://badges.gitter.im/python-urllib3/Lobby.svg
  58. :alt: Gitter
  59. :target: https://gitter.im/python-urllib3/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
  60. urllib3 is a powerful, *sanity-friendly* HTTP client for Python. Much of the
  61. Python ecosystem already uses urllib3 and you should too.
  62. urllib3 brings many critical features that are missing from the Python
  63. standard libraries:
  64. - Thread safety.
  65. - Connection pooling.
  66. - Client-side SSL/TLS verification.
  67. - File uploads with multipart encoding.
  68. - Helpers for retrying requests and dealing with HTTP redirects.
  69. - Support for gzip and deflate encoding.
  70. - Proxy support for HTTP and SOCKS.
  71. - 100% test coverage.
  72. urllib3 is powerful and easy to use::
  73. >>> import urllib3
  74. >>> http = urllib3.PoolManager()
  75. >>> r = http.request('GET', 'http://httpbin.org/robots.txt')
  76. >>> r.status
  77. 200
  78. >>> r.data
  79. 'User-agent: *\nDisallow: /deny\n'
  80. Installing
  81. ----------
  82. urllib3 can be installed with `pip <https://pip.pypa.io>`_::
  83. $ pip install urllib3
  84. Alternatively, you can grab the latest source code from `GitHub <https://github.com/urllib3/urllib3>`_::
  85. $ git clone git://github.com/urllib3/urllib3.git
  86. $ python setup.py install
  87. Documentation
  88. -------------
  89. urllib3 has usage and reference documentation at `urllib3.readthedocs.io <https://urllib3.readthedocs.io>`_.
  90. Contributing
  91. ------------
  92. urllib3 happily accepts contributions. Please see our
  93. `contributing documentation <https://urllib3.readthedocs.io/en/latest/contributing.html>`_
  94. for some tips on getting started.
  95. Maintainers
  96. -----------
  97. - `@theacodes <https://github.com/theacodes>`_ (Thea Flowers)
  98. - `@SethMichaelLarson <https://github.com/SethMichaelLarson>`_ (Seth M. Larson)
  99. - `@haikuginger <https://github.com/haikuginger>`_ (Jesse Shapiro)
  100. - `@lukasa <https://github.com/lukasa>`_ (Cory Benfield)
  101. - `@sigmavirus24 <https://github.com/sigmavirus24>`_ (Ian Cordasco)
  102. - `@shazow <https://github.com/shazow>`_ (Andrey Petrov)
  103. 👋
  104. Sponsorship
  105. -----------
  106. If your company benefits from this library, please consider `sponsoring its
  107. development <https://urllib3.readthedocs.io/en/latest/contributing.html#sponsorship>`_.
  108. Sponsors include:
  109. - Google Cloud Platform (2018-present), sponsors `@theacodes <https://github.com/theacodes>`_'s work on an ongoing basis
  110. - Abbott (2018-present), sponsors `@SethMichaelLarson <https://github.com/SethMichaelLarson>`_'s work on an ongoing basis
  111. - Akamai (2017-present), sponsors `@haikuginger <https://github.com/haikuginger>`_'s work on an ongoing basis
  112. - Hewlett Packard Enterprise (2016-2017), sponsored `@Lukasa’s <https://github.com/Lukasa>`_ work on urllib3
  113. Changes
  114. =======
  115. 1.24.1 (2018-11-02)
  116. -------------------
  117. * Remove quadratic behavior within ``GzipDecoder.decompress()`` (Issue #1467)
  118. * Restored functionality of `ciphers` parameter for `create_urllib3_context()`. (Issue #1462)
  119. 1.24 (2018-10-16)
  120. -----------------
  121. * Allow key_server_hostname to be specified when initializing a PoolManager to allow custom SNI to be overridden. (Pull #1449)
  122. * Test against Python 3.7 on AppVeyor. (Pull #1453)
  123. * Early-out ipv6 checks when running on App Engine. (Pull #1450)
  124. * Change ambiguous description of backoff_factor (Pull #1436)
  125. * Add ability to handle multiple Content-Encodings (Issue #1441 and Pull #1442)
  126. * Skip DNS names that can't be idna-decoded when using pyOpenSSL (Issue #1405).
  127. * Add a server_hostname parameter to HTTPSConnection which allows for
  128. overriding the SNI hostname sent in the handshake. (Pull #1397)
  129. * Drop support for EOL Python 2.6 (Pull #1429 and Pull #1430)
  130. * Fixed bug where responses with header Content-Type: message/* erroneously
  131. raised HeaderParsingError, resulting in a warning being logged. (Pull #1439)
  132. * Move urllib3 to src/urllib3 (Pull #1409)
  133. 1.23 (2018-06-04)
  134. -----------------
  135. * Allow providing a list of headers to strip from requests when redirecting
  136. to a different host. Defaults to the ``Authorization`` header. Different
  137. headers can be set via ``Retry.remove_headers_on_redirect``. (Issue #1316)
  138. * Fix ``util.selectors._fileobj_to_fd`` to accept ``long`` (Issue #1247).
  139. * Dropped Python 3.3 support. (Pull #1242)
  140. * Put the connection back in the pool when calling stream() or read_chunked() on
  141. a chunked HEAD response. (Issue #1234)
  142. * Fixed pyOpenSSL-specific ssl client authentication issue when clients
  143. attempted to auth via certificate + chain (Issue #1060)
  144. * Add the port to the connectionpool connect print (Pull #1251)
  145. * Don't use the ``uuid`` module to create multipart data boundaries. (Pull #1380)
  146. * ``read_chunked()`` on a closed response returns no chunks. (Issue #1088)
  147. * Add Python 2.6 support to ``contrib.securetransport`` (Pull #1359)
  148. * Added support for auth info in url for SOCKS proxy (Pull #1363)
  149. 1.22 (2017-07-20)
  150. -----------------
  151. * Fixed missing brackets in ``HTTP CONNECT`` when connecting to IPv6 address via
  152. IPv6 proxy. (Issue #1222)
  153. * Made the connection pool retry on ``SSLError``. The original ``SSLError``
  154. is available on ``MaxRetryError.reason``. (Issue #1112)
  155. * Drain and release connection before recursing on retry/redirect. Fixes
  156. deadlocks with a blocking connectionpool. (Issue #1167)
  157. * Fixed compatibility for cookiejar. (Issue #1229)
  158. * pyopenssl: Use vendored version of ``six``. (Issue #1231)
  159. 1.21.1 (2017-05-02)
  160. -------------------
  161. * Fixed SecureTransport issue that would cause long delays in response body
  162. delivery. (Pull #1154)
  163. * Fixed regression in 1.21 that threw exceptions when users passed the
  164. ``socket_options`` flag to the ``PoolManager``. (Issue #1165)
  165. * Fixed regression in 1.21 that threw exceptions when users passed the
  166. ``assert_hostname`` or ``assert_fingerprint`` flag to the ``PoolManager``.
  167. (Pull #1157)
  168. 1.21 (2017-04-25)
  169. -----------------
  170. * Improved performance of certain selector system calls on Python 3.5 and
  171. later. (Pull #1095)
  172. * Resolved issue where the PyOpenSSL backend would not wrap SysCallError
  173. exceptions appropriately when sending data. (Pull #1125)
  174. * Selectors now detects a monkey-patched select module after import for modules
  175. that patch the select module like eventlet, greenlet. (Pull #1128)
  176. * Reduced memory consumption when streaming zlib-compressed responses
  177. (as opposed to raw deflate streams). (Pull #1129)
  178. * Connection pools now use the entire request context when constructing the
  179. pool key. (Pull #1016)
  180. * ``PoolManager.connection_from_*`` methods now accept a new keyword argument,
  181. ``pool_kwargs``, which are merged with the existing ``connection_pool_kw``.
  182. (Pull #1016)
  183. * Add retry counter for ``status_forcelist``. (Issue #1147)
  184. * Added ``contrib`` module for using SecureTransport on macOS:
  185. ``urllib3.contrib.securetransport``. (Pull #1122)
  186. * urllib3 now only normalizes the case of ``http://`` and ``https://`` schemes:
  187. for schemes it does not recognise, it assumes they are case-sensitive and
  188. leaves them unchanged.
  189. (Issue #1080)
  190. 1.20 (2017-01-19)
  191. -----------------
  192. * Added support for waiting for I/O using selectors other than select,
  193. improving urllib3's behaviour with large numbers of concurrent connections.
  194. (Pull #1001)
  195. * Updated the date for the system clock check. (Issue #1005)
  196. * ConnectionPools now correctly consider hostnames to be case-insensitive.
  197. (Issue #1032)
  198. * Outdated versions of PyOpenSSL now cause the PyOpenSSL contrib module
  199. to fail when it is injected, rather than at first use. (Pull #1063)
  200. * Outdated versions of cryptography now cause the PyOpenSSL contrib module
  201. to fail when it is injected, rather than at first use. (Issue #1044)
  202. * Automatically attempt to rewind a file-like body object when a request is
  203. retried or redirected. (Pull #1039)
  204. * Fix some bugs that occur when modules incautiously patch the queue module.
  205. (Pull #1061)
  206. * Prevent retries from occurring on read timeouts for which the request method
  207. was not in the method whitelist. (Issue #1059)
  208. * Changed the PyOpenSSL contrib module to lazily load idna to avoid
  209. unnecessarily bloating the memory of programs that don't need it. (Pull
  210. #1076)
  211. * Add support for IPv6 literals with zone identifiers. (Pull #1013)
  212. * Added support for socks5h:// and socks4a:// schemes when working with SOCKS
  213. proxies, and controlled remote DNS appropriately. (Issue #1035)
  214. 1.19.1 (2016-11-16)
  215. -------------------
  216. * Fixed AppEngine import that didn't function on Python 3.5. (Pull #1025)
  217. 1.19 (2016-11-03)
  218. -----------------
  219. * urllib3 now respects Retry-After headers on 413, 429, and 503 responses when
  220. using the default retry logic. (Pull #955)
  221. * Remove markers from setup.py to assist ancient setuptools versions. (Issue
  222. #986)
  223. * Disallow superscripts and other integerish things in URL ports. (Issue #989)
  224. * Allow urllib3's HTTPResponse.stream() method to continue to work with
  225. non-httplib underlying FPs. (Pull #990)
  226. * Empty filenames in multipart headers are now emitted as such, rather than
  227. being suppressed. (Issue #1015)
  228. * Prefer user-supplied Host headers on chunked uploads. (Issue #1009)
  229. 1.18.1 (2016-10-27)
  230. -------------------
  231. * CVE-2016-9015. Users who are using urllib3 version 1.17 or 1.18 along with
  232. PyOpenSSL injection and OpenSSL 1.1.0 *must* upgrade to this version. This
  233. release fixes a vulnerability whereby urllib3 in the above configuration
  234. would silently fail to validate TLS certificates due to erroneously setting
  235. invalid flags in OpenSSL's ``SSL_CTX_set_verify`` function. These erroneous
  236. flags do not cause a problem in OpenSSL versions before 1.1.0, which
  237. interprets the presence of any flag as requesting certificate validation.
  238. There is no PR for this patch, as it was prepared for simultaneous disclosure
  239. and release. The master branch received the same fix in PR #1010.
  240. 1.18 (2016-09-26)
  241. -----------------
  242. * Fixed incorrect message for IncompleteRead exception. (PR #973)
  243. * Accept ``iPAddress`` subject alternative name fields in TLS certificates.
  244. (Issue #258)
  245. * Fixed consistency of ``HTTPResponse.closed`` between Python 2 and 3.
  246. (Issue #977)
  247. * Fixed handling of wildcard certificates when using PyOpenSSL. (Issue #979)
  248. 1.17 (2016-09-06)
  249. -----------------
  250. * Accept ``SSLContext`` objects for use in SSL/TLS negotiation. (Issue #835)
  251. * ConnectionPool debug log now includes scheme, host, and port. (Issue #897)
  252. * Substantially refactored documentation. (Issue #887)
  253. * Used URLFetch default timeout on AppEngine, rather than hardcoding our own.
  254. (Issue #858)
  255. * Normalize the scheme and host in the URL parser (Issue #833)
  256. * ``HTTPResponse`` contains the last ``Retry`` object, which now also
  257. contains retries history. (Issue #848)
  258. * Timeout can no longer be set as boolean, and must be greater than zero.
  259. (PR #924)
  260. * Removed pyasn1 and ndg-httpsclient from dependencies used for PyOpenSSL. We
  261. now use cryptography and idna, both of which are already dependencies of
  262. PyOpenSSL. (PR #930)
  263. * Fixed infinite loop in ``stream`` when amt=None. (Issue #928)
  264. * Try to use the operating system's certificates when we are using an
  265. ``SSLContext``. (PR #941)
  266. * Updated cipher suite list to allow ChaCha20+Poly1305. AES-GCM is preferred to
  267. ChaCha20, but ChaCha20 is then preferred to everything else. (PR #947)
  268. * Updated cipher suite list to remove 3DES-based cipher suites. (PR #958)
  269. * Removed the cipher suite fallback to allow HIGH ciphers. (PR #958)
  270. * Implemented ``length_remaining`` to determine remaining content
  271. to be read. (PR #949)
  272. * Implemented ``enforce_content_length`` to enable exceptions when
  273. incomplete data chunks are received. (PR #949)
  274. * Dropped connection start, dropped connection reset, redirect, forced retry,
  275. and new HTTPS connection log levels to DEBUG, from INFO. (PR #967)
  276. 1.16 (2016-06-11)
  277. -----------------
  278. * Disable IPv6 DNS when IPv6 connections are not possible. (Issue #840)
  279. * Provide ``key_fn_by_scheme`` pool keying mechanism that can be
  280. overridden. (Issue #830)
  281. * Normalize scheme and host to lowercase for pool keys, and include
  282. ``source_address``. (Issue #830)
  283. * Cleaner exception chain in Python 3 for ``_make_request``.
  284. (Issue #861)
  285. * Fixed installing ``urllib3[socks]`` extra. (Issue #864)
  286. * Fixed signature of ``ConnectionPool.close`` so it can actually safely be
  287. called by subclasses. (Issue #873)
  288. * Retain ``release_conn`` state across retries. (Issues #651, #866)
  289. * Add customizable ``HTTPConnectionPool.ResponseCls``, which defaults to
  290. ``HTTPResponse`` but can be replaced with a subclass. (Issue #879)
  291. 1.15.1 (2016-04-11)
  292. -------------------
  293. * Fix packaging to include backports module. (Issue #841)
  294. 1.15 (2016-04-06)
  295. -----------------
  296. * Added Retry(raise_on_status=False). (Issue #720)
  297. * Always use setuptools, no more distutils fallback. (Issue #785)
  298. * Dropped support for Python 3.2. (Issue #786)
  299. * Chunked transfer encoding when requesting with ``chunked=True``.
  300. (Issue #790)
  301. * Fixed regression with IPv6 port parsing. (Issue #801)
  302. * Append SNIMissingWarning messages to allow users to specify it in
  303. the PYTHONWARNINGS environment variable. (Issue #816)
  304. * Handle unicode headers in Py2. (Issue #818)
  305. * Log certificate when there is a hostname mismatch. (Issue #820)
  306. * Preserve order of request/response headers. (Issue #821)
  307. 1.14 (2015-12-29)
  308. -----------------
  309. * contrib: SOCKS proxy support! (Issue #762)
  310. * Fixed AppEngine handling of transfer-encoding header and bug
  311. in Timeout defaults checking. (Issue #763)
  312. 1.13.1 (2015-12-18)
  313. -------------------
  314. * Fixed regression in IPv6 + SSL for match_hostname. (Issue #761)
  315. 1.13 (2015-12-14)
  316. -----------------
  317. * Fixed ``pip install urllib3[secure]`` on modern pip. (Issue #706)
  318. * pyopenssl: Fixed SSL3_WRITE_PENDING error. (Issue #717)
  319. * pyopenssl: Support for TLSv1.1 and TLSv1.2. (Issue #696)
  320. * Close connections more defensively on exception. (Issue #734)
  321. * Adjusted ``read_chunked`` to handle gzipped, chunk-encoded bodies without
  322. repeatedly flushing the decoder, to function better on Jython. (Issue #743)
  323. * Accept ``ca_cert_dir`` for SSL-related PoolManager configuration. (Issue #758)
  324. 1.12 (2015-09-03)
  325. -----------------
  326. * Rely on ``six`` for importing ``httplib`` to work around
  327. conflicts with other Python 3 shims. (Issue #688)
  328. * Add support for directories of certificate authorities, as supported by
  329. OpenSSL. (Issue #701)
  330. * New exception: ``NewConnectionError``, raised when we fail to establish
  331. a new connection, usually ``ECONNREFUSED`` socket error.
  332. 1.11 (2015-07-21)
  333. -----------------
  334. * When ``ca_certs`` is given, ``cert_reqs`` defaults to
  335. ``'CERT_REQUIRED'``. (Issue #650)
  336. * ``pip install urllib3[secure]`` will install Certifi and
  337. PyOpenSSL as dependencies. (Issue #678)
  338. * Made ``HTTPHeaderDict`` usable as a ``headers`` input value
  339. (Issues #632, #679)
  340. * Added `urllib3.contrib.appengine <https://urllib3.readthedocs.io/en/latest/contrib.html#google-app-engine>`_
  341. which has an ``AppEngineManager`` for using ``URLFetch`` in a
  342. Google AppEngine environment. (Issue #664)
  343. * Dev: Added test suite for AppEngine. (Issue #631)
  344. * Fix performance regression when using PyOpenSSL. (Issue #626)
  345. * Passing incorrect scheme (e.g. ``foo://``) will raise
  346. ``ValueError`` instead of ``AssertionError`` (backwards
  347. compatible for now, but please migrate). (Issue #640)
  348. * Fix pools not getting replenished when an error occurs during a
  349. request using ``release_conn=False``. (Issue #644)
  350. * Fix pool-default headers not applying for url-encoded requests
  351. like GET. (Issue #657)
  352. * log.warning in Python 3 when headers are skipped due to parsing
  353. errors. (Issue #642)
  354. * Close and discard connections if an error occurs during read.
  355. (Issue #660)
  356. * Fix host parsing for IPv6 proxies. (Issue #668)
  357. * Separate warning type SubjectAltNameWarning, now issued once
  358. per host. (Issue #671)
  359. * Fix ``httplib.IncompleteRead`` not getting converted to
  360. ``ProtocolError`` when using ``HTTPResponse.stream()``
  361. (Issue #674)
  362. 1.10.4 (2015-05-03)
  363. -------------------
  364. * Migrate tests to Tornado 4. (Issue #594)
  365. * Append default warning configuration rather than overwrite.
  366. (Issue #603)
  367. * Fix streaming decoding regression. (Issue #595)
  368. * Fix chunked requests losing state across keep-alive connections.
  369. (Issue #599)
  370. * Fix hanging when chunked HEAD response has no body. (Issue #605)
  371. 1.10.3 (2015-04-21)
  372. -------------------
  373. * Emit ``InsecurePlatformWarning`` when SSLContext object is missing.
  374. (Issue #558)
  375. * Fix regression of duplicate header keys being discarded.
  376. (Issue #563)
  377. * ``Response.stream()`` returns a generator for chunked responses.
  378. (Issue #560)
  379. * Set upper-bound timeout when waiting for a socket in PyOpenSSL.
  380. (Issue #585)
  381. * Work on platforms without `ssl` module for plain HTTP requests.
  382. (Issue #587)
  383. * Stop relying on the stdlib's default cipher list. (Issue #588)
  384. 1.10.2 (2015-02-25)
  385. -------------------
  386. * Fix file descriptor leakage on retries. (Issue #548)
  387. * Removed RC4 from default cipher list. (Issue #551)
  388. * Header performance improvements. (Issue #544)
  389. * Fix PoolManager not obeying redirect retry settings. (Issue #553)
  390. 1.10.1 (2015-02-10)
  391. -------------------
  392. * Pools can be used as context managers. (Issue #545)
  393. * Don't re-use connections which experienced an SSLError. (Issue #529)
  394. * Don't fail when gzip decoding an empty stream. (Issue #535)
  395. * Add sha256 support for fingerprint verification. (Issue #540)
  396. * Fixed handling of header values containing commas. (Issue #533)
  397. 1.10 (2014-12-14)
  398. -----------------
  399. * Disabled SSLv3. (Issue #473)
  400. * Add ``Url.url`` property to return the composed url string. (Issue #394)
  401. * Fixed PyOpenSSL + gevent ``WantWriteError``. (Issue #412)
  402. * ``MaxRetryError.reason`` will always be an exception, not string.
  403. (Issue #481)
  404. * Fixed SSL-related timeouts not being detected as timeouts. (Issue #492)
  405. * Py3: Use ``ssl.create_default_context()`` when available. (Issue #473)
  406. * Emit ``InsecureRequestWarning`` for *every* insecure HTTPS request.
  407. (Issue #496)
  408. * Emit ``SecurityWarning`` when certificate has no ``subjectAltName``.
  409. (Issue #499)
  410. * Close and discard sockets which experienced SSL-related errors.
  411. (Issue #501)
  412. * Handle ``body`` param in ``.request(...)``. (Issue #513)
  413. * Respect timeout with HTTPS proxy. (Issue #505)
  414. * PyOpenSSL: Handle ZeroReturnError exception. (Issue #520)
  415. 1.9.1 (2014-09-13)
  416. ------------------
  417. * Apply socket arguments before binding. (Issue #427)
  418. * More careful checks if fp-like object is closed. (Issue #435)
  419. * Fixed packaging issues of some development-related files not
  420. getting included. (Issue #440)
  421. * Allow performing *only* fingerprint verification. (Issue #444)
  422. * Emit ``SecurityWarning`` if system clock is waaay off. (Issue #445)
  423. * Fixed PyOpenSSL compatibility with PyPy. (Issue #450)
  424. * Fixed ``BrokenPipeError`` and ``ConnectionError`` handling in Py3.
  425. (Issue #443)
  426. 1.9 (2014-07-04)
  427. ----------------
  428. * Shuffled around development-related files. If you're maintaining a distro
  429. package of urllib3, you may need to tweak things. (Issue #415)
  430. * Unverified HTTPS requests will trigger a warning on the first request. See
  431. our new `security documentation
  432. <https://urllib3.readthedocs.io/en/latest/security.html>`_ for details.
  433. (Issue #426)
  434. * New retry logic and ``urllib3.util.retry.Retry`` configuration object.
  435. (Issue #326)
  436. * All raised exceptions should now wrapped in a
  437. ``urllib3.exceptions.HTTPException``-extending exception. (Issue #326)
  438. * All errors during a retry-enabled request should be wrapped in
  439. ``urllib3.exceptions.MaxRetryError``, including timeout-related exceptions
  440. which were previously exempt. Underlying error is accessible from the
  441. ``.reason`` property. (Issue #326)
  442. * ``urllib3.exceptions.ConnectionError`` renamed to
  443. ``urllib3.exceptions.ProtocolError``. (Issue #326)
  444. * Errors during response read (such as IncompleteRead) are now wrapped in
  445. ``urllib3.exceptions.ProtocolError``. (Issue #418)
  446. * Requesting an empty host will raise ``urllib3.exceptions.LocationValueError``.
  447. (Issue #417)
  448. * Catch read timeouts over SSL connections as
  449. ``urllib3.exceptions.ReadTimeoutError``. (Issue #419)
  450. * Apply socket arguments before connecting. (Issue #427)
  451. 1.8.3 (2014-06-23)
  452. ------------------
  453. * Fix TLS verification when using a proxy in Python 3.4.1. (Issue #385)
  454. * Add ``disable_cache`` option to ``urllib3.util.make_headers``. (Issue #393)
  455. * Wrap ``socket.timeout`` exception with
  456. ``urllib3.exceptions.ReadTimeoutError``. (Issue #399)
  457. * Fixed proxy-related bug where connections were being reused incorrectly.
  458. (Issues #366, #369)
  459. * Added ``socket_options`` keyword parameter which allows to define
  460. ``setsockopt`` configuration of new sockets. (Issue #397)
  461. * Removed ``HTTPConnection.tcp_nodelay`` in favor of
  462. ``HTTPConnection.default_socket_options``. (Issue #397)
  463. * Fixed ``TypeError`` bug in Python 2.6.4. (Issue #411)
  464. 1.8.2 (2014-04-17)
  465. ------------------
  466. * Fix ``urllib3.util`` not being included in the package.
  467. 1.8.1 (2014-04-17)
  468. ------------------
  469. * Fix AppEngine bug of HTTPS requests going out as HTTP. (Issue #356)
  470. * Don't install ``dummyserver`` into ``site-packages`` as it's only needed
  471. for the test suite. (Issue #362)
  472. * Added support for specifying ``source_address``. (Issue #352)
  473. 1.8 (2014-03-04)
  474. ----------------
  475. * Improved url parsing in ``urllib3.util.parse_url`` (properly parse '@' in
  476. username, and blank ports like 'hostname:').
  477. * New ``urllib3.connection`` module which contains all the HTTPConnection
  478. objects.
  479. * Several ``urllib3.util.Timeout``-related fixes. Also changed constructor
  480. signature to a more sensible order. [Backwards incompatible]
  481. (Issues #252, #262, #263)
  482. * Use ``backports.ssl_match_hostname`` if it's installed. (Issue #274)
  483. * Added ``.tell()`` method to ``urllib3.response.HTTPResponse`` which
  484. returns the number of bytes read so far. (Issue #277)
  485. * Support for platforms without threading. (Issue #289)
  486. * Expand default-port comparison in ``HTTPConnectionPool.is_same_host``
  487. to allow a pool with no specified port to be considered equal to to an
  488. HTTP/HTTPS url with port 80/443 explicitly provided. (Issue #305)
  489. * Improved default SSL/TLS settings to avoid vulnerabilities.
  490. (Issue #309)
  491. * Fixed ``urllib3.poolmanager.ProxyManager`` not retrying on connect errors.
  492. (Issue #310)
  493. * Disable Nagle's Algorithm on the socket for non-proxies. A subset of requests
  494. will send the entire HTTP request ~200 milliseconds faster; however, some of
  495. the resulting TCP packets will be smaller. (Issue #254)
  496. * Increased maximum number of SubjectAltNames in ``urllib3.contrib.pyopenssl``
  497. from the default 64 to 1024 in a single certificate. (Issue #318)
  498. * Headers are now passed and stored as a custom
  499. ``urllib3.collections_.HTTPHeaderDict`` object rather than a plain ``dict``.
  500. (Issue #329, #333)
  501. * Headers no longer lose their case on Python 3. (Issue #236)
  502. * ``urllib3.contrib.pyopenssl`` now uses the operating system's default CA
  503. certificates on inject. (Issue #332)
  504. * Requests with ``retries=False`` will immediately raise any exceptions without
  505. wrapping them in ``MaxRetryError``. (Issue #348)
  506. * Fixed open socket leak with SSL-related failures. (Issue #344, #348)
  507. 1.7.1 (2013-09-25)
  508. ------------------
  509. * Added granular timeout support with new ``urllib3.util.Timeout`` class.
  510. (Issue #231)
  511. * Fixed Python 3.4 support. (Issue #238)
  512. 1.7 (2013-08-14)
  513. ----------------
  514. * More exceptions are now pickle-able, with tests. (Issue #174)
  515. * Fixed redirecting with relative URLs in Location header. (Issue #178)
  516. * Support for relative urls in ``Location: ...`` header. (Issue #179)
  517. * ``urllib3.response.HTTPResponse`` now inherits from ``io.IOBase`` for bonus
  518. file-like functionality. (Issue #187)
  519. * Passing ``assert_hostname=False`` when creating a HTTPSConnectionPool will
  520. skip hostname verification for SSL connections. (Issue #194)
  521. * New method ``urllib3.response.HTTPResponse.stream(...)`` which acts as a
  522. generator wrapped around ``.read(...)``. (Issue #198)
  523. * IPv6 url parsing enforces brackets around the hostname. (Issue #199)
  524. * Fixed thread race condition in
  525. ``urllib3.poolmanager.PoolManager.connection_from_host(...)`` (Issue #204)
  526. * ``ProxyManager`` requests now include non-default port in ``Host: ...``
  527. header. (Issue #217)
  528. * Added HTTPS proxy support in ``ProxyManager``. (Issue #170 #139)
  529. * New ``RequestField`` object can be passed to the ``fields=...`` param which
  530. can specify headers. (Issue #220)
  531. * Raise ``urllib3.exceptions.ProxyError`` when connecting to proxy fails.
  532. (Issue #221)
  533. * Use international headers when posting file names. (Issue #119)
  534. * Improved IPv6 support. (Issue #203)
  535. 1.6 (2013-04-25)
  536. ----------------
  537. * Contrib: Optional SNI support for Py2 using PyOpenSSL. (Issue #156)
  538. * ``ProxyManager`` automatically adds ``Host: ...`` header if not given.
  539. * Improved SSL-related code. ``cert_req`` now optionally takes a string like
  540. "REQUIRED" or "NONE". Same with ``ssl_version`` takes strings like "SSLv23"
  541. The string values reflect the suffix of the respective constant variable.
  542. (Issue #130)
  543. * Vendored ``socksipy`` now based on Anorov's fork which handles unexpectedly
  544. closed proxy connections and larger read buffers. (Issue #135)
  545. * Ensure the connection is closed if no data is received, fixes connection leak
  546. on some platforms. (Issue #133)
  547. * Added SNI support for SSL/TLS connections on Py32+. (Issue #89)
  548. * Tests fixed to be compatible with Py26 again. (Issue #125)
  549. * Added ability to choose SSL version by passing an ``ssl.PROTOCOL_*`` constant
  550. to the ``ssl_version`` parameter of ``HTTPSConnectionPool``. (Issue #109)
  551. * Allow an explicit content type to be specified when encoding file fields.
  552. (Issue #126)
  553. * Exceptions are now pickleable, with tests. (Issue #101)
  554. * Fixed default headers not getting passed in some cases. (Issue #99)
  555. * Treat "content-encoding" header value as case-insensitive, per RFC 2616
  556. Section 3.5. (Issue #110)
  557. * "Connection Refused" SocketErrors will get retried rather than raised.
  558. (Issue #92)
  559. * Updated vendored ``six``, no longer overrides the global ``six`` module
  560. namespace. (Issue #113)
  561. * ``urllib3.exceptions.MaxRetryError`` contains a ``reason`` property holding
  562. the exception that prompted the final retry. If ``reason is None`` then it
  563. was due to a redirect. (Issue #92, #114)
  564. * Fixed ``PoolManager.urlopen()`` from not redirecting more than once.
  565. (Issue #149)
  566. * Don't assume ``Content-Type: text/plain`` for multi-part encoding parameters
  567. that are not files. (Issue #111)
  568. * Pass `strict` param down to ``httplib.HTTPConnection``. (Issue #122)
  569. * Added mechanism to verify SSL certificates by fingerprint (md5, sha1) or
  570. against an arbitrary hostname (when connecting by IP or for misconfigured
  571. servers). (Issue #140)
  572. * Streaming decompression support. (Issue #159)
  573. 1.5 (2012-08-02)
  574. ----------------
  575. * Added ``urllib3.add_stderr_logger()`` for quickly enabling STDERR debug
  576. logging in urllib3.
  577. * Native full URL parsing (including auth, path, query, fragment) available in
  578. ``urllib3.util.parse_url(url)``.
  579. * Built-in redirect will switch method to 'GET' if status code is 303.
  580. (Issue #11)
  581. * ``urllib3.PoolManager`` strips the scheme and host before sending the request
  582. uri. (Issue #8)
  583. * New ``urllib3.exceptions.DecodeError`` exception for when automatic decoding,
  584. based on the Content-Type header, fails.
  585. * Fixed bug with pool depletion and leaking connections (Issue #76). Added
  586. explicit connection closing on pool eviction. Added
  587. ``urllib3.PoolManager.clear()``.
  588. * 99% -> 100% unit test coverage.
  589. 1.4 (2012-06-16)
  590. ----------------
  591. * Minor AppEngine-related fixes.
  592. * Switched from ``mimetools.choose_boundary`` to ``uuid.uuid4()``.
  593. * Improved url parsing. (Issue #73)
  594. * IPv6 url support. (Issue #72)
  595. 1.3 (2012-03-25)
  596. ----------------
  597. * Removed pre-1.0 deprecated API.
  598. * Refactored helpers into a ``urllib3.util`` submodule.
  599. * Fixed multipart encoding to support list-of-tuples for keys with multiple
  600. values. (Issue #48)
  601. * Fixed multiple Set-Cookie headers in response not getting merged properly in
  602. Python 3. (Issue #53)
  603. * AppEngine support with Py27. (Issue #61)
  604. * Minor ``encode_multipart_formdata`` fixes related to Python 3 strings vs
  605. bytes.
  606. 1.2.2 (2012-02-06)
  607. ------------------
  608. * Fixed packaging bug of not shipping ``test-requirements.txt``. (Issue #47)
  609. 1.2.1 (2012-02-05)
  610. ------------------
  611. * Fixed another bug related to when ``ssl`` module is not available. (Issue #41)
  612. * Location parsing errors now raise ``urllib3.exceptions.LocationParseError``
  613. which inherits from ``ValueError``.
  614. 1.2 (2012-01-29)
  615. ----------------
  616. * Added Python 3 support (tested on 3.2.2)
  617. * Dropped Python 2.5 support (tested on 2.6.7, 2.7.2)
  618. * Use ``select.poll`` instead of ``select.select`` for platforms that support
  619. it.
  620. * Use ``Queue.LifoQueue`` instead of ``Queue.Queue`` for more aggressive
  621. connection reusing. Configurable by overriding ``ConnectionPool.QueueCls``.
  622. * Fixed ``ImportError`` during install when ``ssl`` module is not available.
  623. (Issue #41)
  624. * Fixed ``PoolManager`` redirects between schemes (such as HTTP -> HTTPS) not
  625. completing properly. (Issue #28, uncovered by Issue #10 in v1.1)
  626. * Ported ``dummyserver`` to use ``tornado`` instead of ``webob`` +
  627. ``eventlet``. Removed extraneous unsupported dummyserver testing backends.
  628. Added socket-level tests.
  629. * More tests. Achievement Unlocked: 99% Coverage.
  630. 1.1 (2012-01-07)
  631. ----------------
  632. * Refactored ``dummyserver`` to its own root namespace module (used for
  633. testing).
  634. * Added hostname verification for ``VerifiedHTTPSConnection`` by vendoring in
  635. Py32's ``ssl_match_hostname``. (Issue #25)
  636. * Fixed cross-host HTTP redirects when using ``PoolManager``. (Issue #10)
  637. * Fixed ``decode_content`` being ignored when set through ``urlopen``. (Issue
  638. #27)
  639. * Fixed timeout-related bugs. (Issues #17, #23)
  640. 1.0.2 (2011-11-04)
  641. ------------------
  642. * Fixed typo in ``VerifiedHTTPSConnection`` which would only present as a bug if
  643. you're using the object manually. (Thanks pyos)
  644. * Made RecentlyUsedContainer (and consequently PoolManager) more thread-safe by
  645. wrapping the access log in a mutex. (Thanks @christer)
  646. * Made RecentlyUsedContainer more dict-like (corrected ``__delitem__`` and
  647. ``__getitem__`` behaviour), with tests. Shouldn't affect core urllib3 code.
  648. 1.0.1 (2011-10-10)
  649. ------------------
  650. * Fixed a bug where the same connection would get returned into the pool twice,
  651. causing extraneous "HttpConnectionPool is full" log warnings.
  652. 1.0 (2011-10-08)
  653. ----------------
  654. * Added ``PoolManager`` with LRU expiration of connections (tested and
  655. documented).
  656. * Added ``ProxyManager`` (needs tests, docs, and confirmation that it works
  657. with HTTPS proxies).
  658. * Added optional partial-read support for responses when
  659. ``preload_content=False``. You can now make requests and just read the headers
  660. without loading the content.
  661. * Made response decoding optional (default on, same as before).
  662. * Added optional explicit boundary string for ``encode_multipart_formdata``.
  663. * Convenience request methods are now inherited from ``RequestMethods``. Old
  664. helpers like ``get_url`` and ``post_url`` should be abandoned in favour of
  665. the new ``request(method, url, ...)``.
  666. * Refactored code to be even more decoupled, reusable, and extendable.
  667. * License header added to ``.py`` files.
  668. * Embiggened the documentation: Lots of Sphinx-friendly docstrings in the code
  669. and docs in ``docs/`` and on https://urllib3.readthedocs.io/.
  670. * Embettered all the things!
  671. * Started writing this file.
  672. 0.4.1 (2011-07-17)
  673. ------------------
  674. * Minor bug fixes, code cleanup.
  675. 0.4 (2011-03-01)
  676. ----------------
  677. * Better unicode support.
  678. * Added ``VerifiedHTTPSConnection``.
  679. * Added ``NTLMConnectionPool`` in contrib.
  680. * Minor improvements.
  681. 0.3.1 (2010-07-13)
  682. ------------------
  683. * Added ``assert_host_name`` optional parameter. Now compatible with proxies.
  684. 0.3 (2009-12-10)
  685. ----------------
  686. * Added HTTPS support.
  687. * Minor bug fixes.
  688. * Refactored, broken backwards compatibility with 0.2.
  689. * API to be treated as stable from this version forward.
  690. 0.2 (2008-11-17)
  691. ----------------
  692. * Added unit tests.
  693. * Bug fixes.
  694. 0.1 (2008-11-16)
  695. ----------------
  696. * First release.