extract_filename_parts

namefiles.extract_filename_parts(potential_filename_parts: dict, file_naming_convention: Optional[dict] = None) → dict

Extracts filename parts from a dictionary based by a file naming convention.

Parameters

• potential_filename_parts – A dictionary which potentially contains filename parts to be applied by the defined file naming convention.

• file_naming_convention – The file naming convention jsonschema, which should be applied.

Returns

dict

Examples

>>> from namefiles import extract_filename_parts
>>> sample_parts = {"identifier": "A", "sub_id": "BRA", "not-a": "name-part"}
>>> extract_filename_parts(sample_parts)
{'identifier': 'A', 'sub_id': 'BRA'}