admin/scribe
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

added docstings and typings

Browse Source
This commit is contained in:
Schmieder, Jacob
2024-01-29 12:32:23 +00:00
parent 41be3fdee2
commit 6975986ed4
9 changed files with 410 additions and 136 deletions
Download Patch File Download Diff File Expand all files Collapse all files
scraibe/app/utils.py
+123 -41
View File
@@ -1,22 +1,51 @@
"""
utils.py
This module contains two classes, ConfigLoader and AppConfig, which are used to manage application-specific configuration settings.
The ConfigLoader class provides methods for loading a configuration file, applying overrides, and restoring default values for specified keys. It also includes methods for recursively updating nested keys and getting the default configuration.
The AppConfig class extends ConfigLoader and provides additional methods for setting global variables, launch options, and layout options from the configuration. It also includes methods for checking and setting file paths, and getting layout options.
Classes:
ConfigLoader: Manages application-specific configuration settings.
AppConfig: Extends ConfigLoader to provide additional methods for managing application-specific configuration settings.
"""
import os
import warnings
import yaml
from typing import Any, Dict, Optional
import scraibe.app.global_var as gv
CURRENT_PATH = os.path.dirname(os.path.realpath(__file__))
class ConfigLoader:
def __init__(self, config):
self.config = config
def restore_defaults_for_keys(self, *args):
"""
Restores specified keys to their default values, including nested keys.
"""A class that extends ConfigLoader to manage application-specific configuration settings.
This class provides methods for setting global variables, launch options, and layout options from the configuration.
Attributes:
config (Dict[str, Any]): The current configuration settings.
launch (Dict[str, Any]): The launch configuration settings.
model (Dict[str, Any]): The model configuration settings.
advanced (Dict[str, Any]): The advanced configuration settings.
queue (Dict[str, Any]): The queue configuration settings.
layout (Dict[str, Any]): The layout configuration settings.
"""
def __init__(self, config: Dict[str, Any]):
"""Initializes a new instance of the ConfigLoader class.
Args:
keys (list): A list of keys or paths to keys (for nested dictionaries) to restore to default values.
config (dict): The configuration dictionary.
"""
self.config = config
def restore_defaults_for_keys(self, *args: str):
"""Restores specified keys to their default values, including nested keys.
Args:
*args (str): A list of keys or paths to keys (for nested dictionaries) to restore to default values.
Each key or path should be a list of keys leading to the desired key.
"""
default_config = self.get_default_config()
@@ -27,16 +56,15 @@ class ConfigLoader:
@classmethod
def load_config(cls, yaml_path = None, **kwargs):
"""
Load the configuration file and apply overrides.
def load_config(cls, yaml_path: Optional[str] = None, **kwargs: Any) -> 'ConfigLoader':
"""Load the configuration file and apply overrides.
Args:
yaml_path (str): Path to the YAML file containing overrides.
yaml_path (str, optional): Path to the YAML file containing overrides.
**kwargs: Additional overrides as keyword arguments.
Returns:
Config: A Config object with the loaded configuration.
ConfigLoader: A ConfigLoader object with the loaded configuration.
"""
# Load the original configuration
@@ -54,8 +82,14 @@ class ConfigLoader:
return cls(config)
@staticmethod
def apply_overrides(orig_dict, override_dict, specific=None):
""" Recursively apply overrides to the configuration, only for specific keys. """
def apply_overrides(orig_dict: Dict[str, Any], override_dict: Dict[str, Any], specific: Optional[str] = None):
"""Recursively apply overrides to the configuration, only for specific keys.
Args:
orig_dict (Dict[str, Any]): The original dictionary.
override_dict (Dict[str, Any]): The override dictionary.
specific (str, optional): The specific key to override.
"""
for key, value in override_dict.items():
if isinstance(value, dict):
@@ -80,7 +114,16 @@ class ConfigLoader:
@staticmethod
def update_nested_key(d, key, value):
""" Recursively search and update the key in nested dictionary. """
"""Recursively search and update the key in nested dictionary.
Args:
d (Dict[str, Any]): The dictionary.
key (str): The key to update.
value (Any): The new value.
Returns:
bool: True if the key was found and updated, False otherwise.
"""
if key in d:
d[key] = value
@@ -92,16 +135,35 @@ class ConfigLoader:
@staticmethod
def get_default_config():
""" Return the default configuration. """
"""Return the default configuration.
Returns:
Dict[str, Any]: The default configuration.
"""
with open(gv.DEFAULT_APP_CONIFG_PATH , 'r') as file:
config = yaml.safe_load(file)
return config
class AppConfig(ConfigLoader):
def __init__(self, config):
"""A class that extends ConfigLoader to manage application-specific configuration settings.
This class provides methods for setting global variables, launch options, and layout options from the configuration.
Attributes:
config (dict): The current configuration settings.
launch (dict): The launch configuration settings.
model (dict): The model configuration settings.
advanced (dict): The advanced configuration settings.
queue (dict): The queue configuration settings.
layout (dict): The layout configuration settings.
"""
def __init__(self, config : Dict[str, Any]):
"""Initializes a new instance of the AppConfig class.
Args:
config (dict): The configuration dictionary.
"""
self.config = config
self.set_global_vars_from_config()
@@ -114,23 +176,28 @@ class AppConfig(ConfigLoader):
self.queue = self.config.get("queue")
self.layout = self.config.get("layout")
def set_global_vars_from_config(self):
"""
Sets the global variables from a configuration dictionary.
def set_global_vars_from_config(self) -> None:
"""Sets the global variables from a configuration dictionary.
Args:
config (dict): A dictionary containing the parameters for the model. Modify the default parameters in the config.yml file.
Returns:
None
"""
gv.MODEL_PARAMS = self.config.get('model')
gv.TIMEOUT = self.config.get("advanced").get('timeout')
def set_launch_options(self):
def set_launch_options(self) -> None:
"""Sets the launch options from a configuration dictionary.
Args:
None
Returns:
None
"""
launch_options = self.config.get("launch")
if launch_options.get('auth').pop('auth_enabled'):
@@ -139,13 +206,28 @@ class AppConfig(ConfigLoader):
else:
self.config['launch']['auth'] = None
def set_layout_options(self):
def set_layout_options(self) -> None:
"""Sets the layout options from a configuration dictionary.
Args:
None
Returns:
None
"""
self.config['layout']['header'] = self.check_and_set_path(self.config['layout'], 'header')
self.config['layout']['footer'] = self.check_and_set_path(self.config['layout'], 'footer')
self.config['layout']['logo'] = self.check_and_set_path(self.config['layout'], 'logo')
def get_layout(self):
def get_layout(self) -> Dict[str, str]:
"""Gets the layout options from a configuration dictionary.
Args:
None
Returns:
dict: A dictionary containing the header and footer layout options.
"""
if not os.path.exists(self.config['layout']['header']) and \
self.config['layout']['header'] == "scraibe/app/header.html":
@@ -189,10 +271,16 @@ class AppConfig(ConfigLoader):
'footer' : footer}
@staticmethod
def check_and_set_path(config_item, key):
"""
Check if the file exists at the given path. If not, try with CURRENT_PATH.
def check_and_set_path(config_item: dict, key: str) -> Optional[str]:
"""Check if the file exists at the given path. If not, try with CURRENT_PATH.
Raise FileNotFoundError if the file still doesn't exist.
Args:
config_item (dict): The configuration item.
key (str): The key to check in the configuration item.
Returns:
str: The path to the file if it exists, None otherwise.
"""
_current_path = os.path.dirname(os.path.realpath(__file__)) # Define your CURRENT_PATH
@@ -207,10 +295,4 @@ class AppConfig(ConfigLoader):
else:
config_item[key] = new_path
return config_item[key]
return config_item[key]