matflow.FileNameStem

class matflow.FileNameStem(file_name)

Bases: FileNameStem

The stem of a file name.

Methods

from_json_like	Make an instance of this class from JSON (or YAML) data.
to_dict	Serialize this object as a dictionary.
to_json_like	Serialize this object as an object structure that can be trivially converted to JSON.
value	Get the stem, possibly with directory specified.

Attributes

file_name

The file specification this is derived from.

Parameters:

file_name (FileNameSpec) –

file_name: FileNameSpec

The file specification this is derived from.

classmethod from_json_like(json_like, shared_data=None)

Make an instance of this class from JSON (or YAML) data.

Parameters:

• json_like (str | Mapping[str, JSONed] | Sequence[Mapping[str, JSONed]] | None) – The data to deserialise.

• shared_data (Mapping[str, ObjectList[JSONable]] | None) – Shared context data.

Return type:

The deserialised object.

to_dict()

Serialize this object as a dictionary.

Return type:

dict[str, Any]

to_json_like(dct=None, shared_data=None, exclude=(), path=None)

Serialize this object as an object structure that can be trivially converted to JSON. Note that YAML can also be produced from the result of this method; it just requires a different final serialization step.

Parameters:

• dct (dict[str, JSONable] | None) –

• shared_data (_JSONDeserState) –

• exclude (Container[str | None]) –

• path (list | None) –

Return type:

tuple[JSONDocument, _JSONDeserState]

value(directory='.')

Get the stem, possibly with directory specified.

Parameters:

directory (str | os.PathLike) –

Return type:

str