cognite-neat 0.127.31__py3-none-any.whl → 0.128.1__py3-none-any.whl

cognite/neat/_config.py

@@ -1,9 +1,12 @@
 import sys
 from pathlib import Path
+from typing import Any, Literal, TypeAlias
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 
+from cognite.neat._exceptions import UserInputError
 from cognite.neat._issues import ConsistencyError, ModelSyntaxError
+from cognite.neat._utils.text import humanize_collection
 from cognite.neat._utils.useful_types import ModusOperandi
 
 if sys.version_info >= (3, 11):
@@ -11,8 +14,14 @@ if sys.version_info >= (3, 11):
 else:
     import tomli  # type: ignore
 
+PredefinedProfile: TypeAlias = Literal["legacy-additive", "legacy-rebuild", "deep-additive", "deep-rebuild"]
 
-class ValidationConfig(BaseModel, populate_by_name=True):
+
+class ConfigModel(BaseModel):
+    model_config = ConfigDict(populate_by_name=True, validate_assignment=True)
+
+
+class ValidationConfig(ConfigModel):
     """Validation configuration."""
 
     exclude: list[str] = Field(default_factory=list)
@@ -71,18 +80,45 @@ class ValidationConfig(BaseModel, populate_by_name=True):
         return f"Excluded Rules: {', '.join(self.exclude)}"
 
 
-class ModelingConfig(BaseModel, populate_by_name=True):
+class ModelingConfig(ConfigModel):
     """Modeling configuration."""
 
     mode: ModusOperandi = "additive"
 
 
-class NeatConfig(BaseModel, populate_by_name=True):
+class AlphaFlagConfig(ConfigModel):
+    """Alpha feature flags configuration."""
+
+    fix_validation_issues: bool = Field(
+        default=False,
+        description="If enabled, Neat will attempt to automatically fix certain validation issues in the data model.",
+    )
+
+    def __setattr__(self, key: str, value: Any) -> None:
+        """Set attribute value or raise AttributeError."""
+        if key in self.model_fields:
+            super().__setattr__(key, value)
+        else:
+            available_flags = humanize_collection(type(self).model_fields.keys())
+            raise UserInputError(f"Alpha flag '{key}' not found. Available flags: {available_flags}.")
+
+    def _repr_html_(self) -> str:
+        """HTML representation for Jupyter notebooks."""
+        lines = ["<b>Alpha Feature Flags:</b>"]
+        for field_name, field in type(self).model_fields.items():
+            value = getattr(self, field_name)
+            display = "Enabled" if value else "Disabled"
+            lines.append(f"<li><b>{field_name}</b>: {display} - {field.description}</li>")
+        return "<ul>" + "\n".join(lines) + "</ul>"
+
+
+class NeatConfig(ConfigModel):
     """Configuration for a custom profile."""
 
     profile: str
     validation: ValidationConfig
     modeling: ModelingConfig
+    alpha: AlphaFlagConfig = Field(default_factory=AlphaFlagConfig)
 
     def __str__(self) -> str:
         """Human-readable configuration summary."""
@@ -93,8 +129,19 @@ class NeatConfig(BaseModel, populate_by_name=True):
         ]
         return "\n".join(lines)
 
+    @classmethod
+    def create_predefined(cls, profile: PredefinedProfile = "legacy-additive") -> "NeatConfig":
+        """Create NeatConfig from internal profiles."""
+        available_profiles = internal_profiles()
+        if profile not in available_profiles:
+            raise UserInputError(
+                f"Profile {profile!r} not found. Available predefined profiles: "
+                f"{humanize_collection(available_profiles.keys())}."
+            )
+        return available_profiles[profile]
+
 
