validate_json_schema() function

Author: SarahJohnsonONS

.vscode/settings.json

@@ -3,5 +3,12 @@
         "tests"
     ],
     "python.testing.unittestEnabled": false,
-    "python.testing.pytestEnabled": true
+    "python.testing.pytestEnabled": true,
+    "python.testing.unittestArgs": [
+        "-v",
+        "-s",
+        "./tests",
+        "-p",
+        "test_*.py"
+    ],
 }

Makefile

@@ -5,11 +5,11 @@ help:
 	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 
 fmt: ## (Format) - runs black and isort against the codebase
-	poetry run black ./src/*
-	poetry run isort ./src/*
+	poetry run black ./dpytools/*
+	poetry run isort ./dpytools/*
 
 lint: ## Run the ruff python linter
-	poetry run ruff ./src/*
+	poetry run ruff ./dpytools/*
 
 test: ## Run pytest and check test coverage
 	poetry run pytest --cov-report term-missing --cov=dpytools

dpytools/config/config.py

@@ -2,8 +2,8 @@
 
 from .properties.base import BaseProperty
 
-class Config:
 
+class Config:
     @staticmethod
     def from_env(config_dict: Dict[str, BaseProperty]):
         # TODO = read in and populate property classes as
@@ -34,5 +34,3 @@ def assert_valid_config(self):
         # For each of the properties you imbided above, run
         # self.type_is_valid()
         # self.secondary_validation()
-
-        

dpytools/config/properties/__init__.py

@@ -1 +1 @@
-from .string import StringProperty
+from .string import StringProperty

dpytools/config/properties/base.py

@@ -1,6 +1,7 @@
 from abc import ABCMeta, abstractmethod
 from dataclasses import dataclass
-from typing import Any, Union, Tuple, Optional
+from typing import Any
+
 
 @dataclass
 class BaseProperty(metaclass=ABCMeta):
@@ -20,7 +21,7 @@ class BaseProperty(metaclass=ABCMeta):
     def type_is_valid(self):
         """
         Validate that the property looks like
-        its of the correct type 
+        its of the correct type
         """
         ...
 
@@ -32,4 +33,4 @@ def secondary_validation(self):
         Non type based validation you might want to
         run against a configuration value.
         """
-        ...
+        ...

dpytools/config/properties/string.py

@@ -11,12 +11,14 @@ class StringProperty(BaseProperty):
     def type_is_valid(self):
         """
         Validate that the property looks like
-        its of the correct type 
+        its of the correct type
         """
         try:
             str(self.value)
         except Exception as err:
-            raise Exception(f"Cannot cast {self.name} value {self.value} to string.") from err
+            raise Exception(
+                f"Cannot cast {self.name} value {self.value} to string."
+            ) from err
 
     def secondary_validation_passed(self):
         """
@@ -25,7 +27,7 @@ def secondary_validation_passed(self):
         """
         if len(self.value) == 0:
             raise ValueError(f"Str value for {self.name} is an empty string")
-        
+
         if self.regex:
             # TODO - confirm the value matches the regex
             ...
@@ -36,4 +38,4 @@ def secondary_validation_passed(self):
 
         if self.max_len:
             # TODO - confirm the value matches or is less than the max length
-            ...
+            ...

dpytools/http_clients/base.py

@@ -1,7 +1,8 @@
+import logging
+
 import backoff
 import requests
 from requests.exceptions import HTTPError
-import logging
 
 
 # Function to log retry attempts
@@ -15,19 +16,14 @@ def __init__(self, backoff_max=30):
         self.backoff_max = backoff_max
 
     # GET request method with exponential backoff
-    @backoff.on_exception(
-        backoff.expo, 
-        HTTPError,
-        max_time=30,  
-        on_backoff=log_retry
-    )
+    @backoff.on_exception(backoff.expo, HTTPError, max_time=30, on_backoff=log_retry)
     def get(self, url, *args, **kwargs):
         """
         Sends a GET request to the specified URL with optional extra arguments.
 
-        This method is a thin wrapper around `requests.get()`. Any additional arguments 
-        are passed directly to `requests.get()`. For more information on the available 
-        arguments, refer to the `requests.get()` documentation: 
+        This method is a thin wrapper around `requests.get()`. Any additional arguments
+        are passed directly to `requests.get()`. For more information on the available
+        arguments, refer to the `requests.get()` documentation:
         https://docs.python-requests.org/en/latest/api/#requests.get
 
         Args:
@@ -40,22 +36,22 @@ def get(self, url, *args, **kwargs):
         Raises:
             HTTPError: If the request fails for a network-related reason.
         """
-        return self._handle_request('GET', url, *args, **kwargs)
+        return self._handle_request("GET", url, *args, **kwargs)
 
     # POST request method with exponential backoff
     @backoff.on_exception(
-        backoff.expo, 
+        backoff.expo,
         HTTPError,
-        max_time=30, 
+        max_time=30,
         on_backoff=log_retry,
     )
     def post(self, url, *args, **kwargs):
         """
         Sends a POST request to the specified URL with optional extra arguments.
 
-        This method is a thin wrapper around `requests.post()`. Any additional arguments 
-        are passed directly to `requests.post()`. For more information on the available 
-        arguments, refer to the `requests.post()` documentation: 
+        This method is a thin wrapper around `requests.post()`. Any additional arguments
+        are passed directly to `requests.post()`. For more information on the available
+        arguments, refer to the `requests.post()` documentation:
         https://docs.python-requests.org/en/latest/api/#requests.post
 
         Args:
@@ -69,8 +65,8 @@ def post(self, url, *args, **kwargs):
         Raises:
             HTTPError: If the request fails for a network-related reason.
         """
-        return self._handle_request('POST', url, *args, **kwargs)
-    
+        return self._handle_request("POST", url, *args, **kwargs)
+
     # Method to handle requests for GET and POST
     def _handle_request(self, method, url, *args, **kwargs):
         logging.info(f"Sending {method} request to {url}")
@@ -80,8 +76,12 @@ def _handle_request(self, method, url, *args, **kwargs):
             return response
 
         except HTTPError as http_err:
-            logging.error(f"HTTP error occurred: {http_err} when sending a {method} to {url} with headers {kwargs.get('headers')}")
+            logging.error(
+                f"HTTP error occurred: {http_err} when sending a {method} to {url} with headers {kwargs.get('headers')}"
+            )
             raise http_err
         except Exception as err:
-            logging.error(f"Other error occurred: {err} when sending a {method} to {url} with headers {kwargs.get('headers')}")
+            logging.error(
+                f"Other error occurred: {err} when sending a {method} to {url} with headers {kwargs.get('headers')}"
+            )
             raise err

dpytools/logger/logger.py

@@ -1,8 +1,9 @@
-from typing import Dict, List, Optional, Union
-import structlog
-import traceback
 import json
+import traceback
 from datetime import datetime, timezone
+from typing import Dict, List, Optional
+
+import structlog
 
 
 def level_to_severity(level: int) -> int:

dpytools/slack/slack.py

@@ -1,11 +1,12 @@
 import logging
+
 from dpytools.http_clients.base import BaseHttpClient
 
-class SlackNotifier:
 
+class SlackNotifier:
     def __init__(self, webhook_url):
         if not webhook_url:
-            raise ValueError('webhook_url is not set')
+            raise ValueError("webhook_url is not set")
         self.webhook_url = webhook_url
         self.http_client = BaseHttpClient()
 
@@ -20,12 +21,12 @@ def notify(self, msg_dict: dict):
             response = self.http_client.post(self.webhook_url, json=msg_dict)
             response.raise_for_status()
         except Exception as e:
-            logging.error(f'Failed to send notification: {e}')
+            logging.error(f"Failed to send notification: {e}")
 
     def msg_str(self, msg: str):
         """
         Send a string message to the Slack webhook.
 
         The msg parameter is wrapped into a dictionary before being sent.
         """
-        self.notify({'text': msg})
+        self.notify({"text": msg})

dpytools/sns/sns.py

@@ -1,4 +1,3 @@
-
 # See here: https://docs.aws.amazon.com/code-library/latest/ug/python_3_sns_code_examples.html
 # Ideally we want to publish a message by passing in a dictionary.
 # If SNS doesn not support that stringify any dict that is a message
@@ -12,20 +11,18 @@
 
 from typing import Union
 
+
 # Note: return True if it works and False if we hit errors
 # (so we can control the flow in calling programs)
 def publish(topic: str, msg: Union[str, dict]) -> bool:
-    """
-    
-    """
+    """ """
 
 
 # For this you'll want boto3 again, create a subscription
 # when the class is instantiated (error if you cant)
 # The get_message() needs to pull from the queue that's
 # been subscribed to.
 class Subscription:
-
     def __init__(self, topic):
         """
         subscrube to a topic (i.e setup to read messages)