v2.16.5

faster ci (test)

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,28 @@
+Summary.
+
+## Expected Result
+
+What you expected.
+
+## Actual Result
+
+What happened instead.
+
+## Reproduction Steps
+
+```python
+import requests
+
+```
+
+## System Information
+
+    $ python -m requests.help
+
+```
+<paste here>
+```
+
+This command is only available on Requests v2.16.4 and greater. Otherwise,
+please provide some basic information about your system (Python version,
+operating system, &c).

.gitignore

@@ -5,7 +5,6 @@ nosetests.xml
 junit-report.xml
 pylint.txt
 toy.py
-tox.ini
 cover/
 build/
 docs/_build

.travis.yml

@@ -7,7 +7,7 @@ python:
   - "3.4"
   - "3.5"
   - "3.6"
-  - "3.7-dev"
+  # - "3.7-dev"
   # - "pypy"  -- appears to hang
   # - "pypy3"
 # command to install dependencies
@@ -16,7 +16,7 @@ install: "make"
 script:
   - |
     if [[ "$TRAVIS_PYTHON_VERSION" != "2.6" ]] ; then make test-readme; fi
-  - make coverage
+  - make ci
 after_success:
   - pipenv run codecov
 cache: pip

AUTHORS.rst

@@ -181,3 +181,4 @@ Patches and Suggestions
 - Jonathan Vanasco (`@jvanasco <https://github.com/jvanasco>`_)
 - David Fontenot (`@davidfontenot <https://github.com/davidfontenot>`_)
 - Shmuel Amar (`@shmuelamar <https://github.com/shmuelamar>`_)
+- Gary Wu (`@garywu <https://github.com/garywu>`_)

HISTORY.rst

@@ -3,6 +3,51 @@
 Release History
 ---------------
 
+2.16.5 (2017-05-28)
++++++++++++++++++++
+
+- Improvements to ``$ python -m requests.help``.
+
+2.16.4 (2017-05-27)
++++++++++++++++++++
+
+- Introduction of the ``$ python -m requests.help`` command, for debugging with maintainers!
+
+2.16.3 (2017-05-27)
++++++++++++++++++++
+
+- Further restored the ``requests.packages`` namespace for compatibility reasons.
+
+2.16.2 (2017-05-27)
++++++++++++++++++++
+
+- Further restored the ``requests.packages`` namespace for compatibility reasons.
+
+No code modification (noted below) should be neccessary any longer.
+
+2.16.1 (2017-05-27)
++++++++++++++++++++
+
+- Restored the ``requests.packages`` namespace for compatibility reasons.
+- Bugfix for ``urllib3`` version parsing.
+
+**Note**: code that was written to import against the ``requests.packages``
+namespace previously will have to import code that rests at this module-level
+now.
+
+For example::
+
+    from requests.packages.urllib3.poolmanager import PoolManager
+
+Will need to be re-written to be::
+
+    from requests.packages import urllib3
+    urllib3.poolmanager.PoolManager
+
+Or, even better::
+
+    from urllib3.poolmanager import PoolManager
+
 2.16.0 (2017-05-26)
 +++++++++++++++++++
 

Makefile

@@ -1,23 +1,17 @@
 .PHONY: docs
-
 init:
-	pip install pipenv
-	pipenv install --dev
-	pipenv run pip install -e .[socks]
-
+	pip install -r requirements.txt
 test:
-	# This runs all of the tests. To run an individual test, run py.test with
-	# the -k flag, like "py.test -k test_path_is_not_double_encoded"
-	pipenv run py.test tests
+	# This runs all of the tests, on both Python 2 and Python 3.
+	detox
+ci:
+	python setup.py test
 
 test-readme:
-	pipenv run python setup.py check -r -s
+	python setup.py check -r -s
 
 coverage:
-	pipenv run py.test --cov-config .coveragerc --verbose --cov-report term --cov-report xml --cov=requests tests
-
-certs:
-	curl http://ci.kennethreitz.org/job/ca-bundle/lastSuccessfulBuild/artifact/cacerts.pem -o requests/cacert.pem
+	py.test --cov-config .coveragerc --verbose --cov-report term --cov-report xml --cov=requests tests
 
 publish:
 	pip install 'twine>=1.5.0'

Pipfile

@@ -1,14 +0,0 @@
-[[source]]
-url = "https://pypi.python.org/simple"
-verify_ssl = true
-
-[dev-packages]
-pytest = ">=2.8.0"
-codecov = "*"
-pytest-httpbin = "==0.0.7"
-pytest-mock = "*"
-pytest-cov = "*"
-alabaster = "*"
-readme_renderer = "*"
-Sphinx = "<=1.5.5"
-PySocks = "*"

