MAINT: split _clean_text_signature out to _utils.

All other functions defined in numpydoc.py module depend on sphinx
and therefore can be skipped for testing purposes when sphinx is
not installed.

importorskips the numpydoc tests but maintains the testing of
_clean_text_signature in new test_utils.py module.

Author: rossbar

numpydoc/_utils.py

@@ -0,0 +1,13 @@
+import re
+
+
+def _clean_text_signature(sig):
+    if sig is None:
+        return None
+    start_pattern = re.compile(r"^[^(]*\(")
+    start, end = start_pattern.search(sig).span()
+    start_sig = sig[start:end]
+    sig = sig[end:-1]
+    sig = re.sub(r"^\$(self|module|type)(,\s|$)", "", sig, count=1)
+    sig = re.sub(r"(^|(?<=,\s))/,\s\*", "*", sig, count=1)
+    return start_sig + sig + ")"

numpydoc/numpydoc.py

@@ -37,6 +37,7 @@
 from .docscrape_sphinx import get_doc_object
 from .validate import get_validation_checks, validate
 from .xref import DEFAULT_LINKS
+from ._utils import _clean_text_signature
 
 logger = logging.getLogger(__name__)
 
@@ -301,18 +302,6 @@ def mangle_signature(app: SphinxApp, what, name, obj, options, sig, retann):
         return sig, ""
 
 
-def _clean_text_signature(sig):
-    if sig is None:
-        return None
-    start_pattern = re.compile(r"^[^(]*\(")
-    start, end = start_pattern.search(sig).span()
-    start_sig = sig[start:end]
-    sig = sig[end:-1]
-    sig = re.sub(r"^\$(self|module|type)(,\s|$)", "", sig, count=1)
-    sig = re.sub(r"(^|(?<=,\s))/,\s\*", "*", sig, count=1)
-    return start_sig + sig + ")"
-
-
 def setup(app: SphinxApp, get_doc_object_=get_doc_object):
     if not hasattr(app, "add_config_value"):
         return None  # probably called by nose, better bail out

numpydoc/tests/test_numpydoc.py

@@ -1,15 +1,17 @@
+import pytest
+pytest.importorskip("sphinx")
+pytest.importorskip("docutils")
+
 from collections import defaultdict
 from copy import deepcopy
 from io import StringIO
 from pathlib import PosixPath
 
-import pytest
 from docutils import nodes
 from sphinx.ext.autodoc import ALL
 from sphinx.util import logging
 
 from numpydoc.numpydoc import (
-    _clean_text_signature,
     clean_backrefs,
     mangle_docstrings,
     update_config,
@@ -111,40 +113,6 @@ def test_mangle_docstrings_inherited_class_members():
     assert "samefile" not in lines
 
 
-def test_clean_text_signature():
-    assert _clean_text_signature(None) is None
-    assert _clean_text_signature("func($self)") == "func()"
-    assert (
-        _clean_text_signature("func($self, *args, **kwargs)") == "func(*args, **kwargs)"
-    )
-    assert _clean_text_signature("($self)") == "()"
-    assert _clean_text_signature("()") == "()"
-    assert _clean_text_signature("func()") == "func()"
-    assert (
-        _clean_text_signature("func($self, /, *args, **kwargs)")
-        == "func(*args, **kwargs)"
-    )
-    assert (
-        _clean_text_signature("func($self, other, /, *args, **kwargs)")
-        == "func(other, *args, **kwargs)"
-    )
-    assert _clean_text_signature("($module)") == "()"
-    assert _clean_text_signature("func($type)") == "func()"
-    assert (
-        _clean_text_signature('func($self, foo="hello world")')
-        == 'func(foo="hello world")'
-    )
-    assert (
-        _clean_text_signature("func($self, foo='hello world')")
-        == "func(foo='hello world')"
-    )
-    assert _clean_text_signature('func(foo="hello world")') == 'func(foo="hello world")'
-    assert _clean_text_signature('func(foo="$self")') == 'func(foo="$self")'
-    assert _clean_text_signature('func($self, foo="$self")') == 'func(foo="$self")'
-    assert _clean_text_signature("func(self, other)") == "func(self, other)"
-    assert _clean_text_signature("func($self, *args)") == "func(*args)"
-
-
 @pytest.fixture
 def f():
     def _function_without_seealso_and_examples():

numpydoc/tests/test_utils.py

@@ -0,0 +1,35 @@
+from numpydoc._utils import _clean_text_signature
+
+
+def test_clean_text_signature():
+    assert _clean_text_signature(None) is None
+    assert _clean_text_signature("func($self)") == "func()"
+    assert (
+        _clean_text_signature("func($self, *args, **kwargs)") == "func(*args, **kwargs)"
+    )
+    assert _clean_text_signature("($self)") == "()"
+    assert _clean_text_signature("()") == "()"
+    assert _clean_text_signature("func()") == "func()"
+    assert (
+        _clean_text_signature("func($self, /, *args, **kwargs)")
+        == "func(*args, **kwargs)"
+    )
+    assert (
+        _clean_text_signature("func($self, other, /, *args, **kwargs)")
+        == "func(other, *args, **kwargs)"
+    )
+    assert _clean_text_signature("($module)") == "()"
+    assert _clean_text_signature("func($type)") == "func()"
+    assert (
+        _clean_text_signature('func($self, foo="hello world")')
+        == 'func(foo="hello world")'
+    )
+    assert (
+        _clean_text_signature("func($self, foo='hello world')")
+        == "func(foo='hello world')"
+    )
+    assert _clean_text_signature('func(foo="hello world")') == 'func(foo="hello world")'
+    assert _clean_text_signature('func(foo="$self")') == 'func(foo="$self")'
+    assert _clean_text_signature('func($self, foo="$self")') == 'func(foo="$self")'
+    assert _clean_text_signature("func(self, other)") == "func(self, other)"
+    assert _clean_text_signature("func($self, *args)") == "func(*args)"