fmu-settings 0.5.0__tar.gz → 0.5.2__tar.gz

{fmu_settings-0.5.0 → fmu_settings-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fmu-settings
-Version: 0.5.0
+Version: 0.5.2
 Summary: A library for managing FMU settings
 Author-email: Equinor <fg-fmu_atlas@equinor.com>
 License: GPL-3.0

{fmu_settings-0.5.0 → fmu_settings-0.5.2}/src/fmu/settings/_global_config.py

@@ -145,16 +145,18 @@ def load_global_configuration_if_present(
         fmu_load: Whether or not to load in the custom 'fmu' format. Default False.
 
     Returns:
-        GlobalConfiguration instance or None.
+        GlobalConfiguration instance or None if file cannot be loaded.
+
+    Raises:
+        ValidationError: If the file is loaded but has invalid schema.
     """
     loader = "fmu" if fmu_load else "standard"
     try:
         global_variables_dict = yaml_load(path, loader=loader)
         global_config = GlobalConfiguration.model_validate(global_variables_dict)
         logger.debug(f"Global variables at {path} has valid settings data")
-    except ValidationError as e:
-        logger.debug(f"Global variables at {path} failed validation: {e}")
-        return None
+    except ValidationError:
+        raise
     except Exception as e:
         logger.debug(
             f"Failed to load global variables at {path}: {type(e).__name__}: {e}"
@@ -173,6 +175,9 @@ def _find_global_variables_file(paths: list[Path]) -> GlobalConfiguration | None
 
     Returns:
         A validated GlobalConfiguration or None.
+
+    Raises:
+        ValidationError: If a file is found but has invalid schema.
     """
     for path in paths:
         if not path.exists():
@@ -204,6 +209,9 @@ def _find_global_config_file(paths: list[Path]) -> GlobalConfiguration | None:
 
     Returns:
         A validated GlobalConfiguration or None.
+
+    Raises:
+        ValidationError: If a file is found but has invalid schema.
     """
     for path in paths:
         if not path.exists():
@@ -241,6 +249,11 @@ def find_global_config(
 
     Returns:
         A valid GlobalConfiguration instance, or None.
+
+    Raises:
+        ValidationError: If a configuration file is found but has invalid schema.
+        InvalidGlobalConfigurationError: If strict=True and configuration contains
+            disallowed content (e.g., Drogon data).
     """
     base_path = Path(base_path)
 

{fmu_settings-0.5.0 → fmu_settings-0.5.2}/src/fmu/settings/_resources/lock_manager.py

@@ -194,6 +194,8 @@ class LockManager(PydanticResourceManager[LockInfo]):
             LockError: If we don't hold the lock or it's invalid
         """
         if not self.exists:
+            if self.is_acquired():
+                self.release()
             raise LockError("Cannot refresh: lock file does not exist")
 
         lock_info = self._safe_load()

{fmu_settings-0.5.0 → fmu_settings-0.5.2}/src/fmu/settings/_resources/pydantic_resource_manager.py

@@ -112,21 +112,21 @@ class PydanticResourceManager(Generic[PydanticResource]):
 
 
 class MutablePydanticResourceManager(PydanticResourceManager[MutablePydanticResource]):
-    """Manages the .fmu configuration file."""
+    """Manages the .fmu resource file."""
 
     def __init__(
-        self: Self, fmu_dir: FMUDirectoryBase, config: type[MutablePydanticResource]
+        self: Self, fmu_dir: FMUDirectoryBase, resource: type[MutablePydanticResource]
     ) -> None:
-        """Initializes the Config resource manager."""
-        super().__init__(fmu_dir, config)
+        """Initializes the resource manager."""
+        super().__init__(fmu_dir, resource)
 
     def _get_dot_notation_key(
-        self: Self, config_dict: dict[str, Any], key: str, default: Any = None
+        self: Self, resource_dict: dict[str, Any], key: str, default: Any = None
     ) -> Any:
         """Sets the value to a dot-notation key.
 
         Args:
-            config_dict: The configuration dictionary we are modifying (by reference)
+            resource_dict: The resource dictionary we are modifying (by reference)
             key: The key to set
             default: Value to return if key is not found. Default None
 
@@ -134,7 +134,7 @@ class MutablePydanticResourceManager(PydanticResourceManager[MutablePydanticReso
             The value or default
         """
         parts = key.split(".")
-        value = config_dict
+        value = resource_dict
         for part in parts:
             if isinstance(value, dict) and part in value:
                 value = value[part]
@@ -144,28 +144,28 @@ class MutablePydanticResourceManager(PydanticResourceManager[MutablePydanticReso
         return value
 
     def get(self: Self, key: str, default: Any = None) -> Any:
-        """Gets a configuration value by key.
+        """Gets a resource value by key.
 
         Supports dot notation for nested values (e.g., "foo.bar")
 
         Args:
-            key: The configuration key
+            key: The resource key
             default: Value to return if key is not found. Default None
 
         Returns:
-            The configuration value or default
+            The resource value or default
         """
         try:
-            config = self.load()
+            resource = self.load()
 
             if "." in key:
-                return self._get_dot_notation_key(config.model_dump(), key, default)
+                return self._get_dot_notation_key(resource.model_dump(), key, default)
 
-            if hasattr(config, key):
-                return getattr(config, key)
+            if hasattr(resource, key):
+                return getattr(resource, key)
 
-            config_dict = config.model_dump()
-            return config_dict.get(key, default)
+            resource_dict = resource.model_dump()
+            return resource_dict.get(key, default)
         except FileNotFoundError as e:
             raise FileNotFoundError(
                 f"Resource file for '{self.__class__.__name__}' not found "
@@ -173,17 +173,17 @@ class MutablePydanticResourceManager(PydanticResourceManager[MutablePydanticReso
             ) from e
 
     def _set_dot_notation_key(
-        self: Self, config_dict: dict[str, Any], key: str, value: Any
+        self: Self, resource_dict: dict[str, Any], key: str, value: Any
     ) -> None:
         """Sets the value to a dot-notation key.
 
         Args:
-            config_dict: The configuration dictionary we are modifying (by reference)
+            resource_dict: The resource dictionary we are modifying (by reference)
             key: The key to set
             value: The value to set
         """
         parts = key.split(".")
-        target = config_dict
+        target = resource_dict
 
         for part in parts[:-1]:
             if part not in target or not isinstance(target[part], dict):
@@ -193,27 +193,27 @@ class MutablePydanticResourceManager(PydanticResourceManager[MutablePydanticReso
         target[parts[-1]] = value
 
     def set(self: Self, key: str, value: Any) -> None:
-        """Sets a configuration value by key.
+        """Sets a resource value by key.
 
         Args:
-            key: The configuration key
+            key: The resource key
             value: The value to set
 
         Raises:
-            FileNotFoundError: If config file doesn't exist
-            ValueError: If the updated config is invalid
+            FileNotFoundError: If resource file doesn't exist
+            ValueError: If the updated resource is invalid
         """
         try:
-            config = self.load()
-            config_dict = config.model_dump()
+            resource = self.load()
+            resource_dict = resource.model_dump()
 
             if "." in key:
-                self._set_dot_notation_key(config_dict, key, value)
+                self._set_dot_notation_key(resource_dict, key, value)
             else:
-                config_dict[key] = value
+                resource_dict[key] = value
 
-            updated_config = config.model_validate(config_dict)
-            self.save(updated_config)
+            updated_resource = resource.model_validate(resource_dict)
+            self.save(updated_resource)
         except ValidationError as e:
             raise ValueError(
                 f"Invalid value set for '{self.__class__.__name__}' with "
@@ -226,31 +226,31 @@ class MutablePydanticResourceManager(PydanticResourceManager[MutablePydanticReso
             ) from e
 
     def update(self: Self, updates: dict[str, Any]) -> MutablePydanticResource:
-        """Updates multiple configuration values at once.
+        """Updates multiple resource values at once.
 
         Args:
             updates: Dictionary of key-value pairs to update
 
         Returns:
-            The updated Config object
+            The updated Resource object
 
         Raises:
-            FileNotFoundError: If config file doesn't exist
-            ValueError: If the updates config is invalid
+            FileNotFoundError: If resource file doesn't exist
+            ValueError: If the updates resource is invalid
         """
         try:
-            config = self.load()
-            config_dict = config.model_dump()
+            resource = self.load()
+            resource_dict = resource.model_dump()
 
             flat_updates = {k: v for k, v in updates.items() if "." not in k}
-            config_dict.update(flat_updates)
+            resource_dict.update(flat_updates)
 
             for key, value in updates.items():
                 if "." in key:
-                    self._set_dot_notation_key(config_dict, key, value)
+                    self._set_dot_notation_key(resource_dict, key, value)
 
-                updated_config = config.model_validate(config_dict)
-            self.save(updated_config)
+            updated_resource = resource.model_validate(resource_dict)
+            self.save(updated_resource)
         except ValidationError as e:
             raise ValueError(
                 f"Invalid value set for '{self.__class__.__name__}' with "
@@ -262,14 +262,14 @@ class MutablePydanticResourceManager(PydanticResourceManager[MutablePydanticReso
                 f"at: '{self.path}' when setting updates {updates}"
             ) from e
 
-        return updated_config
+        return updated_resource
 
     def reset(self: Self) -> MutablePydanticResource:
-        """Resets the configuration to defaults.
+        """Resets the resources to defaults.
 
         Returns:
-            The new default config object
+            The new default resource object
         """
-        config = self.model_class.reset()
-        self.save(config)
-        return config
+        resource = self.model_class.reset()
+        self.save(resource)
+        return resource

{fmu_settings-0.5.0 → fmu_settings-0.5.2}/src/fmu/settings/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.5.0'
-__version_tuple__ = version_tuple = (0, 5, 0)
+__version__ = version = '0.5.2'
+__version_tuple__ = version_tuple = (0, 5, 2)
 
-__commit_id__ = commit_id = 'g53ff72079'
+__commit_id__ = commit_id = 'g4490dbb9d'

{fmu_settings-0.5.0 → fmu_settings-0.5.2}/src/fmu_settings.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fmu-settings
-Version: 0.5.0
+Version: 0.5.2
 Summary: A library for managing FMU settings
 Author-email: Equinor <fg-fmu_atlas@equinor.com>
 License: GPL-3.0

{fmu_settings-0.5.0 → fmu_settings-0.5.2}/tests/test_global_config.py

@@ -13,6 +13,7 @@ from fmu.datamodels.fmu_results.global_configuration import (
     GlobalConfiguration,
     StratigraphyElement,
 )
+from pydantic import ValidationError
 
 from fmu.settings._global_config import (
     InvalidGlobalConfigurationError,
@@ -291,29 +292,51 @@ def test_validate_global_config_strict_stratigraphy_names(
 
 
 @pytest.mark.parametrize("fmu_load", [True, False])
-def test_load_global_configuration_returns_none_if_invalid_yaml(
+def test_load_global_configuration_raises_on_invalid_yaml_structure(
     fmu_load: bool, tmp_path: Path
 ) -> None:
-    """Tests maybe_load returns None if an Exception is raised."""
+    """Tests that ValidationError is raised for invalid YAML structure."""
     config_path = tmp_path / "global_config.yml"
     with open(config_path, "w") as f:
         f.write("foo=bar")
 
-    assert load_global_configuration_if_present(config_path, fmu_load=fmu_load) is None
+    with pytest.raises(ValidationError):
+        load_global_configuration_if_present(config_path, fmu_load=fmu_load)
 
 
 @pytest.mark.parametrize("fmu_load", [True, False])
-def test_load_global_configuration_returns_none_if_invalid_config(
+def test_load_global_configuration_raises_on_missing_required_fields(
     fmu_load: bool,
     tmp_path: Path,
     global_variables_with_masterdata: dict[str, Any],
 ) -> None:
-    """Tests maybe_load returns None if an Exception is raised."""
+    """Tests that ValidationError is raised for missing required fields."""
     config_path = tmp_path / "global_config.yml"
     del global_variables_with_masterdata["masterdata"]
     with open(config_path, "w") as f:
         yaml.safe_dump(global_variables_with_masterdata, f)
 
+    with pytest.raises(ValidationError):
+        load_global_configuration_if_present(config_path, fmu_load=fmu_load)
+
+
+@pytest.mark.parametrize("fmu_load", [True, False])
+def test_load_global_configuration_returns_none_on_file_not_found(
+    fmu_load: bool, tmp_path: Path
+) -> None:
+    """Tests that None is returned when file doesn't exist."""
+    config_path = tmp_path / "non_existent_file.yml"
+    assert load_global_configuration_if_present(config_path, fmu_load=fmu_load) is None
+
+
+@pytest.mark.parametrize("fmu_load", [True, False])
+def test_load_global_configuration_returns_none_on_yaml_parse_error(
+    fmu_load: bool, tmp_path: Path
+) -> None:
+    """Tests that None is returned on YAML parsing errors."""
+    config_path = tmp_path / "invalid.yml"
+    with open(config_path, "w") as f:
+        f.write("key: [unclosed list")
     assert load_global_configuration_if_present(config_path, fmu_load=fmu_load) is None
 
 
@@ -327,10 +350,23 @@ def test_find_global_config_file_not_there(tmp_path: Path) -> None:
     assert _find_global_config_file([tmp_path / "dne"]) is None
 
 
-def test_find_global_configs_file_malformed(tmp_path: Path) -> None:
-    """Tests finding the global config file if it is malformed."""
+def test_find_global_config_file_malformed_raises_validation_error(
+    tmp_path: Path,
+) -> None:
+    """Tests that malformed global config file raises ValidationError."""
     with open(tmp_path / "global_master_config.yml", "w") as f:
         f.write("foo: bar")
+    with pytest.raises(ValidationError):
+        _find_global_config_file([tmp_path])
+
+
+def test_find_global_config_file_skips_invalid_yaml_and_continues(
+    tmp_path: Path,
+) -> None:
+    """Tests that function skips files with YAML parse errors and continues."""
+    with open(tmp_path / "global_config.yml", "w") as f:
+        f.write("key: [unclosed list")
+
     assert _find_global_config_file([tmp_path]) is None
 
 
@@ -363,32 +399,55 @@ def test_find_global_variables_file_not_there(tmp_path: Path) -> None:
     assert _find_global_variables_file([tmp_path / "dne"]) is None
 
 
-def test_find_global_variables_file_malformed(tmp_path: Path) -> None:
-    """Tests finding the global variables file if it is malformed."""
+def test_find_global_variables_file_malformed_raises_validation_error(
+    tmp_path: Path,
+) -> None:
+    """Tests that malformed global variables file raises ValidationError."""
     with open(tmp_path / "global_variables.yml", "w") as f:
         f.write("foo: bar")
-    assert _find_global_variables_file([tmp_path]) is None
+    with pytest.raises(ValidationError):
+        _find_global_variables_file([tmp_path])
 
 
-def test_find_global_variables_file(fmuconfig_with_output: Path) -> None:
-    """Tests finding the global variables file in fmuconfig."""
+def test_find_global_variables_file_returns_none_when_not_found(
+    fmuconfig_with_output: Path,
+) -> None:
+    """Tests that None is returned when no global variables file exists."""
     tmp_path = fmuconfig_with_output
     some_dir = tmp_path / "some_dir"
     some_dir.mkdir()
-    some_file = some_dir / "some_file"
-    some_file.touch()
     does_not_exist = tmp_path / "bad"
-    assert _find_global_variables_file([does_not_exist, some_dir, some_file]) is None
+    assert _find_global_variables_file([does_not_exist, some_dir]) is None
+
+
+def test_find_global_variables_file_skips_invalid_yaml_and_continues(
+    tmp_path: Path,
+) -> None:
+    """Tests that function skips files with YAML parse errors and continues."""
+    invalid_yaml_file = tmp_path / "global_variables.yml"
+    with open(invalid_yaml_file, "w") as f:
+        f.write("key: [unclosed list")
+
+    assert _find_global_variables_file([tmp_path]) is None
+
 
+def test_find_global_variables_file_raises_on_empty_file(
+    fmuconfig_with_output: Path,
+) -> None:
+    """Tests that ValidationError is raised for empty/invalid file."""
+    tmp_path = fmuconfig_with_output
+    some_file = tmp_path / "some_file"
+    some_file.touch()
+    with pytest.raises(ValidationError):
+        _find_global_variables_file([some_file])
+
+
+def test_find_global_variables_file_returns_valid_config(
+    fmuconfig_with_output: Path,
+) -> None:
+    """Tests finding a valid global variables file in fmuconfig."""
     assert isinstance(
-        _find_global_variables_file(
-            [
-                does_not_exist,
-                some_dir,
-                some_file,
-                fmuconfig_with_output / "fmuconfig/output",
-            ]
-        ),
+        _find_global_variables_file([fmuconfig_with_output / "fmuconfig/output"]),
         GlobalConfiguration,
     )
 

{fmu_settings-0.5.0 → fmu_settings-0.5.2}/tests/test_resources/test_lock_manager.py

@@ -649,3 +649,18 @@ def test_ensure_can_write_foreign_lock(fmu_dir: ProjectFMUDirectory) -> None:
         pytest.raises(PermissionError, match="Cannot write to .fmu directory"),
     ):
         lock.ensure_can_write()
+
+
+def test_manual_delete_invalidates_lock_file_on_refresh(
+    fmu_dir: ProjectFMUDirectory,
+) -> None:
+    """Tests that if a user deletes anothers lock it's invalidated on a refresh."""
+    fmu_dir._lock.acquire()
+    assert fmu_dir._lock.is_acquired() is True
+
+    # Someone deletes the lock
+    fmu_dir._lock.path.unlink()
+
+    with pytest.raises(LockError, match="Cannot refresh: lock file does not exist"):
+        fmu_dir._lock.refresh()
+    assert fmu_dir._lock.is_acquired() is False