Rename BugzillaToken to BugzillaTokenCache

djmitche · crobinso · commit 79f17549b6b3 · 2017-02-21T16:36:47.000-05:00
This is a more accurate name, since the object contains tokens, but is
not itself a token.
diff --git a/bugzilla/transport.py b/bugzilla/transport.py
@@ -28,7 +28,12 @@ class BugzillaError(Exception):
     pass
 
 
-class _BugzillaToken(object):
+class _BugzillaTokenCache(object):
+    """
+    Cache for tokens, including, with apologies for the duplicative
+    terminology, both Bugzilla Tokens and API Keys.
+    """
+
     def __init__(self, uri, tokenfilename):
         self.tokenfilename = tokenfilename
         self.tokenfile = SafeConfigParser()
@@ -63,33 +68,33 @@ def value(self, value):
                 self.tokenfile.write(tokenfile)
 
     def __repr__(self):
-        return '<Bugzilla Token :: %s>' % (self.value)
+        return '<Bugzilla Token Cache :: %s>' % self.value
 
 
 class _BugzillaServerProxy(ServerProxy):
     def __init__(self, uri, tokenfile, *args, **kwargs):
         # pylint: disable=super-init-not-called
         # No idea why pylint complains here, must be a bug
         ServerProxy.__init__(self, uri, *args, **kwargs)
-        self.token = _BugzillaToken(uri, tokenfile)
+        self.token_cache = _BugzillaTokenCache(uri, tokenfile)
 
     def clear_token(self):
-        self.token.value = None
+        self.token_cache.value = None
 
     def _ServerProxy__request(self, methodname, params):
-        if self.token.value is not None:
+        if self.token_cache.value is not None:
             if len(params) == 0:
                 params = ({}, )
 
             if 'Bugzilla_token' not in params[0]:
-                params[0]['Bugzilla_token'] = self.token.value
+                params[0]['Bugzilla_token'] = self.token_cache.value
 
         # pylint: disable=maybe-no-member
         ret = ServerProxy._ServerProxy__request(self, methodname, params)
         # pylint: enable=maybe-no-member
 
         if isinstance(ret, dict) and 'token' in ret.keys():
-            self.token.value = ret.get('token')
+            self.token_cache.value = ret.get('token')
         return ret
 
 
diff --git a/tests/rw_functional.py b/tests/rw_functional.py
@@ -25,7 +25,7 @@
 
 import bugzilla
 from bugzilla import Bugzilla
-from bugzilla.transport import _BugzillaToken
+from bugzilla.transport import _BugzillaTokenCache
 
 import tests
 
@@ -53,7 +53,7 @@ def _testCookieOrToken(self):
                 return
 
         if os.path.exists(tf):
-            token = _BugzillaToken(self.url, tokenfilename=tf)
+            token = _BugzillaTokenCache(self.url, tokenfilename=tf)
             if token.value is not None:
                 return
 
