cognite-neat 0.88.2__py3-none-any.whl → 0.89.0__py3-none-any.whl

cognite/neat/rules/issues/dms.py

@@ -1,549 +0,0 @@
-from abc import ABC
-from dataclasses import dataclass
-from typing import Any, ClassVar
-
-from cognite.client.data_classes import data_modeling as dm
-
-from .base import NeatValidationError, ValidationWarning
-
-__all__ = [
-    "DMSSchemaError",
-    "DMSSchemaWarning",
-    "IncompleteSchemaError",
-    "DirectRelationMissingSourceWarning",
-    "ViewModelVersionNotMatchingWarning",
-    "ViewModelSpaceNotMatchingWarning",
-    "ViewMapsToTooManyContainersWarning",
-    "DuplicatedViewInDataModelError",
-    "ContainerPropertyUsedMultipleTimesError",
-    "EmptyContainerWarning",
-    "UnsupportedConnectionWarning",
-    "MultipleReferenceWarning",
-    "HasDataFilterOnNoPropertiesViewWarning",
-    "HasDataFilterAppliedToTooManyContainersWarning",
-    "ReverseRelationMissingOtherSideWarning",
-    "NodeTypeFilterOnParentViewWarning",
-    "MissingViewInModelWarning",
-    "ViewSizeWarning",
-    "ChangingContainerError",
-    "ChangingViewError",
-]
-
-
-@dataclass(frozen=True)
-class DMSSchemaError(NeatValidationError, ABC): ...
-
-
-@dataclass(frozen=True)
-class DMSSchemaWarning(ValidationWarning, ABC): ...
-
-
-@dataclass(frozen=True)
-class ViewSizeWarning(DMSSchemaWarning):
-    description = (
-        "The number of properties in the {view} view is {count} which is more than "
-        "the recommended limit of {limit} properties. This can lead to performance issues."
-    )
-    fix = "Reduce the size of the view"
-    error_name: ClassVar[str] = "ViewSizeWarning"
-
-    view_id: dm.ViewId
-    limit: int
-    count: int
-
-    def message(self) -> str:
-        return self.description.format(view=repr(self.view_id), count=self.count, limit=self.limit)
-
-    def dump(self) -> dict[str, Any]:
-        output = super().dump()
-        output["view_id"] = self.view_id.dump()
-        output["limit"] = self.limit
-        output["count"] = self.count
-        return output
-
-
-@dataclass(frozen=True)
-class IncompleteSchemaError(DMSSchemaError):
-    description = "This error is raised when the schema is claimed to be complete but missing some components"
-    fix = "Either provide the missing components or change the schema to partial"
-    missing_component: dm.ContainerId | dm.ViewId
-
-    def message(self) -> str:
-        return (
-            "The data model schema is set to be complete, however, "
-            f"the referred component {self.missing_component} is not preset."
-        )
-
-    def dump(self) -> dict[str, Any]:
-        output = super().dump()
-        output["missing_component"] = self.missing_component
-        return output
-
-
-@dataclass(frozen=True)
-class DuplicatedViewInDataModelError(DMSSchemaError):
-    description = "The view is duplicated in the DataModel"
-    fix = "Remove the duplicated view"
-    error_name: ClassVar[str] = "DuplicatedViewInDataModel"
-    referred_by: dm.DataModelId
-    view: dm.ViewId
-
-    def message(self) -> str:
-        return f"The view {self.view} is duplicated in the DataModel {self.referred_by}"
-
-    def dump(self) -> dict[str, Any]:
-        output = super().dump()
-        output["referred_by"] = self.referred_by
-        output["view"] = self.view
-        return output
-
-
-@dataclass(frozen=True)
-class DirectRelationMissingSourceWarning(DMSSchemaWarning):
-    description = "The source view referred to by the DirectRelation does not exist"
-    fix = "Create the source view"
-    error_name: ClassVar[str] = "DirectRelationMissingSource"
-    view_id: dm.ViewId
-    property: str
-
-    def message(self) -> str:
-        return f"The source view referred to by '{self.view_id.external_id}.{self.property}' does not exist."
-
-    def dump(self) -> dict[str, Any]:
-        output = super().dump()
-        output["view_id"] = self.view_id
-        output["property"] = self.property
-        return output
-
-
-@dataclass(frozen=True)
-class ViewModelVersionNotMatchingWarning(DMSSchemaWarning):
-    description = "The view model version does not match the data model version"
-    fix = "Update the view model version to match the data model version"
-    error_name: ClassVar[str] = "ViewModelVersionNotMatching"
-    view_ids: list[dm.ViewId]
-    data_model_version: str
-
-    def message(self) -> str:
-        return (
-            f"The version in the views {self.view_ids} does not match the version in the data model "
-            f"{self.data_model_version}. This is not recommended as it easily leads to confusion and errors. "
-            f"Views are very cheap and we recommend you update the version of the views to match the data"
-            f" model version, irrespective of whether the views have changed or not."
-            " The approach of having same version of model components as the model itself "
-            " is a globally recognized data modeling practice."
-        )
-
-    def dump(self) -> dict[str, Any]:
-        output = super().dump()
-        output["view_id"] = [view_id.dump() for view_id in self.view_ids]
-        output["data_model_version"] = self.data_model_version
-        return output
-
-
-@dataclass(frozen=True)
-class ViewModelSpaceNotMatchingWarning(DMSSchemaWarning):
-    description = "The view model space does not match the data model space"
-    fix = "Update the view model space to match the data model space"
-    error_name: ClassVar[str] = "ViewModelSpaceNotMatching"
-    view_ids: list[dm.ViewId]
-    data_model_space: str
-
-    def message(self) -> str:
-        return (
-            f"The space in the views {self.view_ids} does not match the space in the data model "
-            f"{self.data_model_space}. This is not recommended as it easily leads to confusion and errors. "
-            f"Views are very cheap and we recommend you always have views in the same space as the data model."
-        )
-
-    def dump(self) -> dict[str, Any]:
-        output = super().dump()
-        output["view_id"] = [view_id.dump() for view_id in self.view_ids]
-        output["data_model_space"] = self.data_model_space
-        return output
-
-
-@dataclass(frozen=True)
-class ViewMapsToTooManyContainersWarning(DMSSchemaWarning):
-    description = "The view maps to more than 10 containers which impacts read/write performance of data model"
-    fix = "Try to have as few containers as possible to which the view maps to"
-    error_name: ClassVar[str] = "ViewMapsToTooManyContainers"
-    view_id: dm.ViewId
-    container_ids: set[dm.ContainerId]
-
-    def message(self) -> str:
-        return (
-            f"The view {self.view_id} maps to total of {len(self.container_ids)},."
-            "Mapping to more than 10 containers is not recommended and can lead to poor performances."
-            "Re-iterate the data model design to reduce the number of containers to which the view maps to."
-        )
-
-    def dump(self) -> dict[str, Any]:
-        output = super().dump()
-        output["view_id"] = self.view_id.dump()
-        output["container_ids"] = [container_id.dump() for container_id in self.container_ids]
-        return output
-
-
-@dataclass(frozen=True)
-class MissingViewInModelWarning(DMSSchemaWarning):
-    description = "The data model contains view pointing to views not present in the data model"
-    fix = "Add the view(s) to the data model"
-    error_name: ClassVar[str] = "MissingViewInModel"
-    data_model_id: dm.DataModelId
-    view_ids: set[dm.ViewId]
-
-    def message(self) -> str:
-        return f"The view(s) {self.view_ids} are missing in the data model {self.data_model_id}"
-
-    def dump(self) -> dict[str, Any]:
-        output = super().dump()
-        output["data_model_id"] = self.data_model_id.dump()
-        output["view_id"] = [view_id.dump() for view_id in self.view_ids]
-        return output
-
-
-@dataclass(frozen=True)
-class ContainerPropertyUsedMultipleTimesError(DMSSchemaError):
-    description = "The container property is used multiple times by the same view property"
-    fix = "Use unique container properties for when mapping to the same container"
-    error_name: ClassVar[str] = "ContainerPropertyUsedMultipleTimes"
-    container: dm.ContainerId
-    property: str
-    referred_by: frozenset[tuple[dm.ViewId, str]]
-
-    def message(self) -> str:
-        return (
-            f"The container property {self.property} of {self.container} is used multiple times "
-            f"by the same view {self.referred_by}"
-        )
-
-    def dump(self) -> dict[str, Any]:
-        output = super().dump()
-        output["container"] = self.container
-        output["property"] = self.property
-        output["referred_by"] = sorted(self.referred_by)
-        return output
-
-
-@dataclass(frozen=True)
-class ChangingContainerError(DMSSchemaError):
-    description = "You are adding to an existing model. "
-    fix = "Keep the container the same"
-    error_name: ClassVar[str] = "ChangingContainerError"
-    container_id: dm.ContainerId
-    changed_properties: list[str] | None = None
-    changed_attributes: list[str] | None = None
-
-    def __post_init__(self):
-        # Sorting for deterministic output
-        if self.changed_properties:
-            self.changed_properties.sort()
-        if self.changed_attributes:
-            self.changed_attributes.sort()
-
-    def message(self) -> str:
-        if self.changed_properties:
-            changed = f" properties {self.changed_properties}."
-        elif self.changed_attributes:
-            changed = f" attributes {self.changed_attributes}."
-        else:
-            changed = "."
-        return (
-            f"The container {self.container_id} has changed{changed}"
-            "When extending model with extension set to addition or reshape, the container "
-            "properties must remain the same"
-        )
-
-    def dump(self) -> dict[str, Any]:
-        output = super().dump()
-        output["container_id"] = self.container_id.dump()
-        output["changed_properties"] = self.changed_properties
-        return output
-
-
-@dataclass(frozen=True)
-class ChangingViewError(DMSSchemaError):
-    description = "You are adding to an existing model. "
-    fix = "Keep the view the same"
-    error_name: ClassVar[str] = "ChangingViewError"
-    view_id: dm.ViewId
-    changed_properties: list[str] | None = None
-    changed_attributes: list[str] | None = None
-
-    def __post_init__(self):
-        # Sorting for deterministic output
-        if self.changed_properties:
-            self.changed_properties.sort()
-        if self.changed_attributes:
-            self.changed_attributes.sort()
-
-    def message(self) -> str:
-        if self.changed_properties:
-            changed = f" properties {self.changed_properties}."
-        elif self.changed_attributes:
-            changed = f" attributes {self.changed_attributes}."
-        else:
-            changed = "."
-
-        return (
-            f"The view {self.view_id} has changed{changed}"
-            "When extending model with extension set to addition, the view properties must remain the same"
-        )
-
-    def dump(self) -> dict[str, Any]:
-        output = super().dump()
-        output["view_id"] = self.view_id.dump()
-        output["difference"] = self.changed_properties
-        return output
-
-
-@dataclass(frozen=True)
-class EntityIDNotDMSCompliantWarning(DMSSchemaWarning):
-    description = "The entity ID, {entity_id} of type {entity_type}, is not DMS compliant. Violating regex {regex}"
-    fix = "Change the entity ID to be DMS compliant"
-    error_name: ClassVar[str] = "EntityIDNotDMSCompliantWarning"
-    entity_id: str
-    entity_type: str
-    regex: str
-
-    def message(self) -> str:
-        return self.description.format(entity_id=self.entity_id, entity_type=self.entity_type, regex=self.regex)
-
-    def dump(self) -> dict[str, Any]:
-        output = super().dump()
-        output["entity_id"] = self.entity_id
-        output["dms_type"] = self.entity_type
-        output["regex"] = self.regex
-        return output
-
-
-@dataclass(frozen=True)
-class EmptyContainerWarning(DMSSchemaWarning):
-    description = "The container is empty"
-    fix = "Add data to the container"
-    error_name: ClassVar[str] = "EmptyContainerWarning"
-    container_id: dm.ContainerId
-
-    def message(self) -> str:
-        return (
-            f"The container {self.container_id} is empty. Is this intended? Skipping this container "
-            "in the data model."
-        )
-
-    def dump(self) -> dict[str, Any]:
-        output = super().dump()
-        output["container_id"] = self.container_id.dump()
-        return output
-
-
-@dataclass(frozen=True)
-class UnsupportedConnectionWarning(DMSSchemaWarning):
-    description = "The connection type is not supported by neat"
-    fix = "Change the connection to a supported type"
-    error_name: ClassVar[str] = "UnsupportedConnectionWarning"
-    view_id: dm.ViewId
-    property: str
-    connection: str
-
-    def message(self) -> str:
-        return (
-            f"The connection {self.connection} in {self.view_id}.{self.property} is not supported."
-            "This property will be ignored."
-        )
-
-    def dump(self) -> dict[str, Any]:
-        output = super().dump()
-        output["view_id"] = self.view_id.dump()
-        output["property"] = self.property
-        output["connection"] = self.connection
-        return output
-
-
-@dataclass(frozen=True)
-class ReverseRelationMissingOtherSideWarning(DMSSchemaWarning):
-    description = "The relation is missing the other side"
-    fix = "Add the other side of the relation"
-    error_name: ClassVar[str] = "ReverseRelationMissingOtherSideWarning"
-    view_id: dm.ViewId
-    property: str
-
-    def message(self) -> str:
-        return f"The reverse relation specified in {self.view_id}.{self.property} is missing the other side."
-
-    def dump(self) -> dict[str, Any]:
-        output = super().dump()
-        output["view_id"] = self.view_id.dump()
-        output["property"] = self.property
-        return output
-
-
-@dataclass(frozen=True)
-class MultipleReferenceWarning(DMSSchemaWarning):
-    description = "The view is implements multiple views from other spaces"
-    fix = "Neat expects maximum one implementation of a view from another space"
-    error_name: ClassVar[str] = "MultipleReferenceWarning"
-    view_id: dm.ViewId
-    implements: list[dm.ViewId]
-
-    def message(self) -> str:
-        return f"The view {self.view_id} implements multiple views from other spaces: {self.implements}. " + self.fix
-
-    def dump(self) -> dict[str, Any]:
-        output = super().dump()
-        output["view_id"] = self.view_id.dump()
-        output["implements"] = [view.dump() for view in self.implements]
-        return output
-
-
-@dataclass(frozen=True)
-class HasDataFilterOnNoPropertiesViewWarning(DMSSchemaWarning):
-    description = "Attempting to set a HasData filter on a view without properties."
-    fix = "Add properties to the view or use a node type filter"
-    error_name: ClassVar[str] = "HasDataFilterOnNoPropertiesViewWarning"
-    view_id: dm.ViewId
-
-    def message(self) -> str:
-        return (
-            f"Cannot set hasData filter on view {self.view_id} as it does not have properties in any containers. "
-            "Using a node type filter instead."
-        )
-
-    def dump(self) -> dict[str, Any]:
-        output = super().dump()
-        output["view_id"] = self.view_id.dump()
-        return output
-
-
-@dataclass(frozen=True)
-class HasDataFilterAppliedToTooManyContainersWarning(DMSSchemaWarning):
-    description = "The view filter hasData applied to more than 10 containers this will cause DMS API Error"
-    fix = "Do not map to more than 10 containers, alternatively override the filter by using rawFilter"
-    error_name: ClassVar[str] = "HasDataFilterAppliedToTooManyContainers"
-    view_id: dm.ViewId
-    container_ids: set[dm.ContainerId]
-
-    def message(self) -> str:
-        return (
-            f"The view {self.view_id} HasData filter applied to total of {len(self.container_ids)},."
-            "Applying HasData filter to more than 10 containers is not recommended and can lead to DMS API error."
-            "Re-iterate the data model design to reduce the number of containers to which the view maps to."
-        )
-
-    def dump(self) -> dict[str, Any]:
-        output = super().dump()
-        output["view_id"] = self.view_id.dump()
-        output["container_ids"] = [container_id.dump() for container_id in self.container_ids]
-        return output
-
-
-@dataclass(frozen=True)
-class RawFilterAppliedToViewWarning(DMSSchemaWarning):
-    description = "Raw filter is applied to a view, which is against the neat data modeling lifecycle."
-    fix = "Do not use raw filter, instead use HasData filter or nodeType filter or change the data model design."
-    error_name: ClassVar[str] = "RawFilterAppliedToView"
-    view_id: dm.ViewId
-
-    def message(self) -> str:
-        return (
-            f"RawFilter applied to the view {self.view_id}."
-            " The usage of RawFilter is against the neat team recommendations and the neat data modeling lifecycle."
-            " When opting for raw filter, the user is responsible for any errors that arise in neat."
-        )
-
-    def dump(self) -> dict[str, Any]:
-        output = super().dump()
-        output["view_id"] = self.view_id.dump()
-        return output
-
-
-@dataclass(frozen=True)
-class NodeTypeFilterOnParentViewWarning(DMSSchemaWarning):
-    description = (
-        "Setting a node type filter on a parent view. This is not "
-        "recommended as parent views are typically used for multiple type of nodes."
-    )
-    fix = "Use a HasData filter instead"
-    error_name: ClassVar[str] = "NodeTypeFilterOnParentViewWarning"
-    view_id: dm.ViewId
-
-    def message(self) -> str:
-        return (
-            f"Setting a node type filter on parent view {self.view_id}. This is not recommended as "
-            "parent views are typically used for multiple types of nodes."
-        )
-
-    def dump(self) -> dict[str, Any]:
-        output = super().dump()
-        output["view_id"] = self.view_id.dump()
-        return output
-
-
-@dataclass(frozen=True)
-class HasDataFilterOnViewWithReferencesWarning(DMSSchemaWarning):
-    description = (
-        "Setting a hasData filter on a solution view which reference other containers is not recommended."
-        "This will lead to no nodes being returned when querying the solution view."
-    )
-    fix = "Use a node type filter instead"
-    error_name: ClassVar[str] = "HasDataFilterOnReferencedViewWarning"
-
-    view_id: dm.ViewId
-    references: list[dm.ViewId]
-
-    def message(self) -> str:
-        return (
-            f"Setting a hasData filter on view {self.view_id} which references other views {self.references}. "
-            "This is not recommended as it will lead to no nodes being returned when querying the solution view."
-        )
-
-    def dump(self) -> dict[str, Any]:
-        output = super().dump()
-        output["view_id"] = self.view_id.dump()
-        output["references"] = [view.dump() for view in sorted(self.references, key=lambda x: x.as_tuple())]
-        return output
-
-
-@dataclass(frozen=True)
-class OtherDataModelsInSpaceWarning(DMSSchemaWarning):
-    description = "The space contains other data models"
-    fix = "Move the data models to their respective spaces."
-    error_name: ClassVar[str] = "OtherDataModelsInSpaceWarning"
-    space: str
-    data_models: list[dm.DataModelId]
-
-    def message(self) -> str:
-        return (
-            f"The space {self.space} contains data models from other spaces: {self.data_models}. {self.fix}"
-            " It is recommended to only have one data model per space. This avoid potential conflicts and "
-            "makes it easier to manage the data models."
-        )
-
-    def dump(self) -> dict[str, Any]:
-        output = super().dump()
-        output["space"] = self.space
-        output["data_models"] = [data_model.dump() for data_model in self.data_models]
-        return output
-
-
-@dataclass(frozen=True)
-class SolutionOnTopOfSolutionModelWarning(DMSSchemaWarning):
-    description = "The data model is a solution on top of another solution"
-    fix = "Use the base solution as the data model"
-    error_name: ClassVar[str] = "SolutionOnTopOfSolutionModelWarning"
-    data_model: dm.DataModelId
-    base_data_model: dm.DataModelId
-
-    def message(self) -> str:
-        return (
-            f"The data model {self.data_model} is a solution model on top of another solution {self.base_data_model} "
-            "model. This is not recommended as it can lead to confusion and errors. It is very hard to "
-            "maintain a nested structure of solution models. Instead, only build solution models on "
-            "top of enterprise models."
-        )
-
-    def dump(self) -> dict[str, Any]:
-        output = super().dump()
-        output["data_model"] = self.data_model.dump()
-        output["base_data_model"] = self.base_data_model.dump()
-        return output