make the test suite green again (free of warnings)

* must_warn now accepts a num_expected argument to set the number of warnings we expect (instead of just checking there is only one)
* mark all expected warnings as such
* rename TestCheckedSession to CheckedSessionExample to avoid pytest trying to "test" it

Author: gdementen

larray/tests/common.py

@@ -154,23 +154,25 @@ def meta():
 
 
 @contextmanager
-def must_warn(warn_cls=None, msg=None, match=None, check_file=True, check_num=True):
-    if msg is not None and match is not None:
-        raise ValueError("bad test: can't use both msg and match arguments")
-    elif msg is not None:
-        match = re.escape(msg)
-
-    try:
-        with pytest.warns(warn_cls, match=match) as caught_warnings:
-            yield caught_warnings
-    finally:
-        if check_num:
-            assert len(caught_warnings) == 1
-        if check_file:
-            caller_path = inspect.stack()[2].filename
-            warning_path = caught_warnings[0].filename
-            assert warning_path == caller_path, \
-                f"{warning_path} != {caller_path}"
+def must_warn(warn_cls=None, msg=None, match=None, check_file=True, num_expected=1):
+    if num_expected == 0:
+        yield []
+    else:
+        if msg is not None and match is not None:
+            raise ValueError("bad test: can't use both msg and match arguments")
+        elif msg is not None:
+            match = re.escape(msg)
+        try:
+            with pytest.warns(warn_cls, match=match) as caught_warnings:
+                yield caught_warnings
+        finally:
+            if num_expected is not None:
+                num_caught = len(caught_warnings)
+                assert num_caught == num_expected, f"caught {num_caught} warnings instead of {num_expected}"
+            if check_file:
+                caller_path = inspect.stack()[2].filename
+                warning_path = caught_warnings[0].filename
+                assert warning_path == caller_path, f"{warning_path} != {caller_path}"
 
 
 @contextmanager

larray/tests/test_array.py

@@ -5310,7 +5310,8 @@ def test_zip_array_items():
 
 def test_growth_rate():
     arr = Array([1, 2, 0, 0, 0, 4, 5], axes='time=2014..2020')
-    res = arr.growth_rate('time')
+    with must_warn(RuntimeWarning, "divide by zero encountered during operation"):
+        res = arr.growth_rate('time')
     expected_res = Array([1.0, -1.0, 0.0, 0.0, inf, 0.25], axes='time=2015..2020')
     assert_array_equal(res, expected_res)
 

larray/tests/test_checked_session.py

@@ -24,7 +24,7 @@
 meta = meta
 
 
-class TestCheckedSession(CheckedSession):
+class CheckedSessionExample(CheckedSession):
     b = b
     b024 = b024
     a: Axis
@@ -42,7 +42,7 @@ class TestCheckedSession(CheckedSession):
 
 @pytest.fixture()
 def checkedsession():
-    return TestCheckedSession(a=a, a2=a2, a01=a01, e=e, g=g, f=f, h=h)
+    return CheckedSessionExample(a=a, a2=a2, a01=a01, e=e, g=g, f=f, h=h)
 
 
 def test_create_checkedsession_instance(meta):
@@ -53,7 +53,7 @@ def test_create_checkedsession_instance(meta):
     declared_variable_keys = ['a', 'a2', 'a01', 'c', 'e', 'g', 'f', 'h', 'b', 'b024', 'anonymous', 'ano01', 'd']
 
     # setting variables without default values
-    cs = TestCheckedSession(a, a01, a2=a2, e=e, f=f, g=g, h=h)
+    cs = CheckedSessionExample(a, a01, a2=a2, e=e, f=f, g=g, h=h)
     assert list(cs.keys()) == declared_variable_keys
     assert cs.b.equals(b)
     assert cs.b024.equals(b024)
@@ -70,18 +70,19 @@ def test_create_checkedsession_instance(meta):
     assert cs.h.equals(h)
 
     # metadata
-    cs = TestCheckedSession(a, a01, a2=a2, e=e, f=f, g=g, h=h, meta=meta)
+    cs = CheckedSessionExample(a, a01, a2=a2, e=e, f=f, g=g, h=h, meta=meta)
     assert cs.meta == meta
 
     # override default value
     b_alt = Axis('b=b0..b4')
-    cs = TestCheckedSession(a, a01, b=b_alt, a2=a2, e=e, f=f, g=g, h=h)
+    cs = CheckedSessionExample(a, a01, b=b_alt, a2=a2, e=e, f=f, g=g, h=h)
     assert cs.b is b_alt
 
     # test for "NOT_LOADED" variables
