refactor(sqs): change methods to protected

Author: gmcrocetti

aws_lambda_powertools/utilities/batch/sqs.py

@@ -23,7 +23,7 @@ def __init__(self, config: Optional[Config] = None):
 
         super().__init__()
 
-    def get_queue_url(self):
+    def _get_queue_url(self):
         """
         Format QueueUrl from first records entry
         """
@@ -33,7 +33,7 @@ def get_queue_url(self):
         *_, account_id, queue_name = self.records[0]["eventSourceARN"].split(":")
         return f"{self.client._endpoint.host}/{account_id}/{queue_name}"
 
-    def get_entries_to_clean(self):
+    def _get_entries_to_clean(self):
         """
         Format messages to use in batch deletion
         """
@@ -60,8 +60,8 @@ def _clean(self):
         if not (self.fail_messages and self.success_messages):
             return
 
-        queue_url = self.get_queue_url()
-        entries_to_remove = self.get_entries_to_clean()
+        queue_url = self._get_queue_url()
+        entries_to_remove = self._get_entries_to_clean()
 
         return self.client.delete_message_batch(QueueUrl=queue_url, Entries=entries_to_remove)
 

tests/unit/test_utilities_batch.py

@@ -35,12 +35,12 @@ def test_partial_sqs_get_queue_url_with_records(mocker, sqs_event, partial_sqs_p
     records_mock = mocker.patch.object(PartialSQSProcessor, "records", create=True, new_callable=mocker.PropertyMock)
     records_mock.return_value = [sqs_event]
 
-    result = partial_sqs_processor.get_queue_url()
+    result = partial_sqs_processor._get_queue_url()
     assert result == expected_url
 
 
 def test_partial_sqs_get_queue_url_without_records(partial_sqs_processor):
-    assert partial_sqs_processor.get_queue_url() is None
+    assert partial_sqs_processor._get_queue_url() is None
 
 
 def test_partial_sqs_get_entries_to_clean_with_success(mocker, sqs_event, partial_sqs_processor):
@@ -51,7 +51,7 @@ def test_partial_sqs_get_entries_to_clean_with_success(mocker, sqs_event, partia
     )
     success_messages_mock.return_value = [sqs_event]
 
-    result = partial_sqs_processor.get_entries_to_clean()
+    result = partial_sqs_processor._get_entries_to_clean()
 
     assert result == expected_entries
 
@@ -64,7 +64,7 @@ def test_partial_sqs_get_entries_to_clean_without_success(mocker, partial_sqs_pr
     )
     success_messages_mock.return_value = []
 
-    result = partial_sqs_processor.get_entries_to_clean()
+    result = partial_sqs_processor._get_entries_to_clean()
 
     assert result == expected_entries
 
@@ -119,8 +119,8 @@ def test_partial_sqs_clean(monkeypatch, mocker, partial_sqs_processor):
     monkeypatch.setattr(partial_sqs_processor, "fail_messages", records)
     monkeypatch.setattr(partial_sqs_processor, "success_messages", records)
 
-    queue_url_mock = mocker.patch.object(PartialSQSProcessor, "get_queue_url")
-    entries_to_clean_mock = mocker.patch.object(PartialSQSProcessor, "get_entries_to_clean")
+    queue_url_mock = mocker.patch.object(PartialSQSProcessor, "_get_queue_url")
+    entries_to_clean_mock = mocker.patch.object(PartialSQSProcessor, "_get_entries_to_clean")
 
     queue_url_mock.return_value = mocker.sentinel.queue_url
     entries_to_clean_mock.return_value = mocker.sentinel.entries_to_clean