Run ruff check --fix

Author: quis

integration_test/integration_tests.py

@@ -121,7 +121,7 @@ def get_pdf_for_letter(python_client, id):
 
             count += 3
             if count > 45:
-                print("pdf {} not ready at {} after 45 seconds".format(id, datetime.utcnow()))
+                print(f"pdf {id} not ready at {datetime.utcnow()} after 45 seconds")
                 raise
             else:
                 time.sleep(3)

integration_test/schemas/v2/notification_schemas.py

@@ -212,7 +212,7 @@ def create_post_sms_response_from_notification(notification, body, from_number,
         "id": notification.id,
         "reference": notification.client_reference,
         "content": {"body": body, "from_number": from_number},
-        "uri": "{}/v2/notifications/{}".format(url_root, str(notification.id)),
+        "uri": f"{url_root}/v2/notifications/{str(notification.id)}",
         "template": __create_template_from_notification(notification=notification, url_root=url_root),
     }
 
@@ -222,7 +222,7 @@ def create_post_email_response_from_notification(notification, content, subject,
         "id": notification.id,
         "reference": notification.client_reference,
         "content": {"from_email": email_from, "body": content, "subject": subject},
-        "uri": "{}/v2/notifications/{}".format(url_root, str(notification.id)),
+        "uri": f"{url_root}/v2/notifications/{str(notification.id)}",
         "template": __create_template_from_notification(notification=notification, url_root=url_root),
     }
 
@@ -231,5 +231,5 @@ def __create_template_from_notification(notification, url_root):
     return {
         "id": notification.template_id,
         "version": notification.template_version,
-        "uri": "{}/v2/templates/{}".format(url_root, str(notification.template_id)),
+        "uri": f"{url_root}/v2/templates/{str(notification.template_id)}",
     }

notifications_python_client/base.py

@@ -12,7 +12,7 @@
 logger = logging.getLogger(__name__)
 
 
-class BaseAPIClient(object):
+class BaseAPIClient:
     def __init__(self, api_key, base_url="https://api.notifications.service.gov.uk", timeout=30):
         """
         Initialise the client
@@ -49,8 +49,8 @@ def delete(self, url, data=None):
     def generate_headers(self, api_token):
         return {
             "Content-type": "application/json",
-            "Authorization": "Bearer {}".format(api_token),
-            "User-agent": "NOTIFY-API-PYTHON-CLIENT/{}".format(__version__),
+            "Authorization": f"Bearer {api_token}",
+            "User-agent": f"NOTIFY-API-PYTHON-CLIENT/{__version__}",
         }
 
     def request(self, method, url, data=None, params=None):

notifications_python_client/errors.py

@@ -1,4 +1,3 @@
-from typing import List, Union
 
 from requests import RequestException, Response
 
@@ -45,10 +44,10 @@ def __init__(self, response: Response = None, message: str = None):
         self._message = message
 
     def __str__(self):
-        return "{} - {}".format(self.status_code, self.message)
+        return f"{self.status_code} - {self.message}"
 
     @property
-    def message(self) -> Union[str, List[dict]]:
+    def message(self) -> str | list[dict]:
         try:
             json_resp = self.response.json()  # type: ignore
             return json_resp.get("message", json_resp.get("errors"))
@@ -78,7 +77,6 @@ class HTTP503Error(HTTPError):
     Used for detecting whether failed requests should be retried.
     """
 
-    pass
 
 
 class InvalidResponse(APIError):

notifications_python_client/notifications.py

