/+junk/pygooglechart-py3k

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

  • Committer: gak
  • Date: 2007-12-15 23:21:31 UTC
  • Revision ID: git-v1:857495549bac47c6a70872d4b36dd1fe49270357
version bump and MANIFEST fixes to allow examples and COPYING in the sdist

Show diffs side-by-side

added added

removed removed

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