shamo.core.problems.single.components.file_path.CompFilePath

class shamo.core.problems.single.components.file_path.CompFilePath(**kwargs)

Bases: shamo.core.problems.single.components.abc.CompABC

Store information about a path.

Other Parameters

pathpathlib.Path

The path to the file.

Methods

check	Check if the path is properly set.
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
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.
set	Set the path.
setdefault	Insert key with a value of default if key is not in the dictionary.
to_pro_param	Return None.
to_py_param	Return the path.
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

path	Return the path.
use_path	Return True if a path is set.

check(name, **kwargs)

Check if the path is properly set.

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

keys() → a set-like object providing a view on D’s keys

property path

Return the path.

Returns

pathlib.Path

The path.

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.

set(path)

Set the path.

Parameters

pathstr, byte or os.PathLike

The path.

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.

to_pro_param(**kwargs)

Return None.

to_py_param(**kwargs)

Return the path.

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]

property use_path

Return True if a path is set.

Returns

bool

True if a path is set, False otherwise.

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