Module ogr.services.github.auth_providers.token

Classes

class TokenAuthentication (token: str, max_retries: int | urllib3.util.retry.Retry = 0, **_)

Expand source code

class TokenAuthentication(GithubAuthentication):
    def __init__(self, token: str, max_retries: Union[int, Retry] = 0, **_) -> None:
        self._token = token
        self._pygithub_instance = github.Github(login_or_token=token, retry=max_retries)

    def __eq__(self, o: object) -> bool:
        return issubclass(o.__class__, TokenAuthentication) and (
            self._token == o._token  # type: ignore
        )

    def __str__(self) -> str:
        censored_token = (
            f"token='{self._token[:1]}***{self._token[-1:]}'" if self._token else ""
        )
        return f"Token({censored_token})"

    @property
    def pygithub_instance(self) -> github.Github:
        return self._pygithub_instance

    def get_token(self, namespace: str, repo: str) -> str:
        return self._token

    @staticmethod
    def try_create(
        token: Optional[str] = None,
        max_retries: Union[int, Retry] = 0,
        **_,
    ) -> Optional["TokenAuthentication"]:
        return TokenAuthentication(token, max_retries=max_retries)

Represents a token manager for authentication via GitHub App.

Ancestors

• GithubAuthentication

Inherited members

• GithubAuthentication:
  • get_token
  • pygithub_instance
  • try_create