tqdm_pandas: backwards compatibility + deprecation message and unit test

lrq3000 · lrq3000 · commit 2e742748a419 · 2016-07-06T04:05:19.000+02:00
Signed-off-by: Stephen L. &lt;lrq3000@gmail.com&gt;
diff --git a/tqdm/_tqdm_pandas.py b/tqdm/_tqdm_pandas.py
@@ -58,7 +58,15 @@ def inner(df, func, *args, **kwargs):
             total += 1  # pandas calls update once too many
 
         # Init bar
-        t = tclass(*targs, total=total, **tkwargs)
+        if isinstance(tclass, type) or \
+            (hasattr(tclass, '__name__') and
+                tclass.__name__ == 'tqdm_notebook'):  # delayed adapter case
+            t = tclass(*targs, total=total, **tkwargs)
+        else:
+            t = tclass
+            t.total = total
+            t.write("Warning: tqdm_pandas: using a bar instance is deprecated,"
+                    " please provide a bar class instead.", file=t.fp)
 
         # Define bar updating wrapper
         def wrapper(*args, **kwargs):
@@ -69,7 +77,7 @@ def wrapper(*args, **kwargs):
         # on the df using our wrapper (which provides bar updating)
         result = df.apply(wrapper, *args, **kwargs)
 
-        # Close bar and return result
+        # Close bar and return pandas calculation result
         t.close()
         return result
 
diff --git a/tqdm/tests/tests_pandas.py b/tqdm/tests/tests_pandas.py
@@ -83,3 +83,24 @@ def test_pandas_leave():
             our_file.seek(0)
             raise AssertionError("\nExpected:\n{0}\nIn:{1}\n".format(
                 exres, our_file.read()))
+
+
+@with_setup(pretest, posttest)
+def test_pandas_deprecation():
+    """ Test bar object instance as argument deprecation """
+    try:
+        from numpy.random import randint
+        from tqdm import tqdm_pandas
+        import pandas as pd
+    except:
+        raise SkipTest
+
+    # Trigger a warning.
+    with closing(StringIO()) as our_file:
+        df = pd.DataFrame(randint(0, 50, (500, 3)))
+        tqdm_pandas(tqdm(file=our_file, leave=False, ascii=True, ncols=20))
+        df.groupby(0).progress_apply(lambda x: None)
+        # Check deprecation message
+        our_file.seek(0)
+        out = our_file.read()
+        assert "deprecated" in out
