/+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-13 05:31:11 UTC
  • Revision ID: git-v1:606b8fe55157458136af5c54683fe3079a000b92
Added GPL license file "COPYING"

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