gitea.cli.pull_request.list

list

List pull requests command.

Functions:

gitea.cli.pull_request.list.list_command

list_command(
    ctx: Context,
    owner: Annotated[
        str,
        Option("--owner", help="Owner of the repository."),
    ],
    repository: Annotated[
        str | None,
        Option(
            "--repository", help=REPOSITORY_REQUIRED_HELP
        ),
    ] = None,
    base_branch: Annotated[
        str | None,
        Option(
            "--base-branch",
            help="Filter pull requests by base branch.",
        ),
    ] = None,
    state: Annotated[
        Literal["open", "closed", "all"] | None,
        Option(
            "--state", help="Filter pull requests by state."
        ),
    ] = None,
    sort: Annotated[
        Literal[
            "oldest",
            "recentupdate",
            "recentclose",
            "leastupdate",
            "mostcomment",
            "leastcomment",
            "priority",
        ]
        | None,
        Option(
            "--sort",
            help="Sort pull requests by the given criteria.",
        ),
    ] = None,
    milestone: Annotated[
        int | None,
        Option(
            "--milestone",
            help="Filter pull requests by milestone.",
        ),
    ] = None,
    labels: Annotated[
        list[int] | None,
        Option(
            "--labels",
            help="Filter pull requests by labels.",
        ),
    ] = None,
    poster: Annotated[
        str | None,
        Option(
            "--poster",
            help="Filter pull requests by poster.",
        ),
    ] = None,
    page: Annotated[
        int | None,
        Option(
            "--page", help="The page number for pagination."
        ),
    ] = None,
    limit: Annotated[
        int | None,
        Option(
            "--limit",
            help="The number of pull requests per page.",
        ),
    ] = None,
    account_name: Annotated[
        str | None,
        Option(
            "--account-name",
            help="Name of the account to use for authentication.",
        ),
    ] = None,
    token: Annotated[
        str | None,
        Option(
            "--token",
            help="Token for authentication. If not provided, the token from the specified account will be used.",
        ),
    ] = None,
    base_url: Annotated[
        str | None,
        Option(
            "--base-url",
            help="Base URL of the Gitea platform. If not provided, the base URL from the specified account will be used.",
        ),
    ] = None,
)

List pull requests in a repository.

Parameters:

Name	Type	Description	Default
ctx	Context	The Typer context.	required
owner	Annotated[str, Option('--owner', help='Owner of the repository.')]	The owner of the repository.	required
repository	Annotated[str | None, Option('--repository', help=REPOSITORY_REQUIRED_HELP)]	The name of the repository, which this command requires.	None
base_branch	Annotated[str | None, Option('--base-branch', help='Filter pull requests by base branch.')]	Filter pull requests by base branch.	None
state	Annotated[Literal['open', 'closed', 'all'] | None, Option('--state', help='Filter pull requests by state.')]	Filter pull requests by state.	None
sort	Annotated[Literal['oldest', 'recentupdate', 'recentclose', 'leastupdate', 'mostcomment', 'leastcomment', 'priority'] | None, Option('--sort', help='Sort pull requests by the given criteria.')]	Sort pull requests by the given criteria.	None
milestone	Annotated[int | None, Option('--milestone', help='Filter pull requests by milestone.')]	Filter pull requests by milestone.	None
labels	Annotated[list[int] | None, Option('--labels', help='Filter pull requests by labels.')]	Filter pull requests by labels.	None
poster	Annotated[str | None, Option('--poster', help='Filter pull requests by poster.')]	Filter pull requests by poster.	None
page	Annotated[int | None, Option('--page', help='The page number for pagination.')]	The page number for pagination.	None
limit	Annotated[int | None, Option('--limit', help='The number of pull requests per page.')]	The number of pull requests per page.	None
account_name	Annotated[str | None, Option('--account-name', help='Name of the account to use for authentication.')]	Name of the account to use for authentication.	None
token	Annotated[str | None, Option('--token', help='Token for authentication. If not provided, the token from the specified account will be used.')]	Token for authentication. If not provided, the token from the specified account will be used.	None
base_url	Annotated[str | None, Option('--base-url', help='Base URL of the Gitea platform. If not provided, the base URL from the specified account will be used.')]	Base URL of the Gitea platform. If not provided, the base URL from the specified account will be used.	None

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

