Rename proxy_dict to proxies; include reference to the requests docs

WebexCommunity · Sep 20, 2019 · 863c982 · 863c982
1 parent d36477a
commit 863c982
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 12 deletions.
diff --git a/docs/user/quickstart.rst b/docs/user/quickstart.rst
@@ -150,12 +150,13 @@ directly by providing the OAuth information.
                             redirect_uri=redirect_uri
                            )
 
-You can also pass a proxy configuration upon initialization in case you are behind a firewall. 
+You can also pass a proxy configuration upon initialization in case you are behind a firewall.  See the `requests
+documentation on Proxies <https://2.python-requests.org/en/master/user/advanced/#proxies>`_ for details.
 
 .. code-block:: python
     >>> from webexteamssdk import WebexTeamsAPI
-    >>> proxy = {'https': '<proxy_ip>:<proxy_port>'}
-    >>> api = WebexTeamsAPI(access_token=<your_access_token>, proxy_dict=proxy)
+    >>> proxy = {'https': 'http://<proxy_ip>:<proxy_port>'}
+    >>> api = WebexTeamsAPI(access_token=<your_access_token>, proxies=proxy)
 
 
 Making API Calls

diff --git a/webexteamssdk/api/__init__.py b/webexteamssdk/api/__init__.py
@@ -67,7 +67,7 @@ def __init__(self, access_token=None, base_url=DEFAULT_BASE_URL,
                  client_secret=None,
                  oauth_code=None,
                  redirect_uri=None,
-                 proxy_dict=None):
+                 proxies=None):
         """Create a new WebexTeamsAPI object.
 
         An access token must be used when interacting with the Webex Teams API.
@@ -109,7 +109,7 @@ def __init__(self, access_token=None, base_url=DEFAULT_BASE_URL,
                 the user oauth process.
             oauth_redirect_uri(basestring): The redirect URI used in the user
                 OAuth process.
-            proxy_dict(dict): Dictionary of proxies passed on to the requests 
+            proxies(dict): Dictionary of proxies passed on to the requests 
                 session.
 
         Returns:
@@ -129,7 +129,7 @@ def __init__(self, access_token=None, base_url=DEFAULT_BASE_URL,
         check_type(client_secret, basestring, may_be_none=True)
         check_type(oauth_code, basestring, may_be_none=True)
         check_type(redirect_uri, basestring, may_be_none=True)
-        check_type(proxy_dict, dict, may_be_none=True)
+        check_type(proxies, dict, may_be_none=True)
 
         access_token = access_token or WEBEX_TEAMS_ACCESS_TOKEN
 
@@ -167,7 +167,7 @@ def __init__(self, access_token=None, base_url=DEFAULT_BASE_URL,
             base_url=base_url,
             single_request_timeout=single_request_timeout,
             wait_on_rate_limit=wait_on_rate_limit, 
-            proxy_dict=proxy_dict
+            proxies=proxies
         )
 
         # API wrappers

diff --git a/webexteamssdk/restsession.py b/webexteamssdk/restsession.py
@@ -100,7 +100,7 @@ class RestSession(object):
     def __init__(self, access_token, base_url,
                  single_request_timeout=DEFAULT_SINGLE_REQUEST_TIMEOUT,
                  wait_on_rate_limit=DEFAULT_WAIT_ON_RATE_LIMIT,
-                 proxy_dict=None):
+                 proxies=None):
         """Initialize a new RestSession object.
 
         Args:
@@ -112,7 +112,7 @@ def __init__(self, access_token, base_url,
                 HTTP REST API request.
             wait_on_rate_limit(bool): Enable or disable automatic rate-limit
                 handling.
-            proxy_dict(dict): Dictionary of proxies passed on to the requests 
+            proxies(dict): Dictionary of proxies passed on to the requests 
                 session.
 
         Raises:
@@ -123,7 +123,7 @@ def __init__(self, access_token, base_url,
         check_type(base_url, basestring, may_be_none=False)
         check_type(single_request_timeout, int)
         check_type(wait_on_rate_limit, bool, may_be_none=False)
-        check_type(proxy_dict, dict, may_be_none=True)
+        check_type(proxies, dict, may_be_none=True)
 
         super(RestSession, self).__init__()
 
@@ -136,8 +136,8 @@ def __init__(self, access_token, base_url,
         # Initialize a new `requests` session
         self._req_session = requests.session()
 
-        if proxy_dict is not None:
-            self._req_session.proxies.update(proxy_dict)
+        if proxies is not None:
+            self._req_session.proxies.update(proxies)
 
         # Update the headers of the `requests` session
         self.update_headers({'Authorization': 'Bearer ' + access_token,