Source code for fractal.cli.cmd.time

"""Implements ``fractal node time`` sub-app commands."""

from __future__ import annotations

from typing import Optional

import typer

from fractal.cli.utils import command, resolve_target

__all__ = ['time_remaining']




def time_remaining(app: typer.Typer) -> typer.Typer:
    """Register the ``remaining`` command."""
    # node argument
    node_help = 'Target node branch (default: this node).'
    node = typer.Argument(None, help=node_help)
    # scope option
    scope_help = "Timeout scope: 'run', 'iter', or 'step' (default: soonest)."
    scope = typer.Option(None, '--scope', help=scope_help)
    # path option
    path_help = 'Worktree directory.'
    path = typer.Option('.', '--path', help=path_help)

    @command(app, 'remaining')
    def _remaining(
        node: Optional[str] = node,
        scope: Optional[str] = scope,
        path: str = path,
    ) -> None:
        """Print time left before the next timeout fires."""
        node = resolve_target(path, node)
        remaining = node.time.remaining(scope=scope)
        if remaining is None:
            # None countdown means no deadline is active for the queried
            # scope(s) -- all three by default, one under --scope
            if node.time.limit(scope) is None:
                typer.echo('no limit')
            else:
                typer.echo('not running')
            return
        typer.echo(f'{int(remaining)}s')

    return app