Autoformat with ruff

Author: jarrodmillman

doc/conf.py

@@ -4,17 +4,15 @@
 # list see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
-from datetime import date
-import numpydoc
-
 # -- Path setup --------------------------------------------------------------
-
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-
 import os
 import sys
+from datetime import date
+
+import numpydoc
 
 # for example.py
 sys.path.insert(0, os.path.abspath("."))

doc/example.py

@@ -127,4 +127,3 @@ def foo(var1, var2, *args, long_var_name="hi", only_seldom_used_keyword=0, **kwa
     # separate following codes (according to PEP257).
     # But for function, method and module, there should be no blank lines
     # after closing the docstring.
-    pass

numpydoc/cli.py

@@ -2,8 +2,9 @@
 
 import argparse
 import ast
+from collections.abc import Sequence
 from pathlib import Path
-from typing import List, Sequence, Union
+from typing import List, Union
 
 from .docscrape_sphinx import get_doc_object
 from .hooks import utils, validate_docstrings

numpydoc/docscrape.py

@@ -1,18 +1,15 @@
-"""Extract reference documentation from the NumPy source tree.
-
-"""
+"""Extract reference documentation from the NumPy source tree."""
 
+import copy
 import inspect
-import textwrap
-import re
 import pydoc
-from warnings import warn
+import re
+import sys
+import textwrap
 from collections import namedtuple
 from collections.abc import Callable, Mapping
-import copy
-import sys
-
 from functools import cached_property
+from warnings import warn
 
 
 def strip_blank_lines(l):

numpydoc/docscrape_sphinx.py

@@ -1,20 +1,17 @@
-import re
 import inspect
-import textwrap
-import pydoc
-from collections.abc import Callable
 import os
+import pydoc
+import re
+import textwrap
 
 from jinja2 import FileSystemLoader
 from jinja2.sandbox import SandboxedEnvironment
-import sphinx
 from sphinx.jinja2glue import BuiltinTemplateLoader
 
-from .docscrape import NumpyDocString, FunctionDoc, ClassDoc, ObjDoc
+from .docscrape import ClassDoc, FunctionDoc, NumpyDocString, ObjDoc
 from .docscrape import get_doc_object as get_doc_object_orig
 from .xref import make_xref
 
-
 IMPORT_MATPLOTLIB_RE = r"\b(import +matplotlib|from +matplotlib +import)\b"
 
 

numpydoc/hooks/utils.py

@@ -2,8 +2,8 @@
 
 import itertools
 import os
+from collections.abc import Sequence
 from pathlib import Path
-from typing import Sequence
 
 
 def find_project_root(srcs: Sequence[str]):
@@ -31,7 +31,7 @@ def find_project_root(srcs: Sequence[str]):
         `Black <https://github.com/psf/black/blob/main/src/black/files.py>`_.
     """
     if not srcs:
-        return Path(".").resolve(), "current directory"
+        return Path().resolve(), "current directory"
 
     common_path = Path(
         os.path.commonpath([Path(src).expanduser().resolve() for src in srcs])

numpydoc/numpydoc.py

@@ -17,24 +17,22 @@
 
 """
 
-from copy import deepcopy
-import re
-import pydoc
-import inspect
-from collections.abc import Callable
 import hashlib
+import inspect
 import itertools
+import pydoc
+import re
+from collections.abc import Callable
+from copy import deepcopy
 
-from docutils.nodes import citation, Text, section, comment, reference, inline
-import sphinx
-from sphinx.addnodes import pending_xref, desc_content
+from docutils.nodes import Text, citation, comment, inline, reference, section
+from sphinx.addnodes import desc_content, pending_xref
 from sphinx.util import logging
-from sphinx.errors import ExtensionError
 
+from . import __version__
 from .docscrape_sphinx import get_doc_object
-from .validate import validate, ERROR_MSGS, get_validation_checks
+from .validate import get_validation_checks, validate
 from .xref import DEFAULT_LINKS
-from . import __version__
 
 logger = logging.getLogger(__name__)
 
@@ -248,10 +246,10 @@ def mangle_signature(app, what, name, obj, options, sig, retann):
         return "", ""
 
     if not (isinstance(obj, Callable) or hasattr(obj, "__argspec_is_invalid_")):
-        return
+        return None
 
     if not hasattr(obj, "__doc__"):
-        return
+        return None
     doc = get_doc_object(obj, config={"show_class_members": False})
     sig = doc["Signature"] or _clean_text_signature(
         getattr(obj, "__text_signature__", None)
@@ -275,7 +273,7 @@ def _clean_text_signature(sig):
 
 def setup(app, get_doc_object_=get_doc_object):
     if not hasattr(app, "add_config_value"):
-        return  # probably called by nose, better bail out
+        return None  # probably called by nose, better bail out
 
     global get_doc_object
     get_doc_object = get_doc_object_
@@ -417,12 +415,18 @@ def match_items(lines, content_old):
 
     Examples
     --------
-    >>> lines = ['', 'A', '', 'B', '   ', '', 'C', 'D']
-    >>> lines_old = ['a', '', '', 'b', '', 'c']
-    >>> items_old = [('file1.py', 0), ('file1.py', 1), ('file1.py', 2),
-    ...              ('file2.py', 0), ('file2.py', 1), ('file2.py', 2)]
+    >>> lines = ["", "A", "", "B", "   ", "", "C", "D"]
+    >>> lines_old = ["a", "", "", "b", "", "c"]
+    >>> items_old = [
+    ...     ("file1.py", 0),
+    ...     ("file1.py", 1),
+    ...     ("file1.py", 2),
+    ...     ("file2.py", 0),
+    ...     ("file2.py", 1),
+    ...     ("file2.py", 2),
+    ... ]
     >>> content_old = ViewList(lines_old, items=items_old)
-    >>> match_items(lines, content_old) # doctest: +NORMALIZE_WHITESPACE
+    >>> match_items(lines, content_old)  # doctest: +NORMALIZE_WHITESPACE
     [('file1.py', 0), ('file1.py', 0), ('file2.py', 0), ('file2.py', 0),
      ('file2.py', 2), ('file2.py', 2), ('file2.py', 2), ('file2.py', 2)]
     >>> # first 2 ``lines`` are matched to 'a', second 2 to 'b', rest to 'c'

numpydoc/tests/hooks/example_module.py

@@ -3,7 +3,6 @@
 
 def some_function(name):
     """Welcome to some function."""
-    pass
 
 
 class MyClass:
@@ -23,11 +22,9 @@ def do_something(self, *args, **kwargs):
         ----------
         *args
         """
-        pass
 
     def process(self):
         """Process stuff."""
-        pass
 
 
 class NewClass:

numpydoc/tests/hooks/test_validate_hook.py

@@ -8,7 +8,7 @@
 from numpydoc.hooks.validate_docstrings import run_hook
 
 
-@pytest.fixture
+@pytest.fixture()
 def example_module(request):
     fullpath = (
         Path(request.config.rootdir)

numpydoc/tests/test_docscrape.py

@@ -1,24 +1,22 @@
-from collections import namedtuple
-from copy import deepcopy
 import re
 import textwrap
 import warnings
+from collections import namedtuple
+from copy import deepcopy
 
 import jinja2
+import pytest
+from pytest import warns as assert_warns
 
-from numpydoc.numpydoc import update_config
-from numpydoc.xref import DEFAULT_LINKS
-from numpydoc.docscrape import NumpyDocString, FunctionDoc, ClassDoc, ParseError
+from numpydoc.docscrape import ClassDoc, FunctionDoc, NumpyDocString
 from numpydoc.docscrape_sphinx import (
-    SphinxDocString,
     SphinxClassDoc,
+    SphinxDocString,
     SphinxFunctionDoc,
     get_doc_object,
 )
-import pytest
-from pytest import raises as assert_raises
-from pytest import warns as assert_warns
-
+from numpydoc.numpydoc import update_config
+from numpydoc.xref import DEFAULT_LINKS
 
 doc_txt = """\
   numpy.multivariate_normal(mean, cov, shape=None, spam=None)
@@ -316,11 +314,9 @@ class Dummy:
 
         def spam(self, a, b):
             """Spam\n\nSpam spam."""
-            pass
 
         def ham(self, c, d):
             """Cheese\n\nNo cheese."""
-            pass
 
     def dummy_func(arg):
         """
@@ -897,8 +893,6 @@ class Dummy:
         func_d
         """
 
-        pass
-
     s = str(FunctionDoc(Dummy, role="func"))
     assert ":func:`func_a`, :func:`func_b`" in s
     assert "    some relationship" in s
@@ -941,8 +935,6 @@ class BadSection:
         This class has a nope section.
         """
 
-        pass
-
     with pytest.warns(UserWarning, match="Unknown section Mope") as record:
         NumpyDocString(doc_text)
     assert len(record) == 1
@@ -1085,11 +1077,9 @@ class Dummy:
 
         def spam(self, a, b):
             """Spam\n\nSpam spam."""
-            pass
 
         def ham(self, c, d):
             """Cheese\n\nNo cheese."""
-            pass
 
         @property
         def spammity(self):
@@ -1099,8 +1089,6 @@ def spammity(self):
         class Ignorable:
             """local class, to be ignored"""
 
-            pass
-
     for cls in (ClassDoc, SphinxClassDoc):
         doc = cls(Dummy, config=dict(show_class_members=False))
         assert "Methods" not in str(doc), (cls, str(doc))
@@ -1128,11 +1116,9 @@ class SubDummy(Dummy):
 
         def ham(self, c, d):
             """Cheese\n\nNo cheese.\nOverloaded Dummy.ham"""
-            pass
 
         def bar(self, a, b):
             """Bar\n\nNo bar"""
-            pass
 
     for cls in (ClassDoc, SphinxClassDoc):
         doc = cls(
@@ -1274,7 +1260,7 @@ class Foo:
         @property
         def an_attribute(self):
             """Test attribute"""
-            return None
+            return
 
         @property
         def no_docstring(self):
@@ -1288,12 +1274,12 @@ def no_docstring2(self):
         def multiline_sentence(self):
             """This is a
             sentence. It spans multiple lines."""
-            return None
+            return
 
         @property
         def midword_period(self):
             """The sentence for numpy.org."""
-            return None
+            return
 
         @property
         def no_period(self):
@@ -1302,7 +1288,7 @@ def no_period(self):
 
             Apparently.
             """
-            return None
+            return
 
     doc = SphinxClassDoc(Foo, class_doc_txt)
     line_by_line_compare(
@@ -1378,7 +1364,7 @@ class Foo:
         @property
         def an_attribute(self):
             """Test attribute"""
-            return None
+            return
 
     attr_doc = """:Attributes:
 

numpydoc/tests/test_full.py

@@ -1,13 +1,12 @@
 import os.path as op
 import re
 import shutil
-from packaging import version
 
 import pytest
-import sphinx
+from docutils import __version__ as docutils_version
+from packaging import version
 from sphinx.application import Sphinx
 from sphinx.util.docutils import docutils_namespace
-from docutils import __version__ as docutils_version
 
 
 # Test framework adapted from sphinx-gallery (BSD 3-clause)

numpydoc/tests/test_main.py

@@ -33,7 +33,7 @@ def _capture_stdout(func_name, *args, **kwargs):
 
     Examples
     --------
-    >>> _capture_stdout(print, 'hello world')
+    >>> _capture_stdout(print, "hello world")
     'hello world'
     """
     f = io.StringIO()
@@ -53,7 +53,6 @@ def _docstring_with_errors():
     ----------
     made_up_param : str
     """
-    pass
 
 
 def _invalid_docstring():
@@ -64,7 +63,6 @@ def _invalid_docstring():
     --------
     : this is invalid
     """
-    pass
 
 
 def test_renders_package_docstring():