Fixing file format errors

Author: adrianoaru-nhs

docs/utility-guides/SubjectAssertion.md

@@ -1,87 +1,87 @@
-# Utility Guide: Subject Assertion Utility
-
-This guide explains the purpose and usage of the `subject_assertion` utility found in [`utils/subject_assertion.py`](../../utils/subject_assertion.py).
-It is designed to assert that a subject with a given NHS number matches specified criteria in the database, and provides detailed logging when criteria do not match.
-
----
-
-## Table of Contents
-
-- [Utility Guide: Subject Assertion Utility](#utility-guide-subject-assertion-utility)
-  - [Table of Contents](#table-of-contents)
-  - [Overview](#overview)
-  - [Required Arguments](#required-arguments)
-  - [How It Works](#how-it-works)
-  - [Example Usage](#example-usage)
-  - [Behaviour Details](#behaviour-details)
-  - [Best Practices](#best-practices)
-  - [Reference](#reference)
-
----
-
-## Overview
-
-The `subject_assertion` function is used to verify that a subject in the database matches a set of criteria.  
-If the subject does not match all criteria, the function will iteratively remove criteria (except NHS number) and retry, logging any criteria that caused the assertion to fail.
-
----
-
-## Required Arguments
-
-- `nhs_number` (`str`): The NHS number of the subject to check.
-- `criteria` (`dict`): A dictionary of criteria to match against the subject's attributes.
-
----
-
-## How It Works
-
-1. The function first checks if the subject with the given NHS number matches all provided criteria.
-2. If not, it removes one criterion at a time (except NHS number) and retries the assertion.
-3. This process continues until either a match is found or all criteria (except NHS number) have been removed.
-4. If a match is found only after removing criteria, the failed criteria are logged.
-5. The function returns `True` only if all criteria match on the first attempt; otherwise, it returns `False`.
-
----
-
-## Example Usage
-
-Below are examples of how to use `subject_assertion` in your tests:
-
-```python
-import pytest
-from utils.subject_assertion import subject_assertion
-
-pytestmark = [pytest.mark.utils_local]
-
-def test_subject_assertion_true():
-    nhs_number = "9233639266"
-    criteria = {"screening status": "Inactive", "subject age": "> 28"}
-    assert subject_assertion(nhs_number, criteria) is True
-```
-
-See `tests_utils/test_subject_assertion_util.py` for more examples.
-
----
-
-## Behaviour Details
-
-- The function always keeps the NHS number criterion.
-- If a match is found only after removing criteria, the failed criteria are logged in the format:
-  - Failed criteria: Key: 'key1', Value: 'value1'
-- The function will only return `True` if all criteria match on the first attempt.
-
----
-
-## Best Practices
-
-- Use this utility to validate subject data in database-driven tests.
-- Review logs for failed criteria to diagnose why assertions did not pass.
-- Always provide the NHS number as part of your criteria.
-
----
-
-## Reference
-
-- [`utils/subject_assertion.py`](../../utils/subject_assertion.py)
-- [`tests_utils/test_subject_assertion_util.py`](../../tests_utils/test_subject_assertion_util.py)
-- [SubjectSelectionQueryBuilder Utility Guide](SubjectSelectionQueryBuilder.md)
+# Utility Guide: Subject Assertion Utility
+
+This guide explains the purpose and usage of the `subject_assertion` utility found in [`utils/subject_assertion.py`](../../utils/subject_assertion.py).
+It is designed to assert that a subject with a given NHS number matches specified criteria in the database, and provides detailed logging when criteria do not match.
+
+---
+
+## Table of Contents
+
+- [Utility Guide: Subject Assertion Utility](#utility-guide-subject-assertion-utility)
+  - [Table of Contents](#table-of-contents)
+  - [Overview](#overview)
+  - [Required Arguments](#required-arguments)
+  - [How It Works](#how-it-works)
+  - [Example Usage](#example-usage)
+  - [Behaviour Details](#behaviour-details)
+  - [Best Practices](#best-practices)
+  - [Reference](#reference)
+
+---
+
+## Overview
+
+The `subject_assertion` function is used to verify that a subject in the database matches a set of criteria.
+If the subject does not match all criteria, the function will iteratively remove criteria (except NHS number) and retry, logging any criteria that caused the assertion to fail.
+
+---
+
+## Required Arguments
+
+- `nhs_number` (`str`): The NHS number of the subject to check.
+- `criteria` (`dict`): A dictionary of criteria to match against the subject's attributes.
+
+---
+
+## How It Works
+
+1. The function first checks if the subject with the given NHS number matches all provided criteria.
+2. If not, it removes one criterion at a time (except NHS number) and retries the assertion.
+3. This process continues until either a match is found or all criteria (except NHS number) have been removed.
+4. If a match is found only after removing criteria, the failed criteria are logged.
+5. The function returns `True` only if all criteria match on the first attempt; otherwise, it returns `False`.
+
+---
+
+## Example Usage
+
+Below are examples of how to use `subject_assertion` in your tests:
+
+```python
+import pytest
+from utils.subject_assertion import subject_assertion
+
+pytestmark = [pytest.mark.utils_local]
+
+def test_subject_assertion_true():
+    nhs_number = "9233639266"
+    criteria = {"screening status": "Inactive", "subject age": "> 28"}
+    assert subject_assertion(nhs_number, criteria) is True
+```
+
+See `tests_utils/test_subject_assertion_util.py` for more examples.
+
+---
+
+## Behaviour Details
+
+- The function always keeps the NHS number criterion.
+- If a match is found only after removing criteria, the failed criteria are logged in the format:
+  - Failed criteria: Key: 'key1', Value: 'value1'
+- The function will only return `True` if all criteria match on the first attempt.
+
+---
+
+## Best Practices
+
+- Use this utility to validate subject data in database-driven tests.
+- Review logs for failed criteria to diagnose why assertions did not pass.
+- Always provide the NHS number as part of your criteria.
+
+---
+
+## Reference
+
+- [`utils/subject_assertion.py`](../../utils/subject_assertion.py)
+- [`tests_utils/test_subject_assertion_util.py`](../../tests_utils/test_subject_assertion_util.py)
+- [SubjectSelectionQueryBuilder Utility Guide](SubjectSelectionQueryBuilder.md)

tests_utils/test_subject_assertion_util.py

@@ -1,22 +1,22 @@
-import pytest
-from utils.subject_assertion import subject_assertion
-
-pytestmark = [pytest.mark.utils_local]
-
-
-def test_subject_assertion_true():
-    nhs_number = "9233639266"
-    criteria = {"screening status": "Inactive", "subject age": "> 28"}
-    assert subject_assertion(nhs_number, criteria) is True
-
-
-def test_subject_assertion_false():
-    nhs_number = "9233639266"
-    criteria = {"screening status": "Call", "subject age": "< 28"}
-    assert subject_assertion(nhs_number, criteria) is False
-
-
-def test_subject_assertion_false_with_some_true():
-    nhs_number = "9233639266"
-    criteria = {"screening status": "Inactive", "subject age": "< 28"}
-    assert subject_assertion(nhs_number, criteria) is False
+import pytest
+from utils.subject_assertion import subject_assertion
+
+pytestmark = [pytest.mark.utils_local]
+
+
+def test_subject_assertion_true():
+    nhs_number = "9233639266"
+    criteria = {"screening status": "Inactive", "subject age": "> 28"}
+    assert subject_assertion(nhs_number, criteria) is True
+
+
+def test_subject_assertion_false():
+    nhs_number = "9233639266"
+    criteria = {"screening status": "Call", "subject age": "< 28"}
+    assert subject_assertion(nhs_number, criteria) is False
+
+
+def test_subject_assertion_false_with_some_true():
+    nhs_number = "9233639266"
+    criteria = {"screening status": "Inactive", "subject age": "< 28"}
+    assert subject_assertion(nhs_number, criteria) is False

utils/subject_assertion.py

@@ -1,68 +1,68 @@
-from utils.oracle.subject_selection_query_builder import SubjectSelectionQueryBuilder
-from utils.oracle.oracle import OracleDB
-from classes.subject import Subject
-from classes.user import User
-import logging
-
-
-def subject_assertion(nhs_number: str, criteria: dict) -> bool:
-    """
-    Asserts that a subject with the given NHS number exists and matches the provided criteria.
-    Args:
-        nhs_number (str): The NHS number of the subject to find.
-        criteria (dict): A dictionary of criteria to match against the subject's attributes.
-    Returns:
-        bool: True if the subject matches the provided criteria, False if it does not.
-    """
-    nhs_no_criteria = {"nhs number": nhs_number}
-    subject = Subject()
-    user = User()
-    builder = SubjectSelectionQueryBuilder()
-
-    query, bind_vars = builder.build_subject_selection_query(
-        criteria=nhs_no_criteria,
-        user=user,
-        subject=subject,
-        subjects_to_retrieve=1,
-    )
-
-    subject_df = OracleDB().execute_query(query, bind_vars)
-    subject = Subject.from_dataframe_row(subject_df.iloc[0])
-
-    criteria["nhs number"] = nhs_number
-    query, bind_vars = builder.build_subject_selection_query(
-        criteria=criteria,
-        user=user,
-        subject=subject,
-        subjects_to_retrieve=1,
-    )
-
-    df = OracleDB().execute_query(query, bind_vars)
-
-    if nhs_number in df["subject_nhs_number"].values:
-        return True
-
-    # Try removing criteria one by one (except nhs number)
-    failed_criteria = []
-    criteria_keys = [key for key in criteria if key != "nhs number"]
-    for key in criteria_keys:
-        reduced_criteria = {key: value for key, value in criteria.items() if key != key}
-        query, bind_vars = builder.build_subject_selection_query(
-            criteria=reduced_criteria,
-            user=user,
-            subject=subject,
-            subjects_to_retrieve=1,
-        )
-        df = OracleDB().execute_query(query, bind_vars)
-        if nhs_number in df["subject_nhs_number"].values:
-            failed_criteria.append((key, criteria[key]))
-            break
-        else:
-            failed_criteria.append((key, criteria[key]))
-
-    if failed_criteria:
-        log_message = "Subject Assertion Failed\nFailed criteria:\n" + "\n".join(
-            [f"Key: '{key}' - Value: '{value}'" for key, value in failed_criteria]
-        )
-        logging.error(log_message)
-    return False
+from utils.oracle.subject_selection_query_builder import SubjectSelectionQueryBuilder
+from utils.oracle.oracle import OracleDB
+from classes.subject import Subject
+from classes.user import User
+import logging
+
+
+def subject_assertion(nhs_number: str, criteria: dict) -> bool:
+    """
+    Asserts that a subject with the given NHS number exists and matches the provided criteria.
+    Args:
+        nhs_number (str): The NHS number of the subject to find.
+        criteria (dict): A dictionary of criteria to match against the subject's attributes.
+    Returns:
+        bool: True if the subject matches the provided criteria, False if it does not.
+    """
+    nhs_no_criteria = {"nhs number": nhs_number}
+    subject = Subject()
+    user = User()
+    builder = SubjectSelectionQueryBuilder()
+
+    query, bind_vars = builder.build_subject_selection_query(
+        criteria=nhs_no_criteria,
+        user=user,
+        subject=subject,
+        subjects_to_retrieve=1,
+    )
+
+    subject_df = OracleDB().execute_query(query, bind_vars)
+    subject = Subject.from_dataframe_row(subject_df.iloc[0])
+
+    criteria["nhs number"] = nhs_number
+    query, bind_vars = builder.build_subject_selection_query(
+        criteria=criteria,
+        user=user,
+        subject=subject,
+        subjects_to_retrieve=1,
+    )
+
+    df = OracleDB().execute_query(query, bind_vars)
+
+    if nhs_number in df["subject_nhs_number"].values:
+        return True
+
+    # Try removing criteria one by one (except nhs number)
+    failed_criteria = []
+    criteria_keys = [key for key in criteria if key != "nhs number"]
+    for key in criteria_keys:
+        reduced_criteria = {key: value for key, value in criteria.items() if key != key}
+        query, bind_vars = builder.build_subject_selection_query(
+            criteria=reduced_criteria,
+            user=user,
+            subject=subject,
+            subjects_to_retrieve=1,
+        )
+        df = OracleDB().execute_query(query, bind_vars)
+        if nhs_number in df["subject_nhs_number"].values:
+            failed_criteria.append((key, criteria[key]))
+            break
+        else:
+            failed_criteria.append((key, criteria[key]))
+
+    if failed_criteria:
+        log_message = "Subject Assertion Failed\nFailed criteria:\n" + "\n".join(
+            [f"Key: '{key}' - Value: '{value}'" for key, value in failed_criteria]
+        )
+        logging.error(log_message)
+    return False