Skip to content

gitea.cli.notification.list

list

List notifications command.

Functions:

gitea.cli.notification.list.list_command 

list_command(
    ctx: Context,
    owner: Annotated[
        str | None,
        Option(
            "--owner",
            help="Owner of the repository. If omitted, lists the user's notifications.",
        ),
    ] = None,
    repository: Annotated[
        str | None,
        Option(
            "--repository",
            help="Name of the repository. Requires --owner.",
        ),
    ] = None,
    all_notifications: Annotated[
        bool | None,
        Option(
            "--all",
            help="Show notifications marked as read.",
        ),
    ] = None,
    status_types: Annotated[
        list[str] | None,
        Option(
            "--status-type",
            help="Show notifications with the provided status types.",
        ),
    ] = None,
    subject_type: Annotated[
        list[str] | None,
        Option(
            "--subject-type",
            help="Filter notifications by subject type.",
        ),
    ] = None,
    since: Annotated[
        datetime | None,
        Option(
            "--since",
            help="Only show notifications updated after the given time.",
        ),
    ] = None,
    before: Annotated[
        datetime | None,
        Option(
            "--before",
            help="Only show notifications updated before the given time.",
        ),
    ] = None,
    page: Annotated[
        int | None,
        Option(
            "--page", help="The page number for pagination."
        ),
    ] = None,
    limit: Annotated[
        int | None,
        Option(
            "--limit",
            help="The number of notifications 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,
) -> None

List notifications.

Parameters:

Name Type Description Default
ctx Context

The Typer context.

 required
owner Annotated[str | None, Option('--owner', help="Owner of the repository. If omitted, lists the user's notifications.")]

The owner of the repository.

 None
repository Annotated[str | None, Option('--repository', help='Name of the repository. Requires --owner.')]

The name of the repository.

 None
all_notifications Annotated[bool | None, Option('--all', help='Show notifications marked as read.')]

Show notifications marked as read.

 None
status_types Annotated[list[str] | None, Option('--status-type', help='Show notifications with the provided status types.')]

Show notifications with the provided status types.

 None
subject_type Annotated[list[str] | None, Option('--subject-type', help='Filter notifications by subject type.')]

Filter notifications by subject type.

 None
since Annotated[datetime | None, Option('--since', help='Only show notifications updated after the given time.')]

Only show notifications updated after the given time.

 None
before Annotated[datetime | None, Option('--before', help='Only show notifications updated before the given time.')]

Only show notifications updated before the given time.

 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 notifications per page.')]

The number of notifications 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.

 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/notification/list.py 
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
def list_command(
    ctx: typer.Context,
    owner: Annotated[
        str | None,
        typer.Option("--owner", help="Owner of the repository. If omitted, lists the user's notifications."),
    ] = None,
    repository: Annotated[
        str | None,
        typer.Option("--repository", help="Name of the repository. Requires --owner."),
    ] = None,
    all_notifications: Annotated[
        bool | None,
        typer.Option("--all", help="Show notifications marked as read."),
    ] = None,
    status_types: Annotated[
        list[str] | None,
        typer.Option("--status-type", help="Show notifications with the provided status types."),
    ] = None,
    subject_type: Annotated[
        list[str] | None,
        typer.Option("--subject-type", help="Filter notifications by subject type."),
    ] = None,
    since: Annotated[
        datetime | None,
        typer.Option("--since", help="Only show notifications updated after the given time."),
    ] = None,
    before: Annotated[
        datetime | None,
        typer.Option("--before", help="Only show notifications updated before the given time."),
    ] = 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 notifications 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,
) -> None:
    """List notifications.

    Args:
        ctx: The Typer context.
        owner: The owner of the repository.
        repository: The name of the repository.
        all_notifications: Show notifications marked as read.
        status_types: Show notifications with the provided status types.
        subject_type: Filter notifications by subject type.
        since: Only show notifications updated after the given time.
        before: Only show notifications updated before the given time.
        page: The page number for pagination.
        limit: The number of notifications per page.
        account_name: Name of the account to use for authentication.
        token: Token for authentication.
        base_url: Base URL of the Gitea platform.

    """
    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.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,
    )

    if (owner is None) != (repository is None):
        raise typer.BadParameter(
            "Both --owner and --repository must be provided together, or neither "
            "to list the authenticated user's notifications."
        )

    def api_call() -> tuple[dict[str, Any] | list[dict[str, Any]], dict[str, Any]]:
        """List notification information.

        Returns:
            A tuple containing the notification data and metadata.

        """
        with Gitea(token=token, base_url=base_url) as client:
            if owner is not None and repository is not None:
                return client.notification.list_repo_notifications(
                    owner=owner,
                    repository=repository,
                    all_notifications=all_notifications,
                    status_types=status_types,
                    subject_type=subject_type,
                    since=since,
                    before=before,
                    page=page,
                    limit=limit,
                )
            return client.notification.list_notifications(
                all_notifications=all_notifications,
                status_types=status_types,
                subject_type=subject_type,
                since=since,
                before=before,
                page=page,
                limit=limit,
            )

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