The directory_format.py module

Summary

Functions

get_paths

Get the paths to the directories needed for the conversion.

Module detail

directory_format.get_paths(path: pathlib.Path, graph_path: pathlib.Path | None = None, link_path: pathlib.Path | None = None, term_path: pathlib.Path | None = None, xml_path: pathlib.Path | None = None) → Tuple[pathlib.Path, pathlib.Path, pathlib.Path, pathlib.Path]

Get the paths to the directories needed for the conversion.

Parameters:

path: Path

Path object of the directory with the predefined format.

graph_path: Path, optional

Path object of the directory containing the graphics. The default is None, in which case the XML predefined directory format is used.

link_path: Path, optional

Path object of the directory containing the links. The default is None, in which case the XML predefined directory format is used.

term_path: Path, optional

Path object of the directory containing the terms. The default is None, in which case the XML predefined directory format is used.

xml_path: Path, optional

Path object of the directory containing the XML files. The default is None, in which case the XML predefined directory format is used.

Returns:

Path

Path object of the directory containing the graphics.

Path

Path object of the directory containing the links.

Path

Path object of the directory containing the terms.

Path

Path object of the directory containing the XML files.