is_a_filename_part

namefiles.is_a_filename_part(part_name: str, file_naming_convention: Optional[dict] = None) → dict

Returns if the part name is within the 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 is_a_filename_part
>>> is_a_filename_part("identifier")
True
>>> is_a_filename_part("not-a-name-part")
False