Merge branch 'master' into pevm-unittest-determinism

grab bucket property deletion

Author: evanmcc

riak/__init__.py

@@ -30,6 +30,10 @@
 @author Jay Baird (@skatterbean) ([email protected])
 """
 
+__all__ = ['RiakClient', 'RiakBucket', 'RiakNode', 'RiakObject',
+           'RiakMapReduce', 'RiakKeyFilter', 'RiakLink', 'RiakError',
+           'ONE', 'ALL', 'QUORUM', 'key_filter']
+
 
 class RiakError(Exception):
     """
@@ -41,7 +45,11 @@ def __init__(self, value):
     def __str__(self):
         return repr(self.value)
 
-from mapreduce import RiakKeyFilter
+from client import RiakClient
+from bucket import RiakBucket
+from node import RiakNode
+from riak_object import RiakObject
+from mapreduce import RiakKeyFilter, RiakMapReduce, RiakLink
 
 ONE = "one"
 ALL = "all"

riak/bucket.py

@@ -344,6 +344,13 @@ def get_properties(self):
         """
         return self._client.get_bucket_props(self)
 
+    def clear_properties(self):
+        """
+        Reset all bucket properties to their defaults.
+
+        """
+        return self._client.clear_bucket_props(self)
+
     def get_keys(self):
         """
         Return all keys within the bucket.

riak/client/__init__.py

@@ -63,9 +63,19 @@ def __init__(self, protocol='http', transport_options={},
                                   the transport constuctor
         :type transport_options: dict
         """
+        unused_args = unused_args.copy()
+
         if 'port' in unused_args:
             deprecated("port option is deprecated, use http_port or pb_port,"
-                      + " or the nodes option")
+                       " or the nodes option. Your given port of %r will be "
+                       "used as the %s port unless already set" %
+                       (unused_args['port'], protocol))
+            unused_args['already_warned_port'] = True
+            if (protocol in ['http', 'https'] and
+                'http_port' not in unused_args):
+                unused_args['http_port'] = unused_args['port']
+            elif protocol == 'pbc' and 'pb_port' not in unused_args:
+                unused_args['pb_port'] = unused_args['port']
 
         if 'transport_class' in unused_args:
             deprecated(

riak/client/operations.py

@@ -89,6 +89,16 @@ def set_bucket_props(self, transport, bucket, props):
         """
         return transport.set_bucket_props(bucket, props)
 
+    @retryableHttpOnly
+    def clear_bucket_props(self, transport, bucket):
+        """
+        Resets bucket properties for the given bucket.
+
+        :param bucket: the bucket whose properties will be set
+        :type bucket: RiakBucket
+        """
+        return transport.clear_bucket_props(bucket)
+
     @retryable
     def get_keys(self, transport, bucket):
         """

riak/node.py

@@ -90,7 +90,7 @@ def __init__(self, host='127.0.0.1', http_port=8098, pb_port=8087,
         :type pb_port: integer
         """
 
-        if 'port' in unused_args:
+        if 'port' in unused_args and not 'already_warned_port' in unused_args:
             deprecated("port option is deprecated, use http_port or pb_port")
 
         self.host = host

riak/riak_object.py

@@ -30,6 +30,7 @@
     )
 from riak import RiakError
 
+
 class RiakObject(object):
     """
     The RiakObject holds meta information about a Riak object, plus the
@@ -209,7 +210,6 @@ def remove_index(self, field=None, value=None):
             raise RiakError("Cannot pass value without a field"
                             " name while removing index")
 
-
         # This removes the index entries that's in the ries list.
         # Done because this is preferred over metadata[MD_INDEX].remove(rie)
         self.metadata[MD_INDEX] = [rie for rie in self.metadata[MD_INDEX]
@@ -224,7 +224,8 @@ def set_indexes(self, indexes):
         iterable of 2 item tuples, (field, value).
 
         :param indexes: iterable of 2 item tuples consisting the field
-                        and value. Both the field and the value must be a string.
+                        and value. Both the field and the value must
+                        be a string.
         :rtype: RiakObject
         """
         # makes a copy and does type conversion

riak/tests/test_all.py

@@ -170,6 +170,18 @@ def test_too_many_link_headers_shouldnt_break_http(self):
         stored_object = bucket.get("lots_of_links")
         self.assertEqual(len(stored_object.get_links()), 400)
 
+    def test_clear_bucket_properties(self):
+        bucket = self.client.bucket('bucket')
+        bucket.allow_mult = True
+        self.assertTrue(bucket.allow_mult)
+        bucket.n_val = 1
+        self.assertEqual(bucket.n_val, 1)
+        # Test setting clearing properties...
+
+        self.assertTrue(bucket.clear_properties())
+        self.assertFalse(bucket.allow_mult)
+        self.assertEqual(bucket.n_val, 3)
+
 
 class FilterTests(unittest.TestCase):
     def test_simple(self):

riak/transports/http/transport.py

@@ -279,6 +279,30 @@ def set_bucket_props(self, bucket, props):
             raise Exception('Error setting bucket properties.')
         return True
 
+    def clear_bucket_props(self, bucket):
+        """
+        reset the properties on the bucket object given
+        """
+        url = self.bucket_properties_path(bucket.name)
+        headers = {'Content-Type': 'application/json'}
+
+        # Run the request...
+        response = self._request('DELETE', url, headers, None)
+
+        # Handle the response...
+        if response is None:
+            raise Exception('Error clearing bucket properties.')
+
+        # Check the response value...
+        status = response[0]['http_code']
+        if status == 204:
+            return True
+        elif status == 405:
+            return False
+        else:
+            raise Exception('Error %s clearing bucket properties.'
+                            % status)
+
     def mapred(self, inputs, query, timeout=None):
         """
         Run a MapReduce query.

riak/transports/transport.py

@@ -120,6 +120,13 @@ def set_bucket_props(self, bucket, props):
         """
         raise NotImplementedError
 
+    def clear_bucket_props(self, bucket):
+        """
+        Reset bucket properties to their defaults
+        bucket = bucket object
+        """
+        raise NotImplementedError
+
     def get_keys(self, bucket):
         """
         Lists all keys within the given bucket.

riak/util.py

@@ -19,6 +19,7 @@
 import warnings
 from collections import Mapping
 
+
 def quacks_like_dict(object):
     """Check if object is dict-like"""
     return isinstance(object, Mapping)
@@ -54,7 +55,7 @@ def deep_merge(a, b):
 
 
 def deprecated(message, stacklevel=3):
-    warnings.warn(message, DeprecationWarning, stacklevel=stacklevel)
+    warnings.warn(message, UserWarning, stacklevel=stacklevel)
 
 QUORUMS = ['r', 'pr', 'w', 'dw', 'pw', 'rw']
 QDEPMESSAGE = """
@@ -79,21 +80,24 @@ def __deprecateQuorumAccessor(klass, parent, quorum):
     getter_name = "get_%s" % quorum
     setter_name = "set_%s" % quorum
     if not parent:
-        def getter(self, val=None):
+        def direct_getter(self, val=None):
             deprecated(QDEPMESSAGE % klass.__name__)
             if val:
                 return val
             return getattr(self, propname, "default")
 
+        getter = direct_getter
     else:
-        def getter(self, val=None):
+        def parent_getter(self, val=None):
             deprecated(QDEPMESSAGE % klass.__name__)
             if val:
                 return val
             parentInstance = getattr(self, parent)
             return getattr(self, propname,
                            getattr(parentInstance, propname, "default"))
 
+        getter = parent_getter
+
     def setter(self, value):
         deprecated(QDEPMESSAGE % klass.__name__)
         setattr(self, propname, value)