-def internal_profiles() -> dict[str, NeatConfig]:
+def internal_profiles() -> dict[PredefinedProfile, NeatConfig]:
     """Get internal NeatConfig profile by name."""
     return {
         "legacy-additive": NeatConfig(
@@ -136,7 +183,7 @@ def internal_profiles() -> dict[str, NeatConfig]:
     }
 
 
-def get_neat_config(config_file_name: str, profile: str) -> NeatConfig:
+def get_neat_config_from_file(config_file_name: str, profile: str) -> NeatConfig:
     """Get NeatConfig from file or internal profiles.
 
     Args:

cognite/neat/_session/_physical.py

@@ -68,7 +68,7 @@ class PhysicalDataModel:
 
 @session_wrapper
 class ReadPhysicalDataModel:
-    """Read physical data model from various sources into NeatSession graph store."""
+    """Read physical data model from various sources into NeatSession store."""
 
     def __init__(self, store: NeatStore, client: NeatClient, config: NeatConfig) -> None:
         self._store = store
@@ -130,7 +130,12 @@ class ReadPhysicalDataModel:
         return self._store.read_physical(reader, on_success)
 
     def excel(self, io: Any) -> None:
-        """Read physical data model from Excel file"""
+        """Read physical data model from Excel file
+
+        Args:
+            io (Any): The file path or buffer to read from.
+
+        """
 
         path = NeatReader.create(io).materialize_path()
         reader = DMSTableImporter.from_excel(path)
@@ -165,7 +170,7 @@ class ReadPhysicalDataModel:
 
 @session_wrapper
 class WritePhysicalDataModel:
-    """Write physical data model to various sources from NeatSession graph store."""
+    """Write physical data model to various sources from NeatSession store."""
 
     def __init__(self, store: NeatStore, client: NeatClient, config: NeatConfig) -> None:
         self._store = store

cognite/neat/_session/_session.py

@@ -1,11 +1,10 @@
 import json
-from typing import Literal
 
 from cognite.client import ClientConfig, CogniteClient
 
 from cognite.neat import _version
 from cognite.neat._client import NeatClient
-from cognite.neat._config import internal_profiles
+from cognite.neat._config import NeatConfig, PredefinedProfile
 from cognite.neat._state_machine import EmptyState, PhysicalState
 from cognite.neat._store import NeatStore
 from cognite.neat._utils.http_client import ParametersRequest, SuccessResponse
@@ -20,24 +19,18 @@ class NeatSession:
     """A session is an interface for neat operations."""
 
     def __init__(
-        self,
-        client: CogniteClient | ClientConfig,
-        config: Literal["legacy-additive", "legacy-rebuild", "deep-additive", "deep-rebuild"] | None = None,
+        self, client: CogniteClient | ClientConfig, config: PredefinedProfile | NeatConfig = "legacy-additive"
     ) -> None:
         """Initialize a Neat session.
 
         Args:
             client (CogniteClient | ClientConfig): The Cognite client or client configuration to use for the session.
-            config (Literal["legacy-additive", "legacy-rebuild", "deep-additive", "deep-rebuild"] | None):
+            config (Literal["legacy-additive", "legacy-rebuild", "deep-additive", "deep-rebuild"] | NeatConfig):
                 The configuration profile to use for the session.
-                If None, the default profile "legacy-additive" is used. Meaning that Neat will perform additive modeling
-                and apply only validations that were part of the legacy Neat version."""
-
-        # Load configuration
-        if config and config not in internal_profiles():
-            raise ValueError(f"Profile '{config}' not found among internal profiles.")
-
-        self._config = internal_profiles()[config or "legacy-additive"]
+                Defaults to "legacy-additive". This means Neat will perform additive modeling
+                and apply only validations that were part of the legacy Neat version.
+        """
+        self._config = NeatConfig.create_predefined(config) if isinstance(config, str) else config
 
         # Use configuration for physical data model
         self._store = NeatStore()

cognite/neat/_version.py

@@ -1,2 +1,2 @@
-__version__ = "0.127.31"
+__version__ = "0.128.1"
 __engine__ = "^2.0.4"

cognite/neat/v0/core/_utils/auth.py

@@ -93,7 +93,7 @@ class EnvironmentVariables:
     LOGIN_FLOW: _LOGIN_FLOW = "infer"
     IDP_CLIENT_ID: str | None = None
     IDP_CLIENT_SECRET: str | None = None
-    TOKEN: str | None = None
+    CDF_TOKEN: str | None = None
 
     IDP_TENANT_ID: str | None = None
     IDP_TOKEN_URL: str | None = None
@@ -103,7 +103,7 @@ class EnvironmentVariables:
     IDP_SCOPES: str | None = None
     IDP_AUTHORITY_URL: str | None = None
     CDF_MAX_WORKERS: int | None = None
-    CDF_TIMEOUT: int | None = None
+    CDF_CLIENT_TIMEOUT: int | None = None
     CDF_REDIRECT_PORT: int = 53_000
 
     def __post_init__(self) -> None:
@@ -155,7 +155,7 @@ class EnvironmentVariables:
             LOGIN_FLOW=os.environ.get("LOGIN_FLOW", "infer"),  # type: ignore[arg-type]
             IDP_CLIENT_ID=os.environ.get("IDP_CLIENT_ID"),
             IDP_CLIENT_SECRET=os.environ.get("IDP_CLIENT_SECRET"),
-            TOKEN=os.environ.get("TOKEN"),
+            CDF_TOKEN=os.environ.get("CDF_TOKEN"),
             CDF_URL=os.environ.get("CDF_URL"),
             IDP_TOKEN_URL=os.environ.get("IDP_TOKEN_URL"),
             IDP_TENANT_ID=os.environ.get("IDP_TENANT_ID"),
@@ -163,7 +163,7 @@ class EnvironmentVariables:
             IDP_SCOPES=os.environ.get("IDP_SCOPES"),
             IDP_AUTHORITY_URL=os.environ.get("IDP_AUTHORITY_URL"),
             CDF_MAX_WORKERS=int(os.environ["CDF_MAX_WORKERS"]) if "CDF_MAX_WORKERS" in os.environ else None,
-            CDF_TIMEOUT=int(os.environ["CDF_TIMEOUT"]) if "CDF_TIMEOUT" in os.environ else None,
+            CDF_CLIENT_TIMEOUT=int(os.environ["CDF_CLIENT_TIMEOUT"]) if "CDF_CLIENT_TIMEOUT" in os.environ else None,
             CDF_REDIRECT_PORT=int(os.environ.get("CDF_REDIRECT_PORT", 53_000)),
         )
 
