Restricting extra fields in ConfigItem (#373)

Author: kozlov721

luxonis_ml/data/datasets/annotation.py

@@ -23,8 +23,7 @@
 from typing_extensions import Self, override
 
 from luxonis_ml.data.utils.parquet import ParquetRecord
-from luxonis_ml.typing import PathType, check_type
-from luxonis_ml.utils import BaseModelExtraForbid
+from luxonis_ml.typing import BaseModelExtraForbid, PathType, check_type
 from luxonis_ml.utils.logging import log_once
 
 KeypointVisibility: TypeAlias = Literal[0, 1, 2]

luxonis_ml/data/datasets/metadata.py

@@ -4,7 +4,7 @@
 from typing_extensions import TypedDict
 
 from luxonis_ml.data.utils.constants import LDF_VERSION
-from luxonis_ml.utils.pydantic_utils import BaseModelExtraForbid
+from luxonis_ml.typing import BaseModelExtraForbid
 
 from .source import LuxonisSource
 

luxonis_ml/data/datasets/source.py

@@ -3,7 +3,7 @@
 from pydantic import Field, field_validator
 
 from luxonis_ml.data.utils import ImageType, MediaType
-from luxonis_ml.utils import BaseModelExtraForbid
+from luxonis_ml.typing import BaseModelExtraForbid
 
 
 class LuxonisComponent(BaseModelExtraForbid):

luxonis_ml/nn_archive/config.py

@@ -2,7 +2,7 @@
 
 from pydantic import Field, field_validator
 
-from luxonis_ml.utils import BaseModelExtraForbid
+from luxonis_ml.typing import BaseModelExtraForbid
 
 from .model import Model
 

luxonis_ml/nn_archive/config_building_blocks/base_models/input.py

@@ -9,7 +9,7 @@
     InputType,
 )
 from luxonis_ml.nn_archive.utils import infer_layout
-from luxonis_ml.utils import BaseModelExtraForbid
+from luxonis_ml.typing import BaseModelExtraForbid
 
 
 class PreprocessingBlock(BaseModelExtraForbid):

luxonis_ml/nn_archive/config_building_blocks/base_models/output.py

@@ -5,7 +5,7 @@
 
 from luxonis_ml.nn_archive.config_building_blocks.enums import DataType
 from luxonis_ml.nn_archive.utils import infer_layout
-from luxonis_ml.utils import BaseModelExtraForbid
+from luxonis_ml.typing import BaseModelExtraForbid
 
 
 class Output(BaseModelExtraForbid):

luxonis_ml/nn_archive/model.py

@@ -1,6 +1,6 @@
 from pydantic import Field
 
-from luxonis_ml.utils import BaseModelExtraForbid
+from luxonis_ml.typing import BaseModelExtraForbid
 
 from .config_building_blocks import HeadType, Input, Metadata, Output
 

luxonis_ml/typing.py

@@ -3,7 +3,7 @@
 from typing import TYPE_CHECKING, Any, Literal, TypeAlias, TypeGuard, TypeVar
 
 import typeguard
-from pydantic import BaseModel
+from pydantic import BaseModel, ConfigDict
 
 # When used without installed dependencies
 if TYPE_CHECKING:  # pragma: no cover
@@ -83,7 +83,13 @@
 """A keyword dictionary of arbitrary parameters."""
 
 
-class ConfigItem(BaseModel):
+class BaseModelExtraForbid(BaseModel):
+    """BaseModel with extra fields forbidden."""
+
+    model_config: ConfigDict = ConfigDict(extra="forbid")
+
+
+class ConfigItem(BaseModelExtraForbid):
     """Configuration schema for dynamic object instantiation. Typically
     used to instantiate objects stored in registries.
 

luxonis_ml/utils/__init__.py

@@ -6,15 +6,13 @@
     from .filesystem import PUT_FILE_REGISTRY, LuxonisFileSystem
     from .graph import is_acyclic, traverse_graph
     from .logging import deprecated, log_once, setup_logging
-    from .pydantic_utils import BaseModelExtraForbid
     from .registry import AutoRegisterMeta, Registry
     from .rich_utils import make_progress_bar
 
 
 __all__ = [
     "PUT_FILE_REGISTRY",
     "AutoRegisterMeta",
-    "BaseModelExtraForbid",
     "Environ",
     "LuxonisConfig",
     "LuxonisFileSystem",

luxonis_ml/utils/config.py

@@ -5,10 +5,9 @@
 import yaml
 from typing_extensions import Self
 
-from luxonis_ml.typing import Params, PathType
+from luxonis_ml.typing import BaseModelExtraForbid, Params, PathType
 
 from .filesystem import LuxonisFileSystem
-from .pydantic_utils import BaseModelExtraForbid
 
 T = TypeVar("T", bound="LuxonisConfig")