adds add_time_series convenience method for passing series with datetimes

Brian Luft · Brian Luft · commit 2c653598b3bd · 2011-02-04T09:35:18.000-08:00
diff --git a/pyflot/__init__.py b/pyflot/__init__.py
@@ -2,6 +2,7 @@
 from functools import partial
 import inspect
 import json
+import time
 
 
 def update(d, u):
@@ -100,4 +101,19 @@ def add_series(self, series, label=None, **kwargs):
                 new_series.update({line_type: kwargs[line_type]})
         self._series.append(new_series)
 
+    def add_time_series(self, series, label=None, **kwargs):
+    	"""
+    	A specialized form of ``add_series`` for adding time-series data.
+
+        Flot requires times to be specified in Javascript timestamp format.
+        This convenience function lets you pass datetime instances and handles
+        the conversion. It also sets the correct option to indicate to ``flot``
+        that the graph should be treated as a time series
+        """
+        _series = [(time.mktime(ts.timetuple()) * 1000, val) \
+                    for ts, val in series]
+        self._options['xaxis'] = {'mode': 'time'}
+        return self.add_series(_series, label, **kwargs)
+
+
 
diff --git a/tests/__init__.py b/tests/__init__.py
@@ -1,3 +1,4 @@
+from datetime import date, timedelta
 import json
 import unittest
 
@@ -79,6 +80,25 @@ def test_series_with_label_json(self):
         self.flot.add_series(S1, 'label1')
         self.assertEqual(json.dumps([series]), self.flot.series_json)
 
+    def test_add_time_series(self):
+        """
+        make sure adding time series works properly:
+
+        * conversion to JS timestamp
+        * time series mode added to options
+        """
+        time_series = [(date(2010, 3, 14) - timedelta(days=i), i) \
+                        for i in range(5)]
+        self.flot.add_time_series(time_series)
+        self.assertEqual(self.flot._series[0]['data'],
+            [(1268553600000.0, 0),
+            (1268467200000.0, 1),
+            (1268380800000.0, 2),
+            (1268294400000.0, 3),
+            (1268208000000.0, 4)])
+        self.assertEqual(self.flot._options['xaxis'],
+                {'mode': 'time'})
+
     def test_empty_options_json(self):
         "make sure conversion to JSON works for default options"
         self.assertEqual("{}", self.flot.options_json)
