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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fmu-settings
-Version: 0.3.2
+Version: 0.5.0
 Summary: A library for managing FMU settings
 Author-email: Equinor <fg-fmu_atlas@equinor.com>
 License: GPL-3.0
@@ -17,7 +17,9 @@ Classifier: Natural Language :: English
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: PyYAML
 Requires-Dist: annotated_types
+Requires-Dist: fmu-config
 Requires-Dist: fmu-datamodels
 Requires-Dist: pydantic
 Provides-Extra: dev
@@ -27,6 +29,7 @@ Requires-Dist: pytest-cov; extra == "dev"
 Requires-Dist: pytest-mock; extra == "dev"
 Requires-Dist: pytest-xdist; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
+Requires-Dist: types-PyYAML; extra == "dev"
 Dynamic: license-file
 
 # fmu-settings

{fmu_settings-0.3.2 → fmu_settings-0.5.0}/pyproject.toml

@@ -28,7 +28,9 @@ classifiers = [
 ]
 dynamic = ["version"]
 dependencies = [
+    "PyYAML",
     "annotated_types",  # Dependency in Pydantic also
+    "fmu-config",
     "fmu-datamodels",
     "pydantic",
 ]
@@ -41,6 +43,7 @@ dev = [
     "pytest-mock",
     "pytest-xdist",
     "ruff",
+    "types-PyYAML",
 ]
 
 [project.urls]

{fmu_settings-0.3.2 → fmu_settings-0.5.0}/src/fmu/settings/_fmu_dir.py

@@ -82,7 +82,9 @@ class FMUDirectoryBase:
             FileNotFoundError: If config file doesn't exist
             ValueError: If the updated config is invalid
         """
+        logger.info(f"Setting {key} in {self.path}")
         self.config.set(key, value)
+        logger.debug(f"Set {key} to {value}")
 
     def update_config(
         self: Self, updates: dict[str, Any]
@@ -147,6 +149,7 @@ class FMUDirectoryBase:
             relative_path: Path relative to the .fmu directory
             data: Bytes to write
         """
+        self._lock.ensure_can_write()
         file_path = self.get_file_path(relative_path)
         file_path.parent.mkdir(parents=True, exist_ok=True)
 
