hpcflow.sdk.core.utils.JSONLikeDirSnapShot#

class hpcflow.sdk.core.utils.JSONLikeDirSnapShot(root_path=None, data=None, use_strings=False)#

Bases: DirectorySnapshot

Overridden DirectorySnapshot from watchdog to allow saving and loading from JSON.

Parameters:

• root_path (str) – Where to take the snapshot based at.

• data (dict[str, list]) – Serialised snapshot to reload from. See to_json_like().

• use_strings (bool)

Methods

inode	Returns an id for path.
isdir
mtime
path	Returns path for id.
size
stat_info	Returns a stat information object for the specified path from the snapshot.
take	Take the snapshot.
to_json_like	Export to a dict that is JSON-compatible and can be later reloaded.
walk

Attributes

paths	Set of file/directory paths in the snapshot.
root_path	Where to take the snapshot based at.

inode(path)#

Returns an id for path.

Parameters:

path (bytes | str)

Return type:

tuple[int, int]

isdir(path)#

Parameters:

path (bytes | str)

Return type:

bool

mtime(path)#

Parameters:

path (bytes | str)

Return type:

float

path(uid)#

Returns path for id. None if id is unknown to this snapshot.

Parameters:

uid (tuple[int, int])

Return type:

bytes | str | None

property paths: set[bytes | str]#

Set of file/directory paths in the snapshot.

root_path#

Where to take the snapshot based at.

size(path)#

Parameters:

path (bytes | str)

Return type:

int

stat_info(path)#

Returns a stat information object for the specified path from the snapshot.

Attached information is subject to change. Do not use unless you specify stat in constructor. Use inode(), mtime(), isdir() instead.

Parameters:

path (bytes | str) – The path for which stat information should be obtained from a snapshot.

Return type:

stat_result

take(*args, **kwargs)#

Take the snapshot.

Return type:

None

to_json_like(use_strings=False)#

Export to a dict that is JSON-compatible and can be later reloaded.

The last two integers in data for each path are the keys in self._inode_to_path.

Parameters:

use_strings (bool)

Return type:

dict[str, Any]

walk(root)#

Parameters:

root (str)

Return type:

Iterator[tuple[str, os.stat_result]]