[Python-checkins] bpo-32066: Support pathlib.Path in create_unix_connection; sock arg should be optional (#4447)
Yury Selivanov
webhook-mailer at python.org
Mon Nov 20 17:26:31 EST 2017
https://github.com/python/cpython/commit/423fd362f8e4d6c867a5afc8ac7cbeeb66cac19c
commit: 423fd362f8e4d6c867a5afc8ac7cbeeb66cac19c
branch: master
author: Yury Selivanov <yury at magic.io>
committer: GitHub <noreply at github.com>
date: 2017-11-20T17:26:28-05:00
summary:
bpo-32066: Support pathlib.Path in create_unix_connection; sock arg should be optional (#4447)
files:
A Misc/NEWS.d/next/Library/2017-11-17-18-28-53.bpo-32066.OMQFLH.rst
M Doc/library/asyncio-eventloop.rst
M Lib/asyncio/events.py
M Lib/asyncio/unix_events.py
M Lib/test/test_asyncio/test_unix_events.py
diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst
index e635cba659a..dd75a23ae4e 100644
--- a/Doc/library/asyncio-eventloop.rst
+++ b/Doc/library/asyncio-eventloop.rst
@@ -391,7 +391,7 @@ Creating connections
:ref:`UDP echo server protocol <asyncio-udp-echo-server-protocol>` examples.
-.. coroutinemethod:: AbstractEventLoop.create_unix_connection(protocol_factory, path, \*, ssl=None, sock=None, server_hostname=None)
+.. coroutinemethod:: AbstractEventLoop.create_unix_connection(protocol_factory, path=None, \*, ssl=None, sock=None, server_hostname=None)
Create UNIX connection: socket family :py:data:`~socket.AF_UNIX`, socket
type :py:data:`~socket.SOCK_STREAM`. The :py:data:`~socket.AF_UNIX` socket
@@ -403,13 +403,17 @@ Creating connections
coroutine returns a ``(transport, protocol)`` pair.
*path* is the name of a UNIX domain socket, and is required unless a *sock*
- parameter is specified. Abstract UNIX sockets, :class:`str`, and
- :class:`bytes` paths are supported.
+ parameter is specified. Abstract UNIX sockets, :class:`str`,
+ :class:`bytes`, and :class:`~pathlib.Path` paths are supported.
See the :meth:`AbstractEventLoop.create_connection` method for parameters.
Availability: UNIX.
+ .. versionchanged:: 3.7
+
+ The *path* parameter can now be a :class:`~pathlib.Path` object.
+
Creating listening connections
------------------------------
@@ -479,10 +483,18 @@ Creating listening connections
Similar to :meth:`AbstractEventLoop.create_server`, but specific to the
socket family :py:data:`~socket.AF_UNIX`.
+ *path* is the name of a UNIX domain socket, and is required unless a *sock*
+ parameter is specified. Abstract UNIX sockets, :class:`str`,
+ :class:`bytes`, and :class:`~pathlib.Path` paths are supported.
+
This method is a :ref:`coroutine <coroutine>`.
Availability: UNIX.
+ .. versionchanged:: 3.7
+
+ The *path* parameter can now be a :class:`~pathlib.Path` object.
+
.. coroutinemethod:: BaseEventLoop.connect_accepted_socket(protocol_factory, sock, \*, ssl=None)
Handle an accepted connection.
diff --git a/Lib/asyncio/events.py b/Lib/asyncio/events.py
index f2f2e286342..e59d3d2760e 100644
--- a/Lib/asyncio/events.py
+++ b/Lib/asyncio/events.py
@@ -362,12 +362,12 @@ def create_server(self, protocol_factory, host=None, port=None, *,
"""
raise NotImplementedError
- def create_unix_connection(self, protocol_factory, path, *,
+ def create_unix_connection(self, protocol_factory, path=None, *,
ssl=None, sock=None,
server_hostname=None):
raise NotImplementedError
- def create_unix_server(self, protocol_factory, path, *,
+ def create_unix_server(self, protocol_factory, path=None, *,
sock=None, backlog=100, ssl=None):
"""A coroutine which creates a UNIX Domain Socket server.
diff --git a/Lib/asyncio/unix_events.py b/Lib/asyncio/unix_events.py
index bf682a1a98a..be98f334cec 100644
--- a/Lib/asyncio/unix_events.py
+++ b/Lib/asyncio/unix_events.py
@@ -212,7 +212,7 @@ def _child_watcher_callback(self, pid, returncode, transp):
self.call_soon_threadsafe(transp._process_exited, returncode)
@coroutine
- def create_unix_connection(self, protocol_factory, path, *,
+ def create_unix_connection(self, protocol_factory, path=None, *,
ssl=None, sock=None,
server_hostname=None):
assert server_hostname is None or isinstance(server_hostname, str)
@@ -229,6 +229,7 @@ def create_unix_connection(self, protocol_factory, path, *,
raise ValueError(
'path and sock can not be specified at the same time')
+ path = _fspath(path)
sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM, 0)
try:
sock.setblocking(False)
diff --git a/Lib/test/test_asyncio/test_unix_events.py b/Lib/test/test_asyncio/test_unix_events.py
index d558842a1f8..fe758ba5e13 100644
--- a/Lib/test/test_asyncio/test_unix_events.py
+++ b/Lib/test/test_asyncio/test_unix_events.py
@@ -251,7 +251,6 @@ def test_create_unix_server_existing_path_sock(self):
srv.close()
self.loop.run_until_complete(srv.wait_closed())
- @unittest.skipUnless(hasattr(os, 'fspath'), 'no os.fspath')
def test_create_unix_server_pathlib(self):
with test_utils.unix_socket_path() as path:
path = pathlib.Path(path)
@@ -260,6 +259,15 @@ def test_create_unix_server_pathlib(self):
srv.close()
self.loop.run_until_complete(srv.wait_closed())
+ def test_create_unix_connection_pathlib(self):
+ with test_utils.unix_socket_path() as path:
+ path = pathlib.Path(path)
+ coro = self.loop.create_unix_connection(lambda: None, path)
+ with self.assertRaises(FileNotFoundError):
+ # If pathlib.Path wasn't supported, the exception would be
+ # different.
+ self.loop.run_until_complete(coro)
+
def test_create_unix_server_existing_path_nonsock(self):
with tempfile.NamedTemporaryFile() as file:
coro = self.loop.create_unix_server(lambda: None, file.name)
@@ -319,7 +327,7 @@ def test_create_unix_server_path_stream_bittype(self):
def test_create_unix_connection_path_inetsock(self):
sock = socket.socket()
with sock:
- coro = self.loop.create_unix_connection(lambda: None, path=None,
+ coro = self.loop.create_unix_connection(lambda: None,
sock=sock)
with self.assertRaisesRegex(ValueError,
'A UNIX Domain Stream.*was expected'):
diff --git a/Misc/NEWS.d/next/Library/2017-11-17-18-28-53.bpo-32066.OMQFLH.rst b/Misc/NEWS.d/next/Library/2017-11-17-18-28-53.bpo-32066.OMQFLH.rst
new file mode 100644
index 00000000000..cbe07054246
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2017-11-17-18-28-53.bpo-32066.OMQFLH.rst
@@ -0,0 +1,2 @@
+asyncio: Support pathlib.Path in create_unix_connection; sock arg should be
+optional
More information about the Python-checkins
mailing list