more docstrings, change class property to instance prop

Author: raphaelhuefner

gitcoin/__init__.py

@@ -1,3 +1,5 @@
+"""Define the Gitcoin API client."""
+
 from gitcoin.client import Config
 from gitcoin.client import BountyConfig
 from gitcoin.client import Endpoint

gitcoin/client.py

@@ -1,9 +1,13 @@
+"""Define the Gitcoin API client."""
+
 import requests
 
 
 class Config:
     """Define Base Class for API Endpoint Config."""
-    params = {}
+
+    def __init__(self):
+        self.params = {}
 
     def has(self, name):
         """Tell if a setting for 'name' was defined."""
@@ -20,26 +24,28 @@ def get(self, name):
 
 class BountyConfig(Config):
     """Define 'bounties' API Endpoint Config."""
-    params = {
-        'raw_data': (True, str),
-        'experience_level': (True, str),
-        'project_length': (True, str),
-        'bounty_type': (True, str),
-        'bounty_owner_address': (True, str),
-        'idx_status': (True, str),
-        'network': (True, str),
-        'bounty_owner_github_username': (True, str),
-        'standard_bounties_id': (True, str),
-        '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),
-        'order_by': (False, str),
-        'limit': (False, int),
-        'offset': (False, int)
-    }
+
+    def __init__(self):
+        self.params = {
+            'raw_data': (True, str),
+            'experience_level': (True, str),
+            'project_length': (True, str),
+            'bounty_type': (True, str),
+            'bounty_owner_address': (True, str),
+            'idx_status': (True, str),
+            'network': (True, str),
+            'bounty_owner_github_username': (True, str),
+            'standard_bounties_id': (True, str),
+            '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),
+            'order_by': (False, str),
+            'limit': (False, int),
+            'offset': (False, int)
+        }
 
 
 class Endpoint:
@@ -144,6 +150,6 @@ def set_url(self, id, url):
     def bounties(self):
         """Wrap the 'bounties' API endpoint."""
         url = self.urls['bounties']
-        endpointClass = self.classes['endpoint']
-        configClass = self.classes['bounties_list_config']
-        return endpointClass(url, configClass())
+        endpoint_class = self.classes['endpoint']
+        config_class = self.classes['bounties_list_config']
+        return endpoint_class(url, config_class())

tests/test_dry_run.py

@@ -101,6 +101,7 @@ def test_get(self):
     def test_no_normalize(self):
         class ExtendedBountyConfig(BountyConfig):
             def __init__(self):
+                super().__init__()
                 self.params['no_normalize'] = (True, None)
 
         api = Gitcoin()
@@ -121,3 +122,14 @@ 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()
+
+    def test_extending_config_does_not_leak(self):
+        class ExtendedBountyConfig(BountyConfig):
+            def __init__(self):
+                super().__init__()
+                self.params['extra_config'] = (True, None)
+
+        extended_bounty_config = ExtendedBountyConfig()
+        normal_bounty_config = BountyConfig()
+        with pytest.raises(KeyError):
+            normal_bounty_config.get('extra_config')