Merge pull request influxdata#94 from influxdb/dataframe_module_change

aviau · aviau · commit a8b667666abc · 2014-12-13T13:48:30.000-05:00
influxdb.misc.DataFrameClient -&gt; influxdb.DataFrameClient
diff --git a/docs/source/api-documentation.rst b/docs/source/api-documentation.rst
@@ -21,11 +21,11 @@ ports. The below instantiation statements are all equivalent::
     client = InfluxDBClient(host='127.0.0.1', database='dbname', use_udp=True, udp_port=4444)
 
 To write pandas DataFrames or to read data into a
-pandas DataFrame, use a :py:class:`~influxdb.misc.DataFrameClient` object.
+pandas DataFrame, use a :py:class:`~influxdb.DataFrameClient` object.
 These clients are initiated in the same way as the
 :py:class:`~influxdb.InfluxDBClient`::
 
-    from influxdb.misc import DataFrameClient
+    from influxdb import DataFrameClient
 
     client = DataFrameClient(host='127.0.0.1', port=8086, username='root', password='root', dbname='dbname')
 
@@ -50,7 +50,7 @@ These clients are initiated in the same way as the
 -----------------------
 
 
-.. currentmodule:: influxdb.misc.DataFrameClient
-.. autoclass:: influxdb.misc.DataFrameClient
+.. currentmodule:: influxdb.DataFrameClient
+.. autoclass:: influxdb.DataFrameClient
     :members:
     :undoc-members:
diff --git a/examples/tutorial_pandas.py b/examples/tutorial_pandas.py
@@ -1,7 +1,7 @@
 import argparse
 import pandas as pd
 
-from influxdb.misc import DataFrameClient
+from influxdb import DataFrameClient
 
 
 def main(host='localhost', port=8086):
diff --git a/influxdb/__init__.py b/influxdb/__init__.py
@@ -1,7 +1,12 @@
 # -*- coding: utf-8 -*-
-from influxdb.client import InfluxDBClient
+from .client import InfluxDBClient
+from .dataframe_client import DataFrameClient
 
 
-__all__ = ['InfluxDBClient']
+__all__ = [
+    'InfluxDBClient',
+    'DataFrameClient',
+]
+
 
 __version__ = '0.1.13'
diff --git a/influxdb/dataframe_client.py b/influxdb/dataframe_client.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Miscellaneous
+DataFrame client for InfluxDB
 """
 import math
 import warnings
@@ -15,8 +15,18 @@ class DataFrameClient(InfluxDBClient):
     The client reads and writes from pandas DataFrames.
     """
 
-    import pandas as pd
-    EPOCH = pd.Timestamp('1970-01-01 00:00:00.000+00:00')
+    def __init__(self, *args, **kwargs):
+        super(DataFrameClient, self).__init__(*args, **kwargs)
+        try:
+            global pd
+            import pandas as pd
+        except ImportError as ex:
+            raise ImportError(
+                'DataFrameClient requires Pandas, "{ex}" problem importing'
+                .format(ex=str(ex))
+            )
+
+        self.EPOCH = pd.Timestamp('1970-01-01 00:00:00.000+00:00')
 
     def write_points(self, data, *args, **kwargs):
         """
@@ -86,10 +96,6 @@ def query(self, query, time_precision='s', chunked=False):
             return result
 
     def _to_dataframe(self, json_result, time_precision):
-        try:
-            import pandas as pd
-        except ImportError:
-            raise ImportError('pandas required for retrieving as dataframe.')
         dataframe = pd.DataFrame(data=json_result['points'],
                                  columns=json_result['columns'])
         if 'sequence_number' in dataframe.keys():
@@ -108,10 +114,6 @@ def _to_dataframe(self, json_result, time_precision):
         return dataframe
 
     def _convert_dataframe_to_json(self, dataframe, name, time_precision='s'):
-        try:
-            import pandas as pd
-        except ImportError:
-            raise ImportError('pandas required for writing as dataframe.')
         if not isinstance(dataframe, pd.DataFrame):
             raise TypeError('Must be DataFrame, but type was: {}.'
                             .format(type(dataframe)))
@@ -130,7 +132,7 @@ def _convert_dataframe_to_json(self, dataframe, name, time_precision='s'):
         return data
 
     def _datetime_to_epoch(self, datetime, time_precision='s'):
-        seconds = (datetime - DataFrameClient.EPOCH).total_seconds()
+        seconds = (datetime - self.EPOCH).total_seconds()
         if time_precision == 's':
             return seconds
         elif time_precision == 'm':
diff --git a/tests/influxdb/dataframe_client_test.py b/tests/influxdb/dataframe_client_test.py
@@ -13,7 +13,7 @@
 if not using_pypy:
     import pandas as pd
     from pandas.util.testing import assert_frame_equal
-    from influxdb.misc import DataFrameClient
+    from influxdb import DataFrameClient
 
 from .client_test import _mocked_session
 
diff --git a/tox.ini b/tox.ini
@@ -22,10 +22,13 @@ deps = -r{toxinidir}/requirements.txt
 commands = nosetests -v --with-coverage --cover-html --cover-package=influxdb
 
 [testenv:docs]
-deps = Sphinx==1.2.3
+deps = -r{toxinidir}/requirements.txt
+       pandas
+       Sphinx==1.2.3
        sphinx_rtd_theme
 commands = sphinx-build -b html docs/source docs/build
 
 [flake8]
-# Ignored because of nosetests's setUp function
-ignore = N802
+ignore = N802,F821
+# N802: nosetests's setUp function
+# F821: False positive in intluxdb/dataframe_client.py
