"""Contains methods which return common paths."""
import configparser
import time
from configparser import ConfigParser
from pathlib import Path
from typing import Optional
[docs]def get_bout_runners_package_path() -> Path:
"""
Return the absolute path to the bout_runners package.
Returns
-------
Path
The path to the root directory
"""
return Path(__file__).absolute().parents[1]
[docs]def get_config_path() -> Path:
"""
Return the absolute path to the configurations.
Returns
-------
Path
The path to the configuration directory
"""
return get_bout_runners_package_path().joinpath("config")
[docs]def get_logger_config_path() -> Path:
"""
Return the absolute path to the logger configuration.
Returns
-------
Path
The path to the logger configuration file
"""
return get_config_path().joinpath("logging_config.yaml")
[docs]def get_bout_runners_config_path() -> Path:
"""
Return the absolute path to the bout_runners configuration.
Returns
-------
Path
The path to the bout_runners configuration file
"""
return get_config_path().joinpath("bout_runners.ini")
[docs]def get_bout_log_config_path() -> Path:
"""
Return the absolute path to the log configuration.
Returns
-------
Path
The path to the bout_runners configuration file
"""
return get_config_path().joinpath("logging_config.yaml")
[docs]def get_bout_runners_configuration() -> ConfigParser:
"""
Return the bout_runners configuration.
Returns
-------
config : ConfigParser
The configuration of bout_runners
"""
config = configparser.ConfigParser()
config.read(get_bout_runners_config_path())
return config
[docs]def get_log_file_directory() -> Path:
"""
Return the log_file directory.
Returns
-------
log_file_directory : Path
Path to the log_file directory
"""
config = get_bout_runners_configuration()
path_str = config["log"]["directory"]
if path_str == "None":
log_file_dir = get_bout_runners_package_path().joinpath("logs")
else:
log_file_dir = Path(path_str)
log_file_dir.mkdir(exist_ok=True, parents=True)
return log_file_dir
[docs]def get_log_file_path(
log_file_dir: Optional[Path] = None, name: Optional[str] = None
) -> Path:
"""
Return the absolute path to the log file path.
Parameters
----------
log_file_dir : Path or None
Path to the log file directory
If None, default log file directory will be used
name : str or None
Name of the log file
If None, current date will be used
Returns
-------
log_file_path : Path
The path to the log file
"""
if log_file_dir is None:
log_file_dir = get_log_file_directory()
if name is None:
name = time.strftime("%Y%m%d.log")
log_file_path = log_file_dir.joinpath(name)
return log_file_path
[docs]def get_bout_directory() -> Path:
"""
Load the BOUT++ directory from the configuration file.
Returns
-------
bout_path : Path
Path to the BOUT++ repository
"""
config = get_bout_runners_configuration()
path_str = config["bout++"]["directory"]
if "$HOME/" or "${HOME}/" in path_str.lower():
path_str = "/".join(path_str.split("/")[1:])
path_str = f"{Path.home()}/{path_str}"
bout_path = Path(path_str).absolute()
return bout_path