get_database_list -> get_list_database

aviau · aviau · commit b231c79e92f3 · 2014-12-29T13:59:08.000-05:00
diff --git a/influxdb/client.py b/influxdb/client.py
@@ -402,7 +402,7 @@ def delete_database(self, database):
     # ### get list of databases
     # curl -X GET http://localhost:8086/db
 
-    def get_database_list(self):
+    def get_list_database(self):
         """
         Get the list of databases
         """
@@ -416,6 +416,18 @@ def get_database_list(self):
 
         return response.json()
 
+    def get_database_list(self):
+        """
+        DEPRECATED. Get the list of databases
+
+        """
+        warnings.warn(
+            "get_database_list is deprecated, and will be removed "
+            "in future versions. Please use "
+            "``InfluxDBClient.get_list_database`` instead.",
+            FutureWarning)
+        return self.get_list_database()
+
     def delete_series(self, series):
         """
         delete_series()
diff --git a/tests/influxdb/client_test.py b/tests/influxdb/client_test.py
@@ -9,6 +9,7 @@
 import requests_mock
 from nose.tools import raises
 from mock import patch
+import warnings
 
 from influxdb import InfluxDBClient
 from influxdb.client import session
@@ -61,6 +62,9 @@ def request(*args, **kwargs):
 class TestInfluxDBClient(unittest.TestCase):
 
     def setUp(self):
+        # By default, ignore warnings
+        warnings.simplefilter('ignore', FutureWarning)
+
         self.dummy_points = [
             {
                 "points": [
@@ -308,20 +312,31 @@ def test_delete_database_fails(self):
             cli = InfluxDBClient('host', 8086, 'username', 'password', 'db')
             cli.delete_database('old_db')
 
-    def test_get_database_list(self):
+    def test_get_list_database(self):
         data = [
             {"name": "a_db"}
         ]
         with _mocked_session('get', 200, data):
             cli = InfluxDBClient('host', 8086, 'username', 'password')
             assert len(cli.get_database_list()) == 1
-            assert cli.get_database_list()[0]['name'] == 'a_db'
+            assert cli.get_list_database()[0]['name'] == 'a_db'
 
     @raises(Exception)
-    def test_get_database_list_fails(self):
+    def test_get_list_database_fails(self):
         with _mocked_session('get', 401):
             cli = InfluxDBClient('host', 8086, 'username', 'password')
-            cli.get_database_list()
+            cli.get_list_database()
+
+    @raises(FutureWarning)
+    def test_get_database_list_deprecated(self):
+        warnings.simplefilter('error', FutureWarning)
+        data = [
+            {"name": "a_db"}
+        ]
+        with _mocked_session('get', 200, data):
+            cli = InfluxDBClient('host', 8086, 'username', 'password')
+            assert len(cli.get_database_list()) == 1
+            assert cli.get_database_list()[0]['name'] == 'a_db'
 
     def test_delete_series(self):
         with _mocked_session('delete', 204):
