Changes made

Author: SarahJohnsonONS

dpytools/config/config.py

@@ -9,17 +9,14 @@
 
 
 class Config:
-
     def __init__(self):
         self._properties_to_validate: List[BaseProperty] = []
 
     @staticmethod
     def from_env(config_dict: Dict[str, Dict[str, Any]]) -> Config:
-
         config = Config()
 
         for env_var_name, value in config_dict.items():
-
             value_for_property = os.environ.get(env_var_name, None)
             assert (
                 value_for_property is not None

dpytools/config/properties/__init__.py

@@ -1,2 +1,2 @@
-from .string import StringProperty
 from .intproperty import IntegerProperty
+from .string import StringProperty

dpytools/config/properties/base.py

@@ -14,15 +14,19 @@ def name(self):
 
     @name.setter
     def name(self, value):
-         raise ValueError(f"Trying to change name property to value {value} but you cannot change a property name after instantiation.")
+        raise ValueError(
+            f"Trying to change name property to value {value} but you cannot change a property name after instantiation."
+        )
 
     @property
     def value(self):
         return self._value
 
     @value.setter
     def value(self, value):
-        raise ValueError(f"Trying to change value to {value} but you cannot change a property value after instantiation.")
+        raise ValueError(
+            f"Trying to change value to {value} but you cannot change a property value after instantiation."
+        )
 
     @abstractmethod
     def type_is_valid(self):

dpytools/config/properties/intproperty.py

@@ -1,7 +1,9 @@
-from typing import Optional
 from dataclasses import dataclass
+from typing import Optional
+
 from .base import BaseProperty
 
+
 @dataclass
 class IntegerProperty(BaseProperty):
     min_val: Optional[int]
@@ -10,12 +12,14 @@ class IntegerProperty(BaseProperty):
     def type_is_valid(self):
         """
         Validate that the property looks like
-        its of the correct type 
+        its of the correct type
         """
         try:
             int(self._value)
         except Exception as err:
-            raise Exception(f"Cannot cast {self._name} value {self._value} to integer.") from err
+            raise Exception(
+                f"Cannot cast {self._name} value {self._value} to integer."
+            ) from err
 
     def secondary_validation(self):
         """
@@ -26,7 +30,11 @@ def secondary_validation(self):
             raise ValueError(f"Integer value for {self._name} does not exist.")
 
         if self.min_val and self._value < self.min_val:
-            raise ValueError(f"Integer value for {self._name} is lower than allowed minimum.")
+            raise ValueError(
+                f"Integer value for {self._name} is lower than allowed minimum."
+            )
 
         if self.max_val and self._value > self.max_val:
-            raise ValueError(f"Integer value for {self._name} is higher than allowed maximum.")
+            raise ValueError(
+                f"Integer value for {self._name} is higher than allowed maximum."
+            )

dpytools/config/properties/string.py

@@ -1,8 +1,8 @@
-from typing import Optional
+import re
 from dataclasses import dataclass
-from .base import BaseProperty
+from typing import Optional
 
-import re
+from .base import BaseProperty
 
 
 @dataclass

dpytools/validation/json/validation.py

@@ -10,16 +10,16 @@
 def validate_json_schema(
     schema_path: Union[Path, str],
     data_dict: Optional[Dict] = None,
-    data_path: Union[Path, str, None] = None,
-    error_msg: Optional[str] = "",
-    indent: Optional[int] = 2,
+    data_path: Optional[Union[Path, str]] = None,
+    error_msg: Optional[str] = None,
+    indent: Optional[int] = None,
 ):
     """
-    Validate metadata.json files against schema.
+    Validate a JSON file against a schema.
 
     Either `data_dict` or `data_path` must be provided.
 
-    `msg` and `indent` are used to format the error message if validation fails.
+    `error_msg` and `indent` can be used to format the error message if validation fails.
     """
     # Confirm that *either* `data_dict` *or* `data_path` has been provided, otherwise raise ValueError
     if data_dict and data_path:
@@ -46,14 +46,19 @@ def validate_json_schema(
     # Load data to be validated as dict
     if data_dict:
         if not isinstance(data_dict, Dict):
-            raise ValueError("Invalid data format")
+            raise ValueError(
+                "Invalid data format, `data_dict` should be a Python dictionary"
+            )
         data_to_validate = data_dict
 
     if data_path:
         if isinstance(data_path, str):
             data_path = Path(data_path).absolute()
         if not isinstance(data_path, Path):
-            raise ValueError("Invalid data format")
+            raise ValueError(
+                "Invalid data format, `data_path` should be a pathlib.Path or string of file location"
+            )
+        # Check `data_path` exists
         if not data_path.exists():
             raise ValueError(f"Data path '{data_path}' does not exist")
         with open(data_path, "r") as f:
@@ -78,5 +83,6 @@ def validate_json_schema(
 JSON data:
 {json.dumps(data_to_validate, indent=indent)}
 """
+            print(formatted_msg)
             raise ValidationError(formatted_msg) from err
         raise err

tests/test_json_validation.py

@@ -15,7 +15,6 @@ def test_validate_json_schema_data_path():
         validate_json_schema(
             schema_path=pipeline_config_schema,
             data_path=pipeline_config,
-            error_msg="Validating pipeline_config.json",
         )
         is None
     )
@@ -38,7 +37,6 @@ def test_validate_json_schema_data_dict():
         validate_json_schema(
             schema_path=pipeline_config_schema,
             data_dict=pipeline_config,
-            error_msg="Validating pipeline_config dict",
         )
         is None
     )
@@ -82,15 +80,18 @@ def test_validate_json_schema_no_data_dict_or_data_path():
 
 def test_validate_json_schema_invalid_data_path_format():
     """
-    Raise ValueError if data_path is not a file path
+    Raise ValueError if data_path is not a string or file path
     """
     pipeline_config_schema = "tests/test_cases/pipeline_config_schema.json"
     pipeline_config = ["Invalid", "data", "format"]
     with pytest.raises(ValueError) as err:
         validate_json_schema(
             schema_path=pipeline_config_schema, data_path=pipeline_config
         )
-    assert "Invalid data format" in str(err.value)
+    assert (
+        "Invalid data format, `data_path` should be a pathlib.Path or string of file location"
+        in str(err.value)
+    )
 
 
 def test_validate_json_schema_invalid_data_dict_format():
@@ -103,12 +104,14 @@ def test_validate_json_schema_invalid_data_dict_format():
         validate_json_schema(
             schema_path=pipeline_config_schema, data_dict=pipeline_config
         )
-    assert "Invalid data format" in str(err.value)
+    assert "Invalid data format, `data_dict` should be a Python dictionary" in str(
+        err.value
+    )
 
 
 def test_validate_json_schema_url():
     """
-    Raise NotImplementedError if schema path is a URL (i.e. not a local file)
+    Raise NotImplementedError if `schema_path` is a URL (i.e. not a local file)
     """
     pipeline_config_schema = "http://example.org"
     pipeline_config = "tests/test_cases/pipeline_config.json"