-    with must_warn(UserWarning, msg="No value passed for the declared variable 'a'", check_file=False):
-        TestCheckedSession(a01=a01, a2=a2, e=e, f=f, g=g, h=h)
-    cs = TestCheckedSession()
+    with must_warn(UserWarning, msg="No value passed for the declared variable 'a'"):
+        CheckedSessionExample(a01=a01, a2=a2, e=e, f=f, g=g, h=h)
+    with must_warn(UserWarning, match=r"No value passed for the declared variable '\w+'", num_expected=7):
+        cs = CheckedSessionExample()
     assert list(cs.keys()) == declared_variable_keys
     # --- variables with default values ---
     assert cs.b.equals(b)
@@ -100,17 +101,17 @@ def test_create_checkedsession_instance(meta):
     assert isinstance(cs.h, NotLoaded)
 
     # passing a scalar to set all elements a CheckedArray
-    cs = TestCheckedSession(a, a01, a2=a2, e=e, f=f, g=g, h=5)
+    cs = CheckedSessionExample(a, a01, a2=a2, e=e, f=f, g=g, h=5)
     assert cs.h.axes == AxisCollection((a3, b2))
     assert cs.h.equals(full(axes=(a3, b2), fill_value=5))
 
     # add the undeclared variable 'i'
-    with must_warn(UserWarning, f"'i' is not declared in '{cs.__class__.__name__}'", check_file=False):
-        cs = TestCheckedSession(a, a01, a2=a2, i=5, e=e, f=f, g=g, h=h)
+    with must_warn(UserWarning, f"'i' is not declared in '{cs.__class__.__name__}'"):
+        cs = CheckedSessionExample(a, a01, a2=a2, i=5, e=e, f=f, g=g, h=h)
     assert list(cs.keys()) == declared_variable_keys + ['i']
 
     # test inheritance between checked sessions
-    class TestInheritance(TestCheckedSession):
+    class TestInheritance(CheckedSessionExample):
         # override variables
         b = b2
         c: int = 5
@@ -145,7 +146,7 @@ class TestInheritance(TestCheckedSession):
 
 @needs_pytables
 def test_init_checkedsession_hdf():
-    cs = TestCheckedSession(inputpath('test_session.h5'))
+    cs = CheckedSessionExample(inputpath('test_session.h5'))
     assert set(cs.keys()) == {'b', 'b024', 'a', 'a2', 'anonymous', 'a01', 'ano01', 'c', 'd', 'e', 'g', 'f', 'h'}
 
 
@@ -260,7 +261,7 @@ def test_add_cs(checkedsession):
     test_add(cs)
 
     u = Axis('u=u0..u2')
-    with must_warn(UserWarning, msg=f"'u' is not declared in '{cs.__class__.__name__}'", check_file=False):
+    with must_warn(UserWarning, msg=f"'u' is not declared in '{cs.__class__.__name__}'"):
         cs.add(u)
 
 
@@ -276,7 +277,8 @@ def test_iter_cs(checkedsession):
 def test_filter_cs(checkedsession):
     # see comment in test_iter_cs() about fields ordering
     cs = checkedsession
-    cs.ax = 'ax'
+    with must_warn(UserWarning, msg="'ax' is not declared in 'CheckedSessionExample'"):
+        cs.ax = 'ax'
     assert_seq_equal(cs.filter(), [a, a2, a01, c, e, g, f, h, b, b024, anonymous, ano01, d, 'ax'])
     assert_seq_equal(cs.filter('a*'), [a, a2, a01, anonymous, ano01, 'ax'])
     assert list(cs.filter('a*', dict)) == []
@@ -306,9 +308,10 @@ def _test_io_cs(tmpdir, meta, engine, ext):
 
     # a) - all typed variables have a defined value
     #    - no extra variables are added
-    csession = TestCheckedSession(a=a, a2=a2, a01=a01, d=d, e=e, g=g, f=f, h=h, meta=meta)
+    csession = CheckedSessionExample(a=a, a2=a2, a01=a01, d=d, e=e, g=g, f=f, h=h, meta=meta)
     csession.save(fpath, engine=engine)
-    cs = TestCheckedSession()
+    with must_warn(UserWarning, match=r"No value passed for the declared variable '\w+'", num_expected=7):
+        cs = CheckedSessionExample()
     cs.load(fpath, engine=engine)
     # --- keys ---
     assert list(cs.keys()) == list(csession.keys())
@@ -343,12 +346,14 @@ def _test_io_cs(tmpdir, meta, engine, ext):
 
     # b) - not all typed variables have a defined value
     #    - no extra variables are added
