Add Path support on web app run (#6843)

CHANGES/6839.feature

@@ -0,0 +1 @@
+``web.run_app()`` now accept a ``Path`` object for the path parameter.

CONTRIBUTORS.txt

@@ -267,6 +267,7 @@ Robert Lu
 Robert Nikolich
 Roman Markeloff
 Roman Podoliaka
+Samir Akarioh
 Samuel Colvin
 Sean Hunt
 Sebastian Acuna

aiohttp/web.py

@@ -5,6 +5,7 @@
 from argparse import ArgumentParser
 from collections.abc import Iterable
 from importlib import import_module
+from pathlib import Path
 from typing import (
     Any,
     Awaitable,
@@ -290,7 +291,7 @@ async def _run_app(
     *,
     host: Optional[Union[str, HostSequence]] = None,
     port: Optional[int] = None,
-    path: Optional[str] = None,
+    path: Optional[Union[str, Path]] = None,
     sock: Optional[Union[socket.socket, TypingIterable[socket.socket]]] = None,
     shutdown_timeout: float = 60.0,
     keepalive_timeout: float = 75.0,
@@ -366,7 +367,7 @@ async def _run_app(
             )
 
         if path is not None:
-            if isinstance(path, (str, bytes, bytearray, memoryview)):
+            if isinstance(path, (str, bytes, bytearray, memoryview, Path)):
                 sites.append(
                     UnixSite(
                         runner,
@@ -464,7 +465,7 @@ def run_app(
     debug: bool = False,
     host: Optional[Union[str, HostSequence]] = None,
     port: Optional[int] = None,
-    path: Optional[str] = None,
+    path: Optional[Union[str, Path]] = None,
     sock: Optional[Union[socket.socket, TypingIterable[socket.socket]]] = None,
     shutdown_timeout: float = 60.0,
     keepalive_timeout: float = 75.0,

aiohttp/web_runner.py

@@ -2,7 +2,8 @@
 import signal
 import socket
 from abc import ABC, abstractmethod
-from typing import Any, List, Optional, Set, Type
+from pathlib import Path
+from typing import Any, List, Optional, Set, Type, Union
 
 from yarl import URL
 
@@ -141,7 +142,7 @@ class UnixSite(BaseSite):
     def __init__(
         self,
         runner: "BaseRunner",
-        path: str,
+        path: Union[str, Path],
         *,
         shutdown_timeout: float = 60.0,
         ssl_context: Optional[SSLContext] = None,
@@ -166,7 +167,10 @@ async def start(self) -> None:
         server = self._runner.server
         assert server is not None
         self._server = await loop.create_unix_server(
-            server, self._path, ssl=self._ssl_context, backlog=self._backlog
+            server,
+            self._path,  # type: ignore[arg-type]
+            ssl=self._ssl_context,
+            backlog=self._backlog,
         )
 
 

docs/web_reference.rst

@@ -2843,10 +2843,10 @@ Utilities
                     text HTTP and ``8443`` for HTTP via SSL (when
                     *ssl_context* parameter is specified).
 
-   :param str path: file system path for HTTP server Unix domain socket.
+   :param path: file system path for HTTP server Unix domain socket.
                     A sequence of file system paths can be used to bind
                     multiple domain sockets. Listening on Unix domain
-                    sockets is not supported by all operating systems.
+                    sockets is not supported by all operating systems, :class:`str` or :class:`pathlib.Path` .
 
    :param socket.socket sock: a preexisting socket object to accept connections on.
                        A sequence of socket objects can be passed.

tests/test_run_app.py

@@ -518,7 +518,7 @@ def test_run_app_custom_backlog_unix(patched_loop: Any) -> None:
 def test_run_app_http_unix_socket(patched_loop: Any, tmp_path: Any) -> None:
     app = web.Application()
 
-    sock_path = str(tmp_path / "socket.sock")
+    sock_path = tmp_path / "socket.sock"
     printer = mock.Mock(wraps=stopper(patched_loop))
     web.run_app(app, path=sock_path, print=printer, loop=patched_loop)
 
@@ -532,7 +532,7 @@ def test_run_app_http_unix_socket(patched_loop: Any, tmp_path: Any) -> None:
 def test_run_app_https_unix_socket(patched_loop: Any, tmp_path: Any) -> None:
     app = web.Application()
 
-    sock_path = str(tmp_path / "socket.sock")
+    sock_path = tmp_path / "socket.sock"
     ssl_context = ssl.create_default_context()
     printer = mock.Mock(wraps=stopper(patched_loop))
     web.run_app(