image-match/python/py/Lib/site-packages/wandb/integration/weave/interface.py

"""Internal APIs for integrating with weave.

The public functions here are intended to be called by weave and care should
be taken to maintain backward compatibility.
"""

from __future__ import annotations

import dataclasses

from wandb.sdk import wandb_setup


@dataclasses.dataclass(frozen=True)
class RunPath:
    entity: str
    """The entity to which the run is logging. Never empty."""

    project: str
    """The project to which the run is logging. Never empty."""

    run_id: str
    """The run's ID. Never empty."""


def active_run_path() -> RunPath | None:
    """Returns the path of an initialized, unfinished run.

    Returns None if all initialized runs are finished. If there is
    more than one active run, an arbitrary path is returned.
    The run may be finished by the time its path is returned.

    Thread-safe.
    """
    singleton = wandb_setup.singleton()

    if (
        (run := singleton.most_recent_active_run)
        and run.entity
        and run.project
        and run.id
    ):
        return RunPath(
            entity=run.entity,
            project=run.project,
            run_id=run.id,
        )

    return None