🔧 Update pre-commit hooks (#1109)

Update hooks, fix issues, and also pin dependencies for mypy more
strictly (to reduce potential for differences between local and remote
runs of mypy)

Author: chrisjsewell

.pre-commit-config.yaml

@@ -1,11 +1,11 @@
 repos:
   - repo: https://github.com/psf/black
-    rev: 23.10.1
+    rev: 24.2.0
     hooks:
       - id: black
 
   - repo: https://github.com/PyCQA/flake8
-    rev: 6.1.0
+    rev: 7.0.0
     hooks:
       - id: flake8
         additional_dependencies:
@@ -15,7 +15,7 @@ repos:
           - pep8-naming
 
   - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
+    rev: 5.13.2
     hooks:
       - id: isort
 
@@ -24,17 +24,18 @@ repos:
     hooks:
       - id: pyupgrade
         args:
-          - --py36-plus
+          - --py38-plus
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.6.1
+    rev: v1.8.0
     hooks:
     - id: mypy
       files: sphinx_needs/.*
       args: []
       additional_dependencies:
-      - sphinx==6
-      - types-docutils
+      - sphinx==6.2.1
+      - docutils==0.19
+      - types-docutils==0.20.0.20240201
       - types-jsonschema
       - types-requests
 

codecov.yml

@@ -0,0 +1,10 @@
+coverage:
+  status:
+    project:
+      default:
+        target: 80%
+        threshold: 0.5%
+    patch:
+      default:
+        target: 70%
+        threshold: 0.5%

performance/performance_test.py

@@ -2,6 +2,7 @@
 Executes several performance tests.
 
 """
+
 import os.path
 import shutil
 import subprocess

pyproject.toml

@@ -151,12 +151,6 @@ module = [
 ]
 disable_error_code = ["attr-defined", "no-any-return"]
 
-[[tool.mypy.overrides]]
-module = [
-  "sphinx_needs.directives.needextract",
-]
-disable_error_code = "no-untyped-call"
-
 [build-system]
 requires = ["setuptools", "poetry_core>=1.0.8"]  # setuptools for deps like plantuml
 build-backend = "poetry.core.masonry.api"

sphinx_needs/api/configuration.py

@@ -3,6 +3,7 @@
 
 All functions here are available under ``sphinxcontrib.api``. So do not import this module directly.
 """
+
 from typing import Callable, List, Optional
 
 from docutils.parsers.rst import directives

sphinx_needs/data.py

@@ -1,6 +1,7 @@
 """Module to control access to sphinx-needs data,
 which is stored in the Sphinx environment.
 """
+
 from __future__ import annotations
 
 from typing import TYPE_CHECKING, Literal, TypedDict

sphinx_needs/debug.py

@@ -2,6 +2,7 @@
 Contains debug features to track down
 runtime and other problems with Sphinx-Needs
 """
+
 from __future__ import annotations
 
 import inspect

sphinx_needs/diagrams_common.py

@@ -140,7 +140,7 @@ def get_debug_container(puml_node: nodes.Element) -> nodes.container:
     """Return container containing the raw plantuml code"""
     debug_container = nodes.container()
     if isinstance(puml_node, nodes.figure):
-        data = puml_node.children[0]["uml"]
+        data = puml_node.children[0]["uml"]  # type: ignore
     else:
         data = puml_node["uml"]
     data = "\n".join([html.escape(line) for line in data.split("\n")])

sphinx_needs/directives/need.py

@@ -1,6 +1,5 @@
 import hashlib
 import re
-import typing
 from typing import Any, Dict, List, Optional, Sequence, Tuple
 
 from docutils import nodes
@@ -240,7 +239,7 @@ def get_sections_and_signature_and_needs(
     current_node = need_node
     while current_node:
         if isinstance(current_node, nodes.section):
-            title = typing.cast(str, current_node.children[0].astext())
+            title = current_node.children[0].astext()
             # If using auto-section numbering, then Sphinx inserts
             # multiple non-breaking space unicode characters into the title
             # we'll replace those with a simple space to make them easier to
@@ -344,16 +343,16 @@ def analyse_need_locations(app: Sphinx, doctree: nodes.document) -> None:
     # we can remove the hidden needs from the doctree
     for need_node in hidden_needs:
         if need_node.parent is not None:
-            need_node.parent.remove(need_node)  # type: ignore[attr-defined]
+            need_node.parent.remove(need_node)
 
 
 def previous_sibling(node: nodes.Node) -> Optional[nodes.Node]:
     """Return preceding sibling node or ``None``."""
     try:
-        i = node.parent.index(node)  # type: ignore
+        i = node.parent.index(node)
     except AttributeError:
         return None
-    return node.parent[i - 1] if i > 0 else None  # type: ignore
+    return node.parent[i - 1] if i > 0 else None
 
 
 @profile("NEEDS_POST_PROCESS")
@@ -391,7 +390,7 @@ def process_need_nodes(app: Sphinx, doctree: nodes.document, fromdocname: str) -
     if not needs_config.include_needs:
         for node in doctree.findall(Need):
             if node.parent is not None:
-                node.parent.remove(node)  # type: ignore
+                node.parent.remove(node)
         return
 
     needs_data = SphinxNeedsData(app.env)

sphinx_needs/directives/needextend.py

@@ -2,6 +2,7 @@
 
 
 """
+
 import re
 from typing import Any, Callable, Dict, Sequence