def list_command(
    ctx: typer.Context,
    owner: Annotated[str, typer.Option("--owner", help="Owner of the repository.")],
    repository: Annotated[str | None, typer.Option("--repository", help=REPOSITORY_REQUIRED_HELP)] = None,
    base_branch: Annotated[
        str | None,
        typer.Option("--base-branch", help="Filter pull requests by base branch."),
    ] = None,
    state: Annotated[
        Literal["open", "closed", "all"] | None,
        typer.Option("--state", help="Filter pull requests by state."),
    ] = None,
    sort: Annotated[
        Literal["oldest", "recentupdate", "recentclose", "leastupdate", "mostcomment", "leastcomment", "priority"]
        | None,
        typer.Option("--sort", help="Sort pull requests by the given criteria."),
    ] = None,
    milestone: Annotated[
        int | None,
        typer.Option("--milestone", help="Filter pull requests by milestone."),
    ] = None,
    labels: Annotated[
        list[int] | None,
        typer.Option("--labels", help="Filter pull requests by labels."),
    ] = None,
    poster: Annotated[
        str | None,
        typer.Option("--poster", help="Filter pull requests by poster."),
    ] = None,
    page: Annotated[
        int | None,
        typer.Option("--page", help="The page number for pagination."),
    ] = None,
    limit: Annotated[
        int | None,
        typer.Option("--limit", help="The number of pull requests per page."),
    ] = None,
    account_name: Annotated[
        str | None,
        typer.Option(
            "--account-name",
            help="Name of the account to use for authentication.",
        ),
    ] = None,
    token: Annotated[
        str | None,
        typer.Option(
            "--token",
            help="Token for authentication. If not provided, the token from the specified account will be used.",
        ),
    ] = None,
    base_url: Annotated[
        str | None,
        typer.Option(
            "--base-url",
            help="Base URL of the Gitea platform. If not provided, the base URL from the specified account will be used.",
        ),
    ] = None,
):
    """List pull requests in a repository.

    Args:
        ctx: The Typer context.
        owner: The owner of the repository.
        repository: The name of the repository, which this command requires.
        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.
        account_name: Name of the account to use for authentication.
        token: Token for authentication. If not provided, the token from the specified account will be used.
        base_url: Base URL of the Gitea platform. If not provided, the base URL from the specified account will be used.

    """
    from typing import Any  # noqa: PLC0415

    from gitea.cli.utils.api import execute_api_command  # noqa: PLC0415
    from gitea.cli.utils.auth import get_auth_params  # noqa: PLC0415
    from gitea.cli.utils.options import require_repository  # noqa: PLC0415
    from gitea.client.gitea import Gitea  # noqa: PLC0415

    token, base_url = get_auth_params(
        config_path=ctx.obj.get("config_path"),
        account_name=account_name,
        token=token,
        base_url=base_url,
    )

    def api_call() -> tuple[dict[str, Any] | list[dict[str, Any]], dict[str, Any]]:
        """List pull requests information."""
        target_repository = require_repository(repository, command="gitea-cli pull-request list")

        with Gitea(token=token, base_url=base_url) as client:
            return client.pull_request.list_pull_requests(
                owner=owner,
                repository=target_repository,
                base_branch=base_branch,
                state=state,
                sort=sort,
                milestone=milestone,
                labels=labels,
                poster=poster,
                page=page,
                limit=limit,
            )

    execute_api_command(api_call=api_call, base_url=base_url, command_name="gitea-cli pull-request list")