Errors

`cognite.neat._issues.errors` #

`DefaultPydanticError` `dataclass` #

Bases: NeatError, ValueError

{type}: {msg} [loc={loc}]

`NeatError` `dataclass` #

Bases: NeatIssue, Exception

This is the base class for all exceptions (errors) used in Neat.

`from_errors(errors, **kwargs)` `classmethod` #

Convert a list of pydantic errors to a list of Error instances.

This is intended to be overridden in subclasses to handle specific error types.

`RowError` `dataclass` #

Bases: NeatError, ValueError

In {sheet_name}, row={row}, column={column}: {msg}. [type={type}, input_value={input}]

`AuthorizationError` `dataclass` #

Bases: NeatError, RuntimeError

Missing authorization for {action}: {reason}

`CDFMissingClientError` `dataclass` #

Bases: NeatError, RuntimeError

CDF client is required: {reason}

`FileMissingRequiredFieldError` `dataclass` #

Bases: NeatError, ValueError

Missing required {field_name} in {filepath}: {field}

`FileNotAFileError` `dataclass` #

Bases: NeatError, FileNotFoundError

{filepath} is not a file

`FileNotFoundNeatError` `dataclass` #

Bases: NeatError, FileNotFoundError

File {filepath} not found

`FileReadError` `dataclass` #

Bases: NeatError, RuntimeError

Error when reading file, {filepath}: {reason}

`FileTypeUnexpectedError` `dataclass` #

Bases: NeatError, TypeError

Unexpected file type: {filepath}. Expected format: {expected_format}

`NeatYamlError` `dataclass` #

Bases: NeatError, YAMLError

Invalid YAML: {reason}

`NeatImportError` `dataclass` #

Bases: NeatError, ImportError

The functionality requires {module}. You can include it in your neat installation with pip install "cognite-neat[{neat_extra}]".

`NeatTypeError` `dataclass` #

Bases: NeatError, TypeError

{raw_message}

`NeatValueError` `dataclass` #

Bases: NeatError, ValueError

{raw_message}

`RegexViolationError` `dataclass` #

Bases: NeatError, ValueError

Value, {value} in {location} failed regex, {regex}, validation. Make sure that the name follows the regex pattern.

`PropertyDefinitionDuplicatedError` `dataclass` #

Bases: PropertyError[T_Identifier]

The {resource_type} with identifier {identifier} has multiple definitions for the property {property_name} with values {property_values}

`PropertyDefinitionError` `dataclass` #

Bases: PropertyError[T_Identifier]

Invalid property definition for {resource_type} {identifier}.{property_name}: {reason}

`PropertyMappingDuplicatedError` `dataclass` #

Bases: PropertyError[T_Identifier], Generic[T_Identifier, T_ReferenceIdentifier]

The {resource_type} with identifier {identifier}.{property_name} is mapped to by: {mappings}. Ensure that only one {mapping_type} maps to {resource_type} {identifier}.{property_name}

`PropertyNotFoundError` `dataclass` #

Bases: PropertyError, Generic[T_Identifier, T_ReferenceIdentifier]

The {resource_type} with identifier {identifier} does not have a property {property_name}

`PropertyTypeNotSupportedError` `dataclass` #

Bases: PropertyError[T_Identifier]

The {resource_type} with identifier {identifier} has a property {property_name} of unsupported type {property_type}

`ReversedConnectionNotFeasibleError` `dataclass` #

Bases: PropertyError[T_Identifier]

The {resource_type} {identifier}.{property_name} cannot be created: {reason}

`ResourceChangedError` `dataclass` #

Bases: ResourceError[T_Identifier]

The {resource_type} with identifier {identifier} has changed{changed}

`ResourceConversionError` `dataclass` #

Bases: ResourceError, ValueError

Failed to convert the {resource_type} {identifier} to {target_format}: {reason}

`ResourceCreationError` `dataclass` #

Bases: ResourceError[T_Identifier], ValueError

Failed to create {resource_type} with identifier {identifier}. The error was: {error}

`ResourceDuplicatedError` `dataclass` #

Bases: ResourceError[T_Identifier]

The {resource_type} with identifier {identifier} is duplicated in {location}

`ResourceError` `dataclass` #

Bases: NeatError, Generic[T_Identifier], RuntimeError

Base class for resource errors {resource_type} with identifier {identifier}

`ResourceMissingIdentifierError` `dataclass` #

Bases: NeatError, ValueError

