Changed instance of PlotlyAccountError to PlotlyLocalCredentialsError.

theengineear · theengineear · commit f9390745c822 · 2014-05-20T18:55:41.000-07:00
PlotlyAccountError is reserved for server errors where an actual check
has been done.

In addition, the error message for the PlotlyLocalCredentialsError is
stored in exceptions.py for better use-ability.
diff --git a/plotly/exceptions.py b/plotly/exceptions.py
@@ -23,7 +23,6 @@ class PlotlyError(Exception):
     pass
 
 
-
 ## Graph Objects Errors ##
 
 class PlotlyGraphObjectError(PlotlyError):
@@ -139,6 +138,38 @@ def __init__(self, obj='', index='', **kwargs):
                                                   **kwargs)
 
 
+## Local Config Errors ##
+
+class PlotlyLocalError(PlotlyError):
+    pass
+
+
+class PlotlyLocalCredentialsError(PlotlyLocalError):
+    def __init__(self):
+        message = ("\n"
+            "Couldn't find a 'username', 'api-key' pair for you on your local "
+            "machine. To sign in temporarily (until you stop running Python), "
+            "run:\n"
+            ">>> import plotly.plotly as py\n"
+            ">>> py.sign_in('username', 'api_key')\n\n"
+            "Even better, save your credentials permatently using the 'tools' "
+            "module:\n"
+            ">>> import plotly.tools as tls\n"
+            ">>> tls.set_credentials_file(username='username', api_key='api-key')\n\n"
+            "Note that 'username' should be a string containing YOUR Plotly "
+            "username and 'api-key' should be a string containing YOUR Plotly "
+            "api-key. To view your api-key:\n"
+            "1. Visit our website: https://plot.ly/\n"
+            "2. Sign-in using your Plotly username and password (different "
+            "from api-key)\n"
+            "3. Click the drop-down menu in the upper-right corner that says "
+            "your username.\n"
+            "4. Select 'settings' from this list.\n"
+            "5. Under the 'profile' tab in the settings list, you will find "
+            "your 'API Key'.\n")
+        super(PlotlyLocalCredentialsError, self).__init__(message)
+
+
 ## Server Errors ##
 
 class PlotlyServerError(PlotlyError):
diff --git a/plotly/plotly/plotly.py b/plotly/plotly/plotly.py
@@ -520,8 +520,7 @@ def _send_to_plotly(figure, **plot_options):
         (username, api_key) = (file_credentials['username'],
                                file_credentials['api_key'])
     else:
-        raise exceptions.PlotlyAccountError("Couldn't find a username, "
-                                            "api_key pair.")
+        raise exceptions.PlotlyLocalCredentialsError()
 
     kwargs = json.dumps(dict(filename=plot_options['filename'],
                              fileopt=plot_options['fileopt'],
@@ -563,15 +562,14 @@ def _validation_key_logic():
     elif 'username' in creds_on_file:
         username = creds_on_file['username']
     else:
-        raise exceptions.PlotlyAccountError("Not signed in or no username "
-                                            "saved in config file") # TODO: a message that doesn't suck
-
+        username = None
     if 'api_key' in _credentials:
         api_key = _credentials['api_key']
     elif 'api_key' in creds_on_file:
         api_key = creds_on_file['api_key']
     else:
-        raise exceptions.PlotlyAccountError("Not signed in or no api_key saved "
-                                            "in config file") # TODO: a message that doesn't suck
+        api_key = None
+    if username is None or api_key is None:
+        raise exceptions.PlotlyLocalCredentialsError()
     return (username, api_key)
 
