forked from plotly/plotly.py
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathplotly.py
More file actions
568 lines (470 loc) · 21.2 KB
/
plotly.py
File metadata and controls
568 lines (470 loc) · 21.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
"""
plotly
======
A module that contains the plotly class, a liaison between the user
and ploty's servers.
1. get DEFAULT_PLOT_OPTIONS for options
2. update plot_options with .plotly/ dir
3. update plot_options with _plot_options
4. update plot_options with kwargs!
"""
import requests
import chunked_requests
import json
import warnings
import httplib
import copy
import base64
import os
from .. import utils # TODO make non-relative
from .. import tools
from .. import plotly_exceptions
from .. import version
__all__ = ["sign_in", "update_plot_options", "get_plot_options",
"get_credentials", "iplot", "plot", "iplot_mpl", "plot_mpl",
"get_figure", "Stream", "image"]
_DEFAULT_PLOT_OPTIONS = dict(
filename="plot from API",
fileopt="new",
world_readable=True,
auto_open=True,
validate=True)
_credentials = dict()
_plot_options = 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
_credentials['username'], _credentials['api_key'] = username, api_key
# TODO: verify these _credentials with plotly
### 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()
### plot stuff ###
def iplot(figure_or_data, **plot_options):
"""Create a unique url for this plot in Plotly and open in IPython.
plot_options keyword agruments:
filename (string) -- the name that will be associated with this figure
fileopt ('new' | 'overwrite' | 'extend' | 'append') -- 'new' creates a
'new': create a new, unique url for this plot
'overwrite': overwrite the file associated with `filename` with this
'extend': add additional numbers (data) to existing traces
'append': add additional traces to existing data lists
world_readable (default=True) -- make this figure private/public
"""
if 'auto_open' not in plot_options:
plot_options['auto_open'] = False
res = plot(figure_or_data, **plot_options)
urlsplit = res.split('/')
username, plot_id = urlsplit[-2][1:], urlsplit[-1] # TODO: HACKY!
embed_options = dict()
if 'width' in plot_options:
embed_options['width'] = plot_options['width']
if 'height' in plot_options:
embed_options['height'] = plot_options['height']
return tools.embed(username, plot_id, **embed_options)
def _plot_option_logic(plot_options):
"""Sets plot_options via a precedence hierarchy."""
options = dict()
options.update(_DEFAULT_PLOT_OPTIONS)
options.update(_plot_options)
options.update(plot_options)
if ('filename' in plot_options
and 'fileopt' not in _plot_options
and 'fileopt' not in plot_options):
options['fileopt'] = 'overwrite'
return options
def plot(figure_or_data, validate=True, **plot_options):
"""Create a unique url for this plot in Plotly and optionally open url.
plot_options keyword agruments:
filename (string) -- the name that will be associated with this figure
fileopt ('new' | 'overwrite' | 'extend' | 'append') -- 'new' creates a
'new': create a new, unique url for this plot
'overwrite': overwrite the file associated with `filename` with this
'extend': add additional numbers (data) to existing traces
'append': add additional traces to existing data lists
world_readable (default=True) -- make this figure private/public
auto_open (default=True) -- Toggle browser options
True: open this plot in a new browser tab
False: do not open plot in the browser, but do return the unique url
"""
if isinstance(figure_or_data, dict):
figure = figure_or_data
elif isinstance(figure_or_data, list):
figure = {'data': figure_or_data}
else:
raise plotly_exceptions.PlotlyError("The `figure_or_data` positional argument "
"must be either `dict`-like or "
"`list`-like.")
if validate:
try:
tools.validate(figure, obj_type='Figure')
except plotly_exceptions.PlotlyError as err:
raise plotly_exceptions.PlotlyError("Invalid 'figure_or_data' argument. "
"Plotly will not be able to properly "
"parse the resulting JSON. If you "
"want to send this 'figure_or_data' "
"to Plotly anyway (not recommended), "
"you can set 'validate=False' as a "
"plot option.\nHere's why you're "
"seeing this error:\n\n{}".format(err))
for entry in figure['data']:
for key, val in entry.items():
try:
if len(val) > 40000:
msg = ("Woah there! Look at all those points! Due to "
"browser limitations, Plotly has a hard time "
"graphing more than 500k data points for line "
"charts, or 40k points for other types of charts. "
"Here are some suggestions:\n"
"(1) Trying using the image API to return an image "
"instead of a graph URL\n"
"(2) Use matplotlib\n"
"(3) See if you can create your visualization with "
"fewer data points\n\n"
"If the visualization you're using aggregates "
"points (e.g., box plot, histogram, etc.) you can "
"disregard this warning.")
warnings.warn(msg)
except TypeError:
pass
plot_options = _plot_option_logic(plot_options)
res = _send_to_plotly(figure, **plot_options)
if res['error'] == '':
if plot_options['auto_open']:
try:
from webbrowser import open as wbopen
wbopen(res['url'])
except: # TODO: what should we except here? this is dangerous
pass
return res['url']
else:
raise plotly_exceptions.PlotlyAccountError(res['error'])
def iplot_mpl(fig, resize=True, strip_style=False, **plot_options):
"""Replot a matplotlib figure with plotly in IPython.
This function:
1. converts the mpl figure into JSON (run help(plolty.tools.mpl_to_plotly))
2. makes a request to Plotly to save this figure in your account
3. displays the image in your IPython output cell
Positional agruments:
fig -- a figure object from matplotlib
Keyword arguments:
resize (default=True) -- allow plotly to choose the figure size
strip_style (default=False) -- allow plotly to choose style options
Additional keyword arguments:
plot_options -- run help(plotly.plotly.iplot)
"""
fig = tools.mpl_to_plotly(fig, resize=resize, strip_style=strip_style)
return iplot(fig, **plot_options)
def plot_mpl(fig, resize=True, strip_style=False, **plot_options):
"""Replot a matplotlib figure with plotly.
This function:
1. converts the mpl figure into JSON (run help(plolty.tools.mpl_to_plotly))
2. makes a request to Plotly to save this figure in your account
3. opens your figure in a browser tab OR returns the unique figure url
Positional agruments:
fig -- a figure object from matplotlib
Keyword arguments:
resize (default=True) -- allow plotly to choose the figure size
strip_style (default=False) -- allow plotly to choose style options
Additional keyword arguments:
plot_options -- run help(plotly.plotly.plot)
"""
fig = tools.mpl_to_plotly(fig, resize=resize, strip_style=strip_style)
return plot(fig, **plot_options)
def get_figure(file_owner, file_id, raw=False):
"""Returns a JSON figure representation for the specified file_owner/_id
Plotly uniquely identifies figures with a 'file_owner'/'file_id' pair.
Positional arguments:
file_owner (string) -- a valid plotly username
file_id ("int") -- an int or string that can be converted to int
Keyword arguments:
raw (default=False) -- if true, return unicode JSON string verbatim**
**by default, plotly will return a Figure object (run help(plotly
.graph_objs.Figure)). This representation decodes the keys and values from
unicode (if possible), removes information irrelevant to the figure
representation, and converts the JSON dictionary objects to plotly
`graph objects`.
"""
plotly_rest_url = tools.get_config_file()['plotly_domain']
resource = "/apigetfile/{username}/{file_id}".format(username=file_owner,
file_id=file_id)
(username, api_key) = _validation_key_logic()
headers = {'plotly-username': username,
'plotly-apikey': api_key,
'plotly-version': '2.0',
'plotly-platform': 'python'}
try:
test_if_int = int(file_id)
except ValueError:
raise plotly_exceptions.PlotlyError(
"The 'file_id' argument was not able to be converted into an "
"integer number. Make sure that the positional 'file_id' argument "
"is a number that can be converted into an integer or a string "
"that can be converted into an integer."
)
if int(file_id) < 0:
raise plotly_exceptions.PlotlyError(
"The 'file_id' argument must be a non-negative number."
)
response = requests.get(plotly_rest_url + resource, headers=headers)
if response.status_code == 200:
content = json.loads(response.content)
response_payload = content['payload']
figure = response_payload['figure']
utils.decode_unicode(figure)
if raw:
return figure
else:
return tools.get_valid_graph_obj(figure, obj_type='Figure')
else:
try:
content = json.loads(response.content)
raise plotly_exceptions.PlotlyError(content)
except:
raise plotly_exceptions.PlotlyError(
"There was an error retrieving this file")
@utils.template_doc(**tools.get_config_file())
class Stream:
""" Interface to Plotly's real-time graphing API.
Initialize a Stream object with a stream_id
found in {plotly_domain}/settings.
Real-time graphs are initialized with a call to `plot` that embeds
your unique `stream_id`s in each of the graph's traces. The `Stream`
interface plots data to these traces, as identified with the unique
stream_id, in real-time.
Every viewer of the graph sees the same data at the same time.
View examples and tutorials here:
http://nbviewer.ipython.org/github/plotly/python-user-guide/blob/master/s7_streaming/s7_streaming.ipynb
Stream example:
# Initialize a streaming graph
# by embedding stream_id's in the graph's traces
>>> stream_id = "your_stream_id" # See {plotly_domain}/settings
>>> py.plot(Data([Scatter(x=[],
y=[],
stream=dict(token=stream_id, maxpoints=100))])
# Stream data to the import trace
>>> stream = Stream(stream_id) # Initialize a stream object
>>> stream.open() # Open the stream
>>> stream.write(dict(x=1, y=1)) # Plot (1, 1) in your graph
"""
@utils.template_doc(**tools.get_config_file())
def __init__(self, stream_id):
""" Initialize a Stream object with your unique stream_id.
Find your stream_id at {plotly_domain}/settings.
For more help, see: `help(plotly.plotly.Stream)`
or see examples and tutorials here:
http://nbviewer.ipython.org/github/plotly/python-user-guide/blob/master/s7_streaming/s7_streaming.ipynb
"""
self.stream_id = stream_id
self.connected = False
def open(self):
"""Open streaming connection to plotly.
For more help, see: `help(plotly.plotly.Stream)`
or see examples and tutorials here:
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']
self._stream = chunked_requests.Stream(streaming_url,
80,
{'Host': streaming_url,
'plotly-streamtoken': self.stream_id})
def write(self, data, layout=None, validate=True,
reconnect_on=(200, '', 408)):
""" Write `data` to your stream. This will plot the
`data` in your graph in real-time.
`data` is a plotly formatted dict.
Valid keys:
'x', 'y', 'text', 'z', 'marker', 'line'
Examples:
>>> write(dict(x = 1, y = 2))
>>> write(dict(x = [1, 2, 3], y = [10, 20, 30]))
>>> write(dict(x = 1, y = 2, text = 'scatter text'))
>>> write(dict(x = 1, y = 3, marker = dict(color = 'blue')))
>>> write(dict(z = [[1,2,3], [4,5,6]]))
The connection to plotly's servers is checked before writing
and reconnected if disconnected and if the response status code
is in `reconnect_on`.
For more help, see: `help(plotly.plotly.Stream)`
or see examples and tutorials here:
http://nbviewer.ipython.org/github/plotly/python-user-guide/blob/master/s7_streaming/s7_streaming.ipynb
"""
stream_object = dict()
stream_object.update(data)
if 'type' not in stream_object:
stream_object['type'] = 'scatter'
if validate:
try:
tools.validate(stream_object, stream_object['type'])
except plotly_exceptions.PlotlyError as err:
raise plotly_exceptions.PlotlyError(
"Part of the data object with type, '{}', is invalid. This "
"will default to 'scatter' if you do not supply a 'type'. "
"If you do not want to validate your data objects when "
"streaming, you can set 'validate=False' in the call to "
"'your_stream.write()'. Here's why the object is "
"invalid:\n\n{}".format(stream_object['type'], err)
)
try:
tools.validate_stream(stream_object, stream_object['type'])
except plotly_exceptions.PlotlyError as err:
raise plotly_exceptions.PlotlyError(
"Part of the data object with type, '{}', cannot yet be "
"streamed into Plotly. If you do not want to validate your "
"data objects when streaming, you can set 'validate=False' "
"in the call to 'your_stream.write()'. Here's why the "
"object cannot be streamed:\n\n{}"
"".format(stream_object['type'], err)
)
if layout is not None:
try:
tools.validate(layout, 'Layout')
except plotly_exceptions.PlotlyError as err:
raise plotly_exceptions.PlotlyError(
"Your layout kwarg was invalid. "
"Here's why:\n\n{}".format(err)
)
del stream_object['type']
if layout is not None:
stream_object.update(dict(layout=layout))
# TODO: allow string version of this?
jdata = json.dumps(stream_object, cls=utils._plotlyJSONEncoder)
jdata += "\n"
try:
self._stream.write(jdata, reconnect_on=reconnect_on)
except AttributeError:
raise plotly_exceptions.PlotlyError("Stream has not been opened yet, "
"cannot write to a closed connection. "
"Call `open()` on the stream to open the stream.")
def close(self):
""" Close the stream connection to plotly's streaming servers.
For more help, see: `help(plotly.plotly.Stream)`
or see examples and tutorials here:
http://nbviewer.ipython.org/github/plotly/python-user-guide/blob/master/s7_streaming/s7_streaming.ipynb
"""
try:
self._stream.close()
except AttributeError:
raise plotly_exceptions.PlotlyError("Stream has not been opened yet.")
class image:
''' Helper functions wrapped around plotly's static image generation api.
'''
@staticmethod
def get(figure):
""" Return a static image of the plot described by `figure`.
"""
(username, api_key) = _validation_key_logic()
headers = {'plotly-username': username,
'plotly-apikey': api_key,
'plotly-version': '2.0',
'plotly-platform': 'python'}
url = tools.get_config_file()['plotly_domain'] + "/apigenimage/"
res = requests.post(url,
data=json.dumps(figure,
cls=utils._plotlyJSONEncoder),
headers=headers)
if res.status_code == 200:
return_data = json.loads(res.content)
return return_data['payload']
else:
try:
return_data = json.loads(res.content)
except:
raise plotly_exceptions.PlotlyError("The response "
"from plotly could "
"not be translated.")
raise plotly_exceptions.PlotlyError(return_data['error'])
@classmethod
def ishow(cls, figure):
""" Display a static image of the plot described by `figure`
in an IPython Notebook.
"""
img = cls.get(figure)
from IPython.display import display, Image
display(Image(img))
@classmethod
def save_as(cls, figure, filename):
""" Save a static image of the plot described by `figure`
locally as `filename`.
"""
img = cls.get(figure)
(base, ext) = os.path.splitext(filename)
if not ext:
filename += '.png'
f = open(filename, 'w')
img = base64.b64decode(img)
f.write(img)
f.close()
def _send_to_plotly(figure, **plot_options):
"""
"""
data = json.dumps(figure['data'] if 'data' in figure else [],
cls=utils._plotlyJSONEncoder)
file_credentials = tools.get_credentials_file()
if ('username' in _credentials) and ('api_key' in _credentials):
username, api_key = _credentials['username'], _credentials['api_key']
elif ('username' in file_credentials) and ('api_key' in file_credentials):
(username, api_key) = (file_credentials['username'],
file_credentials['api_key'])
else:
raise plotly_exceptions.PlotlyLocalCredentialsError()
kwargs = json.dumps(dict(filename=plot_options['filename'],
fileopt=plot_options['fileopt'],
world_readable=plot_options['world_readable'],
layout=figure['layout'] if 'layout' in figure
else {}),
cls=utils._plotlyJSONEncoder)
payload = dict(platform='python', # TODO: It'd be cool to expose the platform for RaspPi and others
version=version.__version__,
args=data,
un=username,
key=api_key,
origin='plot',
kwargs=kwargs)
url = tools.get_config_file()['plotly_domain'] + "/clientresp"
r = requests.post(url, data=payload)
r.raise_for_status()
r = json.loads(r.text)
if 'error' in r and r['error'] != '':
print(r['error'])
if 'warning' in r and r['warning'] != '':
warnings.warn(r['warning'])
if 'message' in r and r['message'] != '':
print(r['message'])
return r
def _validation_key_logic():
creds_on_file = tools.get_credentials_file()
if 'username' in _credentials:
username = _credentials['username']
elif 'username' in creds_on_file:
username = creds_on_file['username']
else:
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:
api_key = None
if username is None or api_key is None:
raise plotly_exceptions.PlotlyLocalCredentialsError()
return (username, api_key)