Skip to content

Validation

cognite.pygen._core.validation

This module contains functions for validating the uniqueness of names in the generated classes.

_validate(items, attributes, id_attribute, class_name)

Check that the given attributes are unique for each item in the list

Source code in cognite/pygen/_core/validation.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
53
def _validate(items: list[Any], attributes: list[str], id_attribute: str, class_name: str) -> None:
    """Check that the given attributes are unique for each item in the list"""
    name_conflicts: list[tuple[str, list[dm.VersionedDataModelingId]]] = []
    for prop in attributes:
        ids_by_value = defaultdict(list)
        for item in items:
            value = cast(str, getattr(item, prop))
            id_ = cast(dm.VersionedDataModelingId, getattr(item, id_attribute))
            ids_by_value[value].append(id_)
        for prop, view_ids in ids_by_value.items():
            if len(view_ids) > 1:
                name_conflicts.append((prop, view_ids))
    if name_conflicts:
        raise NameConflict(name_conflicts, class_name)

validate_api_classes_unique_names(api_classes)

Checks that fields that are used in shared namespaces the API classes have unique names.

Source code in cognite/pygen/_core/validation.py 
30
31
32
def validate_api_classes_unique_names(api_classes: list[APIClass]) -> None:
    """Checks that fields that are used in shared namespaces the API classes have unique names."""
    _validate(api_classes, _APICLASS_UNIQUE_PROPERTIES, "view_id", APIClass.__name__)

validate_data_classes_unique_name(data_classes)

Checks that fields that are used in shared namespaces the data classes have unique names.

Source code in cognite/pygen/_core/validation.py 
25
26
27
def validate_data_classes_unique_name(data_classes: list[DataClass]) -> None:
    """Checks that fields that are used in shared namespaces the data classes have unique names."""
    _validate(data_classes, _DATACLASS_UNIQUE_PROPERTIES, "view_id", DataClass.__name__)

validate_multi_api_classes_unique_names(multi_api_classes)

Checks that fields that are used in shared namespaces the MultiAPI classes have unique names.

Source code in cognite/pygen/_core/validation.py 
35
36
37
def validate_multi_api_classes_unique_names(multi_api_classes: list[MultiAPIClass]) -> None:
    """Checks that fields that are used in shared namespaces the MultiAPI classes have unique names."""
    _validate(multi_api_classes, _MULTIAPICLASS_UNIQUE_PROPERTIES, "model_id", MultiAPIClass.__name__)