@@ -163,6 +166,7 @@ class FMUDirectoryBase:
             content: Text content to write
             encoding: Text encoding to use. Default utf-8
         """
+        self._lock.ensure_can_write()
         file_path = self.get_file_path(relative_path)
         file_path.parent.mkdir(parents=True, exist_ok=True)
 

fmu_settings-0.5.0/src/fmu/settings/_global_config.py

@@ -0,0 +1,270 @@
+"""Functions related to finding and validating an existing global configuration."""
+
+from pathlib import Path
+from typing import Final
+
+from pydantic import ValidationError
+
+from fmu.config.utilities import yaml_load
+from fmu.datamodels.fmu_results.global_configuration import GlobalConfiguration
+
+from ._logging import null_logger
+
+logger: Final = null_logger(__name__)
+
+
+class InvalidGlobalConfigurationError(ValueError):
+    """Raised when a GlobalConfiguration contains invalid or disallowed content.
+
+    This includes Drogon test data or other disallowed masterdata.
+    This error is only raised when strict validation is enabled.
+    """
+
+
+# These should all be normalized to lower case.
+INVALID_NAMES: Final[tuple[str, ...]] = (
+    "drogon",
+    "drogon_2020",
+    "drogon_has_no_stratcolumn",
+)
+INVALID_UUIDS: Final[tuple[str, ...]] = (
+    "ad214d85-dac7-19da-e053-c918a4889309",
+    "ad214d85-8a1d-19da-e053-c918a4889310",
+    "00000000-0000-0000-0000-000000000000",
+)
+INVALID_STRAT_NAMES: Final[tuple[str, ...]] = (
+    "basevolantis",
+    "basetherys",
+    "basevalysar",
+    "basevolon",
+    "therys",
+    "toptherys",
+    "topvolantis",
+    "topvolon",
+    "topvalysar",
+    "valysar",
+    "volantis",
+    "volon",
+)
+
+
+def validate_global_configuration_strictly(cfg: GlobalConfiguration) -> None:  # noqa: PLR0912
+    """Does stricter checks against a valid GlobalConfiguration file.
+
+    This is to prevent importing existing but incorrect data that should not make it
+    into a project .fmu configuration. An example of this is Drogon masterdata.
+
+    Args:
+        cfg: A GlobalConfiguration instance to be validated
+
+    Raises:
+        InvalidGlobalConfigurationError: If some value in the GlobalConfiguration
+            is invalid or not allowed
+    """
+    # Check model and access
+    if cfg.model.name.lower() in INVALID_NAMES:
+        raise InvalidGlobalConfigurationError(
+            f"Invalid name in 'model': {cfg.model.name}"
+        )
+    if cfg.access.asset.name.lower() in INVALID_NAMES:
+        raise InvalidGlobalConfigurationError(
+            f"Invalid name in 'access.asset': {cfg.access.asset.name}"
+        )
+
+    # Check masterdata
+
+    # smda.country
+    for country in cfg.masterdata.smda.country:
+        if str(country.uuid) in INVALID_UUIDS:
+            raise InvalidGlobalConfigurationError(
+                f"Invalid SMDA UUID in 'smda.country': {country.uuid}"
+            )
+
+    # smda.discovery
+    for discovery in cfg.masterdata.smda.discovery:
+        if discovery.short_identifier.lower() in INVALID_NAMES:
+            raise InvalidGlobalConfigurationError(
+                f"Invalid SMDA short identifier in 'smda.discovery': "
+                f"{discovery.short_identifier}"
+            )
+        if str(discovery.uuid) in INVALID_UUIDS:
+            raise InvalidGlobalConfigurationError(
+                f"Invalid SMDA UUID in 'smda.discovery': {discovery.uuid}"
+            )
+
+    # smda.field
+    for field in cfg.masterdata.smda.field:
+        if field.identifier.lower() in INVALID_NAMES:
+            raise InvalidGlobalConfigurationError(
+                f"Invalid SMDA identifier in 'smda.field': {field.identifier}"
+            )
+        if str(field.uuid) in INVALID_UUIDS:
+            raise InvalidGlobalConfigurationError(
+                f"Invalid SMDA UUID in 'smda.field': {field.uuid}"
+            )
+
+    # smda.coordinate_system
+    if (coord_uuid := str(cfg.masterdata.smda.coordinate_system.uuid)) in INVALID_UUIDS:
+        raise InvalidGlobalConfigurationError(
+            f"Invalid SMDA UUID in 'smda.coordinate_system': {coord_uuid}"
+        )
+
+    # smda.stratigraphic_column
+    strat = cfg.masterdata.smda.stratigraphic_column
+    if strat.identifier.lower() in INVALID_NAMES:
+        raise InvalidGlobalConfigurationError(
+            f"Invalid SMDA identifier in 'smda.stratigraphic_column': "
+            f"{strat.identifier}"
+        )
+    if str(strat.uuid) in INVALID_UUIDS:
+        raise InvalidGlobalConfigurationError(
+            f"Invalid SMDA UUID in 'smda.stratigraphic_column': {strat.uuid}"
+        )
+
+    # Check stratigraphy
+
+    if cfg.stratigraphy:
+        for key in cfg.stratigraphy:
+            if key.lower() in INVALID_STRAT_NAMES:
+                raise InvalidGlobalConfigurationError(
+                    f"Invalid stratigraphy name in 'smda.stratigraphy': {key}"
+                )
+
+
+def load_global_configuration_if_present(
+    path: Path, fmu_load: bool = False
+) -> GlobalConfiguration | None:
+    """Loads a global config/global variables at a path.
+
+    This loads via fmu-config, which is capable of loading a global _config_, which is
+    different from the global _variables_ in that it may still be in separate files
+    linked by the custom '!include' directive.
+
+    Args:
+        path: The path to the yaml file
+        fmu_load: Whether or not to load in the custom 'fmu' format. Default False.
+
+    Returns:
+        GlobalConfiguration instance or None.
+    """
+    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 Exception as e:
+        logger.debug(
+            f"Failed to load global variables at {path}: {type(e).__name__}: {e}"
+        )
+        return None
+    return global_config
+
+
+def _find_global_variables_file(paths: list[Path]) -> GlobalConfiguration | None:
+    """Finds a valid global variables file, or not.
+
+    This is the _output_ file after fmuconfig is run.
+
+    Args:
+        paths: A list of Paths to check.
+
+    Returns:
+        A validated GlobalConfiguration or None.
+    """
+    for path in paths:
+        if not path.exists():
+            continue
+
+        global_variables_path = path
+        # If the path is a dir, and doesn't contain the right file, move on.
+        if path.is_dir():
+            global_variables_path = path / "global_variables.yml"
+            if not global_variables_path.exists():
+                continue
+
+        logger.info(f"Found global variables at {path}")
+        global_config = load_global_configuration_if_present(global_variables_path)
+        if not global_config:
+            continue
+        return global_config
+
+    return None
+
+
+def _find_global_config_file(paths: list[Path]) -> GlobalConfiguration | None:
+    """Finds a valid global configuration file, or not.
+
+    This is the _input_ file, before fmuconfig is run.
+
+    Args:
+        paths: A list of Paths to check.
+
+    Returns:
+        A validated GlobalConfiguration or None.
+    """
+    for path in paths:
+        if not path.exists():
+            continue
+
+        logger.info(f"Found global config at {path}")
+        # May be global_config*.yml or global_master*.yml
+        for global_config_path in path.glob("**/global*.yml"):
+            global_config = load_global_configuration_if_present(
+                global_config_path, fmu_load=True
+            )
+            if not global_config:
+                continue
+            return global_config
+
+    return None
+
+
+def find_global_config(
+    base_path: str | Path,
+    extra_output_paths: list[Path] | None = None,
+    extra_input_dirs: list[Path] | None = None,
+    strict: bool = True,
+) -> GlobalConfiguration | None:
+    """Try to locate a global configuration with valid masterdata in known location.
+
+    Extra paths may be provided
+
+    Args:
+        base_path: The path to the project root
+        extra_output_paths: A list of extra paths to a global _variables_.
+        extra_input_dirs: A list of extra dirs to a global _config_ might be.
+        strict: If True, valid data but invalid _content_ is disallowed, i.e.  Drogon
+            data. Default True.
+
+    Returns:
+        A valid GlobalConfiguration instance, or None.
+    """
+    base_path = Path(base_path)
+
+    # Loads with 'fmu_load=False'
+    known_output_paths = [base_path / "fmuconfig/output/global_variables.yml"]
+    if extra_output_paths:
+        known_output_paths += extra_output_paths
+
+    global_config = _find_global_variables_file(known_output_paths)
+    if global_config:
+        if strict:
+            validate_global_configuration_strictly(global_config)
+        return global_config
+
+    # Loads with 'fmu_load=True'
+    known_input_paths = [base_path / "fmuconfig/input"]
+    if extra_input_dirs:
+        known_input_paths += extra_input_dirs
+
+    global_config = _find_global_config_file(known_input_paths)
+    if global_config:
+        if strict:
+            validate_global_configuration_strictly(global_config)
+        return global_config
+
+    logger.info("No global variables or config with valid settings data found.")
+    return None

{fmu_settings-0.3.2 → fmu_settings-0.5.0}/src/fmu/settings/_init.py

@@ -4,6 +4,8 @@ from pathlib import Path
 from textwrap import dedent
 from typing import Any, Final
 
+from fmu.datamodels.fmu_results.global_configuration import GlobalConfiguration
+
 from ._fmu_dir import ProjectFMUDirectory, UserFMUDirectory
 from ._logging import null_logger
 from .models.project_config import ProjectConfig
@@ -66,7 +68,9 @@ def _create_fmu_directory(base_path: Path) -> None:
 
 
 def init_fmu_directory(
-    base_path: str | Path, config_data: ProjectConfig | dict[str, Any] | None = None
+    base_path: str | Path,
+    config_data: ProjectConfig | dict[str, Any] | None = None,
+    global_config: GlobalConfiguration | None = None,
 ) -> ProjectFMUDirectory:
     """Creates and initializes a .fmu directory.
 
