import asyncio import logging from abc import ABC, abstractmethod from collections.abc import Sized from http.cookies import BaseCookie, Morsel from typing import ( TYPE_CHECKING, Any, Awaitable, Callable, Dict, Generator, Iterable, List, Optional, Tuple, ) from multidict import CIMultiDict from yarl import URL from .helpers import get_running_loop from .typedefs import LooseCookies if TYPE_CHECKING: from .web_app import Application from .web_exceptions import HTTPException from .web_request import BaseRequest, Request from .web_response import StreamResponse else: BaseRequest = Request = Application = StreamResponse = None HTTPException = None class AbstractRouter(ABC): def __init__(self) -> None: self._frozen = False def post_init(self, app: Application) -> None: """Post init stage. Not an abstract method for sake of backward compatibility, but if the router wants to be aware of the application it can override this. """ @property def frozen(self) -> bool: return self._frozen def freeze(self) -> None: """Freeze router.""" self._frozen = True @abstractmethod async def resolve(self, request: Request) -> "AbstractMatchInfo": """Return MATCH_INFO for given request""" class AbstractMatchInfo(ABC): @property # pragma: no branch @abstractmethod def handler(self) -> Callable[[Request], Awaitable[StreamResponse]]: """Execute matched request handler""" @property @abstractmethod def expect_handler( self, ) -> Callable[[Request], Awaitable[Optional[StreamResponse]]]: """Expect handler for 100-continue processing""" @property # pragma: no branch @abstractmethod def http_exception(self) -> Optional[HTTPException]: """HTTPException instance raised on router's resolving, or None""" @abstractmethod # pragma: no branch def get_info(self) -> Dict[str, Any]: """Return a dict with additional info useful for introspection""" @property # pragma: no branch @abstractmethod def apps(self) -> Tuple[Application, ...]: """Stack of nested applications. Top level application is left-most element. """ @abstractmethod def add_app(self, app: Application) -> None: """Add application to the nested apps stack.""" @abstractmethod def freeze(self) -> None: """Freeze the match info. The method is called after route resolution. After the call .add_app() is forbidden. """ class AbstractView(ABC): """Abstract class based view.""" def __init__(self, request: Request) -> None: self._request = request @property def request(self) -> Request: """Request instance.""" return self._request @abstractmethod def __await__(self) -> Generator[Any, None, StreamResponse]: """Execute the view handler.""" class AbstractResolver(ABC): """Abstract DNS resolver.""" @abstractmethod async def resolve(self, host: str, port: int, family: int) -> List[Dict[str, Any]]: """Return IP address for given hostname""" @abstractmethod async def close(self) -> None: """Release resolver""" if TYPE_CHECKING: IterableBase = Iterable[Morsel[str]] else: IterableBase = Iterable ClearCookiePredicate = Callable[["Morsel[str]"], bool] class AbstractCookieJar(Sized, IterableBase): """Abstract Cookie Jar.""" def __init__(self, *, loop: Optional[asyncio.AbstractEventLoop] = None) -> None: self._loop = get_running_loop(loop) @abstractmethod def clear(self, predicate: Optional[ClearCookiePredicate] = None) -> None: """Clear all cookies if no predicate is passed.""" @abstractmethod def clear_domain(self, domain: str) -> None: """Clear all cookies for domain and all subdomains.""" @abstractmethod def update_cookies(self, cookies: LooseCookies, response_url: URL = URL()) -> None: """Update cookies.""" @abstractmethod def filter_cookies(self, request_url: URL) -> "BaseCookie[str]": """Return the jar's cookies filtered by their attributes.""" class AbstractStreamWriter(ABC): """Abstract stream writer.""" buffer_size = 0 output_size = 0 length: Optional[int] = 0 @abstractmethod async def write(self, chunk: bytes) -> None: """Write chunk into stream.""" @abstractmethod async def write_eof(self, chunk: bytes = b"") -> None: """Write last chunk.""" @abstractmethod async def drain(self) -> None: """Flush the write buffer.""" @abstractmethod def enable_compression(self, encoding: str = "deflate") -> None: """Enable HTTP body compression""" @abstractmethod def enable_chunking(self) -> None: """Enable HTTP chunked mode""" @abstractmethod async def write_headers( self, status_line: str, headers: "CIMultiDict[str]" ) -> None: """Write HTTP headers""" class AbstractAccessLogger(ABC): """Abstract writer to access log.""" def __init__(self, logger: logging.Logger, log_format: str) -> None: self.logger = logger self.log_format = log_format @abstractmethod def log(self, request: BaseRequest, response: StreamResponse, time: float) -> None: """Emit log to logger."""
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
.hash | Folder | 0755 |
|
|
__pycache__ | Folder | 0755 |
|
|
__init__.py | File | 7.58 KB | 0644 |
|
_cparser.pxd | File | 4.22 KB | 0644 |
|
_find_header.pxd | File | 68 B | 0644 |
|
_headers.pxi | File | 1.96 KB | 0644 |
|
_helpers.cpython-311-x86_64-linux-gnu.so | File | 86.01 KB | 0755 |
|
_helpers.pyi | File | 202 B | 0644 |
|
_helpers.pyx | File | 1.02 KB | 0644 |
|
_http_parser.cpython-311-x86_64-linux-gnu.so | File | 569.59 KB | 0755 |
|
_http_parser.pyx | File | 27.4 KB | 0644 |
|
_http_writer.cpython-311-x86_64-linux-gnu.so | File | 75.01 KB | 0755 |
|
_http_writer.pyx | File | 4.47 KB | 0644 |
|
_websocket.cpython-311-x86_64-linux-gnu.so | File | 53.37 KB | 0755 |
|
_websocket.pyx | File | 1.52 KB | 0644 |
|
abc.py | File | 5.37 KB | 0644 |
|
base_protocol.py | File | 2.68 KB | 0644 |
|
client.py | File | 46.17 KB | 0644 |
|
client_exceptions.py | File | 9.19 KB | 0644 |
|
client_proto.py | File | 8.45 KB | 0644 |
|
client_reqrep.py | File | 38.75 KB | 0644 |
|
client_ws.py | File | 10.75 KB | 0644 |
|
compression_utils.py | File | 4.9 KB | 0644 |
|
connector.py | File | 51.56 KB | 0644 |
|
cookiejar.py | File | 13.69 KB | 0644 |
|
formdata.py | File | 5.96 KB | 0644 |
|
hdrs.py | File | 4.5 KB | 0644 |
|
helpers.py | File | 29.55 KB | 0644 |
|
http.py | File | 1.8 KB | 0644 |
|
http_exceptions.py | File | 2.65 KB | 0644 |
|
http_parser.py | File | 34.66 KB | 0644 |
|
http_websocket.py | File | 26.09 KB | 0644 |
|
http_writer.py | File | 5.79 KB | 0644 |
|
locks.py | File | 1.11 KB | 0644 |
|
log.py | File | 325 B | 0644 |
|
multipart.py | File | 31.71 KB | 0644 |
|
payload.py | File | 13.22 KB | 0644 |
|
payload_streamer.py | File | 2.04 KB | 0644 |
|
py.typed | File | 7 B | 0644 |
|
pytest_plugin.py | File | 11.33 KB | 0644 |
|
resolver.py | File | 4.95 KB | 0644 |
|
streams.py | File | 20.35 KB | 0644 |
|
tcp_helpers.py | File | 961 B | 0644 |
|
test_utils.py | File | 19.71 KB | 0644 |
|
tracing.py | File | 14.78 KB | 0644 |
|
typedefs.py | File | 1.44 KB | 0644 |
|
web.py | File | 18.81 KB | 0644 |
|
web_app.py | File | 17.88 KB | 0644 |
|
web_exceptions.py | File | 10.12 KB | 0644 |
|
web_fileresponse.py | File | 11.15 KB | 0644 |
|
web_log.py | File | 7.62 KB | 0644 |
|
web_middlewares.py | File | 3.94 KB | 0644 |
|
web_protocol.py | File | 22.5 KB | 0644 |
|
web_request.py | File | 28.08 KB | 0644 |
|
web_response.py | File | 27.08 KB | 0644 |
|
web_routedef.py | File | 5.99 KB | 0644 |
|
web_runner.py | File | 11.46 KB | 0644 |
|
web_server.py | File | 2.53 KB | 0644 |
|
web_urldispatcher.py | File | 39.12 KB | 0644 |
|
web_ws.py | File | 18.21 KB | 0644 |
|
worker.py | File | 7.78 KB | 0644 |
|