Merge branch 'numpy:main' into ConstructorChecking_ASTValidator

Author: mattgebert

.github/workflows/main.yml

@@ -5,7 +5,7 @@ jobs:
     name: Run CircleCI artifacts redirector
     steps:
       - name: GitHub Action step
-        uses: scientific-python/circleci-artifacts-redirector-action@7eafdb60666f57706a5525a2f5eb76224dc8779b # v1.1.0
+        uses: scientific-python/circleci-artifacts-redirector-action@839631420e45a08af893032e5a5e8843bf47e8ff # v1.2.0
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
           api-token: ${{ secrets.CIRCLECI_ARTIFACT_REDIRECTOR_TOKEN }}

.github/workflows/release.yml

@@ -12,7 +12,7 @@ jobs:
     name: sdist and wheels
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           fetch-depth: 0
       - uses: actions/setup-python@39cd14951b08e74b54015e9e001cdefcf80e669f # v5.1.1
@@ -40,7 +40,7 @@ jobs:
       # IMPORTANT: this permission is mandatory for trusted publishing
       id-token: write
     steps:
-      - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0
+      - uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0
         with:
           name: dist
           path: dist

.github/workflows/test.yml

@@ -16,7 +16,7 @@ jobs:
     strategy:
       matrix:
         os: [Ubuntu]
-        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
         sphinx-version:
           ["sphinx==6.0", "sphinx==6.2", "sphinx==7.0", "sphinx>=7.3"]
         include:
@@ -27,7 +27,7 @@ jobs:
       run:
         shell: bash -eo pipefail {0}
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Python setup
         uses: actions/setup-python@v5
@@ -81,7 +81,7 @@ jobs:
         os: [ubuntu]
         python-version: ["3.11", "3.12", "3.13"]
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Python setup
         uses: actions/setup-python@v5

.pre-commit-config.yaml

@@ -3,7 +3,7 @@
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: cef0300fd0fc4d2a87a85fa2093c6b283ea36f4b # frozen: v5.0.0
+    rev: 3e8a8703264a2f4a69428a0aa4dcb512790b2c8c # frozen: v6.0.0
     hooks:
       - id: check-added-large-files
       - id: check-ast
@@ -25,7 +25,7 @@ repos:
         args: [--prose-wrap=preserve]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "971923581912ef60a6b70dbf0c3e9a39563c9d47" # frozen: v0.11.4
+    rev: "9c89adb347f6b973f4905a4be0051eb2ecf85dea" # frozen: v0.13.3
     hooks:
       - id: ruff
         args: ["--fix", "--show-fixes", "--exit-non-zero-on-fix"]

README.rst

@@ -17,7 +17,7 @@ docstrings formatted according to the NumPy documentation format.
 The extension also adds the code description directives
 ``np:function``, ``np-c:function``, etc.
 
-numpydoc requires Python 3.9+ and sphinx 6+.
+numpydoc requires Python 3.10+ and sphinx 6+.
 
 For usage information, please refer to the `documentation
 <https://numpydoc.readthedocs.io/>`_.

doc/install.rst

@@ -5,7 +5,7 @@ Getting started
 Installation
 ============
 
-This extension requires Python 3.9+, sphinx 6+ and is available from:
+This extension requires Python 3.10+, sphinx 6+ and is available from:
 
 * `numpydoc on PyPI <http://pypi.python.org/pypi/numpydoc>`_
 * `numpydoc on GitHub <https://github.com/numpy/numpydoc/>`_

numpydoc/cli.py

@@ -4,14 +4,14 @@
 import ast
 from collections.abc import Sequence
 from pathlib import Path
-from typing import List, Union
+from typing import List
 
 from .docscrape_sphinx import get_doc_object
 from .hooks import utils, validate_docstrings
 from .validate import ERROR_MSGS, Validator, validate
 
 
-def render_object(import_path: str, config: Union[List[str], None] = None) -> int:
+def render_object(import_path: str, config: List[str] | None = None) -> int:
     """Test numpydoc docstring generation for a given object."""
     # TODO: Move Validator._load_obj to a better place than validate
     print(get_doc_object(Validator._load_obj(import_path), config=dict(config or [])))
@@ -117,7 +117,7 @@ def _parse_config(s):
     return ap
 
 
-def main(argv: Union[Sequence[str], None] = None) -> int:
+def main(argv: Sequence[str] | None = None) -> int:
     """CLI for numpydoc."""
     ap = get_parser()
 

numpydoc/docscrape.py

@@ -597,7 +597,7 @@ def get_func(self):
     def __str__(self):
         out = ""
 
-        func, func_name = self.get_func()
+        _func, func_name = self.get_func()
 
         roles = {"func": "function", "meth": "method"}
 
@@ -701,7 +701,7 @@ def properties(self):
                 and not self._should_skip_member(name, self._cls)
                 and (
                     func is None
-                    or isinstance(func, (property, cached_property))
+                    or isinstance(func, property | cached_property)
                     or inspect.isdatadescriptor(func)
                 )
                 and self._is_show_member(name)

numpydoc/hooks/validate_docstrings.py

@@ -63,7 +63,7 @@ def name(self) -> str:
 
     @property
     def is_function_or_method(self) -> bool:
-        return isinstance(self.node, (ast.FunctionDef, ast.AsyncFunctionDef))
+        return isinstance(self.node, ast.FunctionDef | ast.AsyncFunctionDef)
 
     @property
     def is_mod(self) -> bool:
@@ -236,7 +236,7 @@ def visit(self, node: ast.AST) -> None:
             The node to visit.
         """
         if isinstance(
-            node, (ast.Module, ast.ClassDef, ast.FunctionDef, ast.AsyncFunctionDef)
+            node, ast.Module | ast.ClassDef | ast.FunctionDef | ast.AsyncFunctionDef
         ):
             self.stack.append(node)
 
@@ -395,8 +395,8 @@ def process_file(filepath: os.PathLike, config: dict) -> "list[list[str]]":
 def run_hook(
     files: List[str],
     *,
-    config: Union[Dict[str, Any], None] = None,
-    ignore: Union[List[str], None] = None,
+    config: Dict[str, Any] | None = None,
+    ignore: List[str] | None = None,
 ) -> int:
     """
     Run the numpydoc validation hook.

numpydoc/numpydoc.py

@@ -88,7 +88,7 @@ def _is_cite_in_numpydoc_docstring(citation_node):
     section_node = citation_node.parent
 
     def is_docstring_section(node):
-        return isinstance(node, (section, desc_content))
+        return isinstance(node, section | desc_content)
 
     while not is_docstring_section(section_node):
         section_node = section_node.parent
@@ -185,8 +185,12 @@ def mangle_docstrings(app: SphinxApp, what, name, obj, options, lines):
         "xref_aliases": app.config.numpydoc_xref_aliases_complete,
         "xref_ignore": app.config.numpydoc_xref_ignore,
     }
-
-    cfg.update(options or {})
+    # TODO: Find a cleaner way to take care of this change away from dict
+    # https://github.com/sphinx-doc/sphinx/issues/13942
+    try:
+        cfg.update(options or {})
+    except TypeError:
+        cfg.update(options.__dict__ or {})
     u_NL = "\n"
     if what == "module":
         # Strip top title