Merge remote-tracking branch 'origin/2.x/develop' into 3.0/replace_config_with_settings

pype/settings/__init__.py

@@ -1,11 +1,15 @@
 from .lib import (
-    system_settings,
-    project_settings,
-    environments
+    get_system_settings,
+    get_project_settings,
+    get_current_project_settings,
+    get_anatomy_data,
+    get_environments
 )
 
 __all__ = (
-    "system_settings",
-    "project_settings",
-    "environments"
+    "get_system_settings",
+    "get_project_settings",
+    "get_current_project_settings",
+    "get_anatomy_data",
+    "get_environments"
 )

pype/settings/lib.py

@@ -5,6 +5,9 @@ import copy
 
 log = logging.getLogger(__name__)
 
+# Py2 + Py3 json decode exception
+JSON_EXC = getattr(json.decoder, "JSONDecodeError", ValueError)
+
 # Metadata keys for work with studio and project overrides
 M_OVERRIDEN_KEY = "__overriden_keys__"
 # Metadata key for storing information about environments
@@ -69,7 +72,7 @@ def reset_default_settings():
     _DEFAULT_SETTINGS = None
 
 
-def default_settings():
+def get_default_settings():
     global _DEFAULT_SETTINGS
     if _DEFAULT_SETTINGS is None:
         _DEFAULT_SETTINGS = load_jsons_from_dir(DEFAULTS_DIR)
@@ -82,7 +85,7 @@ def load_json_file(fpath):
         with open(fpath, "r") as opened_file:
             return json.load(opened_file)
 