Pipfile.lock

@@ -1,116 +0,0 @@
-{
-    "_meta": {
-        "hash": {
-            "sha256": "a26ef57f42fa3da7d70d1c1decb4e6445a6ff66e47c9094ddc9ab8e1f4c0a5b6"
-        },
-        "requires": {},
-        "sources": [
-            {
-                "url": "https://pypi.python.org/simple",
-                "verify_ssl": true
-            }
-        ]
-    },
-    "default": {},
-    "develop": {
-        "alabaster": {
-            "version": "==0.7.10"
-        },
-        "appdirs": {
-            "version": "==1.4.3"
-        },
-        "babel": {
-            "version": "==2.4.0"
-        },
-        "click": {
-            "version": "==6.7"
-        },
-        "codecov": {
-            "version": "==2.0.9"
-        },
-        "coverage": {
-            "version": "==4.4.1"
-        },
-        "decorator": {
-            "version": "==4.0.11"
-        },
-        "docutils": {
-            "version": "==0.13.1"
-        },
-        "flask": {
-            "version": "==0.12.2"
-        },
-        "funcsigs": {
-            "version": "==1.0.2"
-        },
-        "httpbin": {
-            "version": "==0.5.0"
-        },
-        "imagesize": {
-            "version": "==0.7.1"
-        },
-        "itsdangerous": {
-            "version": "==0.24"
-        },
-        "jinja2": {
-            "version": "==2.9.6"
-        },
-        "markupsafe": {
-            "version": "==1.0"
-        },
-        "mock": {
-            "version": "==2.0.0"
-        },
-        "packaging": {
-            "version": "==16.8"
-        },
-        "pbr": {
-            "version": "==3.0.0"
-        },
-        "py": {
-            "version": "==1.4.33"
-        },
-        "pygments": {
-            "version": "==2.2.0"
-        },
-        "pyparsing": {
-            "version": "==2.2.0"
-        },
-        "pysocks": {
-            "version": "==1.6.7"
-        },
-        "pytest": {
-            "version": "==3.0.7"
-        },
-        "pytest-cov": {
-            "version": "==2.5.1"
-        },
-        "pytest-httpbin": {
-            "version": "==0.0.7"
-        },
-        "pytest-mock": {
-            "version": "==1.6.0"
-        },
-        "pytz": {
-            "version": "==2017.2"
-        },
-        "requests": {
-            "version": "==2.14.2"
-        },
-        "setuptools": {
-            "version": "==35.0.2"
-        },
-        "six": {
-            "version": "==1.10.0"
-        },
-        "snowballstemmer": {
-            "version": "==1.2.1"
-        },
-        "sphinx": {
-            "version": "==1.5.5"
-        },
-        "werkzeug": {
-            "version": "==0.12.2"
-        }
-    }
-}

README.rst

@@ -57,8 +57,7 @@ See `the similar code, sans Requests <https://gist.github.com/973705>`_.
 Requests allows you to send *organic, grass-fed* HTTP/1.1 requests, without the
 need for manual labor. There's no need to manually add query strings to your
 URLs, or to form-encode your POST data. Keep-alive and HTTP connection pooling
-are 100% automatic, powered by `urllib3 <https://github.com/shazow/urllib3>`_,
-which is embedded within Requests.
+are 100% automatic, thanks to `urllib3 <https://github.com/shazow/urllib3>`_.
 
 Besides, all the cool kids are doing it. Requests is one of the most
 downloaded Python packages of all time, pulling in over 11,000,000 downloads

docs/index.rst

@@ -57,8 +57,7 @@ See `similar code, sans Requests <https://gist.github.com/973705>`_.
 **Requests** allows you to send *organic, grass-fed* HTTP/1.1 requests, without the
 need for manual labor. There's no need to manually add query strings to your
 URLs, or to form-encode your POST data. Keep-alive and HTTP connection pooling
-are 100% automatic, powered by `urllib3 <https://github.com/shazow/urllib3>`_,
-which is embedded within Requests.
+are 100% automatic, thanks to `urllib3 <https://github.com/shazow/urllib3>`_.
 
 User Testimonials
 -----------------

docs/user/quickstart.rst

@@ -234,7 +234,24 @@ dictionary of data will automatically be form-encoded when the request is made::
       ...
     }
 
-There are many times that you want to send data that is not form-encoded. If
+You can also pass a list of tuples to the ``data`` argument. This is particularly
+useful when the form has multiple elements that use the same key::
+
+    >>> payload = (('key1', 'value1'), ('key1', 'value2'))
+    >>> r = requests.post('http://httpbin.org/post', data=payload)
+    >>> print(r.text)
+    {
+      ...
+      "form": {
+        "key1": [
+          "value1",
+          "value2"
+        ]
+      },
+      ...
+    }
+
+There are times that you may want to send data that is not form-encoded. If
 you pass in a ``string`` instead of a ``dict``, that data will be posted directly.
 
 For example, the GitHub API v3 accepts JSON-Encoded POST/PATCH data::
