Function monitor

codecarbon/cli/main.py:322–412

Monitor your machine's carbon emissions.

(
    ctx: typer.Context,
    measure_power_secs: Annotated[
        int,
        typer.Option(help="Interval between two measures."),
    ] = 10,
    api_call_interval: Annotated[
        int,
        typer.Option(help="Number of measures between API calls."),
    ] = 30,
    api: Annotated[
        bool,
        typer.Option(help="Choose to call Code Carbon API or not"),
    ] = True,
    offline: Annotated[bool, typer.Option(help="Run in offline mode")] = False,
    country_iso_code: Annotated[
        str,
        typer.Option(help="3-letter country ISO code for offline mode"),
    ] = None,
    region: Annotated[
        str,
        typer.Option(help="Region/province for offline mode"),
    ] = None,
)

    context_settings={"allow_extra_args": True, "ignore_unknown_options": True},
)
def monitor(
    ctx: typer.Context,
    measure_power_secs: Annotated[
        int,
        typer.Option(help="Interval between two measures."),
    ] = 10,
    api_call_interval: Annotated[
        int,
        typer.Option(help="Number of measures between API calls."),
    ] = 30,
    api: Annotated[
        bool,
        typer.Option(help="Choose to call Code Carbon API or not"),
    ] = True,
    offline: Annotated[bool, typer.Option(help="Run in offline mode")] = False,
    country_iso_code: Annotated[
        str,
        typer.Option(help="3-letter country ISO code for offline mode"),
    ] = None,
    region: Annotated[
        str,
        typer.Option(help="Region/province for offline mode"),
    ] = None,
):
    """Monitor your machine's carbon emissions."""

    # Shared tracker args so monitor and run_and_monitor behave the same
    tracker_args = {
        "measure_power_secs": measure_power_secs,
        "api_call_interval": api_call_interval,
    }
    # Set up the tracker arguments based on mode (offline vs online) and validate required args for each mode
    if offline:
        if not country_iso_code:
            print(
                "ERROR: Country ISO code is required for offline mode. Add it to your configuration or provide it via the command line: `--country-iso-code FRA`",
                file=sys.stderr,
            )
            raise typer.Exit(1)

        tracker_args = {
            **tracker_args,
            "country_iso_code": country_iso_code,
            "region": region,
        }
    else:
        experiment_id = get_existing_exp_id()
        if api and experiment_id is None:
            print(
                "ERROR: No experiment id. Set CODECARBON_EXPERIMENT_ID, call 'codecarbon config' first, or run in offline mode with `--offline --country-iso-code FRA`.",
                file=sys.stderr,
            )
            raise typer.Exit(1)

        tracker_args = {**tracker_args, "save_to_api": api}

    # If extra args are provided (e.g. `codecarbon monitor -- my_script.py`), delegate to `run_and_monitor`
    if getattr(ctx, "args", None):