merge: Merge branch 'main' into ConstructorChecking_ASTValidator, ensure --pre flag remains in pre-release test workflow.

Author: mattgebert

.circleci/config.yml

@@ -20,7 +20,7 @@ jobs:
             python3 -m venv venv
             source venv/bin/activate
             python -m pip install --upgrade pip wheel setuptools
-            python -m pip install --upgrade -r requirements/doc.txt
+            python -m pip install --upgrade --group doc
             python -m pip list
       - save_cache:
           key: pip-cache

.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@4e13a10d89177f4bfc8007a7064bdbeda848d8d1 # v1.0.0
+        uses: scientific-python/circleci-artifacts-redirector-action@7eafdb60666f57706a5525a2f5eb76224dc8779b # v1.1.0
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
           api-token: ${{ secrets.CIRCLECI_ARTIFACT_REDIRECTOR_TOKEN }}

.github/workflows/test.yml

@@ -38,12 +38,12 @@ jobs:
         run: |
           python -m pip install --upgrade pip wheel setuptools
           python -m pip install codecov
-          python -m pip install ${{ matrix.sphinx-version }}
+          python -m pip install "${{ matrix.sphinx-version }}"
           python -m pip list
 
       - name: Install
         run: |
-          python -m pip install .[test,doc]
+          python -m pip install . --group test --group doc
           pip list
 
       - name: Run test suite
@@ -96,7 +96,7 @@ jobs:
 
       - name: Install
         run: |
-          python -m pip install --pre .[test,doc]
+          python -m pip install . --pre --group test --group doc
           pip list
 
       - name: Run test suite

.pre-commit-config.yaml

@@ -31,14 +31,6 @@ repos:
         args: ["--fix", "--show-fixes", "--exit-non-zero-on-fix"]
       - id: ruff-format
 
-  - repo: local
-    hooks:
-      - id: generate_requirements.py
-        name: generate_requirements.py
-        language: system
-        entry: python tools/generate_requirements.py
-        files: "pyproject.toml|requirements/.*\\.txt|tools/generate_requirements.py"
-
 ci:
   autofix_prs: false
   autofix_commit_msg: |

.readthedocs.yaml

@@ -13,22 +13,15 @@ build:
     # nodejs: "19"
     # rust: "1.64"
     # golang: "1.19"
+  jobs:
+    install:
+      - python -m pip install --upgrade pip wheel setuptools
+      - python -m pip install . --group doc
 
 # Build documentation in the "doc/" directory with Sphinx
 sphinx:
   configuration: doc/conf.py
-
 # Optionally build your docs in additional formats such as PDF and ePub
 # formats:
 #    - pdf
 #    - epub
-
-# Optional but recommended, declare the Python requirements required
-# to build your documentation
-# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
-python:
-  install:
-    - method: pip
-      path: .
-      extra_requirements:
-        - doc

MANIFEST.in

@@ -2,7 +2,6 @@ include MANIFEST.in
 include *.txt
 include *.rst
 recursive-include doc *
-recursive-include requirements *
 recursive-include numpydoc *
 
 # Exclude what we don't want to include

doc/format.rst

@@ -769,9 +769,9 @@ leads to the following style recommendations:
   enclosed within ````double backticks````.
 
 A more extensive example of reST markup can be found in `this example
-document <http://docutils.sourceforge.net/docs/user/rst/demo.txt>`_;
+document <https://docutils.sourceforge.net/docs/user/rst/demo.rst>`_;
 the `quick reference
-<http://docutils.sourceforge.net/docs/user/rst/quickref.html>`_ is
+<https://docutils.sourceforge.net/docs/user/rst/quickref.html>`_ is
 useful while editing.
 
 Line spacing and indentation are significant and should be carefully

numpydoc/hooks/validate_docstrings.py