@@ -485,7 +502,7 @@ Timeouts
 --------
 
 You can tell Requests to stop waiting for a response after a given number of
-seconds with the ``timeout`` parameter. Nearly all production code should use 
+seconds with the ``timeout`` parameter. Nearly all production code should use
 this parameter in nearly all requests. Failure to do so can cause your program
 to hang indefinitely::
 

requests/__init__.py

@@ -46,7 +46,11 @@ from .__version__ import __copyright__, __cake__
 
 # Check urllib3 for compatibility.
 import urllib3
-major, minor, patch = urllib3.__version__.split('.')[:3]
+urllib3_version = urllib3.__version__.split('.')
+# Sometimes, urllib3 only reports its version as 16.1.
+if len(urllib3_version) == 2:
+    urllib3_version.append('0')
+major, minor, patch = urllib3_version
 major, minor, patch = int(major), int(minor), int(patch)
 # urllib3 >= 1.21.1, < 1.22
 try:
@@ -83,6 +87,7 @@ from urllib3.exceptions import DependencyWarning
 warnings.simplefilter('ignore', DependencyWarning)
 
 from . import utils
+from . import packages
 from .models import Request, Response, PreparedRequest
 from .api import request, get, head, post, patch, put, delete, options
 from .sessions import session, Session

requests/__version__.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 # .-. .-. .-. . . .-. .-. .-. .-.
 # |(  |-  |.| | | |-  `-.  |  `-.
 # ' ' `-' `-`.`-' `-' `-'  '  `-'
@@ -7,10 +5,12 @@
 __title__ = 'requests'
 __description__ = 'Python HTTP for Humans.'
 __url__ = 'http://python-requests.org'
-__version__ = '2.16.0'
-__build__ = 0x021600
+__version__ = '2.16.5'
+__build__ = 0x021605
 __author__ = 'Kenneth Reitz'
 __author_email__ = 'me@kennethreitz.org'
 __license__ = 'Apache 2.0'
 __copyright__ = 'Copyright 2017 Kenneth Reitz'
-__cake__ = u'✨ 🍰 ✨'
+__cake__ = u'\u2728 \U0001f370 \u2728'
+
+

requests/help.py

@@ -0,0 +1,110 @@
+"""Module containing bug report helper(s)."""
+from __future__ import print_function
+
+import json
+import platform
+import sys
+import ssl
+
+import urllib3
+import chardet
+
+from . import __version__ as requests_version
+
+try:
+    from .packages.urllib3.contrib import pyopenssl
+except ImportError:
+    pyopenssl = None
+    OpenSSL = None
+    cryptography = None
+else:
+    import OpenSSL
+    import cryptography
+
+
+def _implementation():
+    """Return a dict with the Python implementation and verison.
+
+    Provide both the name and the version of the Python implementation
+    currently running. For example, on CPython 2.7.5 it will return
+    {'name': 'CPython', 'version': '2.7.5'}.
+
+    This function works best on CPython and PyPy: in particular, it probably
+    doesn't work for Jython or IronPython. Future investigation should be done
+    to work out the correct shape of the code for those platforms.
+    """
+    implementation = platform.python_implementation()
+
+    if implementation == 'CPython':
+        implementation_version = platform.python_version()
+    elif implementation == 'PyPy':
+        implementation_version = '%s.%s.%s' % (sys.pypy_version_info.major,
+                                               sys.pypy_version_info.minor,
+                                               sys.pypy_version_info.micro)
+        if sys.pypy_version_info.releaselevel != 'final':
+            implementation_version = ''.join([
+                implementation_version, sys.pypy_version_info.releaselevel
+                ])
+    elif implementation == 'Jython':
+        implementation_version = platform.python_version()  # Complete Guess
+    elif implementation == 'IronPython':
+        implementation_version = platform.python_version()  # Complete Guess
+    else:
+        implementation_version = 'Unknown'
+
+    return {'name': implementation, 'version': implementation_version}
+
+
+def info():
+    """Generate information for a bug report."""
+    try:
+        platform_info = {
+            'system': platform.system(),
+            'release': platform.release(),
+        }
+    except IOError:
+        platform_info = {
+            'system': 'Unknown',
+            'release': 'Unknown',
+        }
+
+    implementation_info = _implementation()
+    urllib3_info = {'version': urllib3.__version__}
+    chardet_info = {'version': chardet.__version__}
+
+    pyopenssl_info = {
+        'version': None,
+        'openssl_version': '',
+    }
+    if OpenSSL:
+        pyopenssl_info = {
+            'version': OpenSSL.__version__,
+            'openssl_version': '%x' % OpenSSL.SSL.OPENSSL_VERSION_NUMBER,
+        }
+    cryptography_info = {
+        'version': getattr(cryptography, '__version__', ''),
+    }
+
+    return {
+        'platform': platform_info,
+        'implementation': implementation_info,
+        'system_ssl': {
+            'version': '%x' % ssl.OPENSSL_VERSION_NUMBER,
+        },
+        'using_pyopenssl': pyopenssl is not None,
+        'pyOpenSSL': pyopenssl_info,
+        'urllib3': urllib3_info,
+        'chardet': chardet_info,
+        'cryptography': cryptography_info,
+        'requests': {
+            'version': requests_version,
+        },
+    }
+
+def main():
+    """Pretty-print the bug information as JSON."""
+    print(json.dumps(info(), sort_keys=True, indent=2))
+
+if __name__ == '__main__':
+    main()
+

