To get this branch, use:
bzr branch
http://gegoxaren.bato24.eu/bzr/%2Bjunk/pygooglechart-py3k
« back to all changes in this revision
Viewing changes to pygooglechart.py
- browse files at revision 36
- compare with another revision
- download diff
- download tarball
- view history from revision 36
- Committer: gak
- Date: 2008-05-03 07:30:58 UTC
- Revision ID: git-v1:9342edb8666dde7e843e3eb438f1f6a717aa32fc
- Really added initial unit tests
- Converted setup.py to unix file format
- warnings made when data is being clipped and when data scaling is incorrect
- max_value is now a variable
- pie and google-o-meter chart data is now on the x-axis
- More grammar work
- Converted setup.py to unix file format
- warnings made when data is being clipped and when data scaling is incorrect
- max_value is now a variable
- pie and google-o-meter chart data is now on the x-axis
- More grammar work
- files added:
- examples/bar.py
- test
- files modified:
- examples/line.py
added
removed
pygooglechart.py
1
"""
2
PyGoogleChart - A complete Python wrapper for the Google Chart API
3
4
http://pygooglechart.slowchop.com/
5
6
Copyright 2007 Gerald Kaszuba
7
8
This program is free software: you can redistribute it and/or modify
9
it under the terms of the GNU General Public License as published by
10
the Free Software Foundation, either version 3 of the License, or
11
(at your option) any later version.
12
13
This program is distributed in the hope that it will be useful,
14
but WITHOUT ANY WARRANTY; without even the implied warranty of
15
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16
GNU General Public License for more details.
17
18
You should have received a copy of the GNU General Public License
19
along with this program. If not, see <http://www.gnu.org/licenses/>.
20
21
"""
22
23
import os
24
import urllib
25
import urllib2
26
import math
27
import random
28
import re
29
30
# Helper variables and functions
31
# -----------------------------------------------------------------------------
32
33
__version__ = '0.1.2'
34
35
reo_colour = re.compile('^([A-Fa-f0-9]{2,2}){3,4}$')
36
37
38
def _check_colour(colour):
39
if not reo_colour.match(colour):
40
raise InvalidParametersException('Colours need to be in ' \
41
'RRGGBB or RRGGBBAA format. One of your colours has %s' % \
42
colour)
43
44
# Exception Classes
45
# -----------------------------------------------------------------------------
46
47
48
class PyGoogleChartException(Exception):
49
pass
50
51
52
class DataOutOfRangeException(PyGoogleChartException):
53
pass
54
55
56
class UnknownDataTypeException(PyGoogleChartException):
57
pass
58
59
60
class NoDataGivenException(PyGoogleChartException):
61
pass
62
63
64
class InvalidParametersException(PyGoogleChartException):
65
pass
66
67
68
class BadContentTypeException(PyGoogleChartException):
69
pass
70
71
72
# Data Classes
73
# -----------------------------------------------------------------------------
74
75
76
class Data(object):
77
78
def __init__(self, data):
79
assert(type(self) != Data) # This is an abstract class
80
self.data = data
81
82
83
class SimpleData(Data):
84
enc_map = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'
85
86
def __repr__(self):
87
encoded_data = []
88
for data in self.data:
89
sub_data = []
90
for value in data:
91
if value is None:
92
sub_data.append('_')
93
elif value >= 0 and value <= SimpleData.max_value:
94
sub_data.append(SimpleData.enc_map[value])
95
else:
96
raise DataOutOfRangeException()
97
encoded_data.append(''.join(sub_data))
98
return 'chd=s:' + ','.join(encoded_data)
99
100
@staticmethod
101
def max_value():
102
return 61
103
104
105
class TextData(Data):
106
107
def __repr__(self):
108
encoded_data = []
109
for data in self.data:
110
sub_data = []
111
for value in data:
112
if value is None:
113
sub_data.append(-1)
114
elif value >= 0 and value <= TextData.max_value:
115
sub_data.append(str(float(value)))
116
else:
117
raise DataOutOfRangeException()
118
encoded_data.append(','.join(sub_data))
119
return 'chd=t:' + '|'.join(encoded_data)
120
121
@staticmethod
122
def max_value():
123
return 100
124
125
126
class ExtendedData(Data):
127
enc_map = \
128
'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-.'
129
130
def __repr__(self):
131
encoded_data = []
132
enc_size = len(ExtendedData.enc_map)
133
for data in self.data:
134
sub_data = []
135
for value in data:
136
if value is None:
137
sub_data.append('__')
138
elif value >= 0 and value <= ExtendedData.max_value:
139
first, second = divmod(int(value), enc_size)
140
sub_data.append('%s%s' % (
141
ExtendedData.enc_map[first],
142
ExtendedData.enc_map[second]))
143
else:
144
raise DataOutOfRangeException( \
145
'Item #%i "%s" is out of range' % (data.index(value), \
146
value))
147
encoded_data.append(''.join(sub_data))
148
return 'chd=e:' + ','.join(encoded_data)
149
150
@staticmethod
151
def max_value():
152
return 4095
153
154
# Axis Classes
155
# -----------------------------------------------------------------------------
156
157
158
class Axis(object):
159
BOTTOM = 'x'
160
TOP = 't'
161
LEFT = 'y'
162
RIGHT = 'r'
163
TYPES = (BOTTOM, TOP, LEFT, RIGHT)
164
165
def __init__(self, axis_index, axis_type, **kw):
166
assert(axis_type in Axis.TYPES)
167
self.has_style = False
168
self.axis_index = axis_index
169
self.axis_type = axis_type
170
self.positions = None
171
172
def set_index(self, axis_index):
173
self.axis_index = axis_index
174
175
def set_positions(self, positions):
176
self.positions = positions
177
178
def set_style(self, colour, font_size=None, alignment=None):
179
_check_colour(colour)
180
self.colour = colour
181
self.font_size = font_size
182
self.alignment = alignment
183
self.has_style = True
184
185
def style_to_url(self):
186
bits = []
187
bits.append(str(self.axis_index))
188
bits.append(self.colour)
189
if self.font_size is not None:
190
bits.append(str(self.font_size))
191
if self.alignment is not None:
192
bits.append(str(self.alignment))
193
return ','.join(bits)
194
195
def positions_to_url(self):
196
bits = []
197
bits.append(str(self.axis_index))
198
bits += [str(a) for a in self.positions]
199
return ','.join(bits)
200
201
202
class LabelAxis(Axis):
203
204
def __init__(self, axis_index, axis_type, values, **kwargs):
205
Axis.__init__(self, axis_index, axis_type, **kwargs)
206
self.values = [str(a) for a in values]
207
208
def __repr__(self):
209
return '%i:|%s' % (self.axis_index, '|'.join(self.values))
210
211
212
class RangeAxis(Axis):
213
214
def __init__(self, axis_index, axis_type, low, high, **kwargs):
215
Axis.__init__(self, axis_index, axis_type, **kwargs)
216
self.low = low
217
self.high = high
218
219
def __repr__(self):
220
return '%i,%s,%s' % (self.axis_index, self.low, self.high)
221
222
# Chart Classes
223
# -----------------------------------------------------------------------------
224
225
226
class Chart(object):
227
"""Abstract class for all chart types.
228
229
width are height specify the dimensions of the image. title sets the title
230
of the chart. legend requires a list that corresponds to datasets.
231
"""
232
233
BASE_URL = 'http://chart.apis.google.com/chart?'
234
BACKGROUND = 'bg'
235
CHART = 'c'
236
SOLID = 's'
237
LINEAR_GRADIENT = 'lg'
238
LINEAR_STRIPES = 'ls'
239
240
def __init__(self, width, height, title=None, legend=None, colours=None):
241
assert(type(self) != Chart) # This is an abstract class
242
assert(isinstance(width, int))
243
assert(isinstance(height, int))
244
self.width = width
245
self.height = height
246
self.data = []
247
self.set_title(title)
248
self.set_legend(legend)
249
self.set_colours(colours)
250
self.fill_types = {
251
Chart.BACKGROUND: None,
252
Chart.CHART: None,
253
}
254
self.fill_area = {
255
Chart.BACKGROUND: None,
256
Chart.CHART: None,
257
}
258
# self.axis = {
259
# Axis.TOP: None,
260
# Axis.BOTTOM: None,
261
# Axis.LEFT: None,
262
# Axis.RIGHT: None,
263
# }
264
self.axis = []
265
self.markers = []
266
267
# URL generation
268
# -------------------------------------------------------------------------
269
270
def get_url(self):
271
url_bits = self.get_url_bits()
272
return self.BASE_URL + '&'.join(url_bits)
273
274
def get_url_bits(self):
275
url_bits = []
276
# required arguments
277
url_bits.append(self.type_to_url())
278
url_bits.append('chs=%ix%i' % (self.width, self.height))
279
url_bits.append(self.data_to_url())
280
# optional arguments
281
if self.title:
282
url_bits.append('chtt=%s' % self.title)
283
if self.legend:
284
url_bits.append('chdl=%s' % '|'.join(self.legend))
285
if self.colours:
286
url_bits.append('chco=%s' % ','.join(self.colours))
287
ret = self.fill_to_url()
288
if ret:
289
url_bits.append(ret)
290
ret = self.axis_to_url()
291
if ret:
292
url_bits.append(ret)
293
if self.markers:
294
url_bits.append(self.markers_to_url())
295
return url_bits
296
297
# Downloading
298
# -------------------------------------------------------------------------
299
300
def download(self, file_name):
301
opener = urllib2.urlopen(self.get_url())
302
303
if opener.headers['content-type'] != 'image/png':
304
raise BadContentTypeException('Server responded with a ' \
305
'content-type of %s' % opener.headers['content-type'])
306
307
open(file_name, 'wb').write(urllib.urlopen(self.get_url()).read())
308
309
# Simple settings
310
# -------------------------------------------------------------------------
311
312
def set_title(self, title):
313
if title:
314
self.title = urllib.quote(title)
315
else:
316
self.title = None
317
318
def set_legend(self, legend):
319
# legend needs to be a list, tuple or None
320
assert(isinstance(legend, list) or isinstance(legend, tuple) or
321
legend is None)
322
if legend:
323
self.legend = [urllib.quote(a) for a in legend]
324
else:
325
self.legend = None
326
327
# Chart colours
328
# -------------------------------------------------------------------------
329
330
def set_colours(self, colours):
331
# colours needs to be a list, tuple or None
332
assert(isinstance(colours, list) or isinstance(colours, tuple) or
333
colours is None)
334
# make sure the colours are in the right format
335
if colours:
336
for col in colours:
337
_check_colour(col)
338
self.colours = colours
339
340
# Background/Chart colours
341
# -------------------------------------------------------------------------
342
343
def fill_solid(self, area, colour):
344
assert(area in (Chart.BACKGROUND, Chart.CHART))
345
_check_colour(colour)
346
self.fill_area[area] = colour
347
self.fill_types[area] = Chart.SOLID
348
349
def _check_fill_linear(self, angle, *args):
350
assert(isinstance(args, list) or isinstance(args, tuple))
351
assert(angle >= 0 and angle <= 90)
352
assert(len(args) % 2 == 0)
353
args = list(args) # args is probably a tuple and we need to mutate
354
for a in xrange(len(args) / 2):
355
col = args[a * 2]
356
offset = args[a * 2 + 1]
357
_check_colour(col)
358
assert(offset >= 0 and offset <= 1)
359
args[a * 2 + 1] = str(args[a * 2 + 1])
360
return args
361
362
def fill_linear_gradient(self, area, angle, *args):
363
assert(area in (Chart.BACKGROUND, Chart.CHART))
364
args = self._check_fill_linear(angle, *args)
365
self.fill_types[area] = Chart.LINEAR_GRADIENT
366
self.fill_area[area] = ','.join([str(angle)] + args)
367
368
def fill_linear_stripes(self, area, angle, *args):
369
assert(area in (Chart.BACKGROUND, Chart.CHART))
370
args = self._check_fill_linear(angle, *args)
371
self.fill_types[area] = Chart.LINEAR_STRIPES
372
self.fill_area[area] = ','.join([str(angle)] + args)
373
374
def fill_to_url(self):
375
areas = []
376
for area in (Chart.BACKGROUND, Chart.CHART):
377
if self.fill_types[area]:
378
areas.append('%s,%s,%s' % (area, self.fill_types[area], \
379
self.fill_area[area]))
380
if areas:
381
return 'chf=' + '|'.join(areas)
382
383
# Data
384
# -------------------------------------------------------------------------
385
386
def data_class_detection(self, data):
387
"""
388
Detects and returns the data type required based on the range of the
389
data given. The data given must be lists of numbers within a list.
390
"""
391
assert(isinstance(data, list) or isinstance(data, tuple))
392
max_value = None
393
for a in data:
394
assert(isinstance(a, list) or isinstance(a, tuple))
395
if max_value is None or max(a) > max_value:
396
max_value = max(a)
397
for data_class in (SimpleData, TextData, ExtendedData):
398
if max_value <= data_class.max_value():
399
return data_class
400
raise DataOutOfRangeException()
401
402
def add_data(self, data):
403
self.data.append(data)
404
return len(self.data) - 1 # return the "index" of the data set
405
406
def data_to_url(self, data_class=None):
407
if not data_class:
408
data_class = self.data_class_detection(self.data)
409
if not issubclass(data_class, Data):
410
raise UnknownDataTypeException()
411
return repr(data_class(self.data))
412
413
# Axis Labels
414
# -------------------------------------------------------------------------
415
416
def set_axis_labels(self, axis_type, values):
417
assert(axis_type in Axis.TYPES)
418
values = [ urllib.quote(a) for a in values ]
419
axis_index = len(self.axis)
420
axis = LabelAxis(axis_index, axis_type, values)
421
self.axis.append(axis)
422
return axis_index
423
424
def set_axis_range(self, axis_type, low, high):
425
assert(axis_type in Axis.TYPES)
426
axis_index = len(self.axis)
427
axis = RangeAxis(axis_index, axis_type, low, high)
428
self.axis.append(axis)
429
return axis_index
430
431
def set_axis_positions(self, axis_index, positions):
432
try:
433
self.axis[axis_index].set_positions(positions)
434
except IndexError:
435
raise InvalidParametersException('Axis index %i has not been ' \
436
'created' % axis)
437
438
def set_axis_style(self, axis_index, colour, font_size=None, \
439
alignment=None):
440
try:
441
self.axis[axis_index].set_style(colour, font_size, alignment)
442
except IndexError:
443
raise InvalidParametersException('Axis index %i has not been ' \
444
'created' % axis)
445
446
def axis_to_url(self):
447
available_axis = []
448
label_axis = []
449
range_axis = []
450
positions = []
451
styles = []
452
index = -1
453
for axis in self.axis:
454
available_axis.append(axis.axis_type)
455
if isinstance(axis, RangeAxis):
456
range_axis.append(repr(axis))
457
if isinstance(axis, LabelAxis):
458
label_axis.append(repr(axis))
459
if axis.positions:
460
positions.append(axis.positions_to_url())
461
if axis.has_style:
462
styles.append(axis.style_to_url())
463
if not available_axis:
464
return
465
url_bits = []
466
url_bits.append('chxt=%s' % ','.join(available_axis))
467
if label_axis:
468
url_bits.append('chxl=%s' % '|'.join(label_axis))
469
if range_axis:
470
url_bits.append('chxr=%s' % '|'.join(range_axis))
471
if positions:
472
url_bits.append('chxp=%s' % '|'.join(positions))
473
if styles:
474
url_bits.append('chxs=%s' % '|'.join(styles))
475
return '&'.join(url_bits)
476
477
# Markers, Ranges and Fill area (chm)
478
# -------------------------------------------------------------------------
479
480
def markers_to_url(self):
481
return 'chm=%s' % '|'.join([','.join(a) for a in self.markers])
482
483
def add_marker(self, index, point, marker_type, colour, size):
484
self.markers.append((marker_type, colour, str(index), str(point), \
485
str(size)))
486
487
def add_horizontal_range(self, colour, start, stop):
488
self.markers.append(('r', colour, '1', str(start), str(stop)))
489
490
def add_vertical_range(self, colour, start, stop):
491
self.markers.append(('R', colour, '1', str(start), str(stop)))
492
493
def add_fill_range(self, colour, index_start, index_end):
494
self.markers.append(('b', colour, str(index_start), str(index_end), \
495
'1'))
496
497
def add_fill_simple(self, colour):
498
self.markers.append(('B', colour, '1', '1', '1'))
499
500
501
class ScatterChart(Chart):
502
503
def __init__(self, *args, **kwargs):
504
Chart.__init__(self, *args, **kwargs)
505
506
def type_to_url(self):
507
return 'cht=s'
508
509
510
class LineChart(Chart):
511
512
def __init__(self, *args, **kwargs):
513
assert(type(self) != LineChart) # This is an abstract class
514
Chart.__init__(self, *args, **kwargs)
515
self.line_styles = {}
516
self.grid = None
517
518
def set_line_style(self, index, thickness=1, line_segment=None, \
519
blank_segment=None):
520
value = []
521
value.append(str(thickness))
522
if line_segment:
523
value.append(str(line_segment))
524
value.append(str(blank_segment))
525
self.line_styles[index] = value
526
527
def set_grid(self, x_step, y_step, line_segment=1, \
528
blank_segment=0):
529
self.grid = '%s,%s,%s,%s' % (x_step, y_step, line_segment, \
530
blank_segment)
531
532
def get_url_bits(self):
533
url_bits = Chart.get_url_bits(self)
534
if self.line_styles:
535
style = []
536
# for index, values in self.line_style.items():
537
for index in xrange(max(self.line_styles) + 1):
538
if index in self.line_styles:
539
values = self.line_styles[index]
540
else:
541
values = ('1', )
542
style.append(','.join(values))
543
url_bits.append('chls=%s' % '|'.join(style))
544
if self.grid:
545
url_bits.append('chg=%s' % self.grid)
546
return url_bits
547
548
549
class SimpleLineChart(LineChart):
550
551
def type_to_url(self):
552
return 'cht=lc'
553
554
555
class XYLineChart(LineChart):
556
557
def type_to_url(self):
558
return 'cht=lxy'
559
560
561
class BarChart(Chart):
562
563
def __init__(self, *args, **kwargs):
564
assert(type(self) != BarChart) # This is an abstract class
565
Chart.__init__(self, *args, **kwargs)
566
self.bar_width = None
567
568
def set_bar_width(self, bar_width):
569
self.bar_width = bar_width
570
571
def get_url_bits(self):
572
url_bits = Chart.get_url_bits(self)
573
url_bits.append('chbh=%i' % self.bar_width)
574
return url_bits
575
576
577
class StackedHorizontalBarChart(BarChart):
578
579
def type_to_url(self):
580
return 'cht=bhs'
581
582
583
class StackedVerticalBarChart(BarChart):
584
585
def type_to_url(self):
586
return 'cht=bvs'
587
588
589
class GroupedBarChart(BarChart):
590
591
def __init__(self, *args, **kwargs):
592
assert(type(self) != GroupedBarChart) # This is an abstract class
593
BarChart.__init__(self, *args, **kwargs)
594
self.bar_spacing = None
595
596
def set_bar_spacing(self, spacing):
597
self.bar_spacing = spacing
598
599
def get_url_bits(self):
600
# Skip 'BarChart.get_url_bits' and call Chart directly so the parent
601
# doesn't add "chbh" before we do.
602
url_bits = Chart.get_url_bits(self)
603
if self.bar_spacing is not None:
604
if self.bar_width is None:
605
raise InvalidParametersException('Bar width is required to ' \
606
'be set when setting spacing')
607
url_bits.append('chbh=%i,%i' % (self.bar_width, self.bar_spacing))
608
else:
609
url_bits.append('chbh=%i' % self.bar_width)
610
return url_bits
611
612
613
class GroupedHorizontalBarChart(GroupedBarChart):
614
615
def type_to_url(self):
616
return 'cht=bhg'
617
618
619
class GroupedVerticalBarChart(GroupedBarChart):
620
621
def type_to_url(self):
622
return 'cht=bvg'
623
624
625
class PieChart(Chart):
626
627
def __init__(self, *args, **kwargs):
628
assert(type(self) != PieChart) # This is an abstract class
629
Chart.__init__(self, *args, **kwargs)
630
self.pie_labels = []
631
632
def set_pie_labels(self, labels):
633
self.pie_labels = [urllib.quote(a) for a in labels]
634
635
def get_url_bits(self):
636
url_bits = Chart.get_url_bits(self)
637
if self.pie_labels:
638
url_bits.append('chl=%s' % '|'.join(self.pie_labels))
639
return url_bits
640
641
642
class PieChart2D(PieChart):
643
644
def type_to_url(self):
645
return 'cht=p'
646
647
648
class PieChart3D(PieChart):
649
650
def type_to_url(self):
651
return 'cht=p3'
652
653
654
class VennChart(Chart):
655
656
def type_to_url(self):
657
return 'cht=v'
658
659
660
def test():
661
chart = GroupedVerticalBarChart(320, 200)
662
chart = PieChart2D(320, 200)
663
chart = ScatterChart(320, 200)
664
chart = SimpleLineChart(320, 200)
665
sine_data = [math.sin(float(a) / 10) * 2000 + 2000 for a in xrange(100)]
666
random_data = [a * random.random() * 30 for a in xrange(40)]
667
random_data2 = [random.random() * 4000 for a in xrange(10)]
668
# chart.set_bar_width(50)
669
# chart.set_bar_spacing(0)
670
chart.add_data(sine_data)
671
chart.add_data(random_data)
672
chart.add_data(random_data2)
673
# chart.set_line_style(1, thickness=2)
674
# chart.set_line_style(2, line_segment=10, blank_segment=5)
675
# chart.set_title('heloooo')
676
# chart.set_legend(('sine wave', 'random * x'))
677
# chart.set_colours(('ee2000', 'DDDDAA', 'fF03f2'))
678
# chart.fill_solid(Chart.BACKGROUND, '123456')
679
# chart.fill_linear_gradient(Chart.CHART, 20, '004070', 1, '300040', 0,
680
# 'aabbcc00', 0.5)
681
# chart.fill_linear_stripes(Chart.CHART, 20, '204070', .2, '300040', .2,
682
# 'aabbcc00', 0.2)
683
axis_left_index = chart.set_axis_range(Axis.LEFT, 0, 10)
684
axis_left_index = chart.set_axis_range(Axis.LEFT, 0, 10)
685
axis_left_index = chart.set_axis_range(Axis.LEFT, 0, 10)
686
axis_right_index = chart.set_axis_range(Axis.RIGHT, 5, 30)
687
axis_bottom_index = chart.set_axis_labels(Axis.BOTTOM, [1, 25, 95])
688
chart.set_axis_positions(axis_bottom_index, [1, 25, 95])
689
chart.set_axis_style(axis_bottom_index, '003050', 15)
690
691
# chart.set_pie_labels(('apples', 'oranges', 'bananas'))
692
693
# chart.set_grid(10, 10)
694
695
# for a in xrange(0, 100, 10):
696
# chart.add_marker(1, a, 'a', 'AACA20', 10)
697
698
chart.add_horizontal_range('00A020', .2, .5)
699
chart.add_vertical_range('00c030', .2, .4)
700
701
chart.add_fill_simple('303030A0')
702
703
chart.download('test.png')
704
705
url = chart.get_url()
706
print url
707
if 0:
708
data = urllib.urlopen(chart.get_url()).read()
709
open('meh.png', 'wb').write(data)
710
os.system('start meh.png')
711
712
713
if __name__ == '__main__':
714
test()
1
"""
2
pygooglechart - A complete Python wrapper for the Google Chart API
3
4
http://pygooglechart.slowchop.com/
5
6
Copyright 2007-2008 Gerald Kaszuba
7
8
This program is free software: you can redistribute it and/or modify
9
it under the terms of the GNU General Public License as published by
10
the Free Software Foundation, either version 3 of the License, or
11
(at your option) any later version.
12
13
This program is distributed in the hope that it will be useful,
14
but WITHOUT ANY WARRANTY; without even the implied warranty of
15
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16
GNU General Public License for more details.
17
18
You should have received a copy of the GNU General Public License
19
along with this program. If not, see <http://www.gnu.org/licenses/>.
20
21
"""
22
23
import os
24
import urllib
25
import urllib2
26
import math
27
import random
28
import re
29
import warnings
30
import copy
31
32
# Helper variables and functions
33
# -----------------------------------------------------------------------------
34
35
__version__ = '0.2.1'
36
__author__ = 'Gerald Kaszuba'
37
38
reo_colour = re.compile('^([A-Fa-f0-9]{2,2}){3,4}$')
39
40
def _check_colour(colour):
41
if not reo_colour.match(colour):
42
raise InvalidParametersException('Colours need to be in ' \
43
'RRGGBB or RRGGBBAA format. One of your colours has %s' % \
44
colour)
45
46
47
def _reset_warnings():
48
"""Helper function to reset all warnings. Used by the unit tests."""
49
globals()['__warningregistry__'] = None
50
#def _warn(message):
51
# warnings.warn_explicit(msg, warnings.UserWarning,
52
53
54
# Exception Classes
55
# -----------------------------------------------------------------------------
56
57
58
class PyGoogleChartException(Exception):
59
pass
60
61
62
class DataOutOfRangeException(PyGoogleChartException):
63
pass
64
65
66
class UnknownDataTypeException(PyGoogleChartException):
67
pass
68
69
70
class NoDataGivenException(PyGoogleChartException):
71
pass
72
73
74
class InvalidParametersException(PyGoogleChartException):
75
pass
76
77
78
class BadContentTypeException(PyGoogleChartException):
79
pass
80
81
82
class AbstractClassException(PyGoogleChartException):
83
pass
84
85
86
class UnknownChartType(PyGoogleChartException):
87
pass
88
89
90
# Data Classes
91
# -----------------------------------------------------------------------------
92
93
94
class Data(object):
95
96
def __init__(self, data):
97
if type(self) == Data:
98
raise AbstractClassException('This is an abstract class')
99
self.data = data
100
101
@classmethod
102
def float_scale_value(cls, value, range):
103
lower, upper = range
104
assert(upper > lower)
105
scaled = (value - lower) * (float(cls.max_value) / (upper - lower))
106
return scaled
107
108
@classmethod
109
def clip_value(cls, value):
110
return max(0, min(value, cls.max_value))
111
112
@classmethod
113
def int_scale_value(cls, value, range):
114
return int(round(cls.float_scale_value(value, range)))
115
116
@classmethod
117
def scale_value(cls, value, range):
118
scaled = cls.int_scale_value(value, range)
119
clipped = cls.clip_value(scaled)
120
if clipped != scaled:
121
warnings.warn('One or more of of your data points has been '
122
'clipped because it is out of range.')
123
return clipped
124
125
126
class SimpleData(Data):
127
128
max_value = 61
129
enc_map = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'
130
131
def __repr__(self):
132
encoded_data = []
133
for data in self.data:
134
sub_data = []
135
for value in data:
136
if value is None:
137
sub_data.append('_')
138
elif value >= 0 and value <= self.max_value:
139
sub_data.append(SimpleData.enc_map[value])
140
else:
141
raise DataOutOfRangeException('cannot encode value: %d'
142
% value)
143
encoded_data.append(''.join(sub_data))
144
return 'chd=s:' + ','.join(encoded_data)
145
146
147
class TextData(Data):
148
149
max_value = 100
150
151
def __repr__(self):
152
encoded_data = []
153
for data in self.data:
154
sub_data = []
155
for value in data:
156
if value is None:
157
sub_data.append(-1)
158
elif value >= 0 and value <= self.max_value:
159
sub_data.append("%.1f" % float(value))
160
else:
161
raise DataOutOfRangeException()
162
encoded_data.append(','.join(sub_data))
163
return 'chd=t:' + '|'.join(encoded_data)
164
165
@classmethod
166
def scale_value(cls, value, range):
167
# use float values instead of integers because we don't need an encode
168
# map index
169
scaled = cls.float_scale_value(value, range)
170
clipped = cls.clip_value(scaled)
171
return clipped
172
173
174
class ExtendedData(Data):
175
176
max_value = 4095
177
enc_map = \
178
'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-.'
179
180
def __repr__(self):
181
encoded_data = []
182
enc_size = len(ExtendedData.enc_map)
183
for data in self.data:
184
sub_data = []
185
for value in data:
186
if value is None:
187
sub_data.append('__')
188
elif value >= 0 and value <= self.max_value:
189
first, second = divmod(int(value), enc_size)
190
sub_data.append('%s%s' % (
191
ExtendedData.enc_map[first],
192
ExtendedData.enc_map[second]))
193
else:
194
raise DataOutOfRangeException( \
195
'Item #%i "%s" is out of range' % (data.index(value), \
196
value))
197
encoded_data.append(''.join(sub_data))
198
return 'chd=e:' + ','.join(encoded_data)
199
200
201
# Axis Classes
202
# -----------------------------------------------------------------------------
203
204
205
class Axis(object):
206
207
BOTTOM = 'x'
208
TOP = 't'
209
LEFT = 'y'
210
RIGHT = 'r'
211
TYPES = (BOTTOM, TOP, LEFT, RIGHT)
212
213
def __init__(self, axis_index, axis_type, **kw):
214
assert(axis_type in Axis.TYPES)
215
self.has_style = False
216
self.axis_index = axis_index
217
self.axis_type = axis_type
218
self.positions = None
219
220
def set_index(self, axis_index):
221
self.axis_index = axis_index
222
223
def set_positions(self, positions):
224
self.positions = positions
225
226
def set_style(self, colour, font_size=None, alignment=None):
227
_check_colour(colour)
228
self.colour = colour
229
self.font_size = font_size
230
self.alignment = alignment
231
self.has_style = True
232
233
def style_to_url(self):
234
bits = []
235
bits.append(str(self.axis_index))
236
bits.append(self.colour)
237
if self.font_size is not None:
238
bits.append(str(self.font_size))
239
if self.alignment is not None:
240
bits.append(str(self.alignment))
241
return ','.join(bits)
242
243
def positions_to_url(self):
244
bits = []
245
bits.append(str(self.axis_index))
246
bits += [str(a) for a in self.positions]
247
return ','.join(bits)
248
249
250
class LabelAxis(Axis):
251
252
def __init__(self, axis_index, axis_type, values, **kwargs):
253
Axis.__init__(self, axis_index, axis_type, **kwargs)
254
self.values = [str(a) for a in values]
255
256
def __repr__(self):
257
return '%i:|%s' % (self.axis_index, '|'.join(self.values))
258
259
260
class RangeAxis(Axis):
261
262
def __init__(self, axis_index, axis_type, low, high, **kwargs):
263
Axis.__init__(self, axis_index, axis_type, **kwargs)
264
self.low = low
265
self.high = high
266
267
def __repr__(self):
268
return '%i,%s,%s' % (self.axis_index, self.low, self.high)
269
270
# Chart Classes
271
# -----------------------------------------------------------------------------
272
273
274
class Chart(object):
275
"""Abstract class for all chart types.
276
277
width are height specify the dimensions of the image. title sets the title
278
of the chart. legend requires a list that corresponds to datasets.
279
"""
280
281
BASE_URL = 'http://chart.apis.google.com/chart?'
282
BACKGROUND = 'bg'
283
CHART = 'c'
284
ALPHA = 'a'
285
VALID_SOLID_FILL_TYPES = (BACKGROUND, CHART, ALPHA)
286
SOLID = 's'
287
LINEAR_GRADIENT = 'lg'
288
LINEAR_STRIPES = 'ls'
289
290
def __init__(self, width, height, title=None, legend=None, colours=None,
291
auto_scale=True, x_range=None, y_range=None):
292
if type(self) == Chart:
293
raise AbstractClassException('This is an abstract class')
294
assert(isinstance(width, int))
295
assert(isinstance(height, int))
296
self.width = width
297
self.height = height
298
self.data = []
299
self.set_title(title)
300
self.set_legend(legend)
301
self.set_colours(colours)
302
303
# Data for scaling.
304
self.auto_scale = auto_scale # Whether to automatically scale data
305
self.x_range = x_range # (min, max) x-axis range for scaling
306
self.y_range = y_range # (min, max) y-axis range for scaling
307
self.scaled_data_class = None
308
self.scaled_x_range = None
309
self.scaled_y_range = None
310
311
self.fill_types = {
312
Chart.BACKGROUND: None,
313
Chart.CHART: None,
314
Chart.ALPHA: None,
315
}
316
self.fill_area = {
317
Chart.BACKGROUND: None,
318
Chart.CHART: None,
319
Chart.ALPHA: None,
320
}
321
self.axis = []
322
self.markers = []
323
self.line_styles = {}
324
self.grid = None
325
326
# URL generation
327
# -------------------------------------------------------------------------
328
329
def get_url(self, data_class=None):
330
url_bits = self.get_url_bits(data_class=data_class)
331
return self.BASE_URL + '&'.join(url_bits)
332
333
def get_url_bits(self, data_class=None):
334
url_bits = []
335
# required arguments
336
url_bits.append(self.type_to_url())
337
url_bits.append('chs=%ix%i' % (self.width, self.height))
338
url_bits.append(self.data_to_url(data_class=data_class))
339
# optional arguments
340
if self.title:
341
url_bits.append('chtt=%s' % self.title)
342
if self.legend:
343
url_bits.append('chdl=%s' % '|'.join(self.legend))
344
if self.colours:
345
url_bits.append('chco=%s' % ','.join(self.colours))
346
ret = self.fill_to_url()
347
if ret:
348
url_bits.append(ret)
349
ret = self.axis_to_url()
350
if ret:
351
url_bits.append(ret)
352
if self.markers:
353
url_bits.append(self.markers_to_url())
354
if self.line_styles:
355
style = []
356
for index in xrange(max(self.line_styles) + 1):
357
if index in self.line_styles:
358
values = self.line_styles[index]
359
else:
360
values = ('1', )
361
style.append(','.join(values))
362
url_bits.append('chls=%s' % '|'.join(style))
363
if self.grid:
364
url_bits.append('chg=%s' % self.grid)
365
return url_bits
366
367
# Downloading
368
# -------------------------------------------------------------------------
369
370
def download(self, file_name):
371
opener = urllib2.urlopen(self.get_url())
372
373
if opener.headers['content-type'] != 'image/png':
374
raise BadContentTypeException('Server responded with a ' \
375
'content-type of %s' % opener.headers['content-type'])
376
377
open(file_name, 'wb').write(urllib.urlopen(self.get_url()).read())
378
379
# Simple settings
380
# -------------------------------------------------------------------------
381
382
def set_title(self, title):
383
if title:
384
self.title = urllib.quote(title)
385
else:
386
self.title = None
387
388
def set_legend(self, legend):
389
"""legend needs to be a list, tuple or None"""
390
assert(isinstance(legend, list) or isinstance(legend, tuple) or
391
legend is None)
392
if legend:
393
self.legend = [urllib.quote(a) for a in legend]
394
else:
395
self.legend = None
396
397
# Chart colours
398
# -------------------------------------------------------------------------
399
400
def set_colours(self, colours):
401
# colours needs to be a list, tuple or None
402
assert(isinstance(colours, list) or isinstance(colours, tuple) or
403
colours is None)
404
# make sure the colours are in the right format
405
if colours:
406
for col in colours:
407
_check_colour(col)
408
self.colours = colours
409
410
# Background/Chart colours
411
# -------------------------------------------------------------------------
412
413
def fill_solid(self, area, colour):
414
assert(area in Chart.VALID_SOLID_FILL_TYPES)
415
_check_colour(colour)
416
self.fill_area[area] = colour
417
self.fill_types[area] = Chart.SOLID
418
419
def _check_fill_linear(self, angle, *args):
420
assert(isinstance(args, list) or isinstance(args, tuple))
421
assert(angle >= 0 and angle <= 90)
422
assert(len(args) % 2 == 0)
423
args = list(args) # args is probably a tuple and we need to mutate
424
for a in xrange(len(args) / 2):
425
col = args[a * 2]
426
offset = args[a * 2 + 1]
427
_check_colour(col)
428
assert(offset >= 0 and offset <= 1)
429
args[a * 2 + 1] = str(args[a * 2 + 1])
430
return args
431
432
def fill_linear_gradient(self, area, angle, *args):
433
assert(area in Chart.VALID_SOLID_FILL_TYPES)
434
args = self._check_fill_linear(angle, *args)
435
self.fill_types[area] = Chart.LINEAR_GRADIENT
436
self.fill_area[area] = ','.join([str(angle)] + args)
437
438
def fill_linear_stripes(self, area, angle, *args):
439
assert(area in Chart.VALID_SOLID_FILL_TYPES)
440
args = self._check_fill_linear(angle, *args)
441
self.fill_types[area] = Chart.LINEAR_STRIPES
442
self.fill_area[area] = ','.join([str(angle)] + args)
443
444
def fill_to_url(self):
445
areas = []
446
for area in (Chart.BACKGROUND, Chart.CHART, Chart.ALPHA):
447
if self.fill_types[area]:
448
areas.append('%s,%s,%s' % (area, self.fill_types[area], \
449
self.fill_area[area]))
450
if areas:
451
return 'chf=' + '|'.join(areas)
452
453
# Data
454
# -------------------------------------------------------------------------
455
456
def data_class_detection(self, data):
457
"""Determines the appropriate data encoding type to give satisfactory
458
resolution (http://code.google.com/apis/chart/#chart_data).
459
"""
460
assert(isinstance(data, list) or isinstance(data, tuple))
461
if not isinstance(self, (LineChart, BarChart, ScatterChart)):
462
# From the link above:
463
# Simple encoding is suitable for all other types of chart
464
# regardless of size.
465
return SimpleData
466
elif self.height < 100:
467
# The link above indicates that line and bar charts less
468
# than 300px in size can be suitably represented with the
469
# simple encoding. I've found that this isn't sufficient,
470
# e.g. examples/line-xy-circle.png. Let's try 100px.
471
return SimpleData
472
else:
473
return ExtendedData
474
475
def data_x_range(self):
476
"""Return a 2-tuple giving the minimum and maximum x-axis
477
data range.
478
"""
479
try:
480
lower = min([min(s) for type, s in self.annotated_data()
481
if type == 'x'])
482
upper = max([max(s) for type, s in self.annotated_data()
483
if type == 'x'])
484
return (lower, upper)
485
except ValueError:
486
return None # no x-axis datasets
487
488
def data_y_range(self):
489
"""Return a 2-tuple giving the minimum and maximum y-axis
490
data range.
491
"""
492
try:
493
lower = min([min(s) for type, s in self.annotated_data()
494
if type == 'y'])
495
upper = max([max(s) + 1 for type, s in self.annotated_data()
496
if type == 'y'])
497
return (lower, upper)
498
except ValueError:
499
return None # no y-axis datasets
500
501
def scaled_data(self, data_class, x_range=None, y_range=None):
502
"""Scale `self.data` as appropriate for the given data encoding
503
(data_class) and return it.
504
505
An optional `y_range` -- a 2-tuple (lower, upper) -- can be
506
given to specify the y-axis bounds. If not given, the range is
507
inferred from the data: (0, <max-value>) presuming no negative
508
values, or (<min-value>, <max-value>) if there are negative
509
values. `self.scaled_y_range` is set to the actual lower and
510
upper scaling range.
511
512
Ditto for `x_range`. Note that some chart types don't have x-axis
513
data.
514
"""
515
self.scaled_data_class = data_class
516
517
# Determine the x-axis range for scaling.
518
if x_range is None:
519
x_range = self.data_x_range()
520
if x_range and x_range[0] > 0:
521
x_range = (0, x_range[1])
522
self.scaled_x_range = x_range
523
524
# Determine the y-axis range for scaling.
525
if y_range is None:
526
y_range = self.data_y_range()
527
if y_range and y_range[0] > 0:
528
y_range = (0, y_range[1])
529
self.scaled_y_range = y_range
530
531
scaled_data = []
532
for type, dataset in self.annotated_data():
533
if type == 'x':
534
scale_range = x_range
535
elif type == 'y':
536
scale_range = y_range
537
elif type == 'marker-size':
538
scale_range = (0, max(dataset))
539
scaled_data.append([data_class.scale_value(v, scale_range)
540
for v in dataset])
541
return scaled_data
542
543
def add_data(self, data):
544
self.data.append(data)
545
return len(self.data) - 1 # return the "index" of the data set
546
547
def data_to_url(self, data_class=None):
548
if not data_class:
549
data_class = self.data_class_detection(self.data)
550
if not issubclass(data_class, Data):
551
raise UnknownDataTypeException()
552
if self.auto_scale:
553
data = self.scaled_data(data_class, self.x_range, self.y_range)
554
else:
555
data = self.data
556
return repr(data_class(data))
557
558
def annotated_data(self):
559
for dataset in self.data:
560
yield ('x', dataset)
561
562
# Axis Labels
563
# -------------------------------------------------------------------------
564
565
def set_axis_labels(self, axis_type, values):
566
assert(axis_type in Axis.TYPES)
567
values = [urllib.quote(a) for a in values]
568
axis_index = len(self.axis)
569
axis = LabelAxis(axis_index, axis_type, values)
570
self.axis.append(axis)
571
return axis_index
572
573
def set_axis_range(self, axis_type, low, high):
574
assert(axis_type in Axis.TYPES)
575
axis_index = len(self.axis)
576
axis = RangeAxis(axis_index, axis_type, low, high)
577
self.axis.append(axis)
578
return axis_index
579
580
def set_axis_positions(self, axis_index, positions):
581
try:
582
self.axis[axis_index].set_positions(positions)
583
except IndexError:
584
raise InvalidParametersException('Axis index %i has not been ' \
585
'created' % axis)
586
587
def set_axis_style(self, axis_index, colour, font_size=None, \
588
alignment=None):
589
try:
590
self.axis[axis_index].set_style(colour, font_size, alignment)
591
except IndexError:
592
raise InvalidParametersException('Axis index %i has not been ' \
593
'created' % axis)
594
595
def axis_to_url(self):
596
available_axis = []
597
label_axis = []
598
range_axis = []
599
positions = []
600
styles = []
601
index = -1
602
for axis in self.axis:
603
available_axis.append(axis.axis_type)
604
if isinstance(axis, RangeAxis):
605
range_axis.append(repr(axis))
606
if isinstance(axis, LabelAxis):
607
label_axis.append(repr(axis))
608
if axis.positions:
609
positions.append(axis.positions_to_url())
610
if axis.has_style:
611
styles.append(axis.style_to_url())
612
if not available_axis:
613
return
614
url_bits = []
615
url_bits.append('chxt=%s' % ','.join(available_axis))
616
if label_axis:
617
url_bits.append('chxl=%s' % '|'.join(label_axis))
618
if range_axis:
619
url_bits.append('chxr=%s' % '|'.join(range_axis))
620
if positions:
621
url_bits.append('chxp=%s' % '|'.join(positions))
622
if styles:
623
url_bits.append('chxs=%s' % '|'.join(styles))
624
return '&'.join(url_bits)
625
626
# Markers, Ranges and Fill area (chm)
627
# -------------------------------------------------------------------------
628
629
def markers_to_url(self):
630
return 'chm=%s' % '|'.join([','.join(a) for a in self.markers])
631
632
def add_marker(self, index, point, marker_type, colour, size, priority=0):
633
self.markers.append((marker_type, colour, str(index), str(point), \
634
str(size), str(priority)))
635
636
def add_horizontal_range(self, colour, start, stop):
637
self.markers.append(('r', colour, '1', str(start), str(stop)))
638
639
def add_vertical_range(self, colour, start, stop):
640
self.markers.append(('R', colour, '1', str(start), str(stop)))
641
642
def add_fill_range(self, colour, index_start, index_end):
643
self.markers.append(('b', colour, str(index_start), str(index_end), \
644
'1'))
645
646
def add_fill_simple(self, colour):
647
self.markers.append(('B', colour, '1', '1', '1'))
648
649
# Line styles
650
# -------------------------------------------------------------------------
651
652
def set_line_style(self, index, thickness=1, line_segment=None, \
653
blank_segment=None):
654
value = []
655
value.append(str(thickness))
656
if line_segment:
657
value.append(str(line_segment))
658
value.append(str(blank_segment))
659
self.line_styles[index] = value
660
661
# Grid
662
# -------------------------------------------------------------------------
663
664
def set_grid(self, x_step, y_step, line_segment=1, \
665
blank_segment=0):
666
self.grid = '%s,%s,%s,%s' % (x_step, y_step, line_segment, \
667
blank_segment)
668
669
670
class ScatterChart(Chart):
671
672
def type_to_url(self):
673
return 'cht=s'
674
675
def annotated_data(self):
676
yield ('x', self.data[0])
677
yield ('y', self.data[1])
678
if len(self.data) > 2:
679
# The optional third dataset is relative sizing for point
680
# markers.
681
yield ('marker-size', self.data[2])
682
683
684
class LineChart(Chart):
685
686
def __init__(self, *args, **kwargs):
687
if type(self) == LineChart:
688
raise AbstractClassException('This is an abstract class')
689
Chart.__init__(self, *args, **kwargs)
690
691
692
class SimpleLineChart(LineChart):
693
694
def type_to_url(self):
695
return 'cht=lc'
696
697
def annotated_data(self):
698
# All datasets are y-axis data.
699
for dataset in self.data:
700
yield ('y', dataset)
701
702
703
class SparkLineChart(SimpleLineChart):
704
705
def type_to_url(self):
706
return 'cht=ls'
707
708
709
class XYLineChart(LineChart):
710
711
def type_to_url(self):
712
return 'cht=lxy'
713
714
def annotated_data(self):
715
# Datasets alternate between x-axis, y-axis.
716
for i, dataset in enumerate(self.data):
717
if i % 2 == 0:
718
yield ('x', dataset)
719
else:
720
yield ('y', dataset)
721
722
723
class BarChart(Chart):
724
725
def __init__(self, *args, **kwargs):
726
if type(self) == BarChart:
727
raise AbstractClassException('This is an abstract class')
728
Chart.__init__(self, *args, **kwargs)
729
self.bar_width = None
730
self.zero_lines = {}
731
732
def set_bar_width(self, bar_width):
733
self.bar_width = bar_width
734
735
def set_zero_line(self, index, zero_line):
736
self.zero_lines[index] = zero_line
737
738
def get_url_bits(self, data_class=None, skip_chbh=False):
739
url_bits = Chart.get_url_bits(self, data_class=data_class)
740
if not skip_chbh and self.bar_width is not None:
741
url_bits.append('chbh=%i' % self.bar_width)
742
zero_line = []
743
if self.zero_lines:
744
for index in xrange(max(self.zero_lines) + 1):
745
if index in self.zero_lines:
746
zero_line.append(str(self.zero_lines[index]))
747
else:
748
zero_line.append('0')
749
url_bits.append('chp=%s' % ','.join(zero_line))
750
return url_bits
751
752
753
class StackedHorizontalBarChart(BarChart):
754
755
def type_to_url(self):
756
return 'cht=bhs'
757
758
759
class StackedVerticalBarChart(BarChart):
760
761
def type_to_url(self):
762
return 'cht=bvs'
763
764
def annotated_data(self):
765
for dataset in self.data:
766
yield ('y', dataset)
767
768
769
class GroupedBarChart(BarChart):
770
771
def __init__(self, *args, **kwargs):
772
if type(self) == GroupedBarChart:
773
raise AbstractClassException('This is an abstract class')
774
BarChart.__init__(self, *args, **kwargs)
775
self.bar_spacing = None
776
self.group_spacing = None
777
778
def set_bar_spacing(self, spacing):
779
"""Set spacing between bars in a group."""
780
self.bar_spacing = spacing
781
782
def set_group_spacing(self, spacing):
783
"""Set spacing between groups of bars."""
784
self.group_spacing = spacing
785
786
def get_url_bits(self, data_class=None):
787
# Skip 'BarChart.get_url_bits' and call Chart directly so the parent
788
# doesn't add "chbh" before we do.
789
url_bits = BarChart.get_url_bits(self, data_class=data_class,
790
skip_chbh=True)
791
if self.group_spacing is not None:
792
if self.bar_spacing is None:
793
raise InvalidParametersException('Bar spacing is required ' \
794
'to be set when setting group spacing')
795
if self.bar_width is None:
796
raise InvalidParametersException('Bar width is required to ' \
797
'be set when setting bar spacing')
798
url_bits.append('chbh=%i,%i,%i'
799
% (self.bar_width, self.bar_spacing, self.group_spacing))
800
elif self.bar_spacing is not None:
801
if self.bar_width is None:
802
raise InvalidParametersException('Bar width is required to ' \
803
'be set when setting bar spacing')
804
url_bits.append('chbh=%i,%i' % (self.bar_width, self.bar_spacing))
805
elif self.bar_width:
806
url_bits.append('chbh=%i' % self.bar_width)
807
return url_bits
808
809
810
class GroupedHorizontalBarChart(GroupedBarChart):
811
812
def type_to_url(self):
813
return 'cht=bhg'
814
815
816
class GroupedVerticalBarChart(GroupedBarChart):
817
818
def type_to_url(self):
819
return 'cht=bvg'
820
821
def annotated_data(self):
822
for dataset in self.data:
823
yield ('y', dataset)
824
825
826
class PieChart(Chart):
827
828
def __init__(self, *args, **kwargs):
829
if type(self) == PieChart:
830
raise AbstractClassException('This is an abstract class')
831
Chart.__init__(self, *args, **kwargs)
832
self.pie_labels = []
833
if self.y_range:
834
warnings.warn('y_range is not used with %s.' % \
835
(self.__class__.__name__))
836
837
def set_pie_labels(self, labels):
838
self.pie_labels = [urllib.quote(a) for a in labels]
839
840
def get_url_bits(self, data_class=None):
841
url_bits = Chart.get_url_bits(self, data_class=data_class)
842
if self.pie_labels:
843
url_bits.append('chl=%s' % '|'.join(self.pie_labels))
844
return url_bits
845
846
def annotated_data(self):
847
# Datasets are all y-axis data. However, there should only be
848
# one dataset for pie charts.
849
for dataset in self.data:
850
yield ('x', dataset)
851
852
853
class PieChart2D(PieChart):
854
855
def type_to_url(self):
856
return 'cht=p'
857
858
859
class PieChart3D(PieChart):
860
861
def type_to_url(self):
862
return 'cht=p3'
863
864
865
class VennChart(Chart):
866
867
def type_to_url(self):
868
return 'cht=v'
869
870
def annotated_data(self):
871
for dataset in self.data:
872
yield ('y', dataset)
873
874
875
class RadarChart(Chart):
876
877
def type_to_url(self):
878
return 'cht=r'
879
880
881
class SplineRadarChart(RadarChart):
882
883
def type_to_url(self):
884
return 'cht=rs'
885
886
887
class MapChart(Chart):
888
889
def __init__(self, *args, **kwargs):
890
Chart.__init__(self, *args, **kwargs)
891
self.geo_area = 'world'
892
self.codes = []
893
894
def type_to_url(self):
895
return 'cht=t'
896
897
def set_codes(self, codes):
898
self.codes = codes
899
900
def get_url_bits(self, data_class=None):
901
url_bits = Chart.get_url_bits(self, data_class=data_class)
902
url_bits.append('chtm=%s' % self.geo_area)
903
if self.codes:
904
url_bits.append('chld=%s' % ''.join(self.codes))
905
return url_bits
906
907
908
class GoogleOMeterChart(PieChart):
909
"""Inheriting from PieChart because of similar labeling"""
910
911
def __init__(self, *args, **kwargs):
912
PieChart.__init__(self, *args, **kwargs)
913
if self.auto_scale and not self.x_range:
914
warnings.warn('Please specify an x_range with GoogleOMeterChart, '
915
'otherwise one arrow will always be at the max.')
916
917
def type_to_url(self):
918
return 'cht=gom'
919
920
921
class ChartGrammar(object):
922
923
def __init__(self):
924
self.grammar = None
925
self.chart = None
926
927
def parse(self, grammar):
928
self.grammar = grammar
929
self.chart = self.create_chart_instance()
930
931
for attr in self.grammar:
932
if attr in ('w', 'h', 'type', 'auto_scale', 'x_range', 'y_range'):
933
continue # These are already parsed in create_chart_instance
934
attr_func = 'parse_' + attr
935
if not hasattr(self, attr_func):
936
warnings.warn('No parser for grammar attribute "%s"' % (attr))
937
continue
938
getattr(self, attr_func)(grammar[attr])
939
940
return self.chart
941
942
def parse_data(self, data):
943
self.chart.data = data
944
print self.chart.data
945
946
@staticmethod
947
def get_possible_chart_types():
948
possible_charts = []
949
for cls_name in globals().keys():
950
if not cls_name.endswith('Chart'):
951
continue
952
cls = globals()[cls_name]
953
# Check if it is an abstract class
954
try:
955
a = cls(1, 1, auto_scale=False)
956
del a
957
except AbstractClassException:
958
continue
959
# Strip off "Class"
960
possible_charts.append(cls_name[:-5])
961
return possible_charts
962
963
def create_chart_instance(self, grammar=None):
964
if not grammar:
965
grammar = self.grammar
966
assert(isinstance(grammar, dict)) # grammar must be a dict
967
assert('w' in grammar) # width is required
968
assert('h' in grammar) # height is required
969
assert('type' in grammar) # type is required
970
chart_type = grammar['type']
971
w = grammar['w']
972
h = grammar['h']
973
auto_scale = grammar.get('auto_scale', None)
974
x_range = grammar.get('x_range', None)
975
y_range = grammar.get('y_range', None)
976
types = ChartGrammar.get_possible_chart_types()
977
if chart_type not in types:
978
raise UnknownChartType('%s is an unknown chart type. Possible '
979
'chart types are %s' % (chart_type, ','.join(types)))
980
return globals()[chart_type + 'Chart'](w, h, auto_scale=auto_scale,
981
x_range=x_range, y_range=y_range)
982
983
def download(self):
984
pass
985
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0