cognite-extractor-utils 7.4.8__tar.gz → 7.4.9__tar.gz

{cognite_extractor_utils-7.4.8 → cognite_extractor_utils-7.4.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cognite-extractor-utils
-Version: 7.4.8
+Version: 7.4.9
 Summary: Utilities for easier development of extractors for CDF
 Home-page: https://github.com/cognitedata/python-extractor-utils
 License: Apache-2.0

{cognite_extractor_utils-7.4.8 → cognite_extractor_utils-7.4.9}/cognite/extractorutils/__init__.py

@@ -16,5 +16,5 @@
 Cognite extractor utils is a Python package that simplifies the development of new extractors.
 """
 
-__version__ = "7.4.8"
+__version__ = "7.4.9"
 from .base import Extractor

{cognite_extractor_utils-7.4.8 → cognite_extractor_utils-7.4.9}/cognite/extractorutils/configtools/__init__.py

@@ -90,6 +90,7 @@ from cognite.extractorutils.exceptions import InvalidConfigError
 from .elements import (
     AuthenticatorConfig,
     BaseConfig,
+    CastableInt,
     CertificateConfig,
     CogniteConfig,
     ConfigType,
@@ -99,6 +100,7 @@ from .elements import (
     LocalStateStoreConfig,
     LoggingConfig,
     MetricsConfig,
+    PortNumber,
     RawDestinationConfig,
     RawStateStoreConfig,
     StateStoreConfig,

{cognite_extractor_utils-7.4.8 → cognite_extractor_utils-7.4.9}/cognite/extractorutils/configtools/elements.py

@@ -744,3 +744,43 @@ class IgnorePattern:
             _logger.warning("'options' is preferred over 'flags' as this may be removed in a future release")
             self.options = self.flags
             self.flags = None
+
+
+class CastableInt(int):
+    """
+    Represents an integer in a config schema. Difference from regular int is that the
+    value if this type can be  either a string or an integer in the yaml file.
+    """
+
+    def __new__(cls, value: Any) -> "CastableInt":
+        """
+        Returns value as is if it's int. If it's str or bytes try to convert to int.
+        Raises ValueError if conversion is unsuccessful or value is of not supported type.
+
+        Type check is required to avoid unexpected behaviour, such as implictly casting booleans,
+        floats and other types supported by standard int.
+        """
+
+        if not isinstance(value, (int, str, bytes)):
+            raise ValueError(f"CastableInt cannot be created form value {value!r} of type {type(value)!r}.")
+
+        return super().__new__(cls, value)
+
+
+class PortNumber(CastableInt):
+    """
+    A subclass of int to be used in config schemas. It represents a valid port number (0 to 65535) and allows the value
+    to be of either str or int type. If the value is not a valid port number raises a ValueError at instantiation.
+    """
+
+    def __new__(cls, value: Any) -> "PortNumber":
+        """
+        Try to convert the `value` to int. If successful, check if it's within a valid range for a port number.
+        Raises ValueError if conversion to int or validation is unsuccessful.
+        """
+        value = super().__new__(cls, value)
+
+        if not (0 <= value <= 65535):
+            raise ValueError(f"Port number must be between 0 and 65535. Got: {value}.")
+
+        return value

{cognite_extractor_utils-7.4.8 → cognite_extractor_utils-7.4.9}/cognite/extractorutils/configtools/loaders.py

@@ -36,8 +36,10 @@ from cognite.client import CogniteClient
 from cognite.extractorutils.configtools._util import _to_snake_case
 from cognite.extractorutils.configtools.elements import (
     BaseConfig,
+    CastableInt,
     ConfigType,
     IgnorePattern,
+    PortNumber,
     TimeIntervalConfig,
     _BaseConfig,
 )
@@ -224,7 +226,7 @@ def _load_yaml(
         config = dacite.from_dict(
             data=config_dict,
             data_class=config_type,
-            config=dacite.Config(strict=True, cast=[Enum, TimeIntervalConfig, Path]),
+            config=dacite.Config(strict=True, cast=[Enum, TimeIntervalConfig, Path, CastableInt, PortNumber]),
         )
     except dacite.UnexpectedDataError as e:
         unknowns = [f'"{k.replace("_", "-") if case_style == "hyphen" else k}"' for k in e.keys]

{cognite_extractor_utils-7.4.8 → cognite_extractor_utils-7.4.9}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cognite-extractor-utils"
-version = "7.4.8"
+version = "7.4.9"
 description = "Utilities for easier development of extractors for CDF"
 authors = ["Mathias Lohne <mathias.lohne@cognite.com>"]
 license = "Apache-2.0"