-    except json.decoder.JSONDecodeError:
+    except JSON_EXC:
         log.warning(
             "File has invalid json format \"{}\"".format(fpath),
             exc_info=True
@@ -236,27 +239,6 @@ def subkey_merge(_dict, value, keys):
     return _dict
 
 
-def studio_system_settings():
-    """Studio overrides of system settings."""
-    if os.path.exists(SYSTEM_SETTINGS_PATH):
-        return load_json_file(SYSTEM_SETTINGS_PATH)
-    return {}
-
-
-def studio_project_settings():
-    """Studio overrides of default project settings."""
-    if os.path.exists(PROJECT_SETTINGS_PATH):
-        return load_json_file(PROJECT_SETTINGS_PATH)
-    return {}
-
-
-def studio_project_anatomy():
-    """Studio overrides of default project anatomy data."""
-    if os.path.exists(PROJECT_ANATOMY_PATH):
-        return load_json_file(PROJECT_ANATOMY_PATH)
-    return {}
-
-
 def path_to_project_settings(project_name):
     if not project_name:
         return PROJECT_SETTINGS_PATH
@@ -305,9 +287,9 @@ def save_project_settings(project_name, overrides):
 
     Do not use to store whole project settings data with defaults but only it's
     overrides with metadata defining how overrides should be applied in load
-    function. For loading should be used functions `studio_project_settings`
-    for global project settings and `project_settings_overrides` for
-    project specific settings.
+    function. For loading should be used function
+    `get_studio_project_settings_overrides` for global project settings
+    and `get_project_settings_overrides` for project specific settings.
 
     Args:
         project_name(str, null): Project name for which overrides are
@@ -346,7 +328,28 @@ def save_project_anatomy(project_name, anatomy_data):
         json.dump(anatomy_data, file_stream, indent=4)
 
 
-def project_settings_overrides(project_name):
+def get_studio_system_settings_overrides():
+    """Studio overrides of system settings."""
+    if os.path.exists(SYSTEM_SETTINGS_PATH):
+        return load_json_file(SYSTEM_SETTINGS_PATH)
+    return {}
+
+
+def get_studio_project_settings_overrides():
+    """Studio overrides of default project settings."""
+    if os.path.exists(PROJECT_SETTINGS_PATH):
+        return load_json_file(PROJECT_SETTINGS_PATH)
+    return {}
+
+
+def get_studio_project_anatomy_overrides():
+    """Studio overrides of default project anatomy data."""
+    if os.path.exists(PROJECT_ANATOMY_PATH):
+        return load_json_file(PROJECT_ANATOMY_PATH)
+    return {}
+
+
+def get_project_settings_overrides(project_name):
     """Studio overrides of project settings for specific project.
 
     Args:
@@ -355,8 +358,6 @@ def project_settings_overrides(project_name):
     Returns:
         dict: Only overrides for entered project, may be empty dictionary.
     """
-    if not project_name:
-        return {}
 
     path_to_json = path_to_project_settings(project_name)
     if not os.path.exists(path_to_json):
@@ -364,7 +365,7 @@ def project_settings_overrides(project_name):
     return load_json_file(path_to_json)
 
 
-def project_anatomy_overrides(project_name):
+def get_project_anatomy_overrides(project_name):
     """Studio overrides of project anatomy for specific project.
 
     Args:
@@ -412,26 +413,74 @@ def apply_overrides(source_data, override_data):
     return merge_overrides(_source_data, override_data)
 
 
-def system_settings():
+def get_system_settings():
     """System settings with applied studio overrides."""
-    default_values = default_settings()[SYSTEM_SETTINGS_KEY]
-    studio_values = studio_system_settings()
+    default_values = get_default_settings()[SYSTEM_SETTINGS_KEY]
+    studio_values = get_studio_system_settings_overrides()
     return apply_overrides(default_values, studio_values)
 
 
-def project_settings(project_name):
-    """Project settings with applied studio and project overrides."""
-    default_values = default_settings()[PROJECT_SETTINGS_KEY]
-    studio_values = studio_project_settings()
+def get_default_project_settings():
+    """Project settings with applied studio's default project overrides."""
+    default_values = get_default_settings()[PROJECT_SETTINGS_KEY]
+    studio_values = get_studio_project_settings_overrides()
 
-    studio_overrides = apply_overrides(default_values, studio_values)
+    return apply_overrides(default_values, studio_values)
 
-    project_overrides = project_settings_overrides(project_name)
+
+def get_default_project_anatomy_data():
+    """Project anatomy data with applied studio's default project overrides."""
+    default_values = get_default_settings()[PROJECT_ANATOMY_KEY]
+    studio_values = get_studio_project_anatomy_overrides()
+
+    return apply_overrides(default_values, studio_values)
+
+
+def get_anatomy_data(project_name):
+    """Project anatomy data with applied studio and project overrides."""
+    if not project_name:
+        raise ValueError(
+            "Must enter project name."
+            " Call `get_default_project_anatomy_data` to get project defaults."
+        )
+
+    studio_overrides = get_default_project_anatomy_data()
+    project_overrides = get_project_anatomy_overrides(project_name)
 
     return apply_overrides(studio_overrides, project_overrides)
 
 
-def environments():
+def get_project_settings(project_name):
+    """Project settings with applied studio and project overrides."""
+    if not project_name:
+        raise ValueError(
+            "Must enter project name."
+            " Call `get_default_project_settings` to get project defaults."
+        )
+
+    studio_overrides = get_default_project_settings()
+    project_overrides = get_project_settings_overrides(project_name)
+
+    return apply_overrides(studio_overrides, project_overrides)
+
+
+def get_current_project_settings():
+    """Project settings for current context project.
+
+    Project name should be stored in environment variable `AVALON_PROJECT`.
+    This function should be used only in host context where environment
+    variable must be set and should not happen that any part of process will
+    change the value of the enviornment variable.
+    """
+    project_name = os.environ.get("AVALON_PROJECT")
+    if not project_name:
+        raise ValueError(
+            "Missing context project in environemt variable `AVALON_PROJECT`."
+        )
+    return get_project_settings(project_name)
+
+
+def get_environments():
     """Calculated environment based on defaults and system settings.
 
     Any default environment also found in the system settings will be fully
@@ -440,11 +489,5 @@ def environments():
     Returns:
         dict: Output should be ready for `acre` module.
     """
-    # TODO remove these defaults (All should be set with system settings)
-    envs = copy.deepcopy(default_settings()[ENVIRONMENTS_KEY])
-    # This is part of loading environments from settings
-    envs_from_system_settings = find_environments(system_settings())
 
-    for env_group_key, values in envs_from_system_settings.items():
-        envs[env_group_key] = values
-    return envs
+    return find_environments(get_system_settings())