shamo.core.objects.abc.ObjABC

class shamo.core.objects.abc.ObjABC(name, parent_path)[source]

Bases: dict, abc.ABC

A base class for any savable/loadable object.

All the main object can be saved to/loaded from human readable JSON files to make it easily compatible with BIDS standars and simplify interactions with other scripts.

Parameters
namestr

The name of the object.

parent_pathstr, byte or os.PathLike

The path to the parent directory of the object.

Raises
TypeError

If argument name is not a str. If argument parent_path is not a str, byte or os.PathLike.

Methods

clear

copy

fromkeys

Create a new dictionary with keys from iterable and values set to value.

get

Return the value for key if key is in the dictionary, else default.

items

keys

load

Load an object from a JSON file.

pop

If key is not found, d is returned if given, otherwise KeyError is raised

popitem

Remove and return a (key, value) pair as a 2-tuple.

save

Save the object to a JSON file.

setdefault

Insert key with a value of default if key is not in the dictionary.

update

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values

Attributes

json_path

Return the path to the object JSON file.

name

Return the name of the object.

parent_path

Return the path to the parent directory of the object.

path

Return the path to the object.

clear() → None. Remove all items from D.
copy() → a shallow copy of D
fromkeys(iterable, value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D’s items
abstract property json_path

Return the path to the object JSON file.

Returns
pathlib.Path

The path to the object JSON file.

keys() → a set-like object providing a view on D’s keys
classmethod load(json_path)[source]

Load an object from a JSON file.

Parameters
json_pathstr, byte or os.PathLike

The path to the JSON file containing the object data.

Raises
TypeError

If argument json_path is not a str, byte or os.PathLike.

property name

Return the name of the object.

Returns
str

The name of the object.

property parent_path

Return the path to the parent directory of the object.

Returns
pathlib.Path

The path to the parent directory of the object.

abstract property path

Return the path to the object.

Returns
pathlib.Path

The path to the object.

pop(k[, d]) → v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised

popitem(/)

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

save(exist_ok=True)[source]

Save the object to a JSON file.

Parameters
exist_okbool, optional

If set to True, any already existing object is overriden. Otherwise, if the object already exists, a FileExistsError. The default is True.

Raises
FileExistsError

If exist_ok is set to False and the object already exists.

TypeError

If any of the keys/values to be stored is not a str, int, float, bool or None.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None. Update D from dict/iterable E and F.

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D’s values