gitea.cli.main

main

Main entry point for the python-gitea CLI application.

Classes

gitea.cli.main.LoggingLevel

Bases: StrEnum

Logging levels for the CLI.

Functions:

gitea.cli.main.setup_logging

setup_logging(
    level: LoggingLevel = LoggingLevel.INFO,
) -> None

Set up logging with Rich handler.

Parameters:

Name	Type	Description	Default
level	LoggingLevel	Logging level.	INFO

Source code in src/gitea/cli/main.py

def setup_logging(level: LoggingLevel = LoggingLevel.INFO) -> None:
    """Set up logging with Rich handler.

    Args:
        level: Logging level.

    """
    import logging  # noqa: PLC0415

    from rich.console import Console  # noqa: PLC0415
    from rich.logging import RichHandler  # noqa: PLC0415

    logger = logging.getLogger("gitea")

    logger.setLevel(level.value)

    console = Console(stderr=True)

    # Remove any existing handlers to ensure RichHandler is used
    for h in logger.handlers[:]:  # Use slice copy to avoid modification during iteration
        logger.removeHandler(h)
    # Add the RichHandler

    handler = RichHandler(
        console=console,
        rich_tracebacks=True,
        show_time=True,
        show_level=True,  # Keep level (e.g., DEBUG, INFO) for clarity
        markup=True,  # Enable Rich markup in messages for styling
        level=level.value,  # Ensure handler respects the level
        omit_repeated_times=False,
        log_time_format="%H:%M",
    )
    handler.setLevel(level.value)
    logger.addHandler(handler)

    # Prevent propagation to root logger to avoid duplicate output
    logger.propagate = False

gitea.cli.main.version_callback

version_callback(value: bool) -> None

Print the package version and exit when the flag is set.

Parameters:

Name	Type	Description	Default
value	bool	Whether the --version flag was provided.	required

Raises:

Type	Description
Exit	When the version has been printed.

Source code in src/gitea/cli/main.py

def version_callback(value: bool) -> None:
    """Print the package version and exit when the flag is set.

    Args:
        value: Whether the `--version` flag was provided.

    Raises:
        typer.Exit: When the version has been printed.

    """
    if not value:
        return

    from gitea.version import __version__  # noqa: PLC0415

    print(__version__)
    raise typer.Exit

gitea.cli.main.main

main(
    ctx: Context,
    config_path: Annotated[
        str | None,
        Option(
            "--config-path",
            help="Path to the configuration file. If not provided, it uses the path specified by `PYTHON_GITEA_CONFIG_PATH`. If the environment variable is not defined, it uses the default location.",
        ),
    ] = None,
    verbose: Annotated[
        LoggingLevel,
        Option(
            "--verbose", "-v", help="Set verbosity level."
        ),
    ] = LoggingLevel.INFO,
    output: Annotated[
        OutputFormat,
        Option(
            "--output",
            "-o",
            envvar="PYTHON_GITEA_OUTPUT",
            help="Output format for command results. `json` emits the `{data, metadata}` envelope for every subcommand.",
        ),
    ] = OutputFormat.TEXT,
    version: Annotated[
        bool,
        Option(
            "--version",
            help="Show the version of python-gitea and exit.",
            callback=version_callback,
            is_eager=True,
        ),
    ] = False,
) -> None

Enter the CLI application.

Parameters:

Name	Type	Description	Default
ctx	Context	Typer context.	required
config_path	Annotated[str | None, Option('--config-path', help='Path to the configuration file. If not provided, it uses the path specified by `PYTHON_GITEA_CONFIG_PATH`. If the environment variable is not defined, it uses the default location.')]	Path to the configuration file.	None
verbose	Annotated[LoggingLevel, Option('--verbose', '-v', help='Set verbosity level.')]	Verbosity level for logging.	INFO
output	Annotated[OutputFormat, Option('--output', '-o', envvar='PYTHON_GITEA_OUTPUT', help='Output format for command results. `json` emits the `{data, metadata}` envelope for every subcommand.')]	Output format shared by every subcommand.	TEXT
version	Annotated[bool, Option('--version', help='Show the version of python-gitea and exit.', callback=version_callback, is_eager=True)]	Whether to print the version and exit. Handled by version_callback.	False

Source code in src/gitea/cli/main.py

@app.callback()
def main(
    ctx: typer.Context,
    config_path: Annotated[
        str | None,
        typer.Option(
            "--config-path",
            help="Path to the configuration file. If not provided, it uses the path specified by `PYTHON_GITEA_CONFIG_PATH`. If the environment variable is not defined, it uses the default location.",
        ),
    ] = None,
    verbose: Annotated[
        LoggingLevel,
        typer.Option("--verbose", "-v", help="Set verbosity level."),
    ] = LoggingLevel.INFO,
    output: Annotated[
        OutputFormat,
        typer.Option(
            "--output",
            "-o",
            envvar="PYTHON_GITEA_OUTPUT",
            help="Output format for command results. `json` emits the `{data, metadata}` envelope for every subcommand.",
        ),
    ] = OutputFormat.TEXT,
    version: Annotated[
        bool,
        typer.Option(
            "--version",
            help="Show the version of python-gitea and exit.",
            callback=version_callback,
            is_eager=True,
        ),
    ] = False,
) -> None:
    """Enter the CLI application.

    Args:
        ctx: Typer context.
        config_path: Path to the configuration file.
        verbose: Verbosity level for logging.
        output: Output format shared by every subcommand.
        version: Whether to print the version and exit. Handled by `version_callback`.

    """
    import os  # noqa: PLC0415

    config_path = config_path or os.getenv("PYTHON_GITEA_CONFIG_PATH")

    ctx.obj = {"config_path": config_path, "output": output}
    setup_logging(verbose)

gitea.cli.main.register_commands

register_commands() -> None

Register CLI commands.

Source code in src/gitea/cli/main.py

def register_commands() -> None:
    """Register CLI commands."""
    from gitea.cli.actions.main import actions_app  # noqa: PLC0415
    from gitea.cli.comment.main import comment_app  # noqa: PLC0415
    from gitea.cli.config.main import config_app  # noqa: PLC0415
    from gitea.cli.issue.main import issue_app  # noqa: PLC0415
    from gitea.cli.label.main import label_app  # noqa: PLC0415
    from gitea.cli.milestone.main import milestone_app  # noqa: PLC0415
    from gitea.cli.notification.main import notification_app  # noqa: PLC0415
    from gitea.cli.organization.main import organization_app  # noqa: PLC0415
    from gitea.cli.project.main import project_app  # noqa: PLC0415
    from gitea.cli.pull_request.main import pull_request_app  # noqa: PLC0415
    from gitea.cli.repository.main import repository_app  # noqa: PLC0415
    from gitea.cli.user.main import user_app  # noqa: PLC0415
    from gitea.cli.watch.main import watch_app  # noqa: PLC0415

    app.add_typer(config_app, name="config", help="Commands for managing configurations.")
    app.add_typer(actions_app, name="actions", help="Commands for Gitea Actions.")
    app.add_typer(issue_app, name="issue", help="Commands for managing issues.")
    app.add_typer(pull_request_app, name="pull-request", help="Commands for managing pull requests.")
    app.add_typer(user_app, name="user", help="Commands for managing users.")
    app.add_typer(comment_app, name="comment", help="Commands for managing comments.")
    app.add_typer(label_app, name="label", help="Commands for managing labels.")
    app.add_typer(milestone_app, name="milestone", help="Commands for managing milestones.")
    app.add_typer(notification_app, name="notification", help="Commands for managing notifications.")
    app.add_typer(project_app, name="project", help="Commands for managing projects.")
    app.add_typer(organization_app, name="org", help="Commands for managing organizations.")
    app.add_typer(repository_app, name="repo", help="Commands for managing repositories.")
    app.add_typer(watch_app, name="watch", help="Commands for watching issues for changes.")