:py:mod:`aces.operations.directory` =================================== .. py:module:: aces.operations.directory .. autoapi-nested-parse:: Holds bespoke operations related to directories Module Contents --------------- Functions ~~~~~~~~~ .. autoapisummary:: aces.operations.directory.setup_chdir_workdir aces.operations.directory.check_create_dir Attributes ~~~~~~~~~~ .. autoapisummary:: aces.operations.directory.logger .. py:data:: logger .. py:function:: setup_chdir_workdir(workdir: Optional[Union[pathlib.Path, str]] = None) -> pathlib.Path Perform checks on the target working directory. If it does not exist it will be created, and execution will be switched to take placce in the target Args: workdir (Optional[Union[Path,str]], optional): Location where work will be carried out. If None the current working directory is used. Defaults to None. Returns: Path: The resolved working directory .. py:function:: check_create_dir(target_dir: pathlib.Path) -> pathlib.Path Check and if necessary create a directory Args: target_dir (Path): Path to ensure if it is a directory, and create it if it does not exist Returns: Path: Path to directory