"""
.. code-block:: python
from aioauth import requests
Request objects used throughout the project.
----
"""
from dataclasses import dataclass, field
from typing import Any, Generic, Optional, TypeVar
from .collections import HTTPHeaderDict
from .config import Settings
from .types import CodeChallengeMethod, GrantType, RequestMethod, ResponseMode
[docs]@dataclass
class Query:
"""
Object that contains a client's query string portion of a request.
Read more on query strings `here <https://en.wikipedia.org/wiki/Query_string>`__.
"""
client_id: Optional[str] = None
redirect_uri: str = ""
response_type: Optional[str] = None
state: str = ""
scope: str = ""
nonce: Optional[str] = None
code_challenge_method: Optional[CodeChallengeMethod] = None
code_challenge: Optional[str] = None
response_mode: Optional[ResponseMode] = None
[docs]@dataclass
class Post:
"""
Object that contains a client's post request portion of a request.
Read more on post requests `here <https://en.wikipedia.org/wiki/POST_(HTTP)>`__.
"""
grant_type: Optional[GrantType] = None
client_id: Optional[str] = None
client_secret: Optional[str] = None
redirect_uri: Optional[str] = None
scope: str = ""
username: Optional[str] = None
password: Optional[str] = None
refresh_token: Optional[str] = None
code: Optional[str] = None
token: Optional[str] = None
token_type_hint: Optional[str] = None
code_verifier: Optional[str] = None
TQuery = TypeVar("TQuery", bound=Query)
TPost = TypeVar("TPost", bound=Post)
TUser = TypeVar("TUser")
[docs]@dataclass
class BaseRequest(Generic[TQuery, TPost, TUser]):
method: RequestMethod
query: TQuery
post: TPost
headers: HTTPHeaderDict = field(default_factory=HTTPHeaderDict)
url: str = ""
user: Optional[TUser] = None
settings: Settings = field(default_factory=Settings)
TRequest = TypeVar("TRequest", bound=BaseRequest)
[docs]@dataclass
class Request(BaseRequest[Query, Post, Any]):
"""Object that contains a client's complete request."""
query: Query = field(default_factory=Query)
post: Post = field(default_factory=Post)
user: Optional[Any] = None