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

cognite/neat/rules/issues/spreadsheet_file.py

@@ -1,151 +0,0 @@
-from abc import ABC
-from dataclasses import dataclass
-from pathlib import Path
-from typing import Any, ClassVar
-
-from .base import NeatValidationError
-
-__all__ = [
-    "SpreadsheetFileError",
-    "SpreadsheetNotFoundError",
-    "MetadataSheetMissingOrFailedError",
-    "SheetMissingError",
-    "ReadSpreadsheetsError",
-    "InvalidRoleError",
-]
-
-
-@dataclass(frozen=True)
-class SpreadsheetFileError(NeatValidationError, ABC):
-    description = "Error when reading spreadsheet"
-    filepath: Path
-
-
-@dataclass(frozen=True)
-class SpreadsheetNotFoundError(SpreadsheetFileError):
-    description: ClassVar[str] = "Spreadsheet not found"
-    fix: ClassVar[str] = "Make sure to provide a valid spreadsheet"
-
-    def message(self) -> str:
-        return f"Spreadsheet {self.filepath.name} not found"
-
-    def dump(self) -> dict[str, Any]:
-        output = super().dump()
-        output["spreadsheet_name"] = str(self.filepath)
-        return output
-
-
-@dataclass(frozen=True)
-class MetadataSheetMissingOrFailedError(SpreadsheetFileError):
-    description: ClassVar[str] = "Metadata sheet is missing or it failed validation for one or more fields"
-    fix: ClassVar[str] = "Make sure to define compliant Metadata sheet before proceeding"
-    hint: str | None = None
-    sheet_name: str = "Metadata"
-
-    def message(self) -> str:
-        output = (
-            f" {self.sheet_name} sheet is missing or it failed"
-            + f" validation for one or more fields in {self.filepath.name}. "
-            + self.fix
-        )
-        if self.hint:
-            output += f" Hint: {self.hint}"
-        return output
-
-
-@dataclass(frozen=True)
-class RoleMissingOrUnsupportedError(SpreadsheetFileError):
-    description: ClassVar[str] = "Role field in Metadata sheet is missing or its value is unsupported"
-    fix: ClassVar[str] = "Make sure to define compliant role in Metadata sheet before proceeding"
-
-    hint: str | None = None
-
-    def message(self) -> str:
-        output = (
-            f"Role field in Metadata sheet is missing or its value is unsupported {self.filepath.name}. " + self.fix
-        )
-        if self.hint:
-            output += f" Hint: {self.hint}"
-        return output
-
-
-@dataclass(frozen=True)
-class RoleMismatchError(SpreadsheetFileError):
-    description: ClassVar[str] = "Roles between user and reference Metadata sheets do not match"
-    fix: ClassVar[str] = "Make sure that both user and reference Metadata sheets have the same role defined"
-
-    hint: str | None = None
-
-    def message(self) -> str:
-        output = f"Roles between user and reference Metadata sheets do not match {self.filepath.name}. " + self.fix
-        if self.hint:
-            output += f" Hint: {self.hint}"
-        return output
-
-
-@dataclass(frozen=True)
-class SchemaMissingOrUnsupportedError(SpreadsheetFileError):
-    description: ClassVar[str] = "Schema field in Metadata sheet is missing or its value unsupported"
-    fix: ClassVar[str] = "Make sure to define compliant schema in Metadata sheet before proceeding"
-
-    hint: str | None = None
-
-    def message(self) -> str:
-        output = (
-            f"Schema field in Metadata sheet is missing or its value unsupported in file {self.filepath.name}. "
-            + self.fix
-        )
-        if self.hint:
-            output += f" Hint: {self.hint}"
-        return output
-
-
-@dataclass(frozen=True)
-class SheetMissingError(SpreadsheetFileError):
-    description: ClassVar[str] = "Spreadsheet(s) is missing"
-    fix: ClassVar[str] = "Make sure to provide compliant spreadsheet(s) before proceeding"
-
-    missing_spreadsheets: list[str]
-
-    def message(self) -> str:
-        if len(self.missing_spreadsheets) == 1:
-            return f"Spreadsheet {self.missing_spreadsheets[0]} is missing"
-        else:
-            return f"Spreadsheets {', '.join(self.missing_spreadsheets)} are missing"
-
-    def dump(self) -> dict[str, Any]:
-        output = super().dump()
-        output["missing_spreadsheets"] = self.missing_spreadsheets
-        return output
-
-
-@dataclass(frozen=True)
-class ReadSpreadsheetsError(SpreadsheetFileError):
-    description: ClassVar[str] = "Error reading spreadsheet(s)"
-    fix: ClassVar[str] = "Is the excel document open in another program? Is the file corrupted?"
-
-    error_message: str
-
-    def message(self) -> str:
-        return f"Error reading spreadsheet {self.filepath.name}: {self.error_message}"
-
-    def dump(self) -> dict[str, Any]:
-        output = super().dump()
-        output["error_message"] = self.error_message
-        return output
-
-
-@dataclass(frozen=True)
-class InvalidRoleError(NeatValidationError):
-    description: ClassVar[str] = "Invalid role"
-    fix: ClassVar[str] = "Make sure to provide a valid role"
-
-    provided_role: str
-
-    def message(self) -> str:
-        return f"Invalid role: {self.provided_role}"
-
-    def dump(self) -> dict[str, Any]:
-        output = super().dump()
-        output["provided_role"] = self.provided_role
-        return output

