esrf_pathlib._schemas.fields.path#

Classes

PathTemplate(name, schema_identifier, ...)

Class for matching, parsing, and rendering paths from segment templates.

class esrf_pathlib._schemas.fields.path.PathTemplate(name, schema_identifier, segments, concepts)[source]#

Class for matching, parsing, and rendering paths from segment templates.

Parameters:

contains_optionals(concept_values)[source]#

Parameters:: concept_values (Dict[str, Union[str, date, DataType, TomoResultType, None]])
Return type:: bool

parse(path)[source]#

Match and convert a path to a dictionary of path concept values.

Raises:: PathTemplateMatchError –
Parameters:: path (str)
Return type:: Dict[str, Union[str, date, DataType, TomoResultType, None]]

parse_with_score(path)[source]#

Returns an empty tuple if it does not match. If it does match it returns the concept values and the match score.

Parameters:: path (str)
Return type:: Tuple[Optional[Dict[str, Union[str, date, DataType, TomoResultType, None]]], Tuple[int, ...]]

remove_optionals(concept_values)[source]#

Parameters:: concept_values (Dict[str, Union[str, date, DataType, TomoResultType, None]])
Return type:: Dict[str, Union[str, date, DataType, TomoResultType, None]]

render(concept_values, raise_on_missing=True, raise_on_mismatch=True)[source]#

Convert a dictionary of path concept values to a path.

Raises:

PathConceptValueError –

Parameters:

concept_values (Dict[str, Union[str, date, DataType, TomoResultType, None]])
raise_on_missing (bool)
raise_on_mismatch (bool)

Return type:

str

render_score(concept_values)[source]#

Returns an empty tuple if it does not match. If it does match it returns the match score.

Parameters:: concept_values (Dict[str, Union[str, date, DataType, TomoResultType, None]])
Return type:: Tuple[int, ...]

strip_mount_point(concept_values)[source]#

Strip all segments from the root concept before a specific marker segment.

Parameters:: concept_values (Dict[str, Union[str, date, DataType, TomoResultType, None]])
Return type:: Dict[str, Union[str, date, DataType, TomoResultType, None]]