deprecation tslib

Author: jreback

doc/source/whatsnew/v0.20.0.txt

@@ -461,9 +461,9 @@ If indicated, a deprecation warning will be issued if you reference that module.
     "pandas.json", "pandas.io.json.libjson", "X"
     "pandas.parser", "pandas.io.libparsers", "X"
     "pandas.lib", "pandas.libs.lib", "X"
+    "pandas.tslib", "pandas.libs.tslib", "X"
     "pandas.io.sas.saslib", "pandas.io.sas.libsas", ""
     "pandas.msgpack", "pandas.io.msgpack", ""
-    "pandas.tslib", "pandas.libs.tslib", ""
     "pandas.index", "pandas.libs.index", ""
     "pandas.algos", "pandas.libs.algos", ""
     "pandas.hashtable", "pandas.libs.hashtable", ""

pandas/__init__.py

@@ -64,6 +64,7 @@
 json = _DeprecatedModule(deprmod='pandas.json', deprmodto='pandas.io.json.libjson')
 parser = _DeprecatedModule(deprmod='pandas.parser', deprmodto='pandas.io.libparsers')
 lib = _DeprecatedModule(deprmod='pandas.lib', deprmodto='pandas.libs.lib')
+tslib = _DeprecatedModule(deprmod='pandas.tslib', deprmodto='pandas.libs.tslib')
 
 # use the closest tagged version if possible
 from ._version import get_versions

pandas/tests/api/test_api.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 
+from warnings import catch_warnings
 import numpy as np
 
 import pandas as pd
@@ -37,7 +38,8 @@ class TestPDApi(Base, tm.TestCase):
            'types', 'util', 'options', 'io', 'libs']
 
     # these are already deprecated; awaiting removal
-    deprecated_modules = ['stats', 'datetools', 'parser', 'json', 'lib']
+    deprecated_modules = ['stats', 'datetools', 'parser',
+                          'json', 'lib', 'tslib']
 
     # misc
     misc = ['IndexSlice', 'NaT']
@@ -244,3 +246,12 @@ def test_deprecation_access_func(self):
         with tm.assert_produces_warning(FutureWarning,
                                         check_stacklevel=False):
             pd.lib.infer_dtype
+
+
+class TestTSLib(tm.TestCase):
+
+    def test_deprecation_access_func(self):
+        # some libraries may be imported before we
+        # test and could show the warning
+        with catch_warnings(record=True):
+            pd.tslib.Timestamp

pandas/tslib.py

@@ -0,0 +1,7 @@
+# flake8: noqa
+
+import warnings
+warnings.warn("The pandas.tslib module is deprecated and will be "
+              "removed in a future version. Please import from "
+              "the pandas.libs.tslib instead", FutureWarning, stacklevel=2)
+from pandas.libs.tslib import Timestamp, Timedelta, NaT

pandas/util/depr_module.py

@@ -73,7 +73,10 @@ def __getattr__(self, name):
 
         return obj
 
-    def _import_deprmod(self, mod):
+    def _import_deprmod(self, mod=None):
+        if mod is None:
+            mod = self.deprmod
+
         with warnings.catch_warnings():
             warnings.filterwarnings('ignore', category=FutureWarning)
             deprmodule = importlib.import_module(mod)