refactor: formatting updates

Author: ClarksonAdam

sandbox/api/app.py

@@ -25,7 +25,7 @@
     CONSENT__NO_RELATIONSHIPS,
     CONSENT__FILTERED_RELATIONSHIPS_STATUS_ACTIVE,
     CONSENT__FILTERED_RELATIONSHIPS_STATUS_INACTIVE,
-    CONSENT__FILTERED_RELATIONSHIPS_STATUS_PROPOSED_ACTIVE
+    CONSENT__FILTERED_RELATIONSHIPS_STATUS_PROPOSED_ACTIVE,
 )
 from .utils import (
     check_for_empty,
@@ -37,7 +37,7 @@
     load_json_file,
     remove_system,
     check_for_consent_include_params,
-    check_for_consent_filtering_params
+    check_for_consent_filtering_params,
 )
 
 app = Flask(__name__)
@@ -146,30 +146,30 @@ def get_consent() -> Union[dict, tuple]:
         _include = request.args.get("_include")
 
         # Single consenting adult relationship
-        if (performer_identifier == "9000000010"):
+        if performer_identifier == "9000000010":
             return check_for_consent_include_params(
                 _include,
                 logger,
                 CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP,
                 CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP_INCLUDE_BOTH,
             )
         # Single mother child relationship
-        elif (performer_identifier == "9000000019"):
+        elif performer_identifier == "9000000019":
             return check_for_consent_include_params(
                 _include,
                 logger,
                 CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP,
-                CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP_INCLUDE_BOTH
+                CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP_INCLUDE_BOTH,
             )
         # Filtering
-        elif (performer_identifier == "9000000017"):
+        elif performer_identifier == "9000000017":
             return check_for_consent_filtering_params(
                 status,
                 CONSENT__FILTERED_RELATIONSHIPS_STATUS_ACTIVE,
                 CONSENT__FILTERED_RELATIONSHIPS_STATUS_INACTIVE,
-                CONSENT__FILTERED_RELATIONSHIPS_STATUS_PROPOSED_ACTIVE
+                CONSENT__FILTERED_RELATIONSHIPS_STATUS_PROPOSED_ACTIVE,
             )
-        elif (performer_identifier == "9000000022"):
+        elif performer_identifier == "9000000022":
             return check_for_consent_include_params(
                 _include,
                 logger,
@@ -179,7 +179,7 @@ def get_consent() -> Union[dict, tuple]:
                 CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_PERFORMER,
             )
         # No relationships
-        elif (performer_identifier == "9000000025"):
+        elif performer_identifier == "9000000025":
             return generate_response_from_example(CONSENT__NO_RELATIONSHIPS, 200)
         else:
             logger.error(f"Performer identifier does not match examples")

sandbox/api/constants.py

@@ -34,28 +34,44 @@
 
 # Common examples
 INTERNAL_SERVER_ERROR_EXAMPLE = "./api/examples/errors/internal-server-error.yaml"
-BAD_REQUEST_INCLUDE_PARAM_INVALID = "./api/examples/errors/invalid-include-parameter.yaml"
+BAD_REQUEST_INCLUDE_PARAM_INVALID = (
+    "./api/examples/errors/invalid-include-parameter.yaml"
+)
 NOT_FOUND = "./api/examples/errors/not-found.yaml"
 MISSING_IDENTIFIER = "./api/examples/errors/missing-identifier.yaml"
 INVALID_IDENTIFIER = "./api/examples/errors/invalid-identifier.yaml"
 
 # Consent examples
 consent_dir = "./api/examples/GET_Consent/"
-CONSENT__FILTERED_RELATIONSHIPS_STATUS_ACTIVE = consent_dir + "filtered-relationships-status-active.yaml"
-CONSENT__FILTERED_RELATIONSHIPS_STATUS_INACTIVE = consent_dir + "filtered-relationships-status-inactive.yaml"
+CONSENT__FILTERED_RELATIONSHIPS_STATUS_ACTIVE = (
+    consent_dir + "filtered-relationships-status-active.yaml"
+)
+CONSENT__FILTERED_RELATIONSHIPS_STATUS_INACTIVE = (
+    consent_dir + "filtered-relationships-status-inactive.yaml"
+)
 CONSENT__FILTERED_RELATIONSHIPS_STATUS_PROPOSED_ACTIVE = (
     consent_dir + "filtered-relationships-status-proposed-active.yaml"
 )
 CONSENT__MULTIPLE_RELATIONSHIPS = consent_dir + "multiple-relationships.yaml"
-CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_BOTH = consent_dir + "multiple-relationships-include-performer-patient.yaml"
-CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_PATIENT = consent_dir + "multiple-relationships-include-patient.yaml"
-CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_PERFORMER = consent_dir + "multiple-relationships-include-performer.yaml"
+CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_BOTH = (
+    consent_dir + "multiple-relationships-include-performer-patient.yaml"
+)
+CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_PATIENT = (
+    consent_dir + "multiple-relationships-include-patient.yaml"
+)
+CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_PERFORMER = (
+    consent_dir + "multiple-relationships-include-performer.yaml"
+)
 CONSENT__NO_RELATIONSHIPS = consent_dir + "no-relationships.yaml"
-CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP = consent_dir + "single-consenting-adult-relationship.yaml"
+CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP = (
+    consent_dir + "single-consenting-adult-relationship.yaml"
+)
 CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP_INCLUDE_BOTH = (
     consent_dir + "single-consenting-adult-relationship-include-performer-patient.yaml"
 )
-CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP = consent_dir + "single-mother-child-relationship.yaml"
+CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP = (
+    consent_dir + "single-mother-child-relationship.yaml"
+)
 CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP_INCLUDE_BOTH = (
     consent_dir + "single-mother-child-relationship-include-performer-patient.yaml"
 )

sandbox/api/utils.py

@@ -16,7 +16,7 @@
     CONSENT_PATIENT,
     INTERNAL_SERVER_ERROR_EXAMPLE,
     CONSENT__STATUS_PARAM_INVALID,
-    BAD_REQUEST_INCLUDE_PARAM_INVALID
+    BAD_REQUEST_INCLUDE_PARAM_INVALID,
 )
 
 FHIR_MIMETYPE = "application/fhir+json"
@@ -28,7 +28,7 @@ def load_json_file(file_name: str) -> dict:
         return load(file)
 
 
-def check_for_errors(request: Request, identifier_key : str) -> Optional[tuple]:
+def check_for_errors(request: Request, identifier_key: str) -> Optional[tuple]:
     """Check for shared in the request headers and arguments
 
     Args:
@@ -45,31 +45,22 @@ def check_for_errors(request: Request, identifier_key : str) -> Optional[tuple]:
     print(f"Identifier_without_system = {identifier_without_system}")
 
     if not identifier:
-        return (
-            generate_response_from_example(
-                "./api/examples/errors/missing-identifier.yaml"
-            ,
-            400)
+        return generate_response_from_example(
+            "./api/examples/errors/missing-identifier.yaml", 400
         )
     elif identifier and len(identifier_without_system) != 10:
         # invalid identifier
-        return (
-            generate_response_from_example(
-                "./api/examples/errors/invalid-identifier.yaml"
-            ,
-            400)
+        return generate_response_from_example(
+            "./api/examples/errors/invalid-identifier.yaml", 400
         )
     elif (
         isinstance(identifier, str)
         and "|" in identifier
         and "https://fhir.nhs.uk/Id/nhs-number" != identifier.split("|", maxsplit=2)[0]
     ):
         # invalid identifier system
-        return (
-            generate_response_from_example(
-                "./api/examples/errors/invalid-identifier-system.yaml"
-            ,
-            400)
+        return generate_response_from_example(
+            "./api/examples/errors/invalid-identifier-system.yaml", 400
         )
 
 
@@ -194,12 +185,12 @@ def generate_response_from_example(example_path: str, status_code: int) -> Respo
 
 
 def check_for_consent_include_params(
-    _include : str,
+    _include: str,
     logger: logging.Logger,
     include_none_response_yaml: str,
-    include_both_response_yaml : str,
+    include_both_response_yaml: str,
     include_patient_response_yaml: str = None,
-    include_performer_response_yaml: str = None
+    include_performer_response_yaml: str = None,
 ) -> Response:
     """Checks the GET consent request include params and provides the related response
 
@@ -222,29 +213,32 @@ def check_for_consent_include_params(
         and _include != None
     ):
         return generate_response_from_example(BAD_REQUEST_INCLUDE_PARAM_INVALID, 400)
-    elif (_include == CONSENT_PERFORMER):
+    elif _include == CONSENT_PERFORMER:
         if include_performer_response_yaml:
             return generate_response_from_example(include_performer_response_yaml, 200)
         else:
             logger.error("No consent performer example provided")
             return generate_response_from_example(INTERNAL_SERVER_ERROR_EXAMPLE, 500)
-    elif (_include == CONSENT_PATIENT):
+    elif _include == CONSENT_PATIENT:
         if include_performer_response_yaml:
             return generate_response_from_example(include_patient_response_yaml, 200)
         else:
             logger.error("No consent:patient example provided")
             return generate_response_from_example(INTERNAL_SERVER_ERROR_EXAMPLE, 500)
-    elif (_include == f"{CONSENT_PATIENT},{CONSENT_PERFORMER}" or _include == f"{CONSENT_PERFORMER},{CONSENT_PATIENT}"):
+    elif (
+        _include == f"{CONSENT_PATIENT},{CONSENT_PERFORMER}"
+        or _include == f"{CONSENT_PERFORMER},{CONSENT_PATIENT}"
+    ):
         return generate_response_from_example(include_both_response_yaml, 200)
     else:
         return generate_response_from_example(include_none_response_yaml, 200)
 
 
 def check_for_consent_filtering_params(
-    status : str,
-    status_active_response_yaml : str,
-    status_inactive_response_yaml : str,
-    status_proposed_and_inactive_response_yaml : str
+    status: str,
+    status_active_response_yaml: str,
+    status_inactive_response_yaml: str,
+    status_proposed_and_inactive_response_yaml: str,
 ) -> Response:
     """Checks the GET consent request status params and provides related response
 
@@ -257,11 +251,13 @@ def check_for_consent_filtering_params(
     Returns:
         response: Resultant Response object based on input.
     """
-    if (status == "active"):
+    if status == "active":
         return generate_response_from_example(status_active_response_yaml, 200)
-    elif (status == "inactive"):
+    elif status == "inactive":
         return generate_response_from_example(status_inactive_response_yaml, 200)
-    elif (status == "proposed,inactive" or status == "inactive,proposed"):
-        return generate_response_from_example(status_proposed_and_inactive_response_yaml, 200)
+    elif status == "proposed,inactive" or status == "inactive,proposed":
+        return generate_response_from_example(
+            status_proposed_and_inactive_response_yaml, 200
+        )
     else:
         return generate_response_from_example(CONSENT__STATUS_PARAM_INVALID, 400)