Skip to content

muxtools.utils.binaries.types

__all__ module-attribute

__all__ = ['Spec', 'SyncResult', 'RemovalPlan', 'RemovalFailure', 'RemovalResult']

Spec dataclass

Spec(name: str, operator: str | None = None, version: str | None = None)
Source code in muxtools/utils/binaries/types.py
@dataclass(frozen=True)
class Spec:
    name: str
    operator: str | None = None
    version: str | None = None

    def __str__(self) -> str:
        return self.name + (self.operator + self.version if self.operator and self.version else "")

name instance-attribute

name: str

operator class-attribute instance-attribute

operator: str | None = None

version class-attribute instance-attribute

version: str | None = None

__str__

__str__() -> str
Source code in muxtools/utils/binaries/types.py
def __str__(self) -> str:
    return self.name + (self.operator + self.version if self.operator and self.version else "")

SyncResult dataclass

SyncResult(name: str, state: Literal['system', 'existing', 'installed'], version: str | None = None, version_unchecked: bool = False)
Source code in muxtools/utils/binaries/types.py
@dataclass(frozen=True)
class SyncResult:
    name: str
    state: Literal["system", "existing", "installed"]
    version: str | None = None
    version_unchecked: bool = False

name instance-attribute

name: str

state instance-attribute

state: Literal['system', 'existing', 'installed']

version class-attribute instance-attribute

version: str | None = None

version_unchecked class-attribute instance-attribute

version_unchecked: bool = False

RemovalPlan dataclass

RemovalPlan(root: Path, items: tuple[dict[str, Any], ...], declarations: tuple[str, ...], config: ProjectConfig | None)
Source code in muxtools/utils/binaries/types.py
@dataclass(frozen=True)
class RemovalPlan:
    root: Path
    items: tuple[dict[str, Any], ...]
    declarations: tuple[str, ...]
    config: ProjectConfig | None

root instance-attribute

root: Path

items instance-attribute

items: tuple[dict[str, Any], ...]

declarations instance-attribute

declarations: tuple[str, ...]

config instance-attribute

config: ProjectConfig | None

RemovalFailure dataclass

RemovalFailure(item: dict[str, Any], error: OSError | ValueError)
Source code in muxtools/utils/binaries/types.py
@dataclass(frozen=True)
class RemovalFailure:
    item: dict[str, Any]
    error: OSError | ValueError

item instance-attribute

item: dict[str, Any]

error instance-attribute

error: OSError | ValueError

RemovalResult dataclass

RemovalResult(removed: tuple[dict[str, Any], ...], failed: tuple[RemovalFailure, ...], declarations: tuple[str, ...])
Source code in muxtools/utils/binaries/types.py
@dataclass(frozen=True)
class RemovalResult:
    removed: tuple[dict[str, Any], ...]
    failed: tuple[RemovalFailure, ...]
    declarations: tuple[str, ...]

removed instance-attribute

removed: tuple[dict[str, Any], ...]

failed instance-attribute

failed: tuple[RemovalFailure, ...]

declarations instance-attribute

declarations: tuple[str, ...]