Added warning on ResultSet's __getitem__ and documented its replacement

aviau · aviau · commit 99dc3e7c6354 · 2015-06-15T08:54:11.000-04:00
diff --git a/influxdb/__init__.py b/influxdb/__init__.py
@@ -13,4 +13,4 @@
 ]
 
 
-__version__ = '2.5.0'
+__version__ = '2.5.1'
diff --git a/influxdb/resultset.py b/influxdb/resultset.py
@@ -1,5 +1,7 @@
 # -*- coding: utf-8 -*-
 
+import warnings
+
 from influxdb.exceptions import InfluxDBClientError
 
 _sentinel = object()
@@ -37,6 +39,13 @@ def __getitem__(self, key):
         The order in which the points are yielded is actually undefined but
         it might change..
         """
+
+        warnings.warn(
+            ("ResultSet's ``__getitem__`` method will be deprecated. Use"
+             "``get_points`` instead."),
+            DeprecationWarning
+        )
+
         if isinstance(key, tuple):
             if 2 != len(key):
                 raise TypeError('only 2-tuples allowed')
@@ -54,6 +63,17 @@ def __getitem__(self, key):
         return self.get_points(name, tags)
 
     def get_points(self, measurement=None, tags=None):
+        """
+        Returns a generator for all the points that match the given filters.
+
+        :param measurement: The measurement name
+        :type measurement: str
+
+        :param tags: Tags to look for
+        :type tags: dict
+
+        :return: Points generator
+        """
 
         # Raise error if measurement is not str or bytes
         if not isinstance(measurement,
