pysnap.config package

Configuration helpers for PySnap.

Submodules

pysnap.config.protosettings module

Persistent storage for prototype clone settings.

class pysnap.config.protosettings.ProtoSettingsStore(path=None)

Bases: object

Persist VM names that trigger extra clone settings.

Parameters:

path (Path | None)

DEFAULT_FILENAME = '.ptotosettings'

list_vm_names()

Return configured VM names without duplicates.

Returns:

Configured VM names in file order.

Raises:

PySnapError – If the file cannot be read.

Return type:

tuple[str, …]

contains(vm_name)

Return whether one VM name is configured.

Parameters:

vm_name (str) – VM name to check.

Returns:

True when the VM is configured.

Return type:

bool

add_vm_name(vm_name)

Add one VM name to the store.

Parameters:

vm_name (str) – VM name to persist.

Returns:

Updated VM names.

Raises:

PySnapError – If the file cannot be written.

Return type:

tuple[str, …]

remove_vm_names(vm_names)

Remove VM names from the store.

Parameters:

vm_names (list[str] | tuple[str, ...]) – VM names to remove.

Returns:

Remaining VM names.

Raises:

PySnapError – If the file cannot be written.

Return type:

tuple[str, …]