Class ExecutableSpec

deeplabcut/core/debug/debug_logger.py:396–414

Small description of an external executable to report. Parameters ---------- key: Label used in the output report. command: Executable name or absolute path to resolve. version_args: Arguments used to query the executable version.

@dataclass(frozen=True)
class ExecutableSpec:
    """Small description of an external executable to report.

    Parameters
    ----------
    key:
        Label used in the output report.
    command:
        Executable name or absolute path to resolve.
    version_args:
        Arguments used to query the executable version.
    """

    key: str
    command: str | None = None
    version_args: tuple[str, ...] = ("-version",)

    def resolved_command(self) -> str:
        return self.command or self.key


DEFAULT_EXECUTABLE_SPECS: tuple[ExecutableSpec, ...] = (ExecutableSpec("ffmpeg"),)