renaming

pyinfra/storage/adapters/adapter.py

@@ -30,5 +30,5 @@ class StorageAdapter(ABC):
         pass
 
     @abstractmethod
-    def list_bucket_files(self, bucket_name):
+    def get_all_object_names(self, bucket_name):
         pass

pyinfra/storage/adapters/azure.py

@@ -73,7 +73,7 @@ class AzureStorageAdapter(StorageAdapter):
         blobs = container_client.list_blobs()
         container_client.delete_blobs(*blobs)
 
-    def list_bucket_files(self, bucket_name):
+    def get_all_object_names(self, bucket_name):
         container_client = self.__provide_container_client(bucket_name)
         blobs = container_client.list_blobs()
         return zip(repeat(bucket_name), map(attrgetter("name"), blobs))

pyinfra/storage/adapters/s3.py

@@ -50,6 +50,6 @@ class S3StorageAdapter(StorageAdapter):
         for obj in objects:
             self.__client.remove_object(bucket_name, obj.object_name)
 
-    def list_bucket_files(self, bucket_name):
+    def get_all_object_names(self, bucket_name):
         objs = self.__client.list_objects(bucket_name, recursive=True)
         return zip(repeat(bucket_name), map(attrgetter("object_name"), objs))

pyinfra/storage/storage.py

@@ -1,5 +1,8 @@
+from pyinfra.storage.adapters.adapter import StorageAdapter
+
+
 class Storage:
-    def __init__(self, adapter):
+    def __init__(self, adapter: StorageAdapter):
         self.__adapter = adapter
 
     def make_bucket(self, bucket_name):
@@ -20,5 +23,5 @@ class Storage:
     def clear_bucket(self, bucket_name):
         return self.__adapter.clear_bucket(bucket_name)
 
-    def list_bucket_files(self, bucket_name):
-        return self.__adapter.list_bucket_files(bucket_name)
+    def get_all_object_names(self, bucket_name):
+        return self.__adapter.get_all_object_names(bucket_name)

pyinfra/test/storage/adapter_mock.py

@@ -26,5 +26,5 @@ class StorageAdapterMock(StorageAdapter):
     def clear_bucket(self, bucket_name):
         return self.__client.clear_bucket(bucket_name)
 
-    def list_bucket_files(self, bucket_name):
-        return self.__client.list_bucket_files(bucket_name)
+    def get_all_object_names(self, bucket_name):
+        return self.__client.get_all_object_names(bucket_name)

pyinfra/test/storage/client_mock.py

@@ -23,5 +23,5 @@ class StorageClientMock:
     def clear_bucket(self, bucket_name):
         self.__data[bucket_name] = {}
 
-    def list_bucket_files(self, bucket_name):
+    def get_all_object_names(self, bucket_name):
         return zip(repeat(bucket_name), self.__data[bucket_name])

pyinfra/test/unit_tests/storage_test.py

@@ -48,7 +48,7 @@ class TestStorage:
     def test_listing_bucket_files_yields_all_files_in_bucket(self, storage, bucket_name):
         storage.put(bucket_name, "file1", b"content 1")
         storage.put(bucket_name, "file2", b"content 2")
-        full_names_received = storage.list_bucket_files(bucket_name)
+        full_names_received = storage.get_all_object_names(bucket_name)
         assert {(bucket_name, "file1"), (bucket_name, "file2")} == {*full_names_received}
 
 

scripts/mock_client.py

@@ -7,7 +7,7 @@ from pyinfra.storage.storages import get_s3_storage
 
 def build_message_bodies():
     storage = get_s3_storage()
-    for bucket_name, pdf_name in storage.list_bucket_files(CONFIG.test.bucket):
+    for bucket_name, pdf_name in storage.get_all_object_names(CONFIG.test.bucket):
         file_id = pdf_name.split(".")[0]
         dossier_id, file_id = file_id.split("/")
         yield json.dumps({"dossierId": dossier_id, "fileId": file_id})