@@ -59,11 +59,11 @@ def send_precompiled_letter_notification(self, reference, pdf_file, postage=None
 
     def get_received_texts(self, older_than=None):
         if older_than:
-            query_string = "?older_than={}".format(older_than)
+            query_string = f"?older_than={older_than}"
         else:
             query_string = ""
 
-        return self.get("/v2/received-text-messages{}".format(query_string))
+        return self.get(f"/v2/received-text-messages{query_string}")
 
     def get_received_texts_iterator(self, older_than=None):
         result = self.get_received_texts(older_than=older_than)
@@ -77,10 +77,10 @@ def get_received_texts_iterator(self, older_than=None):
             received_texts = result.get("received_text_messages")
 
     def get_notification_by_id(self, id):
-        return self.get("/v2/notifications/{}".format(id))
+        return self.get(f"/v2/notifications/{id}")
 
     def get_pdf_for_letter(self, id):
-        url = "/v2/notifications/{}/pdf".format(id)
+        url = f"/v2/notifications/{id}/pdf"
         logger.debug("API request %s %s", "GET", url)
         url, kwargs = self._create_request_objects(url, data=None, params=None)
 
@@ -117,18 +117,18 @@ def get_all_notifications_iterator(self, status=None, template_type=None, refere
 
     def post_template_preview(self, template_id, personalisation):
         template = {"personalisation": personalisation}
-        return self.post("/v2/template/{}/preview".format(template_id), data=template)
+        return self.post(f"/v2/template/{template_id}/preview", data=template)
 
     def get_template(self, template_id):
-        return self.get("/v2/template/{}".format(template_id))
+        return self.get(f"/v2/template/{template_id}")
 
     def get_template_version(self, template_id, version):
-        return self.get("/v2/template/{}/version/{}".format(template_id, version))
+        return self.get(f"/v2/template/{template_id}/version/{version}")
 
     def get_all_template_versions(self, template_id):
-        return self.get("service/{}/template/{}/versions".format(self.service_id, template_id))
+        return self.get(f"service/{self.service_id}/template/{template_id}/versions")
 
     def get_all_templates(self, template_type=None):
-        _template_type = "?type={}".format(template_type) if template_type else ""
+        _template_type = f"?type={template_type}" if template_type else ""
 
-        return self.get("/v2/templates{}".format(_template_type))
+        return self.get(f"/v2/templates{_template_type}")

tests/conftest.py

@@ -1,4 +1,5 @@
-import mock
+from unittest import mock
+
 import pytest
 import requests_mock
 
@@ -8,7 +9,7 @@
 TEST_HOST = "http://test-host"
 SERVICE_ID = "c745a8d8-b48a-4b0d-96e5-dbea0165ebd1"
 API_KEY_ID = "8b3aa916-ec82-434e-b0c5-d5d9b371d6a3"
-COMBINED_API_KEY = "key_name-{}-{}".format(SERVICE_ID, API_KEY_ID)
+COMBINED_API_KEY = f"key_name-{SERVICE_ID}-{API_KEY_ID}"
 
 
 @pytest.fixture

tests/notifications_python_client/test_authentication.py

@@ -1,8 +1,8 @@
 import calendar
 import time
+from unittest import mock
 
 import jwt
-import mock
 import pytest
 from freezegun import freeze_time
 

tests/notifications_python_client/test_base_api_client.py

@@ -1,7 +1,6 @@
-# -*- coding: utf-8 -*-
 import re
+from unittest import mock
 
-import mock
 import pytest
 import requests
 

tests/notifications_python_client/test_notifications_api_client.py

@@ -1,7 +1,6 @@
 import base64
 import io
-
-from mock import Mock
+from unittest.mock import Mock
 
 from notifications_python_client import prepare_upload
 from tests.conftest import TEST_HOST
@@ -17,7 +16,7 @@ def test_get_notification_by_id(notifications_client, rmock):
 
 
 def test_get_received_texts(notifications_client, rmock):
-    endpoint = "{0}/v2/received-text-messages".format(TEST_HOST)
+    endpoint = f"{TEST_HOST}/v2/received-text-messages"
     rmock.request("GET", endpoint, json={"status": "success"}, status_code=200)
 
     notifications_client.get_received_texts()
@@ -33,7 +32,7 @@ def test_get_received_texts_older_than(notifications_client, rmock):
 
 
 def test_get_all_received_texts_iterator_calls_get_received_texts(notifications_client, rmock):
-    endpoint = "{0}/v2/received-text-messages".format(TEST_HOST)
+    endpoint = f"{TEST_HOST}/v2/received-text-messages"
     rmock.request("GET", endpoint, json={"status": "success"}, status_code=200)
 
     list(notifications_client.get_received_texts_iterator())
@@ -95,7 +94,7 @@ def test_get_all_notifications_including_jobs(notifications_client, rmock):
 
 
 def test_get_all_notifications(notifications_client, rmock):
-    endpoint = "{0}/v2/notifications".format(TEST_HOST)
+    endpoint = f"{TEST_HOST}/v2/notifications"
     rmock.request("GET", endpoint, json={"status": "success"}, status_code=200)
 
     notifications_client.get_all_notifications()
@@ -104,7 +103,7 @@ def test_get_all_notifications(notifications_client, rmock):
 
 
 def test_create_sms_notification(notifications_client, rmock):
-    endpoint = "{0}/v2/notifications/sms".format(TEST_HOST)
+    endpoint = f"{TEST_HOST}/v2/notifications/sms"
     rmock.request("POST", endpoint, json={"status": "success"}, status_code=200)
 
     notifications_client.send_sms_notification(phone_number="07700 900000", template_id="456")
@@ -113,7 +112,7 @@ def test_create_sms_notification(notifications_client, rmock):
 
 
 def test_create_sms_notification_with_personalisation(notifications_client, rmock):
-    endpoint = "{0}/v2/notifications/sms".format(TEST_HOST)
+    endpoint = f"{TEST_HOST}/v2/notifications/sms"
     rmock.request("POST", endpoint, json={"status": "success"}, status_code=200)
 
     notifications_client.send_sms_notification(
@@ -128,7 +127,7 @@ def test_create_sms_notification_with_personalisation(notifications_client, rmoc
 
 
 def test_create_sms_notification_with_sms_sender_id(notifications_client, rmock):
-    endpoint = "{0}/v2/notifications/sms".format(TEST_HOST)
+    endpoint = f"{TEST_HOST}/v2/notifications/sms"
     rmock.request("POST", endpoint, json={"status": "success"}, status_code=200)
 
     notifications_client.send_sms_notification(phone_number="07700 900000", template_id="456", sms_sender_id="789")
@@ -137,7 +136,7 @@ def test_create_sms_notification_with_sms_sender_id(notifications_client, rmock)
 
 
 def test_create_email_notification(notifications_client, rmock):
-    endpoint = "{0}/v2/notifications/email".format(TEST_HOST)
+    endpoint = f"{TEST_HOST}/v2/notifications/email"
     rmock.request("POST", endpoint, json={"status": "success"}, status_code=200)
 
     notifications_client.send_email_notification(email_address="[email protected]", template_id="456")
@@ -146,7 +145,7 @@ def test_create_email_notification(notifications_client, rmock):
 
 
 def test_create_email_notification_with_email_reply_to_id(notifications_client, rmock):
-    endpoint = "{0}/v2/notifications/email".format(TEST_HOST)
+    endpoint = f"{TEST_HOST}/v2/notifications/email"
     rmock.request("POST", endpoint, json={"status": "success"}, status_code=200)
 
     notifications_client.send_email_notification(
@@ -161,7 +160,7 @@ def test_create_email_notification_with_email_reply_to_id(notifications_client,
 
 
 def test_create_email_notification_with_personalisation(notifications_client, rmock):
-    endpoint = "{0}/v2/notifications/email".format(TEST_HOST)
+    endpoint = f"{TEST_HOST}/v2/notifications/email"
     rmock.request("POST", endpoint, json={"status": "success"}, status_code=200)
 
     notifications_client.send_email_notification(
@@ -195,7 +194,7 @@ def test_create_email_notification_with_one_click_unsubscribe_url(notifications_
 
 
 def test_create_email_notification_with_document_stream_upload(notifications_client, rmock):
-    endpoint = "{0}/v2/notifications/email".format(TEST_HOST)
+    endpoint = f"{TEST_HOST}/v2/notifications/email"
     rmock.request("POST", endpoint, json={"status": "success"}, status_code=200)
 
     if hasattr(io, "BytesIO"):
@@ -225,7 +224,7 @@ def test_create_email_notification_with_document_stream_upload(notifications_cli
 
 
 def test_create_email_notification_with_document_file_upload(notifications_client, rmock):
-    endpoint = "{0}/v2/notifications/email".format(TEST_HOST)
+    endpoint = f"{TEST_HOST}/v2/notifications/email"
     rmock.request("POST", endpoint, json={"status": "success"}, status_code=200)
 
     with open("tests/test_files/test.pdf", "rb") as f:
@@ -251,7 +250,7 @@ def test_create_email_notification_with_document_file_upload(notifications_clien
 
 
 def test_create_email_notification_with_csv_file_upload(notifications_client, rmock):
-    endpoint = "{0}/v2/notifications/email".format(TEST_HOST)
+    endpoint = f"{TEST_HOST}/v2/notifications/email"
     rmock.request("POST", endpoint, json={"status": "success"}, status_code=200)
 
     with open("tests/test_files/test.csv", "rb") as f:
@@ -277,7 +276,7 @@ def test_create_email_notification_with_csv_file_upload(notifications_client, rm
 
 
 def test_create_letter_notification(notifications_client, rmock):
-    endpoint = "{0}/v2/notifications/letter".format(TEST_HOST)
+    endpoint = f"{TEST_HOST}/v2/notifications/letter"
     rmock.request("POST", endpoint, json={"status": "success"}, status_code=200)
 
     notifications_client.send_letter_notification(
@@ -291,7 +290,7 @@ def test_create_letter_notification(notifications_client, rmock):
 
 
 def test_create_letter_notification_with_reference(notifications_client, rmock):
-    endpoint = "{0}/v2/notifications/letter".format(TEST_HOST)
+    endpoint = f"{TEST_HOST}/v2/notifications/letter"
     rmock.request("POST", endpoint, json={"status": "success"}, status_code=200)
 
     notifications_client.send_letter_notification(
@@ -308,7 +307,7 @@ def test_create_letter_notification_with_reference(notifications_client, rmock):
 
 
 def test_send_precompiled_letter_notification(notifications_client, rmock, mocker):
-    endpoint = "{0}/v2/notifications/letter".format(TEST_HOST)
+    endpoint = f"{TEST_HOST}/v2/notifications/letter"
     rmock.request("POST", endpoint, json={"status": "success"}, status_code=200)
     mock_file = Mock(
         read=Mock(return_value=b"file_contents"),
@@ -323,7 +322,7 @@ def test_send_precompiled_letter_notification(notifications_client, rmock, mocke
 
 
 def test_send_precompiled_letter_notification_sets_postage(notifications_client, rmock, mocker):
-    endpoint = "{0}/v2/notifications/letter".format(TEST_HOST)
+    endpoint = f"{TEST_HOST}/v2/notifications/letter"
     rmock.request("POST", endpoint, json={"status": "success"}, status_code=200)
     mock_file = Mock(
         read=Mock(return_value=b"file_contents"),
@@ -339,7 +338,7 @@ def test_send_precompiled_letter_notification_sets_postage(notifications_client,
 
 
 def test_get_all_notifications_iterator_calls_get_notifications(notifications_client, rmock):
-    endpoint = "{0}/v2/notifications".format(TEST_HOST)
+    endpoint = f"{TEST_HOST}/v2/notifications"
     rmock.request("GET", endpoint, json={"status": "success"}, status_code=200)
 
     list(notifications_client.get_all_notifications_iterator())
@@ -353,7 +352,7 @@ def test_get_all_notifications_iterator_stops_if_empty_notification_list_returne
         _generate_response("3e8f2f0a-0f2b-4d1b-8a01-761f14a281bb", []),
     ]
 
-    endpoint = "{0}/v2/notifications".format(TEST_HOST)
+    endpoint = f"{TEST_HOST}/v2/notifications"
     rmock.request("GET", endpoint, responses)
 
     list(notifications_client.get_all_notifications_iterator())
@@ -367,7 +366,7 @@ def test_get_all_notifications_iterator_gets_more_notifications_with_correct_id(
         _generate_response("3e8f2f0a-0f2b-4d1b-8a01-761f14a281bb", []),
     ]
 
-    endpoint = "{0}/v2/notifications".format(TEST_HOST)
+    endpoint = f"{TEST_HOST}/v2/notifications"
     rmock.request("GET", endpoint, responses)
     list(notifications_client.get_all_notifications_iterator())
     assert rmock.call_count == 3
@@ -402,7 +401,7 @@ def test_post_template_preview(notifications_client, rmock):
 
 
 def test_get_all_templates(notifications_client, rmock):
-    endpoint = "{0}/v2/templates".format(TEST_HOST)
+    endpoint = f"{TEST_HOST}/v2/templates"
     rmock.request("GET", endpoint, json={"status": "success"}, status_code=200)
 
     notifications_client.get_all_templates()
@@ -434,7 +433,7 @@ def _generate_response(next_link_uuid, notifications: list):
     return {
         "json": {
             "notifications": notifications,
-            "links": {"next": "http://localhost:6011/v2/notifications?older_than={}".format(next_link_uuid)},
+            "links": {"next": f"http://localhost:6011/v2/notifications?older_than={next_link_uuid}"},
         },
         "status_code": 200,
     }

utils/make_api_call.py

@@ -38,7 +38,7 @@ def create_notification(notifications_client, **kwargs):
         return create_letter_notification(notifications_client, **kwargs)
     if notification_type == "precompiled_letter":
         return create_precompiled_letter_notification(notifications_client, **kwargs)
-    print("Invalid type: {}, exiting".format(notification_type))
+    print(f"Invalid type: {notification_type}, exiting")
     sys.exit(1)