2
pygooglechart - A complete Python wrapper for the Google Chart API
4
http://pygooglechart.slowchop.com/
6
Copyright 2007-2008 Gerald Kaszuba
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.
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.
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/>.
32
# Helper variables and functions
33
# -----------------------------------------------------------------------------
36
__author__ = 'Gerald Kaszuba'
38
reo_colour = re.compile('^([A-Fa-f0-9]{2,2}){3,4}$')
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' % \
47
def _reset_warnings():
48
"""Helper function to reset all warnings. Used by the unit tests."""
49
globals()['__warningregistry__'] = None
51
# warnings.warn_explicit(msg, warnings.UserWarning,
55
# -----------------------------------------------------------------------------
58
class PyGoogleChartException(Exception):
62
class DataOutOfRangeException(PyGoogleChartException):
66
class UnknownDataTypeException(PyGoogleChartException):
70
class NoDataGivenException(PyGoogleChartException):
74
class InvalidParametersException(PyGoogleChartException):
78
class BadContentTypeException(PyGoogleChartException):
82
class AbstractClassException(PyGoogleChartException):
86
class UnknownChartType(PyGoogleChartException):
91
# -----------------------------------------------------------------------------
96
def __init__(self, data):
97
if type(self) == Data:
98
raise AbstractClassException('This is an abstract class')
102
def float_scale_value(cls, value, range):
104
assert(upper > lower)
105
scaled = (value - lower) * (float(cls.max_value) / (upper - lower))
109
def clip_value(cls, value):
110
return max(0, min(value, cls.max_value))
113
def int_scale_value(cls, value, range):
114
return int(round(cls.float_scale_value(value, range)))
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.')
126
class SimpleData(Data):
129
enc_map = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'
133
for data in self.data:
138
elif value >= 0 and value <= self.max_value:
139
sub_data.append(SimpleData.enc_map[value])
141
raise DataOutOfRangeException('cannot encode value: %d'
143
encoded_data.append(''.join(sub_data))
144
return 'chd=s:' + ','.join(encoded_data)
147
class TextData(Data):
153
for data in self.data:
158
elif value >= 0 and value <= self.max_value:
159
sub_data.append("%.1f" % float(value))
161
raise DataOutOfRangeException()
162
encoded_data.append(','.join(sub_data))
163
return 'chd=t:' + '|'.join(encoded_data)
166
def scale_value(cls, value, range):
167
# use float values instead of integers because we don't need an encode
169
scaled = cls.float_scale_value(value, range)
170
clipped = cls.clip_value(scaled)
174
class ExtendedData(Data):
178
'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-.'
182
enc_size = len(ExtendedData.enc_map)
183
for data in self.data:
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]))
194
raise DataOutOfRangeException( \
195
'Item #%i "%s" is out of range' % (data.index(value), \
197
encoded_data.append(''.join(sub_data))
198
return 'chd=e:' + ','.join(encoded_data)
202
# -----------------------------------------------------------------------------
211
TYPES = (BOTTOM, TOP, LEFT, RIGHT)
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
220
def set_index(self, axis_index):
221
self.axis_index = axis_index
223
def set_positions(self, positions):
224
self.positions = positions
226
def set_style(self, colour, font_size=None, alignment=None):
227
_check_colour(colour)
229
self.font_size = font_size
230
self.alignment = alignment
231
self.has_style = True
233
def style_to_url(self):
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)
243
def positions_to_url(self):
245
bits.append(str(self.axis_index))
246
bits += [str(a) for a in self.positions]
247
return ','.join(bits)
250
class LabelAxis(Axis):
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]
257
return '%i:|%s' % (self.axis_index, '|'.join(self.values))
260
class RangeAxis(Axis):
262
def __init__(self, axis_index, axis_type, low, high, **kwargs):
263
Axis.__init__(self, axis_index, axis_type, **kwargs)
268
return '%i,%s,%s' % (self.axis_index, self.low, self.high)
271
# -----------------------------------------------------------------------------
275
"""Abstract class for all chart types.
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.
281
BASE_URL = 'http://chart.apis.google.com/chart?'
285
VALID_SOLID_FILL_TYPES = (BACKGROUND, CHART, ALPHA)
287
LINEAR_GRADIENT = 'lg'
288
LINEAR_STRIPES = 'ls'
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))
299
self.set_title(title)
300
self.set_legend(legend)
301
self.set_colours(colours)
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
312
Chart.BACKGROUND: None,
317
Chart.BACKGROUND: None,
323
self.line_styles = {}
327
# -------------------------------------------------------------------------
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)
333
def get_url_bits(self, data_class=None):
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))
341
url_bits.append('chtt=%s' % self.title)
343
url_bits.append('chdl=%s' % '|'.join(self.legend))
345
url_bits.append('chco=%s' % ','.join(self.colours))
346
ret = self.fill_to_url()
349
ret = self.axis_to_url()
353
url_bits.append(self.markers_to_url())
356
for index in xrange(max(self.line_styles) + 1):
357
if index in self.line_styles:
358
values = self.line_styles[index]
361
style.append(','.join(values))
362
url_bits.append('chls=%s' % '|'.join(style))
364
url_bits.append('chg=%s' % self.grid)
368
# -------------------------------------------------------------------------
370
def download(self, file_name):
371
opener = urllib2.urlopen(self.get_url())
373
if opener.headers['content-type'] != 'image/png':
374
raise BadContentTypeException('Server responded with a ' \
375
'content-type of %s' % opener.headers['content-type'])
377
open(file_name, 'wb').write(urllib.urlopen(self.get_url()).read())
380
# -------------------------------------------------------------------------
382
def set_title(self, title):
384
self.title = urllib.quote(title)
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
393
self.legend = [urllib.quote(a) for a in legend]
398
# -------------------------------------------------------------------------
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
404
# make sure the colours are in the right format
408
self.colours = colours
410
# Background/Chart colours
411
# -------------------------------------------------------------------------
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
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):
426
offset = args[a * 2 + 1]
428
assert(offset >= 0 and offset <= 1)
429
args[a * 2 + 1] = str(args[a * 2 + 1])
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)
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)
444
def fill_to_url(self):
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]))
451
return 'chf=' + '|'.join(areas)
454
# -------------------------------------------------------------------------
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).
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.
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.
475
def data_x_range(self):
476
"""Return a 2-tuple giving the minimum and maximum x-axis
480
lower = min([min(s) for type, s in self.annotated_data()
482
upper = max([max(s) for type, s in self.annotated_data()
484
return (lower, upper)
486
return None # no x-axis datasets
488
def data_y_range(self):
489
"""Return a 2-tuple giving the minimum and maximum y-axis
493
lower = min([min(s) for type, s in self.annotated_data()
495
upper = max([max(s) + 1 for type, s in self.annotated_data()
497
return (lower, upper)
499
return None # no y-axis datasets
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.
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
512
Ditto for `x_range`. Note that some chart types don't have x-axis
515
self.scaled_data_class = data_class
517
# Determine the x-axis range for scaling.
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
524
# Determine the y-axis range for scaling.
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
532
for type, dataset in self.annotated_data():
534
scale_range = x_range
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)
543
def add_data(self, data):
544
self.data.append(data)
545
return len(self.data) - 1 # return the "index" of the data set
547
def data_to_url(self, data_class=None):
549
data_class = self.data_class_detection(self.data)
550
if not issubclass(data_class, Data):
551
raise UnknownDataTypeException()
553
data = self.scaled_data(data_class, self.x_range, self.y_range)
556
return repr(data_class(data))
558
def annotated_data(self):
559
for dataset in self.data:
563
# -------------------------------------------------------------------------
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)
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)
580
def set_axis_positions(self, axis_index, positions):
582
self.axis[axis_index].set_positions(positions)
584
raise InvalidParametersException('Axis index %i has not been ' \
587
def set_axis_style(self, axis_index, colour, font_size=None, \
590
self.axis[axis_index].set_style(colour, font_size, alignment)
592
raise InvalidParametersException('Axis index %i has not been ' \
595
def axis_to_url(self):
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))
609
positions.append(axis.positions_to_url())
611
styles.append(axis.style_to_url())
612
if not available_axis:
615
url_bits.append('chxt=%s' % ','.join(available_axis))
617
url_bits.append('chxl=%s' % '|'.join(label_axis))
619
url_bits.append('chxr=%s' % '|'.join(range_axis))
621
url_bits.append('chxp=%s' % '|'.join(positions))
623
url_bits.append('chxs=%s' % '|'.join(styles))
624
return '&'.join(url_bits)
626
# Markers, Ranges and Fill area (chm)
627
# -------------------------------------------------------------------------
629
def markers_to_url(self):
630
return 'chm=%s' % '|'.join([','.join(a) for a in self.markers])
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)))
636
def add_horizontal_range(self, colour, start, stop):
637
self.markers.append(('r', colour, '1', str(start), str(stop)))
639
def add_vertical_range(self, colour, start, stop):
640
self.markers.append(('R', colour, '1', str(start), str(stop)))
642
def add_fill_range(self, colour, index_start, index_end):
643
self.markers.append(('b', colour, str(index_start), str(index_end), \
646
def add_fill_simple(self, colour):
647
self.markers.append(('B', colour, '1', '1', '1'))
650
# -------------------------------------------------------------------------
652
def set_line_style(self, index, thickness=1, line_segment=None, \
655
value.append(str(thickness))
657
value.append(str(line_segment))
658
value.append(str(blank_segment))
659
self.line_styles[index] = value
662
# -------------------------------------------------------------------------
664
def set_grid(self, x_step, y_step, line_segment=1, \
666
self.grid = '%s,%s,%s,%s' % (x_step, y_step, line_segment, \
670
class ScatterChart(Chart):
672
def type_to_url(self):
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
681
yield ('marker-size', self.data[2])
684
class LineChart(Chart):
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)
692
class SimpleLineChart(LineChart):
694
def type_to_url(self):
697
def annotated_data(self):
698
# All datasets are y-axis data.
699
for dataset in self.data:
703
class SparkLineChart(SimpleLineChart):
705
def type_to_url(self):
709
class XYLineChart(LineChart):
711
def type_to_url(self):
714
def annotated_data(self):
715
# Datasets alternate between x-axis, y-axis.
716
for i, dataset in enumerate(self.data):
723
class BarChart(Chart):
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
732
def set_bar_width(self, bar_width):
733
self.bar_width = bar_width
735
def set_zero_line(self, index, zero_line):
736
self.zero_lines[index] = zero_line
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)
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]))
748
zero_line.append('0')
749
url_bits.append('chp=%s' % ','.join(zero_line))
753
class StackedHorizontalBarChart(BarChart):
755
def type_to_url(self):
759
class StackedVerticalBarChart(BarChart):
761
def type_to_url(self):
764
def annotated_data(self):
765
for dataset in self.data:
769
class GroupedBarChart(BarChart):
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
778
def set_bar_spacing(self, spacing):
779
"""Set spacing between bars in a group."""
780
self.bar_spacing = spacing
782
def set_group_spacing(self, spacing):
783
"""Set spacing between groups of bars."""
784
self.group_spacing = spacing
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,
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))
806
url_bits.append('chbh=%i' % self.bar_width)
810
class GroupedHorizontalBarChart(GroupedBarChart):
812
def type_to_url(self):
816
class GroupedVerticalBarChart(GroupedBarChart):
818
def type_to_url(self):
821
def annotated_data(self):
822
for dataset in self.data:
826
class PieChart(Chart):
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)
834
warnings.warn('y_range is not used with %s.' % \
835
(self.__class__.__name__))
837
def set_pie_labels(self, labels):
838
self.pie_labels = [urllib.quote(a) for a in labels]
840
def get_url_bits(self, data_class=None):
841
url_bits = Chart.get_url_bits(self, data_class=data_class)
843
url_bits.append('chl=%s' % '|'.join(self.pie_labels))
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:
853
class PieChart2D(PieChart):
855
def type_to_url(self):
859
class PieChart3D(PieChart):
861
def type_to_url(self):
865
class VennChart(Chart):
867
def type_to_url(self):
870
def annotated_data(self):
871
for dataset in self.data:
875
class RadarChart(Chart):
877
def type_to_url(self):
881
class SplineRadarChart(RadarChart):
883
def type_to_url(self):
887
class MapChart(Chart):
889
def __init__(self, *args, **kwargs):
890
Chart.__init__(self, *args, **kwargs)
891
self.geo_area = 'world'
894
def type_to_url(self):
897
def set_codes(self, codes):
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)
904
url_bits.append('chld=%s' % ''.join(self.codes))
908
class GoogleOMeterChart(PieChart):
909
"""Inheriting from PieChart because of similar labeling"""
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.')
917
def type_to_url(self):
921
class ChartGrammar(object):
927
def parse(self, grammar):
928
self.grammar = grammar
929
self.chart = self.create_chart_instance()
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))
938
getattr(self, attr_func)(grammar[attr])
942
def parse_data(self, data):
943
self.chart.data = data
944
print self.chart.data
947
def get_possible_chart_types():
949
for cls_name in globals().keys():
950
if not cls_name.endswith('Chart'):
952
cls = globals()[cls_name]
953
# Check if it is an abstract class
955
a = cls(1, 1, auto_scale=False)
957
except AbstractClassException:
960
possible_charts.append(cls_name[:-5])
961
return possible_charts
963
def create_chart_instance(self, grammar=None):
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']
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)
2
PyGoogleChart - A complete Python wrapper for the Google Chart API
4
http://pygooglechart.slowchop.com/
6
Copyright 2007 Gerald Kaszuba
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.
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.
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/>.
30
# Helper variables and functions
31
# -----------------------------------------------------------------------------
35
reo_colour = re.compile('^([A-Fa-f0-9]{2,2}){3,4}$')
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' % \
45
# -----------------------------------------------------------------------------
48
class PyGoogleChartException(Exception):
52
class DataOutOfRangeException(PyGoogleChartException):
56
class UnknownDataTypeException(PyGoogleChartException):
60
class NoDataGivenException(PyGoogleChartException):
64
class InvalidParametersException(PyGoogleChartException):
68
class BadContentTypeException(PyGoogleChartException):
73
# -----------------------------------------------------------------------------
78
def __init__(self, data):
79
assert(type(self) != Data) # This is an abstract class
83
class SimpleData(Data):
84
enc_map = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'
88
for data in self.data:
93
elif value >= 0 and value <= SimpleData.max_value:
94
sub_data.append(SimpleData.enc_map[value])
96
raise DataOutOfRangeException()
97
encoded_data.append(''.join(sub_data))
98
return 'chd=s:' + ','.join(encoded_data)
105
class TextData(Data):
109
for data in self.data:
114
elif value >= 0 and value <= TextData.max_value:
115
sub_data.append(str(float(value)))
117
raise DataOutOfRangeException()
118
encoded_data.append(','.join(sub_data))
119
return 'chd=t:' + '|'.join(encoded_data)
126
class ExtendedData(Data):
128
'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-.'
132
enc_size = len(ExtendedData.enc_map)
133
for data in self.data:
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]))
144
raise DataOutOfRangeException( \
145
'Item #%i "%s" is out of range' % (data.index(value), \
147
encoded_data.append(''.join(sub_data))
148
return 'chd=e:' + ','.join(encoded_data)
155
# -----------------------------------------------------------------------------
163
TYPES = (BOTTOM, TOP, LEFT, RIGHT)
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
172
def set_index(self, axis_index):
173
self.axis_index = axis_index
175
def set_positions(self, positions):
176
self.positions = positions
178
def set_style(self, colour, font_size=None, alignment=None):
179
_check_colour(colour)
181
self.font_size = font_size
182
self.alignment = alignment
183
self.has_style = True
185
def style_to_url(self):
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)
195
def positions_to_url(self):
197
bits.append(str(self.axis_index))
198
bits += [str(a) for a in self.positions]
199
return ','.join(bits)
202
class LabelAxis(Axis):
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]
209
return '%i:|%s' % (self.axis_index, '|'.join(self.values))
212
class RangeAxis(Axis):
214
def __init__(self, axis_index, axis_type, low, high, **kwargs):
215
Axis.__init__(self, axis_index, axis_type, **kwargs)
220
return '%i,%s,%s' % (self.axis_index, self.low, self.high)
223
# -----------------------------------------------------------------------------
227
"""Abstract class for all chart types.
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.
233
BASE_URL = 'http://chart.apis.google.com/chart?'
237
LINEAR_GRADIENT = 'lg'
238
LINEAR_STRIPES = 'ls'
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))
247
self.set_title(title)
248
self.set_legend(legend)
249
self.set_colours(colours)
251
Chart.BACKGROUND: None,
255
Chart.BACKGROUND: None,
268
# -------------------------------------------------------------------------
271
url_bits = self.get_url_bits()
272
return self.BASE_URL + '&'.join(url_bits)
274
def get_url_bits(self):
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())
282
url_bits.append('chtt=%s' % self.title)
284
url_bits.append('chdl=%s' % '|'.join(self.legend))
286
url_bits.append('chco=%s' % ','.join(self.colours))
287
ret = self.fill_to_url()
290
ret = self.axis_to_url()
294
url_bits.append(self.markers_to_url())
298
# -------------------------------------------------------------------------
300
def download(self, file_name):
301
opener = urllib2.urlopen(self.get_url())
303
if opener.headers['content-type'] != 'image/png':
304
raise BadContentTypeException('Server responded with a ' \
305
'content-type of %s' % opener.headers['content-type'])
307
open(file_name, 'wb').write(urllib.urlopen(self.get_url()).read())
310
# -------------------------------------------------------------------------
312
def set_title(self, title):
314
self.title = urllib.quote(title)
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
323
self.legend = [urllib.quote(a) for a in legend]
328
# -------------------------------------------------------------------------
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
334
# make sure the colours are in the right format
338
self.colours = colours
340
# Background/Chart colours
341
# -------------------------------------------------------------------------
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
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):
356
offset = args[a * 2 + 1]
358
assert(offset >= 0 and offset <= 1)
359
args[a * 2 + 1] = str(args[a * 2 + 1])
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)
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)
374
def fill_to_url(self):
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]))
381
return 'chf=' + '|'.join(areas)
384
# -------------------------------------------------------------------------
386
def data_class_detection(self, data):
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.
391
assert(isinstance(data, list) or isinstance(data, tuple))
394
assert(isinstance(a, list) or isinstance(a, tuple))
395
if max_value is None or max(a) > max_value:
397
for data_class in (SimpleData, TextData, ExtendedData):
398
if max_value <= data_class.max_value():
400
raise DataOutOfRangeException()
402
def add_data(self, data):
403
self.data.append(data)
404
return len(self.data) - 1 # return the "index" of the data set
406
def data_to_url(self, data_class=None):
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))
414
# -------------------------------------------------------------------------
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)
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)
431
def set_axis_positions(self, axis_index, positions):
433
self.axis[axis_index].set_positions(positions)
435
raise InvalidParametersException('Axis index %i has not been ' \
438
def set_axis_style(self, axis_index, colour, font_size=None, \
441
self.axis[axis_index].set_style(colour, font_size, alignment)
443
raise InvalidParametersException('Axis index %i has not been ' \
446
def axis_to_url(self):
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))
460
positions.append(axis.positions_to_url())
462
styles.append(axis.style_to_url())
463
if not available_axis:
466
url_bits.append('chxt=%s' % ','.join(available_axis))
468
url_bits.append('chxl=%s' % '|'.join(label_axis))
470
url_bits.append('chxr=%s' % '|'.join(range_axis))
472
url_bits.append('chxp=%s' % '|'.join(positions))
474
url_bits.append('chxs=%s' % '|'.join(styles))
475
return '&'.join(url_bits)
477
# Markers, Ranges and Fill area (chm)
478
# -------------------------------------------------------------------------
480
def markers_to_url(self):
481
return 'chm=%s' % '|'.join([','.join(a) for a in self.markers])
483
def add_marker(self, index, point, marker_type, colour, size):
484
self.markers.append((marker_type, colour, str(index), str(point), \
487
def add_horizontal_range(self, colour, start, stop):
488
self.markers.append(('r', colour, '1', str(start), str(stop)))
490
def add_vertical_range(self, colour, start, stop):
491
self.markers.append(('R', colour, '1', str(start), str(stop)))
493
def add_fill_range(self, colour, index_start, index_end):
494
self.markers.append(('b', colour, str(index_start), str(index_end), \
497
def add_fill_simple(self, colour):
498
self.markers.append(('B', colour, '1', '1', '1'))
501
class ScatterChart(Chart):
503
def __init__(self, *args, **kwargs):
504
Chart.__init__(self, *args, **kwargs)
506
def type_to_url(self):
510
class LineChart(Chart):
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 = {}
518
def set_line_style(self, index, thickness=1, line_segment=None, \
521
value.append(str(thickness))
523
value.append(str(line_segment))
524
value.append(str(blank_segment))
525
self.line_styles[index] = value
527
def set_grid(self, x_step, y_step, line_segment=1, \
529
self.grid = '%s,%s,%s,%s' % (x_step, y_step, line_segment, \
532
def get_url_bits(self):
533
url_bits = Chart.get_url_bits(self)
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]
542
style.append(','.join(values))
543
url_bits.append('chls=%s' % '|'.join(style))
545
url_bits.append('chg=%s' % self.grid)
549
class SimpleLineChart(LineChart):
551
def type_to_url(self):
555
class XYLineChart(LineChart):
557
def type_to_url(self):
561
class BarChart(Chart):
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
568
def set_bar_width(self, bar_width):
569
self.bar_width = bar_width
571
def get_url_bits(self):
572
url_bits = Chart.get_url_bits(self)
573
url_bits.append('chbh=%i' % self.bar_width)
577
class StackedHorizontalBarChart(BarChart):
579
def type_to_url(self):
583
class StackedVerticalBarChart(BarChart):
585
def type_to_url(self):
589
class GroupedBarChart(BarChart):
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
596
def set_bar_spacing(self, spacing):
597
self.bar_spacing = spacing
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))
609
url_bits.append('chbh=%i' % self.bar_width)
613
class GroupedHorizontalBarChart(GroupedBarChart):
615
def type_to_url(self):
619
class GroupedVerticalBarChart(GroupedBarChart):
621
def type_to_url(self):
625
class PieChart(Chart):
627
def __init__(self, *args, **kwargs):
628
assert(type(self) != PieChart) # This is an abstract class
629
Chart.__init__(self, *args, **kwargs)
632
def set_pie_labels(self, labels):
633
self.pie_labels = labels
635
def get_url_bits(self):
636
url_bits = Chart.get_url_bits(self)
638
url_bits.append('chl=%s' % '|'.join(self.pie_labels))
642
class PieChart2D(PieChart):
644
def type_to_url(self):
648
class PieChart3D(PieChart):
650
def type_to_url(self):
654
class VennChart(Chart):
656
def type_to_url(self):
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,
681
# chart.fill_linear_stripes(Chart.CHART, 20, '204070', .2, '300040', .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)
691
# chart.set_pie_labels(('apples', 'oranges', 'bananas'))
693
# chart.set_grid(10, 10)
695
# for a in xrange(0, 100, 10):
696
# chart.add_marker(1, a, 'a', 'AACA20', 10)
698
chart.add_horizontal_range('00A020', .2, .5)
699
chart.add_vertical_range('00c030', .2, .4)
701
chart.add_fill_simple('303030A0')
703
chart.download('test.png')
705
url = chart.get_url()
708
data = urllib.urlopen(chart.get_url()).read()
709
open('meh.png', 'wb').write(data)
710
os.system('start meh.png')
713
if __name__ == '__main__':