⬆️ Fix astroid v3 integration (#39)

chrisjsewell · web-flow · commit f32d92f47ff4 · 2023-11-26T23:58:31.000Z
diff --git a/docs/apidocs/aiida/aiida.common.rst b/docs/apidocs/aiida/aiida.common.rst
@@ -179,13 +179,17 @@ API
 
       .. autodoc2-docstring:: aiida.common.datastructures.CalcInfo._default_fields
 
-.. py:class:: CalcJobState
+.. py:class:: CalcJobState(*args, **kwds)
    :canonical: aiida.common.datastructures.CalcJobState
 
    Bases: :py:obj:`enum.Enum`
 
    .. autodoc2-docstring:: aiida.common.datastructures.CalcJobState
 
+   .. rubric:: Initialization
+
+   .. autodoc2-docstring:: aiida.common.datastructures.CalcJobState.__init__
+
    .. py:attribute:: UPLOADING
       :canonical: aiida.common.datastructures.CalcJobState.UPLOADING
       :value: 'uploading'
@@ -462,13 +466,17 @@ API
 
    .. autodoc2-docstring:: aiida.common.links.GraphTraversalRule
 
-.. py:class:: GraphTraversalRules
+.. py:class:: GraphTraversalRules(*args, **kwds)
    :canonical: aiida.common.links.GraphTraversalRules
 
    Bases: :py:obj:`enum.Enum`
 
    .. autodoc2-docstring:: aiida.common.links.GraphTraversalRules
 
+   .. rubric:: Initialization
+
+   .. autodoc2-docstring:: aiida.common.links.GraphTraversalRules.__init__
+
    .. py:attribute:: DEFAULT
       :canonical: aiida.common.links.GraphTraversalRules.DEFAULT
       :value: None
@@ -575,13 +583,17 @@ API
 
    .. autodoc2-docstring:: aiida.common.exceptions.LicensingException.__init__
 
-.. py:class:: LinkType
+.. py:class:: LinkType(*args, **kwds)
    :canonical: aiida.common.links.LinkType
 
    Bases: :py:obj:`enum.Enum`
 
    .. autodoc2-docstring:: aiida.common.links.LinkType
 
+   .. rubric:: Initialization
+
+   .. autodoc2-docstring:: aiida.common.links.LinkType.__init__
+
    .. py:attribute:: CREATE
       :canonical: aiida.common.links.LinkType.CREATE
       :value: 'create'
@@ -846,13 +858,17 @@ API
 
    .. autodoc2-docstring:: aiida.common.exceptions.RemoteOperationError.__init__
 
-.. py:class:: StashMode
+.. py:class:: StashMode(*args, **kwds)
    :canonical: aiida.common.datastructures.StashMode
 
    Bases: :py:obj:`enum.Enum`
 
    .. autodoc2-docstring:: aiida.common.datastructures.StashMode
 
+   .. rubric:: Initialization
+
+   .. autodoc2-docstring:: aiida.common.datastructures.StashMode.__init__
+
    .. py:attribute:: COPY
       :canonical: aiida.common.datastructures.StashMode.COPY
       :value: 'copy'
diff --git a/docs/apidocs/aiida/aiida.engine.rst b/docs/apidocs/aiida/aiida.engine.rst
@@ -235,13 +235,17 @@ API
 
    .. autodoc2-docstring:: aiida.engine.processes.workchains.awaitable.Awaitable
 
-.. py:class:: AwaitableAction
+.. py:class:: AwaitableAction(*args, **kwds)
    :canonical: aiida.engine.processes.workchains.awaitable.AwaitableAction
 
    Bases: :py:obj:`enum.Enum`
 
    .. autodoc2-docstring:: aiida.engine.processes.workchains.awaitable.AwaitableAction
 
+   .. rubric:: Initialization
+
+   .. autodoc2-docstring:: aiida.engine.processes.workchains.awaitable.AwaitableAction.__init__
+
    .. py:attribute:: ASSIGN
       :canonical: aiida.engine.processes.workchains.awaitable.AwaitableAction.ASSIGN
       :value: 'assign'
@@ -254,13 +258,17 @@ API
 
       .. autodoc2-docstring:: aiida.engine.processes.workchains.awaitable.AwaitableAction.APPEND
 
-.. py:class:: AwaitableTarget
+.. py:class:: AwaitableTarget(*args, **kwds)
    :canonical: aiida.engine.processes.workchains.awaitable.AwaitableTarget
 
    Bases: :py:obj:`enum.Enum`
 
    .. autodoc2-docstring:: aiida.engine.processes.workchains.awaitable.AwaitableTarget
 
+   .. rubric:: Initialization
+
+   .. autodoc2-docstring:: aiida.engine.processes.workchains.awaitable.AwaitableTarget.__init__
+
    .. py:attribute:: PROCESS
       :canonical: aiida.engine.processes.workchains.awaitable.AwaitableTarget.PROCESS
       :value: 'process'
@@ -1126,13 +1134,17 @@ API
 
       .. autodoc2-docstring:: aiida.engine.processes.process.Process.SINGLE_OUTPUT_LINKNAME
 
-   .. py:class:: SaveKeys
+   .. py:class:: SaveKeys(*args, **kwds)
       :canonical: aiida.engine.processes.process.Process.SaveKeys
 
       Bases: :py:obj:`enum.Enum`
 
       .. autodoc2-docstring:: aiida.engine.processes.process.Process.SaveKeys
 
+      .. rubric:: Initialization
+
+      .. autodoc2-docstring:: aiida.engine.processes.process.Process.SaveKeys.__init__
+
       .. py:attribute:: CALC_ID
          :canonical: aiida.engine.processes.process.Process.SaveKeys.CALC_ID
          :type: str
diff --git a/docs/apidocs/aiida/aiida.orm.rst b/docs/apidocs/aiida/aiida.orm.rst
@@ -2495,13 +2495,17 @@ API
 
       .. autodoc2-docstring:: aiida.orm.extras.EntityExtras.keys
 
-.. py:class:: EntityTypes
+.. py:class:: EntityTypes(*args, **kwds)
    :canonical: aiida.orm.entities.EntityTypes
 
    Bases: :py:obj:`enum.Enum`
 
    .. autodoc2-docstring:: aiida.orm.entities.EntityTypes
 
+   .. rubric:: Initialization
+
+   .. autodoc2-docstring:: aiida.orm.entities.EntityTypes.__init__
+
    .. py:attribute:: AUTHINFO
       :canonical: aiida.orm.entities.EntityTypes.AUTHINFO
       :value: 'authinfo'
diff --git a/docs/apidocs/aiida/aiida.repository.rst b/docs/apidocs/aiida/aiida.repository.rst
@@ -300,13 +300,17 @@ API
    .. py:method:: __repr__()
       :canonical: aiida.repository.common.File.__repr__
 
-.. py:class:: FileType
+.. py:class:: FileType(*args, **kwds)
    :canonical: aiida.repository.common.FileType
 
    Bases: :py:obj:`enum.Enum`
 
    .. autodoc2-docstring:: aiida.repository.common.FileType
 
+   .. rubric:: Initialization
+
+   .. autodoc2-docstring:: aiida.repository.common.FileType.__init__
+
    .. py:attribute:: DIRECTORY
       :canonical: aiida.repository.common.FileType.DIRECTORY
       :value: 0
diff --git a/docs/apidocs/aiida/aiida.schedulers.rst b/docs/apidocs/aiida/aiida.schedulers.rst
@@ -180,13 +180,17 @@ API
 
       .. autodoc2-docstring:: aiida.schedulers.datastructures.JobResource.get_tot_num_mpiprocs
 
-.. py:class:: JobState
+.. py:class:: JobState(*args, **kwds)
    :canonical: aiida.schedulers.datastructures.JobState
 
    Bases: :py:obj:`enum.Enum`
 
    .. autodoc2-docstring:: aiida.schedulers.datastructures.JobState
 
+   .. rubric:: Initialization
+
+   .. autodoc2-docstring:: aiida.schedulers.datastructures.JobState.__init__
+
    .. py:attribute:: UNDETERMINED
       :canonical: aiida.schedulers.datastructures.JobState.UNDETERMINED
       :value: 'undetermined'
diff --git a/docs/apidocs/autodoc2/autodoc2.astroid_utils.rst b/docs/apidocs/autodoc2/autodoc2.astroid_utils.rst
@@ -170,7 +170,7 @@ API
 
    .. autodoc2-docstring:: autodoc2.astroid_utils.is_decorated_with_property_setter
 
-.. py:function:: get_class_docstring(node: astroid.nodes.ClassDef) -> tuple[str, None | str]
+.. py:function:: get_class_docstring(node: astroid.nodes.ClassDef) -> tuple[str, str | None]
    :canonical: autodoc2.astroid_utils.get_class_docstring
 
    .. autodoc2-docstring:: autodoc2.astroid_utils.get_class_docstring
@@ -205,7 +205,7 @@ API
 
    .. autodoc2-docstring:: autodoc2.astroid_utils.get_args_info
 
-.. py:function:: _iter_args(args: list[astroid.nodes.NodeNG], annotations: list[astroid.nodes.NodeNG], defaults: list[astroid.nodes.NodeNG]) -> typing.Iterable[typing.Tuple[str, None | str, str | None]]
+.. py:function:: _iter_args(args: list[astroid.nodes.NodeNG], annotations: list[astroid.nodes.NodeNG], defaults: list[astroid.nodes.NodeNG]) -> typing.Iterable[tuple[str, None | str, str | None]]
    :canonical: autodoc2.astroid_utils._iter_args
 
    .. autodoc2-docstring:: autodoc2.astroid_utils._iter_args
diff --git a/docs/apidocs/autodoc2/autodoc2.config.rst b/docs/apidocs/autodoc2/autodoc2.config.rst
@@ -140,7 +140,7 @@ API
 
    .. autodoc2-docstring:: autodoc2.config._coerce_packages
 
-.. py:function:: _validate_replace_list(name: str, item: typing.Any) -> list[typing.Tuple[str, str]]
+.. py:function:: _validate_replace_list(name: str, item: typing.Any) -> list[tuple[str, str]]
    :canonical: autodoc2.config._validate_replace_list
 
    .. autodoc2-docstring:: autodoc2.config._validate_replace_list
diff --git a/docs/apidocs/autodoc2/autodoc2.db.md b/docs/apidocs/autodoc2/autodoc2.db.md
@@ -87,7 +87,7 @@ Bases: {py:obj}`typing.Protocol`
 
 ````
 
-````{py:method} get_item(full_name: str) -> typing.Optional[autodoc2.utils.ItemData]
+````{py:method} get_item(full_name: str) -> autodoc2.utils.ItemData | None
 :canonical: autodoc2.db.Database.get_item
 
 ```{autodoc2-docstring} autodoc2.db.Database.get_item
@@ -192,7 +192,7 @@ Bases: {py:obj}`autodoc2.db.Database`
 
 ````
 
-````{py:method} get_item(full_name: str) -> typing.Optional[autodoc2.utils.ItemData]
+````{py:method} get_item(full_name: str) -> autodoc2.utils.ItemData | None
 :canonical: autodoc2.db.InMemoryDb.get_item
 
 ````
diff --git a/docs/apidocs/autodoc2/autodoc2.render.base.rst b/docs/apidocs/autodoc2/autodoc2.render.base.rst
@@ -65,7 +65,7 @@ API
 
       .. autodoc2-docstring:: autodoc2.render.base.RendererBase.warn
 
-   .. py:method:: get_item(full_name: str) -> typing.Optional[autodoc2.utils.ItemData]
+   .. py:method:: get_item(full_name: str) -> autodoc2.utils.ItemData | None
       :canonical: autodoc2.render.base.RendererBase.get_item
 
       .. autodoc2-docstring:: autodoc2.render.base.RendererBase.get_item
diff --git a/docs/apidocs/autodoc2/autodoc2.sphinx.autodoc.rst b/docs/apidocs/autodoc2/autodoc2.sphinx.autodoc.rst
@@ -65,6 +65,7 @@ API
 
    .. py:attribute:: option_spec
       :canonical: autodoc2.sphinx.autodoc.AutodocObject.option_spec
+      :type: typing.ClassVar[dict[str, typing.Any]]
       :value: None
 
       .. autodoc2-docstring:: autodoc2.sphinx.autodoc.AutodocObject.option_spec
diff --git a/docs/apidocs/autodoc2/autodoc2.sphinx.docstring.rst b/docs/apidocs/autodoc2/autodoc2.sphinx.docstring.rst
@@ -94,6 +94,7 @@ API
 
    .. py:attribute:: option_spec
       :canonical: autodoc2.sphinx.docstring.DocstringRenderer.option_spec
+      :type: typing.ClassVar[dict[str, typing.Any]]
       :value: None
 
       .. autodoc2-docstring:: autodoc2.sphinx.docstring.DocstringRenderer.option_spec
diff --git a/docs/apidocs/autodoc2/autodoc2.sphinx.summary.rst b/docs/apidocs/autodoc2/autodoc2.sphinx.summary.rst
@@ -60,6 +60,7 @@ API
 
    .. py:attribute:: option_spec
       :canonical: autodoc2.sphinx.summary.AutodocSummary.option_spec
+      :type: typing.ClassVar[dict[str, typing.Any]]
       :value: None
 
       .. autodoc2-docstring:: autodoc2.sphinx.summary.AutodocSummary.option_spec
diff --git a/docs/apidocs/autodoc2/autodoc2.utils.rst b/docs/apidocs/autodoc2/autodoc2.utils.rst
@@ -186,13 +186,17 @@ API
 
       .. autodoc2-docstring:: autodoc2.utils.ItemData.inherited
 
-.. py:class:: WarningSubtypes
+.. py:class:: WarningSubtypes(*args, **kwds)
    :canonical: autodoc2.utils.WarningSubtypes
 
    Bases: :py:obj:`enum.Enum`
 
    .. autodoc2-docstring:: autodoc2.utils.WarningSubtypes
 
+   .. rubric:: Initialization
+
+   .. autodoc2-docstring:: autodoc2.utils.WarningSubtypes.__init__
+
    .. py:attribute:: CONFIG_ERROR
       :canonical: autodoc2.utils.WarningSubtypes.CONFIG_ERROR
       :value: 'config_error'
diff --git a/pyproject.toml b/pyproject.toml
@@ -19,7 +19,7 @@ keywords = ["sphinx", "autodoc", "extension", "documentation"]
 urls = {Home = "https://github.com/chrisjsewell/sphinx-autodoc2"}
 requires-python = ">=3.8"
 dependencies = [
-    "astroid>=2.7,<3",
+    "astroid>=2.7,<4",
     "tomli; python_version<'3.11'",
     "typing-extensions"
 ]
diff --git a/src/autodoc2/analysis.py b/src/autodoc2/analysis.py
@@ -113,7 +113,9 @@ def yield_module(node: nodes.Module, state: State) -> t.Iterable[ItemData]:
     parent: ItemData = {
         "type": "package" if node.package else "module",
         "full_name": node.name,
-        "doc": fix_docstring_indent(node.doc),
+        "doc": fix_docstring_indent(
+            node.doc_node.value if node.doc_node is not None else None
+        ),
         "file_path": path,
         "encoding": node.file_encoding,
         "all": astroid_utils.get_module_all(node),
diff --git a/src/autodoc2/astroid_utils.py b/src/autodoc2/astroid_utils.py
@@ -142,8 +142,11 @@ def resolve_annotation(annotation: nodes.NodeNG) -> str:
     elif isinstance(annotation, nodes.Subscript):
         value = resolve_annotation(annotation.value)
         slice_node = annotation.slice
-        if isinstance(slice_node, nodes.Index):
-            slice_node = slice_node.value
+        try:
+            if isinstance(slice_node, nodes.Index):
+                slice_node = slice_node.value
+        except AttributeError:
+            pass  # removed in astroid 3
         if isinstance(slice_node, nodes.Tuple):
             slice_ = ", ".join(resolve_annotation(elt) for elt in slice_node.elts)
         else:
@@ -206,10 +209,7 @@ def resolve_qualname(node: nodes.NodeNG, basename: str) -> str:
     full_basename = basename
 
     top_level_name = re.sub(r"\(.*\)", "", basename).split(".", 1)[0]
-    # Disable until pylint uses astroid 2.7
-    lookup_node = (
-        node if isinstance(node, nodes.node_classes.LookupMixIn) else node.scope()
-    )
+    lookup_node = node if isinstance(node, nodes.LocalsDictNodeNG) else node.scope()
 
     assigns = lookup_node.lookup(top_level_name)[1]
 
@@ -386,22 +386,22 @@ def is_decorated_with_property_setter(
     return False
 
 
-def get_class_docstring(node: nodes.ClassDef) -> tuple[str, None | str]:
+def get_class_docstring(node: nodes.ClassDef) -> tuple[str, str | None]:
     """Get the docstring of a node, using a parent docstring if needed."""
-    doc = node.doc
+    doc_node = node.doc_node
 
-    if doc is None:
+    if doc_node is None:
         for base in node.ancestors():
             if base.qname() in (
                 "__builtins__.object",
                 "builtins.object",
                 "builtins.type",
             ):
                 continue
-            if base.doc is not None:
-                return str(base.doc), base.qname()
+            if base.doc_node is not None:
+                return base.doc_node.value, base.qname()
 
-    return doc or "", None
+    return doc_node.value if doc_node is not None else "", None
 
 
 def is_exception(node: nodes.ClassDef) -> bool:
@@ -446,9 +446,9 @@ def is_overload_decorator(decorator: astroid.Name | astroid.Attribute) -> bool:
 
 def get_func_docstring(node: nodes.FunctionDef) -> tuple[str, None | str]:
     """Get the docstring of a node, using a parent docstring if needed."""
-    doc = node.doc
+    doc_node = node.doc_node
 
-    if doc is None and isinstance(node.parent, nodes.ClassDef):
+    if doc_node is None and isinstance(node.parent, nodes.ClassDef):
         for base in node.parent.ancestors():
             if node.name in ("__init__", "__new__") and base.qname() in (
                 "__builtins__.object",
@@ -460,11 +460,11 @@ def get_func_docstring(node: nodes.FunctionDef) -> tuple[str, None | str]:
                 if (
                     isinstance(child, node.__class__)
                     and child.name == node.name
-                    and child.doc is not None
+                    and child.doc_node is not None
                 ):
-                    return str(child.doc), child.qname()
+                    return str(child.doc_node.value), child.qname()
 
-    return doc or "", None
+    return doc_node.value if doc_node is not None else "", None
 
 
 def get_return_annotation(node: nodes.FunctionDef) -> None | str:
