Module `ogr.abstract.git_user`

Classes

class GitUser (service: GitService)

Expand source code

class GitUser(OgrAbstractClass):
    """
    Represents currently authenticated user through service.
    """

    def __init__(self, service: GitService) -> None:
        self.service = service

    def get_username(self) -> str:
        """
        Returns:
            Login of the user.
        """
        raise NotImplementedError()

    def get_email(self) -> str:
        """
        Returns:
            Email of the user.
        """
        raise NotImplementedError()

    def get_projects(self) -> Union[Sequence["GitProject"], Iterable["GitProject"]]:
        """
        Returns:
            Sequence of projects in user's namespace.
        """
        raise NotImplementedError()

    def get_forks(self) -> Union[Sequence["GitProject"], Iterable["GitProject"]]:
        """
        Returns:
            Sequence of forks in user's namespace.
        """
        raise NotImplementedError()

Represents currently authenticated user through service.

Ancestors

OgrAbstractClass

Subclasses

BaseGitUser

Methods

def get_email(self) ‑> str

Expand source code

def get_email(self) -> str:
    """
    Returns:
        Email of the user.
    """
    raise NotImplementedError()

Returns

Email of the user.

def get_forks(self) ‑> Sequence[GitProject] | Iterable[GitProject]

Expand source code

def get_forks(self) -> Union[Sequence["GitProject"], Iterable["GitProject"]]:
    """
    Returns:
        Sequence of forks in user's namespace.
    """
    raise NotImplementedError()

Returns

Sequence of forks in user's namespace.

def get_projects(self) ‑> Sequence[GitProject] | Iterable[GitProject]

Expand source code

def get_projects(self) -> Union[Sequence["GitProject"], Iterable["GitProject"]]:
    """
    Returns:
        Sequence of projects in user's namespace.
    """
    raise NotImplementedError()

Returns

Sequence of projects in user's namespace.

def get_username(self) ‑> str

Expand source code

def get_username(self) -> str:
    """
    Returns:
        Login of the user.
    """
    raise NotImplementedError()