Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add type Path on web app run #6843

Merged
merged 13 commits into from
Jul 24, 2022
Merged

Add type Path on web app run #6843

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
4a59f3c
create branch and commit
SamirPS Jul 23, 2022
3b1e315
add optional and create two file
SamirPS Jul 23, 2022
093208b
chnage some str
SamirPS Jul 23, 2022
96aeca9
Delete str
SamirPS Jul 23, 2022
267a0b4
add str
SamirPS Jul 23, 2022
d52eab1
delete the str
SamirPS Jul 23, 2022
e888927
Update web_runner.py
Dreamsorcerer Jul 23, 2022
609e7fb
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jul 23, 2022
83028f0
Update web_runner.py
Dreamsorcerer Jul 23, 2022
84b65f3
Revert NamedPipeSite
Dreamsorcerer Jul 23, 2022
4bcd6ae
Update 6839.feature
Dreamsorcerer Jul 23, 2022
65a5f99
change documentation for run_app
SamirPS Jul 23, 2022
148badd
Update web_reference.rst
Dreamsorcerer Jul 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGES/6839.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
web.run_app(path=) accept pathlib.Path
1 change: 1 addition & 0 deletions CONTRIBUTORS.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,7 @@ Robert Lu
Robert Nikolich
Roman Markeloff
Roman Podoliaka
Samir Akarioh
Samuel Colvin
Sean Hunt
Sebastian Acuna
Expand Down
7 changes: 4 additions & 3 deletions aiohttp/web.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Dreamsorcerer I wonder if this should've been os.PathLike instead...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, seems we even have a PathLike in typedefs.py.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i didn't see it, you want me to use it or keep path from Pathlib ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm already on it. Updating a couple of other places too.
#6876

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You update this pull request ? #6874

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You update this pull request ? #6874

No, backports must be as close to the original patch as possible, for traceability.

sock: Optional[Union[socket.socket, TypingIterable[socket.socket]]] = None,
shutdown_timeout: float = 60.0,
keepalive_timeout: float = 75.0,
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down
15 changes: 10 additions & 5 deletions aiohttp/web_runner.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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,
Expand All @@ -166,15 +167,19 @@ 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, str(self._path), ssl=self._ssl_context, backlog=self._backlog
SamirPS marked this conversation as resolved.
Show resolved Hide resolved
)


class NamedPipeSite(BaseSite):
__slots__ = ("_path",)

def __init__(
self, runner: "BaseRunner", path: str, *, shutdown_timeout: float = 60.0
self,
runner: "BaseRunner",
path: str,
*,
shutdown_timeout: float = 60.0,
) -> None:
loop = asyncio.get_event_loop()
if not isinstance(
Expand All @@ -196,7 +201,7 @@ async def start(self) -> None:
server = self._runner.server
assert server is not None
_server = await loop.start_serving_pipe( # type: ignore[attr-defined]
server, self._path
server, str(self._path)
)
self._server = _server[0]

Expand Down
4 changes: 2 additions & 2 deletions tests/test_run_app.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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(
Expand Down