allow inf raising

Author: Borda

deprecate/__init__.py

@@ -1,6 +1,6 @@
 import os
 
-__version__ = "0.1.0"
+__version__ = "0.1.1"
 __docs__ = "Deprecation tooling"
 __author__ = "Jiri Borovec"
 __author_email__ = "jiri.borovec@fel.cvut.cz"

deprecate/deprecation.py

@@ -127,7 +127,7 @@ def deprecated(
         remove_in: Define version when the wrapped function will be removed.
         stream: Set stream for printing warning messages, by default is deprecation warning.
             Setting ``None``, no warning is shown to user.
-        num_warns: Custom define number or warning raised.
+        num_warns: Custom define number or warning raised. Negative value (-1) means no limit.
         template_mgs: python formatted string message which has build-ins arguments:
             ``source_name``, ``source_path``, ``target_name``, ``target_path``, ``deprecated_in``, ``remove_in``
             Example of a custom message is
@@ -153,7 +153,7 @@ def wrapped_fn(*args: Any, **kwargs: Any) -> Any:
             nb_warned = getattr(wrapped_fn, '_warned', 0)
             nb_called = getattr(wrapped_fn, '_called', 0)
             # warn user only once in lifetime
-            if stream and nb_warned < num_warns:
+            if stream and (num_warns < 0 or nb_warned < num_warns):
                 _raise_warn(
                     stream,
                     source=source,

tests/test_functions.py

@@ -32,6 +32,11 @@ def depr_sum_calls_2(a: int, b: int = 5) -> int:
     pass
 
 
+@deprecated(target=base_sum_kwargs, deprecated_in="0.1", remove_in="0.7", num_warns=-1)
+def depr_sum_calls_inf(a: int, b: int = 5) -> int:
+    pass
+
+
 @deprecated(
     target=base_sum_kwargs,
     deprecated_in="0.1",
@@ -96,6 +101,12 @@ def test_deprecated_func_stream_calls() -> None:
             assert depr_sum_calls_2(3) == 8
     assert len(record) == 2
 
+    # check that the warning is raised only once per function
+    with pytest.warns(DeprecationWarning) as record:
+        for _ in range(5):
+            assert depr_sum_calls_inf(3) == 8
+    assert len(record) == 5
+
     with pytest.deprecated_call(match='v0.1: `depr_sum_msg` was deprecated, use `test_functions.base_sum_kwargs`'):
         assert depr_sum_msg(3) == 8