Fix tests for existing 'Adding time_precision optional option to SeriesHelper' PR (influxdata#719)

klDen · appunni-m · xginn8 · web-flow · commit 42d172d1db5e · 2020-04-09T21:15:05.000-05:00
* Adding time_precision into Meta of SeriesHelper

time_precision option not currently supported in influx-db python

* Making Time Precision optional

Changed it from required to optional

* Fixing Typo in _time_precision Attribute

* Fixing coding conventions for Travis CI

* Appunni: Test for invalid time_precision on SeriesHelper

* Appunni: Intendation problem resolution in master

* - Fix flake7 errors : E131 continuation line unaligned for hanging indent
- Fix typo
- Fix cls._client declaration ordering
- Remove duplicate code cls._autocommit ...

Co-authored-by: appunni-dishq &lt;31534711+appunni-dishq@users.noreply.github.com&gt;
Co-authored-by: xginn8 &lt;xginn8@users.noreply.github.com&gt;
Co-authored-by: appunni &lt;appunni@dishq.in&gt;
diff --git a/influxdb/helper.py b/influxdb/helper.py
@@ -41,6 +41,10 @@ class Meta:
                 # Only applicable if autocommit is True.
                 autocommit = True
                 # If True and no bulk_size, then will set bulk_size to 1.
+                time_precision = "h"|"m"|s"|"ms"|"u"|"ns"
+                # Default is ns (nanoseconds)
+                # Setting time precision while writing point
+                # You should also make sure time is set in the given precision
 
     """
 
@@ -71,6 +75,13 @@ def __new__(cls, *args, **kwargs):
                             cls.__name__))
 
             cls._autocommit = getattr(_meta, 'autocommit', False)
+            cls._time_precision = getattr(_meta, 'time_precision', None)
+
+            allowed_time_precisions = ['h', 'm', 's', 'ms', 'u', 'ns', None]
+            if cls._time_precision not in allowed_time_precisions:
+                raise AttributeError(
+                    'In {0}, time_precision is set, but invalid use any of {}.'
+                    .format(cls.__name__, ','.join(allowed_time_precisions)))
 
             cls._client = getattr(_meta, 'client', None)
             if cls._autocommit and not cls._client:
@@ -116,11 +127,11 @@ def __init__(self, **kw):
         keys = set(kw.keys())
 
         # all tags should be passed, and keys - tags should be a subset of keys
-        if not(tags <= keys):
+        if not (tags <= keys):
             raise NameError(
                 'Expected arguments to contain all tags {0}, instead got {1}.'
                 .format(cls._tags, kw.keys()))
-        if not(keys - tags <= fields):
+        if not (keys - tags <= fields):
             raise NameError('Got arguments not in tags or fields: {0}'
                             .format(keys - tags - fields))
 
@@ -143,7 +154,10 @@ def commit(cls, client=None):
         """
         if not client:
             client = cls._client
-        rtn = client.write_points(cls._json_body_())
+        rtn = client.write_points(
+            cls._json_body_(),
+            time_precision=cls._time_precision)
+        # will be None if not set and will default to ns
         cls._reset_()
         return rtn
 
diff --git a/influxdb/tests/helper_test.py b/influxdb/tests/helper_test.py
@@ -310,8 +310,19 @@ class Meta:
 
                 series_name = 'events.stats.{server_name}'
 
+        class InvalidTimePrecision(SeriesHelper):
+            """Define instance of SeriesHelper for invalid time precision."""
+
+            class Meta:
+                """Define metadata for InvalidTimePrecision."""
+
+                series_name = 'events.stats.{server_name}'
+                time_precision = "ks"
+                fields = ['time', 'server_name']
+                autocommit = True
+
         for cls in [MissingMeta, MissingClient, MissingFields,
-                    MissingSeriesName]:
+                    MissingSeriesName, InvalidTimePrecision]:
             self.assertRaises(
                 AttributeError, cls, **{'time': 159,
                                         'server_name': 'us.east-1'})