@@ -33,7 +33,12 @@ class AstValidator(validate.Validator):
     """
 
     def __init__(
-        self, *, ast_node: ast.AST, filename: os.PathLike, obj_name: str
+        self,
+        *,
+        ast_node: ast.AST,
+        filename: os.PathLike,
+        obj_name: str,
+        ancestry: list[ast.AST],
     ) -> None:
         self.node: ast.AST = ast_node
         self.raw_doc: str = ast.get_docstring(self.node, clean=False) or ""
@@ -46,6 +51,8 @@ def __init__(
         self.is_class: bool = isinstance(ast_node, ast.ClassDef)
         self.is_module: bool = isinstance(ast_node, ast.Module)
 
+        self.ancestry: list[ast.AST] = ancestry
+
     @staticmethod
     def _load_obj(name):
         raise NotImplementedError("AstValidator does not support this method.")
@@ -91,7 +98,7 @@ def source_file_def_line(self) -> int:
 
     @property
     def signature_parameters(self) -> Tuple[str]:
-        def extract_signature(node):
+        def extract_signature(node, parent):
             args_node = node.args
             params = []
             for arg_type in ["posonlyargs", "args", "vararg", "kwonlyargs", "kwarg"]:
@@ -104,17 +111,21 @@ def extract_signature(node):
                 else:
                     params.extend([arg.arg for arg in entries])
             params = tuple(params)
-            if params and params[0] in {"self", "cls"}:
+            if (
+                params
+                and params[0] in {"self", "cls"}
+                and isinstance(parent, ast.ClassDef)
+            ):
                 return params[1:]
             return params
 
         params = tuple()
         if self.is_function_or_method:
-            params = extract_signature(self.node)
+            params = extract_signature(self.node, self.ancestry[-1])
         elif self.is_class:
             for child in self.node.body:
                 if isinstance(child, ast.FunctionDef) and child.name == "__init__":
-                    params = extract_signature(child)
+                    params = extract_signature(child, self.node)
         return params
 
     @property
@@ -144,9 +155,23 @@ def __init__(
         self.config: dict = config
         self.filepath: str = filepath
         self.module_name: str = Path(self.filepath).stem
-        self.stack: list[str] = []
+        self.stack: list[ast.AST] = []
         self.findings: list = []
 
+    @property
+    def node_name(self) -> str:
+        """
+        Get the full name of the current node in the stack.
+
+        Returns
+        -------
+        str
+            The full name of the current node in the stack.
+        """
+        return ".".join(
+            [getattr(node, "name", self.module_name) for node in self.stack]
+        )
+
     def _ignore_issue(self, node: ast.AST, check: str) -> bool:
         """
         Check whether the issue should be ignored.
@@ -185,9 +210,13 @@ def _get_numpydoc_issues(self, node: ast.AST) -> None:
         node : ast.AST
             The node under inspection.
         """
-        name = ".".join(self.stack)
+        name = self.node_name
         report = validate.validate(
-            name, AstValidator, ast_node=node, filename=self.filepath
+            name,
+            AstValidator,
+            ast_node=node,
+            filename=self.filepath,
+            ancestry=self.stack[:-1],
         )
         self.findings.extend(
             [
@@ -209,13 +238,11 @@ def visit(self, node: ast.AST) -> None:
         if isinstance(
             node, (ast.Module, ast.ClassDef, ast.FunctionDef, ast.AsyncFunctionDef)
         ):
-            self.stack.append(
-                self.module_name if isinstance(node, ast.Module) else node.name
-            )
+            self.stack.append(node)
 
             if not (
                 self.config["exclude"]
-                and re.search(self.config["exclude"], ".".join(self.stack))
+                and re.search(self.config["exclude"], self.node_name)
             ):
                 self._get_numpydoc_issues(node)
 

numpydoc/numpydoc.py

@@ -296,7 +296,7 @@ def setup(app, get_doc_object_=get_doc_object):
     app.add_config_value("numpydoc_attributes_as_param_list", True, True)
     app.add_config_value("numpydoc_xref_param_type", False, True)
     app.add_config_value("numpydoc_xref_aliases", dict(), True)
-    app.add_config_value("numpydoc_xref_ignore", set(), True)
+    app.add_config_value("numpydoc_xref_ignore", set(), True, types=[set, str])
     app.add_config_value("numpydoc_validation_checks", set(), True)
     app.add_config_value("numpydoc_validation_exclude", set(), False)
     app.add_config_value("numpydoc_validation_overrides", dict(), False)

pyproject.toml

@@ -43,10 +43,12 @@ file = 'LICENSE.txt'
 Homepage = 'https://numpydoc.readthedocs.io'
 Source = 'https://github.com/numpy/numpydoc/'
 
-[project.optional-dependencies]
-developer = [
+[dependency-groups]
+dev = [
     'pre-commit>=3.3',
     "tomli; python_version < '3.11'",
+    { include-group = "doc" },
+    { include-group = "test" }
 ]
 doc = [
     'numpy>=1.22',