add data format checker

Author: hyptocrypto

src/pystrong/__init__.py

@@ -1,3 +1,4 @@
+from .checker import check_data_types
 from .decorators import check_arg_type, check_return_types
 from .enforcer import InferredTypeEnforcer, TypeEnforcer
 
@@ -6,4 +7,5 @@
     "InferredTypeEnforcer",
     "check_return_types",
     "check_arg_type",
+    "check_data_types",
 ]

src/pystrong/checker.py

@@ -0,0 +1,18 @@
+from .exceptions import DataFormatCheckError
+
+
+def check_data_types(**kwargs):
+    type_format = kwargs.get("type_format")
+    data = kwargs.get("data")
+    if not data or not type_format:
+        raise DataFormatCheckError(
+            "Arguments type_format and data are required. Example: check_data_types(data=[1,2,3], type_format=[int, int, int])"
+        )
+    if type(data) is not list:
+        raise DataFormatCheckError("Please pass data and type_format as a list")
+
+    if len(data) != len(type_format):
+        raise DataFormatCheckError("Length of arguments data and type format differ.")
+
+    checks = [type(datapoint) is _type for datapoint, _type in zip(data, type_format)]
+    return all(checks)

src/pystrong/exceptions.py

@@ -1,3 +1,7 @@
+class DataFormatCheckError(Exception):
+    pass
+
+
 class InitError(Exception):
     pass
 

tests/test_data_checker.py

@@ -0,0 +1,58 @@
+import pytest
+from src.pystrong import check_data_types
+from src.pystrong.exceptions import DataFormatCheckError
+
+
+clean_data = [
+    [1, "hello", {}],
+    [1, "hello", {}],
+    [1, "hello", {}],
+    [1, "hello", {}],
+    [1, "hello", {}],
+    [1, "hello", {}],
+    [1, "hello", {}],
+]
+dirty_data = [
+    [1, "hello", {}],
+    ["hello", "hello", {}],
+    [1, "hello", {}],
+    [1, "hello", {}],
+    [1, "hello", {}],
+    [1, "hello", {}],
+    [1, "hello", {}],
+]
+unequal_len_data = [
+    [1, "hello", {}, 33, 45],
+    [1, "hello", {}],
+    [1, "hello", {}],
+    [1, "hello", {}],
+    [1, "hello", {}],
+    [1, "hello", {}],
+    [1, "hello", {}],
+]
+
+clean_type_format = [int, str, dict]
+dirty_type_format = [int, str, str]
+unequal_len_type_format = [int, str, dict, list]
+
+
+def test_data_checker():
+    success = all(
+        [check_data_types(data=d, type_format=clean_type_format) for d in clean_data]
+    )
+    fail_dirty_data = all(
+        [check_data_types(data=d, type_format=clean_type_format) for d in dirty_data]
+    )
+    fail_dirty_format = all(
+        [check_data_types(data=d, type_format=dirty_type_format) for d in clean_data]
+    )
+    assert success
+    assert not fail_dirty_data
+    assert not fail_dirty_format
+    with pytest.raises(DataFormatCheckError):
+        fail_unequal_len_type_format = all(
+            [
+                check_data_types(data=d, type_format=unequal_len_type_format)
+                for d in clean_data
+            ]
+        )