requests/packages.py

@@ -0,0 +1,15 @@
+import sys
+
+# This code exists for backwards compatibility reasons.
+# I don't like it either. Just look the other way. :)
+
+import urllib3
+sys.modules['requests.packages.urllib3'] = urllib3
+
+import idna
+sys.modules['requests.packages.idna'] = idna
+
+import chardet
+sys.modules['requests.packages.chardet'] = chardet
+
+# Kinda cool, though, right?

requirements.txt

@@ -1 +1,14 @@
--e .
+-e .[socks]
+pytest>=2.8.0
+codecov
+pytest-httpbin==0.0.7
+pytest-mock
+pytest-cov
+pytest-xdist
+alabaster
+readme_renderer
+Sphinx<=1.5.5
+PySocks
+setuptools>=18.5
+tox
+detox

setup.py

@@ -16,7 +16,7 @@ class PyTest(TestCommand):
 
     def initialize_options(self):
         TestCommand.initialize_options(self)
-        self.pytest_args = []
+        self.pytest_args = ['-n', '8', '--boxed']
 
     def finalize_options(self):
         TestCommand.finalize_options(self)
@@ -44,10 +44,10 @@ requires = [
     'certifi>=2017.4.17'
 
 ]
-test_requirements = ['pytest>=2.8.0', 'pytest-httpbin==0.0.7', 'pytest-cov', 'pytest-mock']
+test_requirements = ['pytest-httpbin==0.0.7', 'pytest-cov', 'pytest-mock', 'pytest-xdist', 'PySocks>=1.5.6, !=1.5.7', 'pytest>=2.8.0']
 
 about = {}
-with open(os.path.join(here, 'requests', '__version__.py')) as f:
+with open(os.path.join(here, 'requests', '__version__.py'), 'r', 'utf-8') as f:
     exec(f.read(), about)
 
 with open('README.rst', 'r', 'utf-8') as f:

tests/test_requests.py

@@ -65,6 +65,8 @@ class TestRequests:
         requests.put
         requests.patch
         requests.post
+        # Not really an entry point, but people rely on it.
+        from requests.packages.urllib3.poolmanager import PoolManager
 
     @pytest.mark.parametrize(
         'exception, url', (
@@ -633,7 +635,7 @@ class TestRequests:
         post1 = requests.post(url, data={'some': 'data'})
         assert post1.status_code == 200
 
-        with open('Pipfile') as f:
+        with open('requirements.txt') as f:
             post2 = requests.post(url, files={'some': f})
         assert post2.status_code == 200
 
@@ -693,7 +695,7 @@ class TestRequests:
         post1 = requests.post(url, data={'some': 'data'})
         assert post1.status_code == 200
 
-        with open('Pipfile') as f:
+        with open('requirements.txt') as f:
             post2 = requests.post(url, data={'some': 'data'}, files={'some': f})
         assert post2.status_code == 200
 
@@ -730,7 +732,7 @@ class TestRequests:
 
     def test_conflicting_post_params(self, httpbin):
         url = httpbin('post')
-        with open('Pipfile') as f:
+        with open('requirements.txt') as f:
             pytest.raises(ValueError, "requests.post(url, data='[{\"some\": \"data\"}]', files={'some': f})")
             pytest.raises(ValueError, "requests.post(url, data=u('[{\"some\": \"data\"}]'), files={'some': f})")
 

tox.ini

@@ -0,0 +1,8 @@
+[tox]
+envlist = py26,py27,py33,py34,py35,py36
+
+[testenv]
+
+commands =
+    pip install -e .[socks]
+    python setup.py test