@@ -74,9 +78,11 @@ def init_fmu_directory(
     function.
 
     Args:
-        base_path: Directory where .fmu should be created
+        base_path: Directory where .fmu should be created.
         config_data: Optional ProjectConfig instance or dictionary with configuration
-          data
+          data.
+        global_config: Optional GlobaConfiguration instance with existing global config
+          data.
 
     Returns:
         Instance of FMUDirectory
@@ -98,12 +104,14 @@ def init_fmu_directory(
     fmu_dir.config.reset()
     if config_data:
         if isinstance(config_data, ProjectConfig):
-            config_dict = config_data.model_dump()
-            fmu_dir.update_config(config_dict)
-        elif isinstance(config_data, dict):
-            fmu_dir.update_config(config_data)
+            config_data = config_data.model_dump()
+        fmu_dir.update_config(config_data)
 
-    logger.debug(f"Successfully initialized .fmu directory at '{fmu_dir}'")
+    if global_config:
+        for key, value in global_config.model_dump().items():
+            fmu_dir.set_config_value(key, value)
+
+    logger.info(f"Successfully initialized .fmu directory at '{fmu_dir}'")
     return fmu_dir
 
 

fmu_settings-0.5.0/src/fmu/settings/_resources/config_managers.py

@@ -0,0 +1,49 @@
+"""The generic configuration file in a .fmu directory."""
+
+from __future__ import annotations
+
+from pathlib import Path
+from typing import TYPE_CHECKING, Final, Self
+
+from fmu.settings._logging import null_logger
+from fmu.settings.models.project_config import ProjectConfig
+from fmu.settings.models.user_config import UserConfig
+
+from .pydantic_resource_manager import (
+    MutablePydanticResourceManager,
+)
+
+if TYPE_CHECKING:
+    # Avoid circular dependency for type hint in __init__ only
+    from fmu.settings._fmu_dir import (
+        ProjectFMUDirectory,
+        UserFMUDirectory,
+    )
+
+logger: Final = null_logger(__name__)
+
+
+class ProjectConfigManager(MutablePydanticResourceManager[ProjectConfig]):
+    """Manages the .fmu configuration file in a project."""
+
+    def __init__(self: Self, fmu_dir: ProjectFMUDirectory) -> None:
+        """Initializes the ProjectConfig resource manager."""
+        super().__init__(fmu_dir, ProjectConfig)
+
+    @property
+    def relative_path(self: Self) -> Path:
+        """Returns the relative path to the config file."""
+        return Path("config.json")
+
+
+class UserConfigManager(MutablePydanticResourceManager[UserConfig]):
+    """Manages the .fmu configuration file in a user's home directory."""
+
+    def __init__(self: Self, fmu_dir: UserFMUDirectory) -> None:
+        """Initializes the UserConfig resource manager."""
+        super().__init__(fmu_dir, UserConfig)
+
+    @property
+    def relative_path(self: Self) -> Path:
+        """Returns the relative path to the config file."""
+        return Path("config.json")

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

@@ -168,6 +168,25 @@ class LockManager(PydanticResourceManager[LockInfo]):
             return False
         return self._is_mine(self._cache) and not self._is_stale()
 
+    def ensure_can_write(self: Self) -> None:
+        """Raise PermissionError if another process currently holds the lock."""
+        try:
+            lock_info = self.load(force=True, store_cache=False)
+        except Exception:
+            lock_info = None
+
+        if (
+            self.exists
+            and lock_info is not None
+            and not self.is_acquired()
+            and not self._is_stale(lock_info=lock_info)
+        ):
+            raise PermissionError(
+                "Cannot write to .fmu directory because it is locked by "
+                f"{lock_info.user}@{lock_info.hostname} (PID: {lock_info.pid}). "
+                f"Lock expires at {time.ctime(lock_info.expires_at)}."
+            )
+
     def refresh(self: Self) -> None:
         """Refresh/extend the lock expiration time.
 
@@ -239,9 +258,11 @@ class LockManager(PydanticResourceManager[LockInfo]):
         except Exception:
             return None
 
-    def _is_stale(self: Self) -> bool:
+    def _is_stale(self: Self, lock_info: LockInfo | None = None) -> bool:
         """Check if existing lock is stale (expired or process dead)."""
-        lock_info = self._safe_load()
+        if lock_info is None:
+            lock_info = self._safe_load()
+
         if not lock_info:
             return True
 

fmu_settings-0.3.2/src/fmu/settings/_resources/config_managers.py → fmu_settings-0.5.0/src/fmu/settings/_resources/pydantic_resource_manager.py

@@ -1,43 +1,124 @@
-"""The generic configuration file in a .fmu directory."""
+"""Contains the base class used for interacting with resources."""
 
 from __future__ import annotations
 
-from pathlib import Path
-from typing import TYPE_CHECKING, Any, Final, Self, TypeVar
+import json
+from typing import TYPE_CHECKING, Any, Generic, Self, TypeVar
 
-from pydantic import ValidationError
+from pydantic import BaseModel, ValidationError
 
-from fmu.settings._logging import null_logger
-from fmu.settings.models.project_config import ProjectConfig
-from fmu.settings.models.user_config import UserConfig
-from fmu.settings.types import ResettableBaseModel  # noqa: TC001
-
-from .pydantic_resource_manager import PydanticResourceManager
+from fmu.settings.types import ResettableBaseModel
 
 if TYPE_CHECKING:
     # Avoid circular dependency for type hint in __init__ only
-    from fmu.settings._fmu_dir import (
-        FMUDirectoryBase,
-        ProjectFMUDirectory,
-        UserFMUDirectory,
-    )
+    from pathlib import Path
 
-logger: Final = null_logger(__name__)
+    from fmu.settings._fmu_dir import FMUDirectoryBase
 
-T = TypeVar("T", bound=ResettableBaseModel)
+PydanticResource = TypeVar("PydanticResource", bound=BaseModel)
+MutablePydanticResource = TypeVar("MutablePydanticResource", bound=ResettableBaseModel)
 
 
-class ConfigManager(PydanticResourceManager[T]):
-    """Manages the .fmu configuration file."""
+class PydanticResourceManager(Generic[PydanticResource]):
+    """Base class for managing resources represented by Pydantic models."""
 
-    def __init__(self: Self, fmu_dir: FMUDirectoryBase, config: type[T]) -> None:
-        """Initializes the Config resource manager."""
-        super().__init__(fmu_dir, config)
+    def __init__(
+        self: Self, fmu_dir: FMUDirectoryBase, model_class: type[PydanticResource]
+    ) -> None:
+        """Initializes the resource manager.
+
+        Args:
+            fmu_dir: The FMUDirectory instance
+            model_class: The Pydantic model class this manager handles
+        """
+        self.fmu_dir = fmu_dir
+        self.model_class = model_class
+        self._cache: PydanticResource | None = None
 
     @property
     def relative_path(self: Self) -> Path:
-        """Returns the relative path to the config file."""
-        return Path("config.json")
+        """Returns the path to the resource file _inside_ the .fmu directory.
+
+        Must be implemented by subclasses.
+        """
+        raise NotImplementedError
+
+    @property
+    def path(self: Self) -> Path:
+        """Returns the full path to the resource file."""
+        return self.fmu_dir.get_file_path(self.relative_path)
+
+    @property
+    def exists(self: Self) -> bool:
+        """Returns whether or not the resource exists."""
+        return self.path.exists()
+
+    def load(
+        self: Self, force: bool = False, store_cache: bool = True
+    ) -> PydanticResource:
+        """Loads the resource from disk and validates it as a Pydantic model.
+
+        Args:
+            force: Force a re-read even if the file is already cached.
+            store_cache: Whether or not to cache the loaded model internally. This is
+                best used with 'force=True' because if a model is already stored in
+                _cache it will be returned without re-loading. Default True.
+
+        Returns:
+            Validated Pydantic model
+
+        Raises:
+            ValueError: If the resource file is missing or data does not match the
+            model schema
+        """
+        if self._cache is None or force:
+            if not self.exists:
+                raise FileNotFoundError(
+                    f"Resource file for '{self.__class__.__name__}' not found "
+                    f"at: '{self.path}'"
+                )
+
+            try:
+                content = self.fmu_dir.read_text_file(self.relative_path)
+                data = json.loads(content)
+                validated_model = self.model_class.model_validate(data)
+                if store_cache:
+                    self._cache = validated_model
+                else:
+                    return validated_model
+            except ValidationError as e:
+                raise ValueError(
+                    f"Invalid content in resource file for '{self.__class__.__name__}: "
+                    f"'{e}"
+                ) from e
+            except json.JSONDecodeError as e:
+                raise ValueError(
+                    f"Invalid JSON in resource file for '{self.__class__.__name__}': "
+                    f"'{e}'"
+                ) from e
+
+        return self._cache
+
+    def save(self: Self, model: PydanticResource) -> None:
+        """Save the Pydantic model to disk.
+
+        Args:
+            model: Validated Pydantic model instance
+        """
+        self.fmu_dir._lock.ensure_can_write()
+        json_data = model.model_dump_json(by_alias=True, indent=2)
+        self.fmu_dir.write_text_file(self.relative_path, json_data)
+        self._cache = model
+
+
+class MutablePydanticResourceManager(PydanticResourceManager[MutablePydanticResource]):
+    """Manages the .fmu configuration file."""
+
+    def __init__(
+        self: Self, fmu_dir: FMUDirectoryBase, config: type[MutablePydanticResource]
+    ) -> None:
+        """Initializes the Config resource manager."""
+        super().__init__(fmu_dir, config)
 
     def _get_dot_notation_key(
         self: Self, config_dict: dict[str, Any], key: str, default: Any = None
@@ -144,7 +225,7 @@ class ConfigManager(PydanticResourceManager[T]):
                 f"at: '{self.path}' when setting key {key}"
             ) from e
 
-    def update(self: Self, updates: dict[str, Any]) -> T:
+    def update(self: Self, updates: dict[str, Any]) -> MutablePydanticResource:
         """Updates multiple configuration values at once.
 
         Args:
@@ -183,7 +264,7 @@ class ConfigManager(PydanticResourceManager[T]):
 
         return updated_config
 
-    def reset(self: Self) -> T:
+    def reset(self: Self) -> MutablePydanticResource:
         """Resets the configuration to defaults.
 
         Returns:
@@ -192,19 +273,3 @@ class ConfigManager(PydanticResourceManager[T]):
         config = self.model_class.reset()
         self.save(config)
         return config
-
-
-class ProjectConfigManager(ConfigManager[ProjectConfig]):
-    """Manages the .fmu configuration file in a project."""
-
-    def __init__(self: Self, fmu_dir: ProjectFMUDirectory) -> None:
-        """Initializes the ProjectConfig resource manager."""
-        super().__init__(fmu_dir, ProjectConfig)
-
-
-class UserConfigManager(ConfigManager[UserConfig]):
-    """Manages the .fmu configuration file in a user's home directory."""
-
-    def __init__(self: Self, fmu_dir: UserFMUDirectory) -> None:
-        """Initializes the UserConfig resource manager."""
-        super().__init__(fmu_dir, UserConfig)

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

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