-    csession = TestCheckedSession(a=a, d=d, e=e, h=h, meta=meta)
+    with must_warn(UserWarning, match=r"No value passed for the declared variable '\w+'", num_expected=4):
+        csession = CheckedSessionExample(a=a, d=d, e=e, h=h, meta=meta)
     if 'csv' in engine:
         import shutil
         shutil.rmtree(fpath)
     csession.save(fpath, engine=engine)
-    cs = TestCheckedSession()
+    with must_warn(UserWarning, match=r"No value passed for the declared variable '\w+'", num_expected=7):
+        cs = CheckedSessionExample()
     cs.load(fpath, engine=engine)
     # --- keys ---
     assert list(cs.keys()) == list(csession.keys())
@@ -379,10 +384,27 @@ def _test_io_cs(tmpdir, meta, engine, ext):
     i = ndtest(6)
     j = ndtest((3, 3))
     k = ndtest((2, 2))
-    csession = TestCheckedSession(a=a, a2=a2, a01=a01, d=d, e=e, g=g, f=f, h=h, k=k, j=j, i=i, meta=meta)
+    with must_warn(UserWarning, match=r"'\w' is not declared in 'CheckedSessionExample'", num_expected=3):
+        csession = CheckedSessionExample(a=a, a2=a2, a01=a01, d=d, e=e, g=g, f=f, h=h, k=k, j=j, i=i, meta=meta)
     csession.save(fpath, engine=engine)
-    cs = TestCheckedSession()
-    cs.load(fpath, engine=engine)
+    with must_warn(UserWarning, match=r"No value passed for the declared variable '\w+'", num_expected=7):
+        cs = CheckedSessionExample()
+
+    # number of expected warnings is different depending on engine
+    expected_warnings = {
+        'pandas_excel': 3,
+        'xlwings_excel': 3,
+        'pandas_csv': 3,
+        'pandas_hdf': 47,  # FIXME: there is something fishy here
+        'pickle': 3,
+    }
+    num_expected = expected_warnings[engine]
+    # FIXME: we should try to fix the bad warning line instead of ignoring it
+    check_file = engine != 'pandas_hdf'
+    with must_warn(UserWarning, match=r"'\w' is not declared in 'CheckedSessionExample'",
+                   check_file=check_file, num_expected=num_expected):
+        cs.load(fpath, engine=engine)
+
     # --- names ---
     # we do not use keys() since order of undeclared variables
     # may not be preserved (at least for the HDF format)
@@ -394,15 +416,29 @@ def _test_io_cs(tmpdir, meta, engine, ext):
 
     # Update a Group + an Axis + an array (overwrite=False)
     # -----------------------------------------------------
-    csession = TestCheckedSession(a=a, a2=a2, a01=a01, d=d, e=e, g=g, f=f, h=h, meta=meta)
+    csession = CheckedSessionExample(a=a, a2=a2, a01=a01, d=d, e=e, g=g, f=f, h=h, meta=meta)
     csession.save(fpath, engine=engine)
     a4 = Axis('a=0..3')
     a4_01 = a3['0,1'] >> 'a01'
     e2 = ndtest((a4, 'b=b0..b2'))
     h2 = full_like(h, fill_value=10)
-    TestCheckedSession(a=a4, a01=a4_01, e=e2, h=h2).save(fpath, overwrite=False, engine=engine)
-    cs = TestCheckedSession()
-    cs.load(fpath, engine=engine)
+    with must_warn(UserWarning, match=r"No value passed for the declared variable '\w+'", num_expected=3):
+        CheckedSessionExample(a=a4, a01=a4_01, e=e2, h=h2).save(fpath, overwrite=False, engine=engine)
+    with must_warn(UserWarning, match=r"No value passed for the declared variable '\w+'", num_expected=7):
+        cs = CheckedSessionExample()
+
+    # number of expected warnings is different depending on engine
+    expected_warnings = {
+        'pandas_excel': 0,
+        'xlwings_excel': 0,
+        'pandas_hdf': 0,
+        'pandas_csv': 3,
+        'pickle': 0,
+    }
+    num_expected = expected_warnings[engine]
+    with must_warn(UserWarning, match=r"'\w' is not declared in 'CheckedSessionExample'",
+                   num_expected=num_expected):
+        cs.load(fpath, engine=engine)
     # --- variables with default values ---
     assert cs.b.equals(b)
     assert cs.b024.equals(b024)
@@ -440,9 +476,10 @@ def _test_io_cs(tmpdir, meta, engine, ext):
 
     # Load only some objects
     # ----------------------
