Added support for not including all fields when using the series helper (influxdata#518)

spott · xginn8 · commit 56ab7203d2a2 · 2017-11-14T08:24:39.000-05:00
* Added support for not including all fields when using the series helper

* fixed flake8 check

* Added tests

* fixed pep error

* more fixes for pep

* fixed flake8 errors
diff --git a/examples/tutorial_serieshelper.py b/examples/tutorial_serieshelper.py
@@ -51,7 +51,8 @@ class Meta:
 MySeriesHelper(server_name='us.east-1', some_stat=159, other_stat=10)
 MySeriesHelper(server_name='us.east-1', some_stat=158, other_stat=20)
 MySeriesHelper(server_name='us.east-1', some_stat=157, other_stat=30)
-MySeriesHelper(server_name='us.east-1', some_stat=156, other_stat=40)
+MySeriesHelper(server_name='us.east-1', some_stat=156, other_stat=30)
+MySeriesHelper(server_name='us.east-1', some_stat=156)
 MySeriesHelper(server_name='us.east-1', some_stat=155, other_stat=50)
 
 # To manually submit data points which are not yet written, call commit:
diff --git a/influxdb/helper.py b/influxdb/helper.py
@@ -98,24 +98,31 @@ def __new__(cls, *args, **kwargs):
             if 'time' in cls._fields:
                 cls._fields.remove('time')
             cls._type = namedtuple(cls.__name__,
-                                   cls._fields + cls._tags + ['time'])
+                                   ['time'] + cls._tags + cls._fields)
+            cls._type.__new__.__defaults__ = (None,) * len(cls._fields)
 
         return super(SeriesHelper, cls).__new__(cls)
 
     def __init__(self, **kw):
-        """Call to constructor creates a new data point. All fields must be present.
+        """Call to constructor creates a new data point.
 
         :note: Data points written when `bulk_size` is reached per Helper.
         :warning: Data points are *immutable* (`namedtuples`).
         """
         cls = self.__class__
         timestamp = kw.pop('time', self._current_timestamp())
+        tags = set(cls._tags)
+        fields = set(cls._fields)
+        keys = set(kw.keys())
 
-        if sorted(cls._fields + cls._tags) != sorted(kw.keys()):
+        # all tags should be passed, and keys - tags should be a subset of keys
+        if not(tags <= keys):
             raise NameError(
-                'Expected {0}, got {1}.'.format(
-                    sorted(cls._fields + cls._tags),
-                    kw.keys()))
+                'Expected arguments to contain all tags {0}, instead got {1}.'
+                .format(cls._tags, kw.keys()))
+        if not(keys - tags <= fields):
+            raise NameError('Got arguments not in tags or fields: {0}'
+                            .format(keys - tags - fields))
 
         cls._datapoints[cls._series_name.format(**kw)].append(
             cls._type(time=timestamp, **kw)
@@ -157,7 +164,9 @@ def _json_body_(cls):
                 }
 
                 for field in cls._fields:
-                    json_point['fields'][field] = getattr(point, field)
+                    value = getattr(point, field)
+                    if value is not None:
+                        json_point['fields'][field] = value
 
                 for tag in cls._tags:
                     json_point['tags'][tag] = getattr(point, tag)
diff --git a/influxdb/tests/helper_test.py b/influxdb/tests/helper_test.py
@@ -231,6 +231,22 @@ def testSeriesWithoutTimeField(self, current_timestamp):
         self.assertEqual(point1['time'], current_date)
         self.assertEqual(point2['time'], yesterday)
 
+    def testSeriesWithoutAllTags(self):
+        """Test that creating a data point without a tag throws an error."""
+        class MyTimeFieldSeriesHelper(SeriesHelper):
+
+            class Meta:
+                client = TestSeriesHelper.client
+                series_name = 'events.stats.{server_name}'
+                fields = ['some_stat', 'time']
+                tags = ['server_name', 'other_tag']
+                bulk_size = 5
+                autocommit = True
+
+        self.assertRaises(NameError, MyTimeFieldSeriesHelper,
+                          **{"server_name": 'us.east-1',
+                             "some_stat": 158})
+
     @mock.patch('influxdb.helper.SeriesHelper._current_timestamp')
     def testSeriesWithTimeField(self, current_timestamp):
         """Test that time is optional on a series with a time field."""
