Main

`cognite.neat._issues.warnings` #

All warnings raised by the neat package are defined here. Note this module is called 'warnings' which conflicts with the built-in Python warnings module. However, it is expected to always be used in an absolute import, and should thus not cause a naming conflict.

`DefaultWarning` `dataclass` #

Bases: NeatWarning

{category}: {warning}

`CDFAuthWarning` `dataclass` #

Bases: NeatWarning

Failed to {action}: {reason}

`CDFMaxIterationsWarning` `dataclass` #

Bases: NeatWarning

The maximum number of iterations ({max_iterations}) has been reached. {message}

`FileItemNotSupportedWarning` `dataclass` #

Bases: NeatWarning

The item {item} in {filepath} is not supported. The item will be skipped

`FileMissingRequiredFieldWarning` `dataclass` #

Bases: NeatWarning

Missing required {field_name} in {filepath}: {field}. The file will be skipped

`FileReadWarning` `dataclass` #

Bases: NeatWarning

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

`FileTypeUnexpectedWarning` `dataclass` #

Bases: NeatWarning

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

`MissingCogniteClientWarning` `dataclass` #

Bases: NeatWarning

Missing Cognite Client required for {functionality}

`NeatValueWarning` `dataclass` #

Bases: NeatWarning

{value}

`NotSupportedWarning` `dataclass` #

Bases: NeatWarning

{feature} is not supported

`RegexViolationWarning` `dataclass` #

Bases: NeatWarning

The value '{value}' of {identifier} does not match the {pattern_name} pattern '{pattern}'

`BreakingModelingPrincipleWarning` `dataclass` #

Bases: NeatWarning, ABC

{warning_class}: {specific} violates the {principle} principle. See {url} for more information.

`CDFNotSupportedWarning` `dataclass` #

Bases: NeatWarning, ABC

This is a base class for warnings for modeling issues that will likely lead to the CDF API rejecting the model.

`NotSupportedHasDataFilterLimitWarning` `dataclass` #

Bases: CDFNotSupportedWarning

The view {view_id} uses a hasData filter applied to {count} containers, which is more than the limit {limit}.

`NotSupportedViewContainerLimitWarning` `dataclass` #

Bases: CDFNotSupportedWarning

The view {view_id} maps, {count} containers, which is more than the limit {limit}.

`PrincipleMatchingSpaceAndVersionWarning` `dataclass` #

Bases: BreakingModelingPrincipleWarning

{warning_class}: {specific} violates the {principle} principle. See {url} for more information.

`PrincipleOneModelOneSpaceWarning` `dataclass` #

Bases: BreakingModelingPrincipleWarning

{warning_class}: {specific} violates the {principle} principle. See {url} for more information.

`PrincipleSolutionBuildsOnEnterpriseWarning` `dataclass` #

Bases: BreakingModelingPrincipleWarning

{warning_class}: {specific} violates the {principle} principle. See {url} for more information.

`UndefinedViewWarning` `dataclass` #

Bases: UserModelingWarning

Undefined view {value_type} has been referred as value type for property <{view_property}> of view {view_id}.

`UserModelingWarning` `dataclass` #

Bases: NeatWarning, ABC

This is a generic warning for user modeling issues. These warnings will not cause the resulting model to be invalid, but will likely lead to suboptimal performance, unnecessary complexity, or other issues.