The {resource_type} with name {name} is missing an identifier.

`ResourceNotDefinedError` `dataclass` #

Bases: ResourceError[T_Identifier]

The {resource_type} {identifier} is not defined in the {location}

`ResourceNotFoundError` `dataclass` #

Bases: ResourceError, Generic[T_Identifier, T_ReferenceIdentifier]

The {resource_type} with identifier '{identifier}' does not exist

`ResourceRetrievalError` `dataclass` #

Bases: ResourceError[T_Identifier]

Failed to retrieve {resource_type} with identifier {identifier}. The error was: {error}

`WorkflowConfigurationNotSetError` `dataclass` #

Bases: NeatError, RuntimeError

The configuration variable '{config_variable}' is not set. Please set the configuration before running the workflow.

`WorkFlowMissingDataError` `dataclass` #

Bases: NeatError, ValueError

In the workflow step {step_name} the following data is missing: {missing_data}.

`WorkflowStepNotInitializedError` `dataclass` #

Bases: NeatError, RuntimeError

Step {step_name} has not been initialized.

`WorkflowStepOutputError` `dataclass` #

Bases: NeatError, RuntimeError

Object type {step_type} is not supported as step output.

Step output must be of type DataContract or a FlowMessage.

Errors

cognite.neat._issues.errors #

DefaultPydanticError dataclass #

NeatError dataclass #

from_errors(errors, **kwargs) classmethod #

RowError dataclass #

AuthorizationError dataclass #

CDFMissingClientError dataclass #

FileMissingRequiredFieldError dataclass #

FileNotAFileError dataclass #

FileNotFoundNeatError dataclass #

FileReadError dataclass #

FileTypeUnexpectedError dataclass #

NeatYamlError dataclass #

NeatImportError dataclass #

NeatTypeError dataclass #

NeatValueError dataclass #

RegexViolationError dataclass #

PropertyDefinitionDuplicatedError dataclass #

PropertyDefinitionError dataclass #

PropertyMappingDuplicatedError dataclass #

PropertyNotFoundError dataclass #

PropertyTypeNotSupportedError dataclass #

ReversedConnectionNotFeasibleError dataclass #

ResourceChangedError dataclass #

ResourceConversionError dataclass #

ResourceCreationError dataclass #

ResourceDuplicatedError dataclass #

ResourceError dataclass #

ResourceMissingIdentifierError dataclass #

ResourceNotDefinedError dataclass #

ResourceNotFoundError dataclass #

ResourceRetrievalError dataclass #

WorkflowConfigurationNotSetError dataclass #

WorkFlowMissingDataError dataclass #

WorkflowStepNotInitializedError dataclass #

WorkflowStepOutputError dataclass #

`cognite.neat._issues.errors` #

`DefaultPydanticError` `dataclass` #

`NeatError` `dataclass` #

`from_errors(errors, **kwargs)` `classmethod` #

`RowError` `dataclass` #

`AuthorizationError` `dataclass` #

`CDFMissingClientError` `dataclass` #

`FileMissingRequiredFieldError` `dataclass` #

`FileNotAFileError` `dataclass` #

`FileNotFoundNeatError` `dataclass` #

`FileReadError` `dataclass` #

`FileTypeUnexpectedError` `dataclass` #

`NeatYamlError` `dataclass` #

`NeatImportError` `dataclass` #

`NeatTypeError` `dataclass` #

`NeatValueError` `dataclass` #

`RegexViolationError` `dataclass` #

`PropertyDefinitionDuplicatedError` `dataclass` #

`PropertyDefinitionError` `dataclass` #

`PropertyMappingDuplicatedError` `dataclass` #

`PropertyNotFoundError` `dataclass` #

`PropertyTypeNotSupportedError` `dataclass` #

`ReversedConnectionNotFeasibleError` `dataclass` #

`ResourceChangedError` `dataclass` #

`ResourceConversionError` `dataclass` #

`ResourceCreationError` `dataclass` #

`ResourceDuplicatedError` `dataclass` #

`ResourceError` `dataclass` #

`ResourceMissingIdentifierError` `dataclass` #

`ResourceNotDefinedError` `dataclass` #

`ResourceNotFoundError` `dataclass` #

`ResourceRetrievalError` `dataclass` #

`WorkflowConfigurationNotSetError` `dataclass` #

`WorkFlowMissingDataError` `dataclass` #

`WorkflowStepNotInitializedError` `dataclass` #

`WorkflowStepOutputError` `dataclass` #