Accept and pass on a prefix value.

txaws/s3/client.py

@@ -191,7 +191,7 @@ def delete_bucket(self, bucket):
         query = self._query_factory(details)
         return self._submit(query)
 
-    def get_bucket(self, bucket, marker=None, max_keys=None):
+    def get_bucket(self, bucket, marker=None, max_keys=None, prefix=None):
         """
         Get a list of all the objects in a bucket.
 
@@ -205,6 +205,10 @@ def get_bucket(self, bucket, marker=None, max_keys=None):
             return.
         @type max_keys: L{int} or L{NoneType}
 
+        @param prefix: If given, indicate that only objects with keys
+            beginning with this value should be returned.
+        @type prefix: L{bytes} or L{NoneType}
+
         @return: A L{Deferred} that fires with a L{BucketListing}
             describing the result.
 
@@ -215,6 +219,8 @@ def get_bucket(self, bucket, marker=None, max_keys=None):
             args.append(("marker", marker))
         if max_keys is not None:
             args.append(("max-keys", "%d" % (max_keys,)))
+        if prefix is not None:
+            args.append(("prefix", prefix))
         if args:
             object_name = "?" + urlencode(args)
         else:

txaws/s3/tests/test_client.py

@@ -292,6 +292,25 @@ def check_query_args(passthrough):
         d.addCallback(check_query_args)
         return d
 
+    def test_get_bucket_prefix(self):
+        """
+        L{S3Client.get_bucket} accepts a C{prefix} argument to ask the server to
+        limit its response to objects beginning with a certain prefix.
+        """
+        query_factory = mock_query_factory(payload.sample_get_bucket_result)
+        def check_query_args(passthrough):
+            self.assertEqual(
+                b"http:///mybucket/?prefix=foobar",
+                query_factory.details.url_context.get_encoded_url(),
+            )
+            return passthrough
+
+        creds = AWSCredentials("foo", "bar")
+        s3 = client.S3Client(creds, query_factory=query_factory)
+        d = s3.get_bucket("mybucket", prefix=b"foobar")
+        d.addCallback(check_query_args)
+        return d
+
     def test_get_bucket_location(self):
         """
         L{S3Client.get_bucket_location} creates a L{Query} to get a bucket's