gitea.pull_request

pull_request

Pull request API for Gitea.

Classes

gitea.pull_request.AsyncPullRequest

AsyncPullRequest(client: AsyncGitea)

Bases: BasePullRequest, AsyncResource

Asynchronous Pull Request API for Gitea.

Source code in src/gitea/resource/async_resource.py

def __init__(self, client: AsyncGitea) -> None:
    """Initialize the Resource with a AsyncGitea client.

    Args:
        client: An instance of the AsyncGitea client.

    """
    self.client = client

Functions

gitea.pull_request.AsyncPullRequest.list_pull_requests async

list_pull_requests(owner: str, repository: str, base_branch: str | None = None, state: Literal['open', 'closed', 'all'] | None = None, sort: Literal['oldest', 'recentupdate', 'recentclose', 'leastupdate', 'mostcomment', 'leastcomment', 'priority'] | None = None, milestone: int | None = None, labels: list[int] | None = None, poster: str | None = None, page: int | None = None, limit: int | None = None, **kwargs: Any) -> tuple[list[dict[str, Any]], dict[str, Any]]

List pull requests in a repository.

Parameters:

Name	Type	Description	Default
owner	str	The owner of the repository.	required
repository	str	The name of the repository.	required
base_branch	str | None	Filter pull requests by base branch.	None
state	Literal['open', 'closed', 'all'] | None	Filter pull requests by state.	None
sort	Literal['oldest', 'recentupdate', 'recentclose', 'leastupdate', 'mostcomment', 'leastcomment', 'priority'] | None	Sort pull requests by the given criteria.	None
milestone	int | None	Filter pull requests by milestone.	None
labels	list[int] | None	Filter pull requests by labels.	None
poster	str | None	Filter pull requests by poster.	None
page	int | None	The page number for pagination.	None
limit	int | None	The number of pull requests per page.	None
**kwargs	Any	Additional arguments for the request.	{}

Returns:

Type	Description
tuple[list[dict[str, Any]], dict[str, Any]]	A tuple containing a list of pull requests and the status code. A list of dictionaries representing pull requests. Status code of the response.

Source code in src/gitea/pull_request/async_pull_request.py

async def list_pull_requests(  # noqa: PLR0913
    self,
    owner: str,
    repository: str,
    base_branch: str | None = None,
    state: Literal["open", "closed", "all"] | None = None,
    sort: (
        Literal["oldest", "recentupdate", "recentclose", "leastupdate", "mostcomment", "leastcomment", "priority"]
        | None
    ) = None,
    milestone: int | None = None,
    labels: list[int] | None = None,
    poster: str | None = None,
    page: int | None = None,
    limit: int | None = None,
    **kwargs: Any,
) -> tuple[list[dict[str, Any]], dict[str, Any]]:
    """List pull requests in a repository.

    Args:
        owner: The owner of the repository.
        repository: The name of the repository.
        base_branch: Filter pull requests by base branch.
        state: Filter pull requests by state.
        sort: Sort pull requests by the given criteria.
        milestone: Filter pull requests by milestone.
        labels: Filter pull requests by labels.
        poster: Filter pull requests by poster.
        page: The page number for pagination.
        limit: The number of pull requests per page.
        **kwargs: Additional arguments for the request.

    Returns:
        A tuple containing a list of pull requests and the status code.

            - A list of dictionaries representing pull requests.
            - Status code of the response.

    """
    response = await self._list_pull_requests(
        owner=owner,
        repository=repository,
        base_branch=base_branch,
        state=state,
        sort=sort,
        milestone=milestone,
        labels=labels,
        poster=poster,
        page=page,
        limit=limit,
        **kwargs,
    )
    data, status_code = await process_async_response(response, default=[])
    return cast(list[dict[str, Any]], data), {"status_code": status_code}

gitea.pull_request.PullRequest

PullRequest(client: Gitea)

Bases: BasePullRequest, Resource

Synchronous Pull Request API for Gitea.

Source code in src/gitea/resource/resource.py

def __init__(self, client: Gitea) -> None:
    """Initialize the Resource with a Gitea client.

    Args:
        client: An instance of the Gitea client.

    """
    self.client = client

Functions

gitea.pull_request.PullRequest.list_pull_requests

list_pull_requests(owner: str, repository: str, base_branch: str | None = None, state: Literal['open', 'closed', 'all'] | None = None, sort: Literal['oldest', 'recentupdate', 'recentclose', 'leastupdate', 'mostcomment', 'leastcomment', 'priority'] | None = None, milestone: int | None = None, labels: list[int] | None = None, poster: str | None = None, page: int | None = None, limit: int | None = None, **kwargs: Any) -> tuple[list[dict[str, Any]], dict[str, Any]]

List pull requests in a repository.

Parameters:

Name	Type	Description	Default
owner	str	The owner of the repository.	required
repository	str	The name of the repository.	required
base_branch	str | None	Filter pull requests by base branch.	None
state	Literal['open', 'closed', 'all'] | None	Filter pull requests by state.	None
sort	Literal['oldest', 'recentupdate', 'recentclose', 'leastupdate', 'mostcomment', 'leastcomment', 'priority'] | None	Sort pull requests by the given criteria.	None
milestone	int | None	Filter pull requests by milestone.	None
labels	list[int] | None	Filter pull requests by labels.	None
poster	str | None	Filter pull requests by poster.	None
page	int | None	The page number for pagination.	None
limit	int | None	The number of pull requests per page.	None
**kwargs	Any	Additional arguments for the request.	{}

Returns:

Type	Description
tuple[list[dict[str, Any]], dict[str, Any]]	A tuple containing a list of pull requests and a dictionary with metadata.

Source code in src/gitea/pull_request/pull_request.py

def list_pull_requests(  # noqa: PLR0913
    self,
    owner: str,
    repository: str,
    base_branch: str | None = None,
    state: Literal["open", "closed", "all"] | None = None,
    sort: (
        Literal["oldest", "recentupdate", "recentclose", "leastupdate", "mostcomment", "leastcomment", "priority"]
        | None
    ) = None,
    milestone: int | None = None,
    labels: list[int] | None = None,
    poster: str | None = None,
    page: int | None = None,
    limit: int | None = None,
    **kwargs: Any,
) -> tuple[list[dict[str, Any]], dict[str, Any]]:
    """List pull requests in a repository.

    Args:
        owner: The owner of the repository.
        repository: The name of the repository.
        base_branch: Filter pull requests by base branch.
        state: Filter pull requests by state.
        sort: Sort pull requests by the given criteria.
        milestone: Filter pull requests by milestone.
        labels: Filter pull requests by labels.
        poster: Filter pull requests by poster.
        page: The page number for pagination.
        limit: The number of pull requests per page.
        **kwargs: Additional arguments for the request.

    Returns:
        A tuple containing a list of pull requests and a dictionary with metadata.

    """
    response = self._list_pull_requests(
        owner=owner,
        repository=repository,
        base_branch=base_branch,
        state=state,
        sort=sort,
        milestone=milestone,
        labels=labels,
        poster=poster,
        page=page,
        limit=limit,
        **kwargs,
    )
    data, status_code = process_response(response, default=[])
    return cast(list[dict[str, Any]], data), {"status_code": status_code}