cognite/neat/rules/issues/tables.py

@@ -1,72 +0,0 @@
-from dataclasses import dataclass
-
-from .base import NeatValidationError
-
-
-@dataclass(frozen=True)
-class NotValidRDFPathError(NeatValidationError):
-    """Provided `rdfpath` is not valid, i.e. it cannot be converted to SPARQL query.
-
-    Args:
-        rdf_path: `rdfpath` that raised exception
-
-    Notes:
-        Get familiar with `rdfpath` to avoid this exception.
-    """
-
-    description = "Provided `rdfpath` is not valid, i.e. it cannot be converted to SPARQL query"
-    fix = "Get familiar with `rdfpath` and check if provided path is valid!"
-    rdf_path: str
-
-    def message(self) -> str:
-        message = f"{self.rdf_path} is not a valid rdfpath!"
-
-        message += f"\nDescription: {self.description}"
-        message += f"\nFix: {self.fix}"
-        return message
-
-
-@dataclass(frozen=True)
-class NotValidTableLookUpError(NeatValidationError):
-    """Provided `table lookup` is not valid, i.e. it cannot be converted to CDF lookup.
-
-    Args:
-        table_look_up: `table_look_up`, a part of `rawlookup`, that raised exception
-
-    Notes:
-        Get familiar with `rawlookup` and `rdfpath` to avoid this exception.
-    """
-
-    description = "Provided table lookup is not valid, i.e. it cannot be converted to CDF lookup"
-    fix = "Get familiar with RAW look up and RDF paths and check if provided rawlookup is valid"
-    table_look_up: str
-
-    def message(self) -> str:
-        message = f"{self.table_look_up} is not a valid table lookup"
-
-        message += f"\nDescription: {self.description}"
-        message += f"\nFix: {self.fix}"
-        return message
-
-
-@dataclass(frozen=True)
-class NotValidRAWLookUpError(NeatValidationError):
-    """Provided `rawlookup` is not valid, i.e. it cannot be converted to SPARQL query and CDF lookup
-
-    Args:
-        raw_look_up: `rawlookup` rule that raised exception
-
-    Notes:
-        Get familiar with `rawlookup` and `rdfpath` to avoid this exception.
-    """
-
-    description = "Provided rawlookup is not valid, i.e. it cannot be converted to SPARQL query and CDF lookup"
-    fix = "Get familiar with `rawlookup` and `rdfpath` to avoid this exception"
-    raw_look_up: str
-
-    def message(self):
-        message = f"Invalid rawlookup expected traversal | table lookup, got {self.raw_look_up}"
-
-        message += f"\nDescription: {self.description}"
-        message += f"\nFix: {self.fix}"
-        return message

cognite/neat/workflows/_exceptions.py

@@ -1,41 +0,0 @@
-from cognite.neat.exceptions import NeatException
-
-
-class InvalidStepOutputException(NeatException):
-    type_ = "invalid_step_output"
-    code = 400
-    description = "The step output is invalid."
-    example = "The step output must be a dictionary."
-
-    def __init__(self, step_type: str):
-        self.message = f"Object type {step_type} is not supported as step output"
-        super().__init__(self.message)
-
-
-class ConfigurationNotSet(NeatException):
-    type_ = "configuration_not_set"
-    code = 400
-    description = "The configuration is not set."
-    example = "The configuration must be set before running the workflow."
-
-    def __init__(self, config_variable: str):
-        self.message = (
-            f"The configuration variable '{config_variable}' is not set. "
-            f"Please set the configuration before running the workflow."
-        )
-        super().__init__(self.message)
-
-    def __str__(self):
-        return self.message
-
-
-class StepNotInitialized(NeatException):
-    def __init__(self, step_name: str):
-        self.message = f"Step {step_name} has not been initialized."
-        super().__init__(self.message)
-
-
-class StepFlowContextNotInitialized(NeatException):
-    def __init__(self, step_name: str):
-        self.message = f"Step {step_name} requires flow context which is missing."
-        super().__init__(self.message)