fmu-settings 0.0.1__tar.gz → 0.2.0__tar.gz

{fmu_settings-0.0.1 → fmu_settings-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fmu-settings
-Version: 0.0.1
+Version: 0.2.0
 Summary: A library for managing FMU settings
 Author-email: Equinor <fg-fmu_atlas@equinor.com>
 License: GPL-3.0
@@ -18,7 +18,7 @@ Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: annotated_types
-Requires-Dist: fmu-dataio
+Requires-Dist: fmu-datamodels
 Requires-Dist: pydantic
 Provides-Extra: dev
 Requires-Dist: mypy; extra == "dev"

{fmu_settings-0.0.1 → fmu_settings-0.2.0}/pyproject.toml

@@ -29,7 +29,7 @@ classifiers = [
 dynamic = ["version"]
 dependencies = [
     "annotated_types",  # Dependency in Pydantic also
-    "fmu-dataio",
+    "fmu-datamodels",
     "pydantic",
 ]
 

{fmu_settings-0.0.1 → fmu_settings-0.2.0}/src/fmu/settings/_fmu_dir.py

@@ -4,12 +4,12 @@ from pathlib import Path
 from typing import Any, Final, Self, TypeAlias, cast
 
 from ._logging import null_logger
-from .models.project_config import ProjectConfig
-from .models.user_config import UserConfig
-from .resources.config_managers import (
+from ._resources.config_managers import (
     ProjectConfigManager,
     UserConfigManager,
 )
+from .models.project_config import ProjectConfig
+from .models.user_config import UserConfig
 
 logger: Final = null_logger(__name__)
 

fmu_settings-0.2.0/src/fmu/settings/_resources/__init__.py

@@ -0,0 +1,5 @@
+"""Contains resources used in this package.
+
+Some resources contained here may also be used
+outside this package.
+"""

{fmu_settings-0.0.1/src/fmu/settings/resources → fmu_settings-0.2.0/src/fmu/settings/_resources}/config_managers.py

@@ -13,7 +13,7 @@ from fmu.settings.models.project_config import ProjectConfig
 from fmu.settings.models.user_config import UserConfig
 from fmu.settings.types import ResettableBaseModel, VersionStr  # noqa TC001
 
-from .managers import PydanticResourceManager
+from .pydantic_resource_manager import PydanticResourceManager
 
 if TYPE_CHECKING:
     # Avoid circular dependency for type hint in __init__ only
@@ -73,7 +73,7 @@ class ConfigManager(PydanticResourceManager[T]):
             default: Value to return if key is not found. Default None
 
         Returns:
-            The configuration value or deafult
+            The configuration value or default
         """
         try:
             config = self.load()

{fmu_settings-0.0.1 → fmu_settings-0.2.0}/src/fmu/settings/_version.py

@@ -1,7 +1,14 @@
 # file generated by setuptools-scm
 # don't change, don't track in version control
 
-__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
 
 TYPE_CHECKING = False
 if TYPE_CHECKING:
@@ -9,13 +16,19 @@ if TYPE_CHECKING:
     from typing import Union
 
     VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
 else:
     VERSION_TUPLE = object
+    COMMIT_ID = object
 
 version: str
 __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
 
-__version__ = version = '0.0.1'
-__version_tuple__ = version_tuple = (0, 0, 1)
+__version__ = version = '0.2.0'
+__version_tuple__ = version_tuple = (0, 2, 0)
+
+__commit_id__ = commit_id = 'g944134f32'

{fmu_settings-0.0.1 → fmu_settings-0.2.0}/src/fmu/settings/models/_mappings.py

@@ -6,7 +6,7 @@ from uuid import UUID
 
 from pydantic import BaseModel, RootModel
 
-from fmu.dataio._models.enums import Content  # type: ignore
+from fmu.datamodels.enums import Content  # type: ignore
 
 from ._enums import (
     DataEntrySource,

{fmu_settings-0.0.1 → fmu_settings-0.2.0}/src/fmu/settings/models/project_config.py

@@ -3,25 +3,13 @@
 import getpass
 from datetime import UTC, datetime
 from typing import Self
-from uuid import UUID  # noqa TC003
 
-from pydantic import AwareDatetime, BaseModel, Field
+from pydantic import AwareDatetime, Field
 
+from fmu.datamodels.fmu_results.fields import Access, Masterdata, Model
 from fmu.settings import __version__
 from fmu.settings.types import ResettableBaseModel, VersionStr  # noqa TC001
 
-from .smda import Smda
-
-
-class Masterdata(BaseModel):
-    """The ``masterdata`` block contains information related to masterdata.
-
-    Currently, SMDA holds the masterdata.
-    """
-
-    smda: Smda | None = Field(default=None)
-    """Block containing SMDA-related attributes. See :class:`Smda`."""
-
 
 class ProjectConfig(ResettableBaseModel):
     """The configuration file in a .fmu directory.
@@ -32,7 +20,9 @@ class ProjectConfig(ResettableBaseModel):
     version: VersionStr
     created_at: AwareDatetime
     created_by: str
-    masterdata: Masterdata
+    masterdata: Masterdata | None = Field(default=None)
+    model: Model | None = Field(default=None)
+    access: Access | None = Field(default=None)
 
     @classmethod
     def reset(cls: type[Self]) -> Self:
@@ -45,5 +35,7 @@ class ProjectConfig(ResettableBaseModel):
             version=__version__,
             created_at=datetime.now(UTC),
             created_by=getpass.getuser(),
-            masterdata=Masterdata(),
+            masterdata=None,
+            model=None,
+            access=None,
         )

{fmu_settings-0.0.1 → fmu_settings-0.2.0}/src/fmu/settings/models/user_config.py

@@ -8,12 +8,18 @@ from typing import Annotated, Self
 from uuid import UUID  # noqa TC003
 
 import annotated_types
-from pydantic import AwareDatetime, BaseModel, SecretStr, field_serializer
+from pydantic import (
+    AwareDatetime,
+    BaseModel,
+    SecretStr,
+    field_serializer,
+    field_validator,
+)
 
 from fmu.settings import __version__
 from fmu.settings.types import ResettableBaseModel, VersionStr  # noqa TC001
 
-RecentDirectories = Annotated[set[Path], annotated_types.Len(0, 5)]
+RecentProjectDirectories = Annotated[list[Path], annotated_types.Len(0, 5)]
 
 
 class UserAPIKeys(BaseModel):
@@ -38,7 +44,7 @@ class UserConfig(ResettableBaseModel):
     version: VersionStr
     created_at: AwareDatetime
     user_api_keys: UserAPIKeys
-    recent_directories: RecentDirectories
+    recent_project_directories: RecentProjectDirectories
 
     @classmethod
     def reset(cls: type[Self]) -> Self:
@@ -47,9 +53,17 @@ class UserConfig(ResettableBaseModel):
             version=__version__,
             created_at=datetime.now(UTC),
             user_api_keys=UserAPIKeys(),
-            recent_directories=set(),
+            recent_project_directories=[],
         )
 
+    @field_validator("recent_project_directories", mode="before")
+    @classmethod
+    def ensure_unique(cls, recent_projects: list[Path]) -> list[Path]:
+        """Ensures that recent_project_directories contains unique entries."""
+        if len(recent_projects) != len(set(recent_projects)):
+            raise ValueError("recent_project_directories must contain unique entries")
+        return recent_projects
+
     def obfuscate_secrets(self: Self) -> Self:
         """Returns a copy of the model with obfuscated secrets.
 

{fmu_settings-0.0.1 → fmu_settings-0.2.0}/src/fmu_settings.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fmu-settings
-Version: 0.0.1
+Version: 0.2.0
 Summary: A library for managing FMU settings
 Author-email: Equinor <fg-fmu_atlas@equinor.com>
 License: GPL-3.0
@@ -18,7 +18,7 @@ Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: annotated_types
-Requires-Dist: fmu-dataio
+Requires-Dist: fmu-datamodels
 Requires-Dist: pydantic
 Provides-Extra: dev
 Requires-Dist: mypy; extra == "dev"

{fmu_settings-0.0.1 → fmu_settings-0.2.0}/src/fmu_settings.egg-info/SOURCES.txt

@@ -17,14 +17,14 @@ src/fmu/settings/_logging.py
 src/fmu/settings/_version.py
 src/fmu/settings/py.typed
 src/fmu/settings/types.py
+src/fmu/settings/_resources/__init__.py
+src/fmu/settings/_resources/config_managers.py
+src/fmu/settings/_resources/pydantic_resource_manager.py
 src/fmu/settings/models/__init__.py
 src/fmu/settings/models/_enums.py
 src/fmu/settings/models/_mappings.py
 src/fmu/settings/models/project_config.py
-src/fmu/settings/models/smda.py
 src/fmu/settings/models/user_config.py
-src/fmu/settings/resources/config_managers.py
-src/fmu/settings/resources/managers.py
 src/fmu_settings.egg-info/PKG-INFO
 src/fmu_settings.egg-info/SOURCES.txt
 src/fmu_settings.egg-info/dependency_links.txt

{fmu_settings-0.0.1 → fmu_settings-0.2.0}/src/fmu_settings.egg-info/requires.txt

@@ -1,5 +1,5 @@
 annotated_types
-fmu-dataio
+fmu-datamodels
 pydantic
 
 [dev]

{fmu_settings-0.0.1 → fmu_settings-0.2.0}/tests/conftest.py

@@ -27,9 +27,9 @@ def config_dict(unix_epoch_utc: datetime) -> dict[str, Any]:
         "version": __version__,
         "created_at": unix_epoch_utc,
         "created_by": "user",
-        "masterdata": {
-            "smda": None,
-        },
+        "masterdata": None,
+        "model": None,
+        "access": None,
     }
 
 
@@ -68,9 +68,30 @@ def masterdata_dict() -> dict[str, Any]:
     }
 
 
+@pytest.fixture
+def model_dict() -> dict[str, Any]:
+    """Example model information."""
+    return {
+        "name": "Drogon",
+        "revision": "21.0.0",
+        "description": None,
+    }
+
+
+@pytest.fixture
+def access_dict() -> dict[str, Any]:
+    """Example access information."""
+    return {
+        "asset": {"name": "Drogon"},
+        "classification": "internal",
+    }
+
+
 @pytest.fixture
 def config_dict_with_masterdata(
-    unix_epoch_utc: datetime, masterdata_dict: dict[str, Any]
+    unix_epoch_utc: datetime,
+    masterdata_dict: dict[str, Any],
+    model_dict: dict[str, Any],
 ) -> dict[str, Any]:
     """A dictionary representing a .fmu config."""
     return {
@@ -78,6 +99,7 @@ def config_dict_with_masterdata(
         "created_at": unix_epoch_utc,
         "created_by": "user",
         "masterdata": masterdata_dict,
+        "model": model_dict,
     }
 
 
@@ -104,7 +126,7 @@ def user_config_dict(unix_epoch_utc: datetime) -> dict[str, Any]:
         "user_api_keys": {
             "smda_subscription": None,
         },
-        "recent_directories": [],
+        "recent_project_directories": [],
     }
 
 

{fmu_settings-0.0.1 → fmu_settings-0.2.0}/tests/test_fmu_dir.py

@@ -288,30 +288,41 @@ def test_update_user_config(user_fmu_dir: UserFMUDirectory) -> None:
     """Tests update_config updates and saves the user config for multiple values."""
     recent_dir = "/foo/bar"
     updated_config = user_fmu_dir.update_config(
-        {"version": "2.0.0", "recent_directories": [recent_dir]}
+        {"version": "2.0.0", "recent_project_directories": [recent_dir]}
     )
 
     assert updated_config.version == "2.0.0"
-    assert updated_config.recent_directories == {Path(recent_dir)}
+    assert updated_config.recent_project_directories == [Path(recent_dir)]
 
     assert user_fmu_dir.config.load() is not None
     assert user_fmu_dir.get_config_value("version", None) == "2.0.0"
-    assert user_fmu_dir.get_config_value("recent_directories") == {Path(recent_dir)}
+    assert user_fmu_dir.get_config_value("recent_project_directories") == [
+        Path(recent_dir)
+    ]
 
     config_file = user_fmu_dir.config.path
     with open(config_file, encoding="utf-8") as f:
         saved_config = json.load(f)
 
     assert saved_config["version"] == "2.0.0"
-    assert saved_config["recent_directories"] == [recent_dir]
+    assert saved_config["recent_project_directories"] == [recent_dir]
 
 
 def test_update_user_config_invalid_data(user_fmu_dir: UserFMUDirectory) -> None:
     """Tests that update_config raises ValidationError on bad data."""
-    updates = {"recent_directories": [123]}
+    updates = {"recent_project_directories": [123]}
     with pytest.raises(
         ValueError,
         match="Invalid value set for 'UserConfigManager' with updates "
-        "'{'recent_directories':",
+        "'{'recent_project_directories':",
     ):
         user_fmu_dir.update_config(updates)
+
+
+def test_update_user_config_non_unique_recent_projects(
+    user_fmu_dir: UserFMUDirectory,
+) -> None:
+    """Tests that update_config raises on non-unique recent_project_directories."""
+    updates = {"recent_project_directories": [Path("/foo/bar"), Path("/foo/bar")]}
+    with pytest.raises(ValueError, match="unique entries"):
+        user_fmu_dir.update_config(updates)

{fmu_settings-0.0.1 → fmu_settings-0.2.0}/tests/test_init.py

@@ -134,7 +134,7 @@ def test_init_user_fmu_directory(
     assert config_json["version"] == __version__
     assert config_json["created_at"] != str(unix_epoch_utc)
     assert config_json["user_api_keys"] == {"smda_subscription": None}
-    assert config_json["recent_directories"] == []
+    assert config_json["recent_project_directories"] == []
 
     created_at = datetime.fromisoformat(config_json["created_at"])
     now = datetime.now(UTC)

{fmu_settings-0.0.1 → fmu_settings-0.2.0}/tests/test_resources/test_project_config.py

@@ -7,14 +7,14 @@ from typing import Any
 
 import pytest
 
+from fmu.datamodels.fmu_results.fields import Access, Model, Smda
 from fmu.settings._fmu_dir import ProjectFMUDirectory, UserFMUDirectory
-from fmu.settings.models.project_config import ProjectConfig
-from fmu.settings.models.smda import Smda
-from fmu.settings.models.user_config import UserConfig
-from fmu.settings.resources.config_managers import (
+from fmu.settings._resources.config_managers import (
     ProjectConfigManager,
     UserConfigManager,
 )
+from fmu.settings.models.project_config import ProjectConfig
+from fmu.settings.models.user_config import UserConfig
 
 
 @pytest.fixture
@@ -238,7 +238,7 @@ def test_set_smda(
     assert fmu_dir.config.get("masterdata.smda") is None
     with open(fmu_dir.path / fmu_dir.config.relative_path, encoding="utf-8") as f:
         config_on_disk = json.loads(f.read())
-    assert config_on_disk["masterdata"]["smda"] is None
+    assert config_on_disk["masterdata"] is None
 
     fmu_dir.set_config_value("masterdata", masterdata_dict)
 
@@ -250,10 +250,85 @@ def test_set_smda(
 
     config_on_disk_model = ProjectConfig.model_validate(config_on_disk)
     assert fmu_dir.config._cache is not None
+    assert fmu_dir.config._cache.masterdata is not None
     assert fmu_dir.config._cache.masterdata.smda == smda_model
     assert config_on_disk_model == fmu_dir.config._cache
 
 
+def test_set_model_invalid_fails(
+    fmu_dir: ProjectFMUDirectory, model_dict: dict[str, Any]
+) -> None:
+    """Tests setting the model value in the config using an invalid dictionary."""
+    assert fmu_dir.config.get("model") is None
+
+    # drop model.name to test validation
+    model_dict.pop("name")
+
+    with pytest.raises(ValueError, match="model.name"):
+        fmu_dir.set_config_value("model", model_dict)
+
+
+def test_set_model(fmu_dir: ProjectFMUDirectory, model_dict: dict[str, Any]) -> None:
+    """Tests setting the model value in the config."""
+    assert fmu_dir.config.get("model") is None
+    with open(fmu_dir.path / fmu_dir.config.relative_path, encoding="utf-8") as f:
+        config_on_disk = json.loads(f.read())
+    assert config_on_disk["model"] is None
+
+    fmu_dir.set_config_value("model", model_dict)
+
+    model = Model.model_validate(model_dict)
+
+    assert fmu_dir.get_config_value("model") == model
+    assert fmu_dir.get_config_value("model.revision") == "21.0.0"
+    assert fmu_dir.get_config_value("model.name") == "Drogon"
+
+    with open(fmu_dir.path / fmu_dir.config.relative_path, encoding="utf-8") as f:
+        config_on_disk = json.loads(f.read())
+
+    config_on_disk_model = ProjectConfig.model_validate(config_on_disk)
+    assert fmu_dir.config._cache is not None
+    assert fmu_dir.config._cache.model == model
+    assert config_on_disk_model == fmu_dir.config._cache
+
+
+def test_set_access_invalid_fails(
+    fmu_dir: ProjectFMUDirectory, access_dict: dict[str, Any]
+) -> None:
+    """Tests setting the access value in the config using an invalid dictionary."""
+    assert fmu_dir.config.get("access") is None
+
+    # drop access.asset to test validation
+    access_dict.pop("asset")
+
+    with pytest.raises(ValueError, match="access.asset"):
+        fmu_dir.set_config_value("access", access_dict)
+
+
+def test_set_access(fmu_dir: ProjectFMUDirectory, access_dict: dict[str, Any]) -> None:
+    """Tests setting the access value in the config."""
+    assert fmu_dir.config.get("access") is None
+    with open(fmu_dir.path / fmu_dir.config.relative_path, encoding="utf-8") as f:
+        config_on_disk = json.loads(f.read())
+    assert config_on_disk["access"] is None
+
+    fmu_dir.set_config_value("access", access_dict)
+
+    access = Access.model_validate(access_dict)
+
+    assert fmu_dir.get_config_value("access") == access
+    assert fmu_dir.get_config_value("access.classification") == "internal"
+    assert fmu_dir.get_config_value("access.asset.name") == "Drogon"
+
+    with open(fmu_dir.path / fmu_dir.config.relative_path, encoding="utf-8") as f:
+        config_on_disk = json.loads(f.read())
+
+    config_on_disk_model = ProjectConfig.model_validate(config_on_disk)
+    assert fmu_dir.config._cache is not None
+    assert fmu_dir.config._cache.access == access
+    assert config_on_disk_model == fmu_dir.config._cache
+
+
 def test_update_config_when_it_does_not_exist(tmp_path: Path) -> None:
     """Tests getting a key when the config is missing."""
     empty_fmu_dir = tmp_path / ".fmu"

{fmu_settings-0.0.1 → fmu_settings-0.2.0}/tests/test_resources/test_resource_managers.py

@@ -8,7 +8,7 @@ import pytest
 from pydantic import BaseModel
 
 from fmu.settings._fmu_dir import ProjectFMUDirectory
-from fmu.settings.resources.managers import PydanticResourceManager
+from fmu.settings._resources.pydantic_resource_manager import PydanticResourceManager
 
 
 class A(BaseModel):

fmu_settings-0.0.1/src/fmu/settings/models/smda.py

@@ -1,90 +0,0 @@
-"""Models for SMDA masterdata."""
-
-from uuid import UUID
-
-from pydantic import BaseModel, Field
-
-from fmu.settings.types import VersionStr  # noqa TC001
-
-
-class SmdaIdentifier(BaseModel):
-    """The identifier for something known to SMDA."""
-
-    identifier: str
-    """Identifier known to SMDA."""
-
-    uuid: UUID
-    """Identifier known to SMDA."""
-
-
-class CountryItem(SmdaIdentifier):
-    """A single country in the list of countries known to SMDA."""
-
-    identifier: str = Field(examples=["Norway"])
-    """Identifier known to SMDA."""
-
-    uuid: UUID = Field(examples=["15ce3b84-766f-4c93-9050-b154861f9100"])
-    """Identifier known to SMDA."""
-
-
-class FieldItem(SmdaIdentifier):
-    """A single field in the list of fields known to SMDA."""
-
-    identifier: str = Field(examples=["OseFax"])
-    """Identifier known to SMDA."""
-
-    uuid: UUID = Field(examples=["15ce3b84-766f-4c93-9050-b154861f9100"])
-    """Identifier known to SMDA."""
-
-
-class CoordinateSystem(SmdaIdentifier):
-    """Contains the coordinate system known to SMDA."""
-
-    identifier: str = Field(examples=["ST_WGS84_UTM37N_P32637"])
-    """Identifier known to SMDA."""
-
-    uuid: UUID = Field(examples=["15ce3b84-766f-4c93-9050-b154861f9100"])
-    """Identifier known to SMDA."""
-
-
-class StratigraphicColumn(SmdaIdentifier):
-    """Contains the stratigraphic column known to SMDA."""
-
-    identifier: str = Field(examples=["DROGON_2020"])
-    """Identifier known to SMDA."""
-
-    uuid: UUID = Field(examples=["15ce3b84-766f-4c93-9050-b154861f9100"])
-    """Identifier known to SMDA."""
-
-
-class DiscoveryItem(BaseModel):
-    """A single discovery in the list of discoveries known to SMDA."""
-
-    short_identifier: str = Field(examples=["SomeDiscovery"])
-    """Identifier known to SMDA."""
-
-    uuid: UUID = Field(examples=["15ce3b84-766f-4c93-9050-b154861f9100"])
-    """Identifier known to SMDA."""
-
-
-class Smda(BaseModel):
-    """Contains SMDA-related attributes."""
-
-    coordinate_system: CoordinateSystem
-    """Reference to coordinate system known to SMDA.  See :class:`CoordinateSystem`."""
-
-    country: list[CountryItem]
-    """A list referring to countries known to SMDA. First item is primary.
-    See :class:`CountryItem`."""
-
-    discovery: list[DiscoveryItem]
-    """A list referring to discoveries known to SMDA. First item is primary.
-    See :class:`DiscoveryItem`."""
-
-    field: list[FieldItem]
-    """A list referring to fields known to SMDA. First item is primary.
-    See :class:`FieldItem`."""
-
-    stratigraphic_column: StratigraphicColumn
-    """Reference to stratigraphic column known to SMDA.
-    See :class:`StratigraphicColumn`."""