mark private methods with "_", add _reset_all_params()

Author: raphaelhuefner

gitcoin/client.py

@@ -30,21 +30,21 @@ def __init__(self):
         """Init params container for 'bounties' filters etc."""
         super().__init__()
         self.params = {
-            'raw_data': (True, str),
             'experience_level': (True, str),
             'project_length': (True, str),
             'bounty_type': (True, str),
             'bounty_owner_address': (True, str),
+            'bounty_owner_github_username': (True, str),
             'idx_status': (True, str),
             'network': (True, str),
-            'bounty_owner_github_username': (True, str),
-            'standard_bounties_id': (True, str),
+            'standard_bounties_id': (True, int),
             'pk__gt': (False, int),
             'started': (False, str),
             'is_open': (False, bool),
             'github_url': (True, str),
             'fulfiller_github_username': (False, str),
             'interested_github_username': (False, str),
+            'raw_data': (True, str),
             'order_by': (False, str),
             'limit': (False, int),
             'offset': (False, int)
@@ -60,27 +60,31 @@ def __init__(self, url, config):
         self.config = config
         self.params = {}
 
-    def add_param(self, name, value):
+    def _add_param(self, name, value):
         """Add query parameter with safeguards."""
         if self.config.has(name):
             is_multiple, normalize = self.config.get(name)
             if not is_multiple:
-                self.del_param(name)  # Throw away all previous values, if any.
+                self._del_param(name)  # Throw away all previous values, if any.
             if callable(normalize):
                 value = normalize(value)
-            self.add_param_unchecked(name, value)
+            self._add_param_unchecked(name, value)
             return self
         else:
             msg = 'Tried to filter by unknown param "{name}".'
             raise KeyError(msg.format(name=name))
 
-    def del_param(self, name):
+    def _del_param(self, name):
         """Delete query parameter."""
         if name in self.params:
             del self.params[name]
         return self
 
-    def add_param_unchecked(self, name, value):
+    def _reset_all_params(self):
+        """Delete all query parameters."""
+        self.params = {}
+
+    def _add_param_unchecked(self, name, value):
         """Add query parameter without safeguards.
 
         This is available in case this API client is out-of-sync with the API.
@@ -93,28 +97,28 @@ def add_param_unchecked(self, name, value):
     def filter(self, **kwargs):
         """Filter the result set."""
         for name, value in kwargs.items():
-            self.add_param(name, value)
+            self._add_param(name, value)
         return self
 
     def order_by(self, sort):
         """Sort the result set."""
-        self.add_param('order_by', sort)
+        self._add_param('order_by', sort)
         return self
 
     def get_page(self, number=1, per_page=25):
-        """Get a page of the result set."""
-        self.add_param('limit', per_page)
-        self.add_param('offset', (number - 1) * per_page)
+        """Get one page of the resources list."""
+        self._add_param('limit', per_page)
+        self._add_param('offset', (number - 1) * per_page)
         return self._request_get()
 
     def all(self):
-        """Get the complete result set."""
-        self.del_param('limit')
-        self.del_param('offset')
+        """List all resources."""
+        self._del_param('limit')
+        self._del_param('offset')
         return self._request_get()
 
     def get(self, primary_key):
-        """Get 1 object by primary key."""
+        """Retrieve one resource by primary key."""
         return self._request_get('/'.join((self.url, str(primary_key))))
 
     def _request_get(self, url=None):

tests/test_dry_run.py

@@ -71,7 +71,34 @@ def test_del_param(self):
             },
             'kwargs': {},
         }
-        result = api.bounties.filter(bounty_type='Feature').del_param('bounty_type').filter(bounty_type='Bug').get_page()
+        result = api.bounties.filter(bounty_type='Feature')._del_param('bounty_type').filter(bounty_type='Bug').get_page()
+        assert expected == result
+
+    def test_reset_all_params(self):
+        api = Gitcoin()
+        bounties_api = api.bounties
+        expected = {
+            'url': 'https://gitcoin.co/api/v0.1/bounties',
+            'params': {
+                'bounty_type': 'Feature',
+                'offset': '0',
+                'limit': '25',
+            },
+            'kwargs': {},
+        }
+        result = bounties_api.filter(bounty_type='Feature').get_page()
+        assert expected == result
+        bounties_api._reset_all_params()
+        expected = {
+            'url': 'https://gitcoin.co/api/v0.1/bounties',
+            'params': {
+                'bounty_type': 'Bug',
+                'offset': '0',
+                'limit': '25',
+            },
+            'kwargs': {},
+        }
+        result = bounties_api.filter(bounty_type='Bug').get_page()
         assert expected == result
 
     def test_order_by(self):
@@ -121,7 +148,7 @@ def __init__(self):
     def test_raise_for_status(self):
         api = Gitcoin()
         with pytest.raises(ValueError):  # ValueError only in mock setup
-            result = api.bounties.add_param_unchecked('raise_for_status', True).all()
+            result = api.bounties._add_param_unchecked('raise_for_status', True).all()
 
     def test_extending_config_does_not_leak(self):
         class ExtendedBountyConfig(BountyConfig):