@@ -179,7 +179,7 @@ class EnvironmentVariables:
             IDP_CLIENT_ID="neat",
             IDP_CLIENT_SECRET="secret",
             IDP_SCOPES="project:read,project:write",
-            CDF_TIMEOUT=60,
+            CDF_CLIENT_TIMEOUT=60,
             CDF_MAX_WORKERS=3,
         )
 
@@ -228,9 +228,9 @@ class EnvironmentVariables:
         )
 
     def get_token(self) -> Token:
-        if not self.TOKEN:
-            raise KeyError("TOKEN must be set in the environment", "TOKEN")
-        return Token(self.TOKEN)
+        if not self.CDF_TOKEN:
+            raise KeyError("CDF_TOKEN must be set in the environment", "CDF_TOKEN")
+        return Token(self.CDF_TOKEN)
 
     def get_client(self) -> CogniteClient:
         config = ClientConfig(
@@ -239,7 +239,7 @@ class EnvironmentVariables:
             credentials=self.get_credentials(),
             base_url=self.cdf_url,
             max_workers=self.CDF_MAX_WORKERS,
-            timeout=self.CDF_TIMEOUT,
+            timeout=self.CDF_CLIENT_TIMEOUT,
         )
         return CogniteClient(config)
 
@@ -298,7 +298,7 @@ def _prompt_user() -> EnvironmentVariables:
     variables.LOGIN_FLOW = login_flow  # type: ignore[assignment]
     if login_flow == "token":
         token = Prompt.ask("Enter token")
