[Python-checkins] cpython (3.4): backport context argument of urlopen (#22366) for pep 476

Sun Nov 2 19:19:24 CET 2014

https://hg.python.org/cpython/rev/13f46fc1a002
changeset: 93363:13f46fc1a002
branch: 3.4
parent: 93360:1590c594550e
user: Senthil Kumaran <senthil at uthcode.com>
date: Fri Sep 19 15:23:30 2014 +0800
summary:
 backport context argument of urlopen (#22366) for pep 476
files:
 Doc/library/urllib.request.rst | 9 ++++++++-
 Lib/test/test_urllib.py | 8 ++++++++
 Lib/urllib/request.py | 10 +++++++++-
 Misc/NEWS | 4 ++++
 4 files changed, 29 insertions(+), 2 deletions(-)

diff --git a/Doc/library/urllib.request.rst b/Doc/library/urllib.request.rst
--- a/Doc/library/urllib.request.rst
+++ b/Doc/library/urllib.request.rst
@@ -16,7 +16,7 @@
 The :mod:`urllib.request` module defines the following functions:
 
 
-.. function:: urlopen(url, data=None[, timeout], *, cafile=None, capath=None, cadefault=False)
+.. function:: urlopen(url, data=None[, timeout], *, cafile=None, capath=None, cadefault=False, context=None)
 
 Open the URL *url*, which can be either a string or a
 :class:`Request` object.
@@ -47,6 +47,10 @@
 the global default timeout setting will be used). This actually
 only works for HTTP, HTTPS and FTP connections.
 
+ If *context* is specified, it must be a :class:`ssl.SSLContext` instance
+ describing the various SSL options. See
+ :class:`~http.client.HTTPSConnection` for more details.
+
 The optional *cafile* and *capath* parameters specify a set of trusted
 CA certificates for HTTPS requests. *cafile* should point to a single
 file containing a bundle of CA certificates, whereas *capath* should
@@ -111,6 +115,9 @@
 .. versionchanged:: 3.3
 *cadefault* was added.
 
+ .. versionchanged:: 3.4.3
+ *context* was added.
+
 .. function:: install_opener(opener)
 
 Install an :class:`OpenerDirector` instance as the default global opener.
diff --git a/Lib/test/test_urllib.py b/Lib/test/test_urllib.py
--- a/Lib/test/test_urllib.py
+++ b/Lib/test/test_urllib.py
@@ -10,6 +10,7 @@
 from unittest.mock import patch
 from test import support
 import os
+import ssl
 import sys
 import tempfile
 from nturl2path import url2pathname, pathname2url
@@ -379,6 +380,13 @@
 with support.check_warnings(('',DeprecationWarning)):
 urllib.request.URLopener()
 
+ def test_cafile_and_context(self):
+ context = ssl.create_default_context()
+ with self.assertRaises(ValueError):
+ urllib.request.urlopen(
+ "https://localhost", cafile="/nonexistent/path", context=context
+ )
+
 class urlopen_DataTests(unittest.TestCase):
 """Test urlopen() opening a data URL."""
 
diff --git a/Lib/urllib/request.py b/Lib/urllib/request.py
--- a/Lib/urllib/request.py
+++ b/Lib/urllib/request.py
@@ -136,9 +136,14 @@
 
 _opener = None
 def urlopen(url, data=None, timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
- *, cafile=None, capath=None, cadefault=False):
+ *, cafile=None, capath=None, cadefault=False, context=None):
 global _opener
 if cafile or capath or cadefault:
+ if context is not None:
+ raise ValueError(
+ "You can't pass both context and any of cafile, capath, and "
+ "cadefault"
+ )
 if not _have_ssl:
 raise ValueError('SSL support not available')
 context = ssl._create_stdlib_context(cert_reqs=ssl.CERT_REQUIRED,
@@ -146,6 +151,9 @@
 capath=capath)
 https_handler = HTTPSHandler(context=context, check_hostname=True)
 opener = build_opener(https_handler)
+ elif context:
+ https_handler = HTTPSHandler(context=context)
+ opener = build_opener(https_handler)
 elif _opener is None:
 _opener = opener = build_opener()
 else:
diff --git a/Misc/NEWS b/Misc/NEWS
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -36,6 +36,10 @@
 Library
 -------
 
+- Issue #22366: urllib.request.urlopen will accept a context object
+ (SSLContext) as an argument which will then used be for HTTPS connection.
+ Patch by Alex Gaynor.
+
 - Issue #22776: Brought excluded code into the scope of a try block in
 SysLogHandler.emit().
 
-- 
Repository URL: https://hg.python.org/cpython
