Merge pull request #134 from plotly/andrew-flexible-sign-in

Andrew flexible sign in

Author: theengineear

plotly/plotly/__init__.py

@@ -9,5 +9,5 @@
 """
 from . plotly import (
     sign_in, update_plot_options, get_plot_options, get_credentials, iplot,
-    plot, iplot_mpl, plot_mpl, get_figure, Stream, image
+    plot, iplot_mpl, plot_mpl, get_figure, Stream, image, get_config
 )

plotly/plotly/plotly.py

@@ -44,44 +44,47 @@
 
 _plot_options = dict()
 
+_config = dict()
+
 ### test file permissions and make sure nothing is corrupted ###
 tools.ensure_local_plotly_files()
 
 ### _credentials stuff ###
 
 
-def sign_in(username, api_key):
-    """Set module-scoped _credentials for session. Verify with plotly."""
-    global _credentials
+def sign_in(username, api_key, **kwargs):
+    """Set module-scoped _credentials for session. Optionally, set config info.
+    """
     _credentials['username'], _credentials['api_key'] = username, api_key
     # TODO: verify these _credentials with plotly
 
+    _config['plotly_domain'] = kwargs.get('plotly_domain')
+    _config['plotly_streaming_domain'] = kwargs.get('plotly_streaming_domain')
+    # TODO: verify format of config options
+
 
 ### plot options stuff ###
 
 def update_plot_options(**kwargs):
     """ Update the module-level _plot_options
     """
-    global _plot_options
     _plot_options.update(kwargs)
 
 
 def get_plot_options():
     """ Returns a copy of the user supplied plot options.
     Use `update_plot_options()` to change.
     """
-    global _plot_options
     return copy.copy(_plot_options)
 
 
 def get_credentials():
-    """ Returns a copy of the user supplied credentials.
-    """
-    global _credentials
-    if ('username' in _credentials) and ('api_key' in _credentials):
-        return copy.copy(_credentials)
-    else:
-        return tools.get_credentials_file()
+    """Returns the credentials that will be sent to plotly."""
+    credentials = tools.get_credentials_file()
+    for credentials_key in credentials:
+        if _credentials.get(credentials_key):
+            credentials[credentials_key] = _credentials[credentials_key]
+    return credentials
 
 
 ### plot stuff ###
@@ -127,6 +130,15 @@ def _plot_option_logic(plot_options):
     return options
 
 
+def get_config():
+    """Returns either module config or file config."""
+    config = tools.get_config_file()
+    for config_key in config:
+        if _config.get(config_key):
+            config[config_key] = _config[config_key]
+    return config
+
+
 def plot(figure_or_data, validate=True, **plot_options):
     """Create a unique url for this plot in Plotly and optionally open url.
 
@@ -307,7 +319,7 @@ def get_figure(file_owner_or_url, file_id=None, raw=False):
     `graph objects`.
 
     """
-    plotly_rest_url = tools.get_config_file()['plotly_domain']
+    plotly_rest_url = get_config()['plotly_domain']
     if file_id is None:  # assume we're using a url
         url = file_owner_or_url
         if url[:len(plotly_rest_url)] != plotly_rest_url:
@@ -413,7 +425,7 @@ def open(self):
         http://nbviewer.ipython.org/github/plotly/python-user-guide/blob/master/s7_streaming/s7_streaming.ipynb
         """
 
-        streaming_url = tools.get_config_file()['plotly_streaming_domain']
+        streaming_url = get_config()['plotly_streaming_domain']
         self._stream = chunked_requests.Stream(streaming_url,
                                                80,
                                                {'Host': streaming_url,
@@ -562,7 +574,7 @@ def get(figure_or_data, format='png', width=None, height=None):
         if height is not None:
             payload['height'] = height
 
-        url = tools.get_config_file()['plotly_domain'] + "/apigenimage/"
+        url = get_config()['plotly_domain'] + "/apigenimage/"
         res = requests.post(url,
                             data=json.dumps(payload,
                                             cls=utils._plotlyJSONEncoder),
@@ -667,7 +679,7 @@ def _send_to_plotly(figure, **plot_options):
                    origin='plot',
                    kwargs=kwargs)
 
-    url = tools.get_config_file()['plotly_domain'] + "/clientresp"
+    url = get_config()['plotly_domain'] + "/clientresp"
 
     r = requests.post(url, data=payload)
     r.raise_for_status()

plotly/tests/test_core/test_plotly/test_credentials.py

@@ -1,3 +1,4 @@
+from unittest import TestCase
 import plotly.plotly.plotly as py
 import plotly.tools as tls
 
@@ -24,4 +25,40 @@ def test_sign_in():
     assert creds['username'] == un
     assert creds['api_key'] == ak
     # TODO, and check it!
-    # assert creds['stream_ids'] == si
+    # assert creds['stream_ids'] == si
+
+
+class TestSignIn(TestCase):
+
+    def test_get_config(self):
+        plotly_domain = 'test domain'
+        plotly_streaming_domain = 'test streaming domain'
+        config1 = py.get_config()
+        py._config['plotly_domain'] = plotly_domain
+        config2 = py.get_config()
+        py._config['plotly_streaming_domain'] = plotly_streaming_domain
+        config3 = py.get_config()
+        self.assertEqual(config2['plotly_domain'], plotly_domain)
+        self.assertNotEqual(
+            config2['plotly_streaming_domain'], plotly_streaming_domain
+        )
+        self.assertEqual(
+            config3['plotly_streaming_domain'], plotly_streaming_domain
+        )
+
+    def test_sign_in_with_config(self):
+        username = 'place holder'
+        api_key = 'place holder'
+        plotly_domain = 'test domain'
+        plotly_streaming_domain = 'test streaming domain'
+        py.sign_in(
+            username,
+            api_key,
+            plotly_domain=plotly_domain,
+            plotly_streaming_domain=plotly_streaming_domain
+        )
+        config = py.get_config()
+        self.assertEqual(config['plotly_domain'], plotly_domain)
+        self.assertEqual(
+            config['plotly_streaming_domain'], plotly_streaming_domain
+        )