-    csession = TestCheckedSession(a=a, a2=a2, a01=a01, d=d, e=e, g=g, f=f, h=h, meta=meta)
+    csession = CheckedSessionExample(a=a, a2=a2, a01=a01, d=d, e=e, g=g, f=f, h=h, meta=meta)
     csession.save(fpath, engine=engine)
-    cs = TestCheckedSession()
+    with must_warn(UserWarning, match=r"No value passed for the declared variable '\w+'", num_expected=7):
+        cs = CheckedSessionExample()
     names_to_load = ['e', 'h'] if is_excel_or_csv else ['a', 'a01', 'a2', 'e', 'h']
     cs.load(fpath, names=names_to_load, engine=engine)
     # --- keys ---

larray/tests/test_session.py

@@ -13,7 +13,7 @@
                                  needs_xlwings, needs_pytables, needs_openpyxl, must_warn)
 from larray.inout.common import _supported_scalars_types
 from larray import (Session, Axis, Array, Group, isnan, zeros_like, ndtest, ones_like,
-                    ones, full, full_like, stack, local_arrays, global_arrays, arrays)
+                    ones, full, full_like, stack, local_arrays, global_arrays, arrays, CheckedSession)
 
 
 # avoid flake8 errors
@@ -152,7 +152,10 @@ def test_setattr(session):
 def test_add(session):
     i = Axis('i=i0..i2')
     i01 = i['i0,i1'] >> 'i01'
-    session.add(i, i01, j='j')
+    expected_warnings = 3 if isinstance(session, CheckedSession) else 0
+    with must_warn(UserWarning, match=r"'\w+' is not declared in 'CheckedSessionExample'",
+                   num_expected=expected_warnings):
+        session.add(i, i01, j='j')
     assert i.equals(session.i)
     assert i01 == session.i01
     assert session.j == 'j'
@@ -371,7 +374,10 @@ def test_element_equals(session):
         del other_session[deleted_key]
         expected_res[deleted_key] = False
     # add one item
-    other_session['k'] = k
+    expected_warnings = 1 if isinstance(other_session, CheckedSession) else 0
+    with must_warn(UserWarning, match=r"'k' is not declared in 'CheckedSessionExample'",
+                   num_expected=expected_warnings):
+        other_session['k'] = k
     expected_res = expected_res.append('name', False, label='k')
 
     res = session.element_equals(other_session)
@@ -408,7 +414,10 @@ def test_eq(session):
     # ====== session with missing/extra items ======
     del other_session['g']
     expected_res['g'] = False
-    other_session['k'] = k
+    expected_warnings = 1 if isinstance(other_session, CheckedSession) else 0
+    with must_warn(UserWarning, match=r"'k' is not declared in 'CheckedSessionExample'",
+                   num_expected=expected_warnings):
+        other_session['k'] = k
     expected_res = expected_res.append('name', False, label='k')
 
     res = session == other_session
@@ -448,7 +457,10 @@ def test_ne(session):
     # ====== session with missing/extra items ======
     del other_session['g']
     expected_res['g'] = True
-    other_session['k'] = k
+    expected_warnings = 1 if isinstance(other_session, CheckedSession) else 0
+    with must_warn(UserWarning, match=r"'k' is not declared in 'CheckedSessionExample'",
+                   num_expected=expected_warnings):
+        other_session['k'] = k
     expected_res = expected_res.append('name', True, label='k')
 
     res = session != other_session
@@ -563,7 +575,7 @@ def test_rdiv(session):
     sess = session
 
     # scalar / session
-    with must_warn(RuntimeWarning, msg="divide by zero encountered during operation", check_num=False):
+    with must_warn(RuntimeWarning, msg="divide by zero encountered during operation", num_expected=4):
         res = 2 / sess
     with np.errstate(divide='ignore'):
         expected_e = 2 / e
@@ -580,7 +592,7 @@ def test_rdiv(session):
     other = {'e': e, 'f': f}
     with must_warn(RuntimeWarning,
                    msg="invalid value (NaN) encountered during operation (this is typically caused by a 0 / 0)",
-                   check_num=False):
+                   num_expected=2):
         res = other / sess
     with np.errstate(invalid='ignore'):
         expected_e = e / e

setup.cfg

@@ -31,6 +31,7 @@ addopts = -v --doctest-modules
           #--cov
 
 filterwarnings =
+    ignore::DeprecationWarning:flake8.*:
     ignore::DeprecationWarning:pyreadline.*:
     ignore::DeprecationWarning:pywintypes.*:
     ignore::DeprecationWarning:tables.*: