Merge pull request #786 from bashtage/test-vendor

TST: Add tests for vendored code

Author: bashtage

arch/tests/test_vendor.py

@@ -0,0 +1,112 @@
+from typing import Literal
+
+import pytest
+
+from arch.vendor._decorators import deprecate_kwarg, indent
+
+
+@deprecate_kwarg("old", "new", {"yes": True, "no": False}, stacklevel=2)
+def f(x: int, *, old: Literal["yes", "no"] = "yes", new: bool = True) -> int:
+    if new:
+        return x + 1
+    else:
+        return x - 1
+
+
+@deprecate_kwarg("old", None, stacklevel=2)
+def g(x: int, *, old: bool = True) -> int:
+    """
+    Function with keyword-only arguments.
+
+    Parameters
+    ----------
+    x : int
+        An integer value.
+    """
+    return x + 1
+
+
+@deprecate_kwarg("old", "new", stacklevel=2)
+def bar(old=False, new=False):
+    return new
+
+
+def _baz_mapping(old: Literal["yes", "no"]) -> bool:
+    if old == "yes":
+        return True
+    elif old == "no":
+        return False
+    else:
+        raise ValueError(old)
+
+
+@deprecate_kwarg("old", "new", _baz_mapping, stacklevel=2)
+def baz(x: int, *, old: Literal["yes", "no"] = "yes", new: bool = True) -> int:
+    if new:
+        return x + 1
+    else:
+        return x - 1
+
+
+def test_deprecate_kwarg():
+    """
+    Test the deprecation of the `y` keyword argument in the function `f`.
+    """
+    with pytest.warns(FutureWarning, match="the old"):
+        f(1, old="yes")
+    with pytest.warns(FutureWarning, match="the old"):
+        f(1, old="no")
+    f(2, new=True)
+    f(2, new=False)
+    with pytest.raises(TypeError):
+        f(2, old="yes", new=True)
+    baz(2, old="yes")
+    baz(2, old="no")
+    with pytest.raises(ValueError):
+        baz(2, old="maybe")
+
+
+def test_deprecate_kwarg_no_alt():
+    """
+    Test the deprecation of the `y` keyword argument in the function `f`.
+    """
+    with pytest.warns(FutureWarning, match="the 'old'"):
+        g(1, old=True)
+
+
+def test_bad_deprecate_kwarg():
+    def constructor():
+        @deprecate_kwarg("old", None, [("yes", True), ("no", False)])
+        def h(x: int, *, old: bool = True) -> int:
+            """
+            Function with keyword-only arguments.
+
+            Parameters
+            ----------
+            x : int
+                An integer value.
+            """
+            return x + 1
+
+        return h
+
+    with pytest.raises(TypeError):
+        constructor()
+
+
+def test_simple_depr():
+    with pytest.warns(FutureWarning, match="the 'old'"):
+        bar(old=True)
+
+
+def test_indent():
+    res = indent(
+        """
+This is a test
+""",
+        1,
+    )
+    assert res[:5] == "\n" + " " * 4
+    assert res[5:] == "This is a test\n    "
+
+    assert indent(None) == ""