disassemble_filename

namefiles.disassemble_filename(target_path: Union[pathlib.Path, str], filename_validator: Optional[namefiles.JsonschemaValidator] = None) dict

Disassembles a file’s name into the parts defined by a file naming convention.

Parameters
  • target_path – The file which name should be disassembled.

  • filename_validator – The validator to validate the filename parts with its file naming convention.

Returns

dict

Examples

>>> from namefiles import disassemble_filename
>>> from doctestprinter import doctest_print
>>> disassemled_filename = disassemble_filename(
...     "zoo/cage/Zebra#A#Afrika#_ffffff_000000.animal.stock"
... )
>>> doctest_print(disassemled_filename, max_line_width=70)
{'identifier': 'zoo', 'extension': '.stock', 'source_id': 'Afrika', 'sub_id':
'A', 'context': 'animal', 'vargroup': ['ffffff', '000000']}