Fix #34: versionadded and versionchanged decorators don't emi…

…t ``DeprecationWarning`` anymore on decorated classes.

CHANGELOG.rst

@@ -28,6 +28,9 @@ Fix
 
 - Fix packit configuration: use ``upstream_tag_template: v{version}``.
 
+- Fix #34: ``versionadded`` and ``versionchanged`` decorators don't emit ``DeprecationWarning``
+  anymore on decorated classes.
+
 
 Other
 -----

deprecated/sphinx.py

@@ -96,6 +96,8 @@ def __call__(self, wrapped):
         if reason:
             docstring += "   {reason}\n".format(reason=reason)
         wrapped.__doc__ = docstring
+        if self.directive in {"versionadded", "versionchanged"}:
+            return wrapped
         return super(SphinxAdapter, self).__call__(wrapped)
 
 

docs/source/sphinx/calc_mean.py

@@ -2,7 +2,7 @@ def mean(values):
     """
     Compute the arithmetic mean (“average”) of values.
 
-    :type  values: list[float]
+    :type  values: typing.List[float]
     :param values: List of floats
     :return: Mean of values.
 

docs/source/sphinx/calc_mean_deco.py

@@ -9,7 +9,7 @@ def mean(values):
     """
     Compute the arithmetic mean (“average”) of values.
 
-    :type  values: list[float]
+    :type  values: typing.List[float]
     :param values: List of floats
     :return: Mean of values.
     """

docs/source/sphinx_deco.rst

@@ -61,7 +61,7 @@ The documentation of the *mean()* function looks like this:
 
    Compute the arithmetic mean (“average”) of values.
 
-   :type  values: list[float]
+   :type  values: typing.List[float]
    :param values: List of floats
    :return: Mean of values.
 

tests/test_sphinx.py

@@ -24,6 +24,7 @@
         :return: sum = *x* + *y*
         """,
     ],
+    ids=["no_docstring", "short_docstring", "long_docstring"]
 )
 def docstring(request):
     return request.param
@@ -68,6 +69,7 @@ def directive(request):
             ),
         ),
     ],
+    ids=["reason&version", "version", "reason"]
 )
 def test_has_sphinx_docstring(docstring, directive, reason, version, expected):
     # The function:
@@ -93,6 +95,16 @@ def foo(x, y):
     if current:
         assert re.search("\n[ ]*\n$", current, flags=re.DOTALL)
 
+    with warnings.catch_warnings(record=True) as warns:
+        foo(1, 2)
+
+    if directive in {'versionadded', 'versionchanged'}:
+        # don't emit DeprecationWarning
+        assert len(warns) == 0
+    else:
+        # emit DeprecationWarning
+        assert len(warns) == 1
+
 
 # noinspection PyShadowingNames
 @pytest.mark.skipif(
@@ -131,6 +143,7 @@ def foo(x, y):
             ),
         ),
     ],
+    ids=["reason&version", "version", "reason"]
 )
 def test_cls_has_sphinx_docstring(docstring, directive, reason, version, expected):
     # The class:
@@ -156,6 +169,16 @@ class Foo(object):
     if current:
         assert re.search("\n[ ]*\n$", current, flags=re.DOTALL)
 
+    with warnings.catch_warnings(record=True) as warns:
+        Foo()
+
+    if directive in {'versionadded', 'versionchanged'}:
+        # don't emit DeprecationWarning
+        assert len(warns) == 0
+    else:
+        # emit DeprecationWarning
+        assert len(warns) == 1
+
 
 class MyDeprecationWarning(DeprecationWarning):
     pass