gitea.cli.project.issues

issues

List all issues on a project, grouped by column.

Functions:

gitea.cli.project.issues.list_project_issues_command

list_project_issues_command(
    ctx: Context,
    owner: Annotated[
        str,
        Option("--owner", help="Owner of the repository."),
    ],
    project_id: Annotated[
        int,
        Option("--project-id", help="ID of the project."),
    ],
    repository: Annotated[
        str | None,
        Option(
            "--repository",
            help="Name of the repository. Omit for organization projects.",
        ),
    ] = None,
    fields: Annotated[
        str | None, Option("--fields", help=FIELDS_HELP)
    ] = 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,
) -> None

List every issue on a project, grouped by the column it sits in.

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='Name of the repository. Omit for organization projects.')]	The name of the repository, or None for organization projects.	None
project_id	Annotated[int, Option('--project-id', help='ID of the project.')]	The ID of the project.	required
fields	Annotated[str | None, Option('--fields', help=FIELDS_HELP)]	Comma-separated fields to keep on each issue, or None for all of them.	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.	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.	None

Source code in src/gitea/cli/project/issues.py

def list_project_issues_command(
    ctx: typer.Context,
    owner: Annotated[str, typer.Option("--owner", help="Owner of the repository.")],
    project_id: Annotated[int, typer.Option("--project-id", help="ID of the project.")],
    repository: Annotated[
        str | None,
        typer.Option("--repository", help="Name of the repository. Omit for organization projects."),
    ] = None,
    fields: Annotated[
        str | None,
        typer.Option("--fields", help=FIELDS_HELP),
    ] = 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,
) -> None:
    """List every issue on a project, grouped by the column it sits in.

    Args:
        ctx: The Typer context.
        owner: The owner of the repository.
        repository: The name of the repository, or None for organization projects.
        project_id: The ID of the project.
        fields: Comma-separated fields to keep on each issue, or None for all of them.
        account_name: Name of the account to use for authentication.
        token: Token for authentication.
        base_url: Base URL of the Gitea platform.

    """
    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.projection import parse_fields, project_records  # 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 the issues on every column of a project.

        Every page of columns, and every page of each column's issues, is fetched.

        Returns:
            A tuple containing one entry per column, each with its issues, and metadata.

        """
        names = parse_fields(fields)
        with Gitea(token=token, base_url=base_url) as client:
            columns, metadata = collect_all_pages(
                lambda page: client.project.list_project_columns(
                    owner=owner,
                    repository=repository,
                    project_id=project_id,
                    page=page,
                    limit=PAGE_SIZE,
                )
            )

            data: list[dict[str, Any]] = []
            issue_count = 0
            for column in columns:
                issues, _ = collect_all_pages(
                    lambda page, column_id=column["id"]: client.project.list_project_column_issues(
                        owner=owner,
                        repository=repository,
                        project_id=project_id,
                        column_id=column_id,
                        page=page,
                        limit=PAGE_SIZE,
                    )
                )
                issue_count += len(issues)
                data.append(
                    {
                        "column": {"id": column["id"], "title": column.get("title")},
                        "issues": project_records(issues, names),
                    }
                )

        return data, {**metadata, "column_count": len(data), "issue_count": issue_count}

    execute_api_command(api_call=api_call, base_url=base_url, command_name="gitea-cli project issues")