pyessential 0.1.2__tar.gz → 0.1.3__tar.gz

{pyessential-0.1.2/pyessential.egg-info → pyessential-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyessential
-Version: 0.1.2
+Version: 0.1.3
 Summary: A growing collection of Python utilities and decorators.
 Home-page: https://github.com/Abhi39054/PyEssential.git
 Author: Abhishek Kumar

pyessential-0.1.3/pyessential/_version.py

@@ -0,0 +1 @@
+__version__ = "0.1.3"

pyessential-0.1.3/pyessential/decorators/__init__.py

@@ -0,0 +1,7 @@
+from .timer import timeit
+from .deprecated import deprecated
+
+__all__ = [
+    "timeit",
+    "deprecated"
+]

pyessential-0.1.3/pyessential/decorators/deprecated.py

@@ -0,0 +1,42 @@
+import functools
+import inspect
+import warnings
+
+
+def deprecated(reason="", *, version=None, category=DeprecationWarning):
+    """Mark a function or class as deprecated.
+
+    Args:
+        reason: Message shown to the caller, e.g. "use new_func instead".
+        version: Optional version in which it was deprecated.
+        category: Warning class to emit (default: DeprecationWarning).
+    """
+
+    def decorator(obj):
+        kind = "class" if inspect.isclass(obj) else "function"
+        message = f"{kind} '{obj.__qualname__}' is deprecated"
+        if version:
+            message += f" since version {version}"
+        message += "."
+        if reason:
+            message += f" {reason}"
+
+        if inspect.isclass(obj):
+            original_init = obj.__init__
+
+            @functools.wraps(original_init)
+            def new_init(self, *args, **kwargs):
+                warnings.warn(message, category, stacklevel=2)
+                original_init(self, *args, **kwargs)
+
+            obj.__init__ = new_init
+            return obj
+
+        @functools.wraps(obj)
+        def wrapper(*args, **kwargs):
+            warnings.warn(message, category, stacklevel=2)
+            return obj(*args, **kwargs)
+
+        return wrapper
+
+    return decorator

{pyessential-0.1.2 → pyessential-0.1.3/pyessential.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyessential
-Version: 0.1.2
+Version: 0.1.3
 Summary: A growing collection of Python utilities and decorators.
 Home-page: https://github.com/Abhi39054/PyEssential.git
 Author: Abhishek Kumar

{pyessential-0.1.2 → pyessential-0.1.3}/pyessential.egg-info/SOURCES.txt

@@ -16,8 +16,10 @@ pyessential.egg-info/dependency_links.txt
 pyessential.egg-info/entry_points.txt
 pyessential.egg-info/top_level.txt
 pyessential/decorators/__init__.py
+pyessential/decorators/deprecated.py
 pyessential/decorators/timer.py
 tests/test_cli.py
-tests/test_decorators.py
 tests/test_generators.py
-tests/test_logger.py
+tests/test_logger.py
+tests/decorators/test_deprecated.py
+tests/decorators/test_timer.py

pyessential-0.1.3/tests/decorators/test_deprecated.py

@@ -0,0 +1,41 @@
+import pytest
+
+from pyessential.decorators import deprecated
+
+
+def test_function_warns_and_still_works():
+    @deprecated("use new_func instead", version="0.2.0")
+    def old(x):
+        return x * 2
+
+    with pytest.warns(DeprecationWarning, match="use new_func instead"):
+        assert old(3) == 6
+
+
+def test_preserves_metadata():
+    @deprecated("nope")
+    def old():
+        """Docstring."""
+
+    assert old.__name__ == "old"
+    assert old.__doc__ == "Docstring."
+
+
+def test_class_warns_on_instantiation():
+    @deprecated("use NewClient instead")
+    class Old:
+        def __init__(self, value):
+            self.value = value
+
+    with pytest.warns(DeprecationWarning, match="NewClient"):
+        obj = Old(5)
+    assert obj.value == 5
+
+
+def test_custom_category():
+    @deprecated("gone soon", category=FutureWarning)
+    def old():
+        pass
+
+    with pytest.warns(FutureWarning):
+        old()

pyessential-0.1.2/pyessential/_version.py

@@ -1 +0,0 @@
-__version__ = "0.1.2"

pyessential-0.1.2/pyessential/decorators/__init__.py

@@ -1,3 +0,0 @@
-from .timer import timeit
-
-__all__ = ["timeit"]