-        variables.TOKEN = token
+        variables.CDF_TOKEN = token
         return variables
 
     variables.IDP_CLIENT_ID = Prompt.ask("Enter IDP Client ID")

cognite/neat/v1.py

@@ -1,3 +1,4 @@
+from ._config import NeatConfig
 from ._session import NeatSession
 
-__all__ = ["NeatSession"]
+__all__ = ["NeatConfig", "NeatSession"]

{cognite_neat-0.127.31.dist-info → cognite_neat-0.128.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cognite-neat
-Version: 0.127.31
+Version: 0.128.1
 Summary: Knowledge graph transformation
 Project-URL: Documentation, https://cognite-neat.readthedocs-hosted.com/
 Project-URL: Homepage, https://cognite-neat.readthedocs-hosted.com/

{cognite_neat-0.127.31.dist-info → cognite_neat-0.128.1.dist-info}/RECORD

@@ -1,10 +1,10 @@
 cognite/neat/__init__.py,sha256=Lo4DbjDOwnhCYUoAgPp5RG1fDdF7OlnomalTe7n1ydw,211
-cognite/neat/_config.py,sha256=W42Lj5PNR9X1is9vIPHLHvkl_rpU5PCrDuQI4zSNTJQ,6359
+cognite/neat/_config.py,sha256=NXObeA-860LV40KlY4orsqjMGACa0jKRz2UE5L9kH6U,8401
 cognite/neat/_exceptions.py,sha256=ox-5hXpee4UJlPE7HpuEHV2C96aLbLKo-BhPDoOAzhA,1650
 cognite/neat/_issues.py,sha256=wH1mnkrpBsHUkQMGUHFLUIQWQlfJ_qMfdF7q0d9wNhY,1871
-cognite/neat/_version.py,sha256=rvkcySAmEggTDqAglgVEXmb2SsDZO3WaXGVcdNwHKNU,47
+cognite/neat/_version.py,sha256=8_r13miyHXqhT9zkzKnh5TPTyZ_MrFhvDyCdgRp7mMg,46
 cognite/neat/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cognite/neat/v1.py,sha256=owqW5Mml2DSZx1AvPvwNRTBngfhBNrQ6EH-7CKL7Jp0,61
+cognite/neat/v1.py,sha256=sLLxIO5MPsC0hsaex7HmMVVOzH1A8KTQBF2INrp_YCg,107
 cognite/neat/_client/__init__.py,sha256=75Bh7eGhaN4sOt3ZcRzHl7pXaheu1z27kmTHeaI05vo,114
 cognite/neat/_client/api.py,sha256=nbxCdWBXcTVM6MrQeT_VpB6ehfoI544JHPFq-ejQKCY,292
 cognite/neat/_client/client.py,sha256=h0HELAHiBFxMNInkDu4AzbgfEIXqeM0BqqnMBmXjgi0,903
@@ -86,9 +86,9 @@ cognite/neat/_data_model/validation/dms/_views.py,sha256=M4egIa7UAMGtZlqzIxx6ZzL
 cognite/neat/_session/__init__.py,sha256=owqW5Mml2DSZx1AvPvwNRTBngfhBNrQ6EH-7CKL7Jp0,61
 cognite/neat/_session/_issues.py,sha256=E8UQeSJURg2dm4MF1pfD9dp-heSRT7pgQZgKlD1-FGs,2723
 cognite/neat/_session/_opt.py,sha256=QcVK08JMmVzJpD0GKHelbljMOQi6CMD1w-maQOlbyZQ,1350
-cognite/neat/_session/_physical.py,sha256=0EdpFS5v4pk4XJju8vZm3pHIM4AlSaCjxGRKeMAcq9g,11304
+cognite/neat/_session/_physical.py,sha256=ajNanS87THBESx_y1x6p6LomqOe51b197VKPaBPLZ30,11377
 cognite/neat/_session/_result.py,sha256=po2X4s-Tioe0GQAGCfK862hKXNRX5YjJZsEzNcTC8nI,7879
-cognite/neat/_session/_session.py,sha256=tWEvzi_85Ji52i2q5vJ7xIg3yR-8ywVCH8FjgncdlnU,3471
+cognite/neat/_session/_session.py,sha256=BNDrG5VdjviDGHiZD9HZcyuDCePdZAGHE-n0Yo8FW7Q,3238
 cognite/neat/_session/_wrappers.py,sha256=9t_MnJ0Sw_v-f6oTIh8dtAT-3oEbqumGuND97aPCC3M,3581
 cognite/neat/_session/_html/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cognite/neat/_session/_html/_render.py,sha256=fD8iee4ql50CrHGH41SSh9Tw1lM0tHt-NF0OnnxHosg,1193
@@ -268,7 +268,7 @@ cognite/neat/v0/core/_store/_instance.py,sha256=zt7pgYwgMbnAwz7Xn-_AiMsXhbBdwXWB
 cognite/neat/v0/core/_store/_provenance.py,sha256=Q96wkVXRovO_uTlNvwCAOl6pAoWItTgFq1F79L_FqBk,7335
 cognite/neat/v0/core/_store/exceptions.py,sha256=dTaBSt7IV7XWtS3EsE8lBX1Dv3tfWX1nIEgGHkluy3s,1668
 cognite/neat/v0/core/_utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cognite/neat/v0/core/_utils/auth.py,sha256=CAAmIYT_Cy458XXsx10ggPhatPbL6sGt90C3DpJAog0,14766
+cognite/neat/v0/core/_utils/auth.py,sha256=SHGujntO3_dGMzCXyF6R24ECtN8DZmmM_1cKigD6byk,14840
 cognite/neat/v0/core/_utils/auxiliary.py,sha256=lflbBC_cxO3PyQGvnwIGDZZIOSGNNyNrbawaFe8tNys,7115
 cognite/neat/v0/core/_utils/collection_.py,sha256=hYyvje47AAvY7sCmZy0NouX1OMVKLhJ6qAzwg0DIOhg,2382
 cognite/neat/v0/core/_utils/graph_transformations_report.py,sha256=-V0LM9BI_bHT6PTTG9Qby4PGtFkYU3cxtF0cz8KoKek,1238
@@ -313,7 +313,7 @@ cognite/neat/v0/session/engine/__init__.py,sha256=D3MxUorEs6-NtgoICqtZ8PISQrjrr4
 cognite/neat/v0/session/engine/_import.py,sha256=1QxA2_EK613lXYAHKQbZyw2yjo5P9XuiX4Z6_6-WMNQ,169
 cognite/neat/v0/session/engine/_interface.py,sha256=3W-cYr493c_mW3P5O6MKN1xEQg3cA7NHR_ev3zdF9Vk,533
 cognite/neat/v0/session/engine/_load.py,sha256=u0x7vuQCRoNcPt25KJBJRn8sJabonYK4vtSZpiTdP4k,5201
-cognite_neat-0.127.31.dist-info/METADATA,sha256=M2giADSPBb8V9B1ejRjCNgGcYL8hZCdPoyg3Ddwrt9M,9150
-cognite_neat-0.127.31.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-cognite_neat-0.127.31.dist-info/licenses/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
-cognite_neat-0.127.31.dist-info/RECORD,,
+cognite_neat-0.128.1.dist-info/METADATA,sha256=AfgJZmmNY7WbFk1_4pTwjfxNXsJiVvNW_eD29cQWlfE,9149
+cognite_neat-0.128.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+cognite_neat-0.128.1.dist-info/licenses/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
+cognite_neat-0.128.1.dist-info/RECORD,,