Apt

class rmote.tools.apt.State(*values)

Bases: IntEnum

ABSENT = 1

LATEST = 2

PRESENT = 0

class rmote.tools.apt.Package(name, state=State.PRESENT, version='')

Bases: object

classmethod from_string(s, state=State.PRESENT)

Return type:

Package

name: str

classmethod parse(s, state=State.PRESENT)

Return type:

Package

state: int = 0

version: str = ''

class rmote.tools.apt.Result(name, changed, version='')

Bases: object

changed: bool

classmethod from_package(package, changed)

Return type:

Result

name: str

version: str = ''

class rmote.tools.apt.Apt

Bases: Tool

Manage Debian/Ubuntu packages via apt-get. Requires root on the remote host.

classmethod converge(*packages)

Ensure all packages are present, reading dpkg status once for efficiency.

Parameters:

*packages (Text | Package) – Package names, name=version strings, or Package instances.

Return type:

list[Result]

Returns:

List of Result objects, one per package, in the same order as the input.

classmethod package(package, state=State.PRESENT)

Install, remove, or upgrade a single package.

Parameters:

• package (Text | Package) – Package name, name=version string, or a Package instance.

• state (State | int) – Desired state - State.PRESENT (install if absent), State.ABSENT (purge if installed), or State.LATEST (install or upgrade to candidate version).

Return type:

Result

Returns:

Result with the package name, installed version, and whether the system was changed.

Raises:

RuntimeError – If the underlying apt-get invocation fails.

static update(ttl=-1)

Run apt-get update, with optional TTL-based skipping.

Parameters:

ttl (int | float) – Minimum age in seconds of the last successful update before re-running. -1 (default) always runs the update.

Return type:

bool

Returns:

True if apt-get update was executed, False if the cache is fresher than ttl seconds.

Raises:

RuntimeError – If apt-get update exits with a non-zero status.