-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: fix main user package home setting for export
- Loading branch information
Showing
3 changed files
with
95 additions
and
160 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,137 +1,47 @@ | ||
| """ this module prepares the local file paths for data and results""" | ||
|
|
||
| from typing import Dict | ||
| import logging | ||
|
|
||
| from pathlib import Path | ||
|
|
||
| import raman_fitting | ||
| from raman_fitting.config.settings import Settings | ||
| from loguru import logger | ||
|
|
||
| logger = logging.getLogger(__name__) | ||
|
|
||
| def check_and_make_dirs(destdir: Path) -> None: | ||
| _destfile = None | ||
| if destdir.suffix: | ||
| _destfile = destdir | ||
| destdir = _destfile.parent | ||
|
|
||
| def get_directory_paths_for_run_mode(run_mode: str = "", **kwargs) -> Dict: | ||
| """ | ||
| Parameters | ||
| ---------- | ||
| run_mode : str, optional | ||
| this is name of the run mode. The default is ''. | ||
| **kwargs : TYPE | ||
| kwargs can contain keys such as DATASET_DIR to overwrite the standard config paths. | ||
| Returns | ||
| ------- | ||
| dest_dirs : dict | ||
| dict containing 3 keys [RESULTS_DIR, DATASET_DIR, INDEX_FILE] | ||
| """ | ||
| run_mode_config = run_mode.lower() | ||
| config_aliases = {"make_index": "normal"} | ||
| if run_mode_config in config_aliases.keys(): | ||
| run_mode_config = config_aliases[run_mode_config] | ||
|
|
||
| dest_dirs = Settings.get_run_mode_paths(run_mode_config) | ||
| if kwargs: | ||
| dest_dirs = override_from_kwargs(dest_dirs, **kwargs) | ||
|
|
||
| check_and_make_dirs(dest_dirs["DATASET_DIR"], dest_dirs["RESULTS_DIR"]) | ||
|
|
||
| return dest_dirs | ||
|
|
||
|
|
||
| def check_and_make_dirs(dataset_dir: Path, results_dir: Path) -> None: | ||
| create_dataset_dir(dataset_dir) | ||
|
|
||
| if not results_dir.is_dir(): | ||
| results_dir.mkdir(exist_ok=True, parents=True) | ||
| if not destdir.is_dir(): | ||
| destdir.mkdir(exist_ok=True, parents=True) | ||
| logger.info( | ||
| f"check_and_make_dirs the results directory did not exist and was created at:\n{results_dir}\n" | ||
| f"check_and_make_dirs the results directory did not exist and was created at:\n{destdir}\n" | ||
| ) | ||
|
|
||
| if _destfile: | ||
| _destfile.touch() | ||
|
|
||
| def override_from_kwargs(_dict, **kwargs): | ||
| _kwargs = kwargs | ||
| if _kwargs: | ||
| _keys = [i for i in _dict.keys() if i in _kwargs.keys()] | ||
| _new_dict = { | ||
| k: Path(val) if not _kwargs.get(k, None) else _kwargs[k] | ||
| for k, val in _dict.items() | ||
| } | ||
| if _new_dict != _dict: | ||
| logger.debug(f"override_from_kwargs keys {_keys} were overwritten") | ||
| return _new_dict | ||
| else: | ||
| return _dict | ||
|
|
||
|
|
||
| def create_dataset_dir(DATASET_DIR): # pragma: no cover | ||
| if not DATASET_DIR.is_dir(): | ||
| logger.warning( | ||
| f"The datafiles directory does not exist yet, the program will now try to create this folder.\n{DATASET_DIR}" | ||
| # therefore {settings.__package_name__} can not find any files. | ||
| # The program will now try to create this folder. | ||
| ) | ||
| try: | ||
| DATASET_DIR.mkdir() | ||
| logger.warning( | ||
| f"""The datafiles directory has now been created at: | ||
| {DATASET_DIR} | ||
| please place your raman datafiles in this folder and run {raman_fitting.__package_name__} again. | ||
| {raman_fitting.__package_name__} exits now. | ||
| """ | ||
| def create_dir_or_ask_user_input(destdir: Path, ask_user=True): | ||
| counter, max_attempts = 0, 10 | ||
| while not destdir.exists() and counter < max_attempts: | ||
| answer = "y" | ||
| if ask_user: | ||
| answer = input( | ||
| f"Directory to store files raman_fitting:\n{destdir}\nCan this be folder be created? (y/n)" | ||
| ) | ||
| except Exception as exc: | ||
| logger.warning( | ||
| f"""The datafiles directory could not be created at: | ||
| {DATASET_DIR} | ||
| An unexpected error ocurred: | ||
| {exc} | ||
| please redefine the path for dataset_dir in the config settings. | ||
| """ | ||
| ) | ||
| else: | ||
| # Check if dir is not empty else raise a warning | ||
| _diter = DATASET_DIR.iterdir() | ||
| try: | ||
| next(_diter) | ||
| except StopIteration: | ||
| logger.warning( | ||
| f"""The datafiles directory is empty: | ||
| {DATASET_DIR} | ||
| please place your files in here or | ||
| change this path in the config settings. | ||
| """ | ||
| ) | ||
|
|
||
|
|
||
| def create_package_home_dir(package_home: Path): | ||
| if package_home.is_dir(): | ||
| logger.info( | ||
| f"Package home directory exists at:\n{package_home}\n--------------------" | ||
| ) | ||
| return | ||
| package_home_choice = input( | ||
| f"""Package home directory did not exist, will now be created at:) | ||
| {package_home} | ||
| -------------------- | ||
| Choose yes(y) to continue or no(n) to select your directory.""" | ||
| ) | ||
| if package_home_choice.startswith("n"): | ||
| from tkinter import Tk, filedialog | ||
|
|
||
| root = Tk() | ||
| root.withdraw() | ||
| root.attributes("-topmost", True) | ||
| package_home = Path(filedialog.askdirectory()) | ||
|
|
||
| try: | ||
| logger.warning( | ||
| f"Package home directory did not exist, will now be created at:\n{package_home}\n--------------------" | ||
| ) | ||
| package_home.mkdir() | ||
| except Exception as exc: | ||
| logger.warning( | ||
| f"Package home mkdir unexpected error\n{exc}.\nFolder{package_home} could not be created, exiting." | ||
| ) | ||
| exit() | ||
| if "y" not in answer.lower(): | ||
| new_path_user = input( | ||
| "Please provide the directory to store files raman_fitting:" | ||
| ) | ||
| try: | ||
| new_path = Path(new_path_user).resolve() | ||
| except Exception as e: | ||
| print(f"Exception: {e}") | ||
| counter += 1 | ||
| destdir = new_path | ||
|
|
||
| destdir.mkdir(exist_ok=True, parents=True) | ||
| logger.info(f"Directory created: {destdir}") | ||
| return destdir |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters