Files
PyGithub/github/Requester.pyi
T
Enrico Minack fc2d0e150a Add authentication classes, move auth logic there (#2528)
This adds argument `auth` and deprecates `login_or_token`, `password`, `jwt`, and `app_auth` arguments of `github.Github`.

This adds argument `auth` and deprecates `integration_id`, `private_key` of `github.GithubIntegration`.

This deprecates the `create_jwt` method of `github.GithubIntegration`, replaced by `github.Auth.AppAuth.create_jwt`.
2023-06-08 09:17:25 +02:00

231 lines
7.0 KiB
Python

from collections import OrderedDict
from io import BufferedReader
from logging import Logger
from typing import (
Any,
Callable,
Dict,
Iterator,
Optional,
Tuple,
Union,
Generic,
TypeVar,
)
from requests.models import Response
from urllib3.util import Retry
from github.Auth import Auth
from github.GithubObject import GithubObject
from github.InstallationAuthorization import InstallationAuthorization
class HTTPRequestsConnectionClass:
def __init__(
self,
host: str,
port: Optional[int] = ...,
strict: bool = ...,
timeout: Optional[int] = ...,
retry: Optional[Union[int, Retry]] = ...,
pool_size: Optional[int] = ...,
**kwargs: str
) -> None: ...
def close(self) -> None: ...
def getresponse(self) -> RequestsResponse: ...
def request(
self, verb: str, url: str, input: None, headers: Dict[str, str]
) -> None: ...
class HTTPSRequestsConnectionClass:
def __init__(
self,
host: str,
port: Optional[int] = ...,
strict: bool = ...,
timeout: Optional[int] = ...,
retry: Optional[Union[int, Retry]] = ...,
pool_size: Optional[int] = ...,
**kwargs: str
) -> None: ...
def close(self) -> None: ...
def getresponse(self) -> RequestsResponse: ...
def request(
self,
verb: str,
url: str,
input: Optional[Union[str, BufferedReader]],
headers: Dict[str, str],
) -> None: ...
class Requester:
__auth: Optional[Auth] = ...
__installation_authorization: Optional[InstallationAuthorization] = ...
__logger: Logger
def DEBUG_ON_RESPONSE(
self, statusCode: int, responseHeader: Dict[str, str], data: str
) -> None: ...
def NEW_DEBUG_FRAME(self, requestHeader: Dict[str, str]) -> None: ...
def __check(
self,
status: int,
responseHeaders: Dict[str, Any],
output: str,
) -> Tuple[Dict[str, Any], Dict[str, Any]]: ...
def __addParametersToUrl(
self,
url: str,
parameters: Dict[str, Any],
) -> str: ...
def __authenticate(
self,
url: str,
requestHeaders: Dict[str, Any],
parameters: Dict[str, Any],
) -> None: ...
def __customConnection(
self,
url: str,
) -> Optional[Union[HTTPRequestsConnectionClass, HTTPSRequestsConnectionClass]]: ...
def __createConnection(
self,
) -> Union[HTTPRequestsConnectionClass, HTTPSRequestsConnectionClass]: ...
def __createException(
self,
status: int,
headers: Dict[str, Any],
output: str,
) -> Any: ...
@property
def _logger(self) -> Logger: ...
def __log(
self,
verb: str,
url: str,
requestHeaders: Dict[str, str],
input: Optional[str],
status: Optional[int],
responseHeaders: Dict[str, Any],
output: Optional[str],
) -> None: ...
def __makeAbsoluteUrl(self, url: str) -> str: ...
def __structuredFromJson(self, data: str) -> Optional[Dict[str, Any]]: ...
def __requestEncode(
self,
cnx: Union[HTTPRequestsConnectionClass, HTTPSRequestsConnectionClass],
verb: str,
url: str,
parameters: Dict[str, str],
requestHeaders: Dict[str, str],
input: Optional[str],
encode: Callable[[str], str],
) -> Tuple[int, Dict[str, Any], str]: ...
def __requestRaw(
self,
cnx: Union[HTTPRequestsConnectionClass, HTTPSRequestsConnectionClass],
verb: str,
url: str,
requestHeaders: Dict[str, str],
input: Optional[str],
) -> Tuple[int, Dict[str, Any], str]: ...
def __init__(
self,
auth: Optional[Auth],
base_url: str,
timeout: int,
user_agent: str,
per_page: int,
verify: bool,
retry: Optional[Union[int, Retry]],
pool_size: Optional[int],
) -> None: ...
@property
def base_url(self) -> str: ...
def withAuth(self, auth: Optional[Auth]) -> Requester: ...
def _initializeDebugFeature(self) -> None: ...
def check_me(self, obj: GithubObject) -> None: ...
def _must_refresh_token(self) -> bool: ...
def _get_installation_authorization(self) -> InstallationAuthorization: ...
def _refresh_token_if_needed(self) -> None: ...
def _refresh_token(self) -> None: ...
@classmethod
def injectConnectionClasses(
cls, httpConnectionClass: Callable, httpsConnectionClass: Callable
) -> None: ...
def requestBlob(
self,
verb: str,
url: str,
parameters: Dict[str, str] = ...,
headers: Dict[str, str] = ...,
input: Optional[str] = ...,
cnx: Optional[
Union[HTTPRequestsConnectionClass, HTTPSRequestsConnectionClass]
] = ...,
) -> Tuple[int, Dict[str, Any], str]: ...
def requestBlobAndCheck(
self,
verb: str,
url: str,
parameters: Optional[Dict[str, Any]] = ...,
headers: Optional[Dict[str, Any]] = ...,
input: Optional[str] = ...,
) -> Tuple[Dict[str, Any], Optional[Dict[str, Any]]]: ...
def requestJson(
self,
verb: str,
url: str,
parameters: Optional[Dict[str, Any]] = ...,
headers: Optional[Dict[str, Any]] = ...,
input: Optional[Any] = ...,
cnx: Optional[
Union[HTTPRequestsConnectionClass, HTTPSRequestsConnectionClass]
] = ...,
) -> Tuple[int, Dict[str, Any], str]: ...
def requestJsonAndCheck(
self,
verb: str,
url: str,
parameters: Optional[Dict[str, Any]] = ...,
headers: Optional[Dict[str, str]] = ...,
input: Optional[Any] = ...,
) -> Tuple[Dict[str, Any], Optional[Dict[str, Any]]]: ...
def requestMultipart(
self,
verb: str,
url: str,
parameters: Optional[Dict[str, Any]] = ...,
headers: Optional[Dict[str, Any]] = ...,
input: Optional[OrderedDict[str, str]] = ...,
cnx: Optional[
Union[HTTPRequestsConnectionClass, HTTPSRequestsConnectionClass]
] = ...,
) -> Tuple[int, Dict[str, Any], str]: ...
def requestMultipartAndCheck(
self,
verb: str,
url: str,
parameters: Optional[Dict[str, Any]] = ...,
headers: Optional[Dict[str, Any]] = ...,
input: Optional[OrderedDict[str, str]] = ...,
) -> Tuple[Dict[str, Any], Optional[Dict[str, Any]]]: ...
@classmethod
def resetConnectionClasses(cls) -> None: ...
@classmethod
def setDebugFlag(cls, flag: bool) -> None: ...
@classmethod
def setOnCheckMe(cls, onCheckMe: Callable) -> None: ...
T = TypeVar("T")
class WithRequester(Generic[T]):
__requester: Optional[Requester]
@property
def requester(self) -> Requester: ...
def withRequester(self, requester: Requester) -> T: ...
class RequestsResponse:
def __init__(self, r: Response) -> None: ...
def getheaders(self) -> Iterator[Any]: ...
def read(self) -> str: ...