fix: support griffe v1, and backwads compat to v0.37.0

Author: machow

quartodoc/_griffe_compat.py

@@ -0,0 +1,22 @@
+# flake8: noqa
+
+try:
+    from griffe import GriffeLoader
+    from griffe import ModulesCollection, LinesCollection
+
+    import _griffe.models as dataclasses
+    import _griffe.docstrings.models as docstrings
+    import _griffe.expressions as expressions
+
+    from griffe import Parser, parse, parse_numpy
+    from griffe import AliasResolutionError
+except ImportError:
+    from griffe.loader import GriffeLoader
+    from griffe.collections import ModulesCollection, LinesCollection
+
+    import griffe.dataclasses as dataclasses
+    import griffe.docstrings.dataclasses as docstrings
+    import griffe.expressions as expressions
+
+    from griffe.docstrings.parsers import Parser, parse
+    from griffe.exceptions import AliasResolutionError

quartodoc/ast.py

@@ -2,10 +2,11 @@
 
 import warnings
 
+from ._griffe_compat import docstrings as ds
+from ._griffe_compat import dataclasses as dc
+
 from enum import Enum
 from dataclasses import dataclass
-from griffe.docstrings import dataclasses as ds
-from griffe import dataclasses as dc
 from plum import dispatch
 from typing import Type, Union
 

quartodoc/autosummary.py

@@ -5,13 +5,11 @@
 import warnings
 import yaml
 
+from ._griffe_compat import GriffeLoader, ModulesCollection, LinesCollection
+from ._griffe_compat import dataclasses as dc
+from ._griffe_compat import Parser, parse
+
 from fnmatch import fnmatchcase
-from griffe.loader import GriffeLoader
-from griffe.collections import ModulesCollection, LinesCollection
-from griffe.dataclasses import Alias
-from griffe.docstrings.parsers import Parser, parse
-from griffe.docstrings import dataclasses as ds  # noqa
-from griffe import dataclasses as dc
 from plum import dispatch  # noqa
 from pathlib import Path
 from types import ModuleType
@@ -37,7 +35,7 @@
 
 def parse_function(module: str, func_name: str):
     griffe = GriffeLoader()
-    mod = griffe.load_module(module)
+    mod = griffe.load(module)
 
     f_data = mod.functions[func_name]
 
@@ -66,7 +64,7 @@ def get_function(module: str, func_name: str, parser: str = "numpy") -> dc.Objec
     griffe = GriffeLoader(
         docstring_parser=Parser(parser), docstring_options=get_parser_defaults(parser)
     )
-    mod = griffe.load_module(module)
+    mod = griffe.load(module)
 
     f_data = mod.functions[func_name]
 
@@ -138,7 +136,7 @@ def get_object(
     # note that it is critical for performance that we only do this when necessary.
     root_mod = module.split(".", 1)[0]
     if root_mod not in loader.modules_collection:
-        loader.load_module(module)
+        loader.load(module)
 
     # griffe uses only periods for the path
     griffe_path = f"{module}.{object_path}" if object_path else module
@@ -164,10 +162,10 @@ def get_object(
     # Alias objects can refer to objects imported from other modules.
     # in this case, we need to import the target's module in order to resolve
     # the alias
-    if isinstance(f_data, Alias) and load_aliases:
+    if isinstance(f_data, dc.Alias) and load_aliases:
         target_mod = f_data.target_path.split(".")[0]
         if target_mod != module:
-            loader.load_module(target_mod)
+            loader.load(target_mod)
 
     return f_data
 

quartodoc/builder/blueprint.py

@@ -4,11 +4,15 @@
 import json
 import yaml
 
-from griffe import dataclasses as dc
-from griffe.loader import GriffeLoader
-from griffe.collections import ModulesCollection, LinesCollection
-from griffe.docstrings.parsers import Parser
-from griffe.exceptions import AliasResolutionError
+from .._griffe_compat import dataclasses as dc
+from .._griffe_compat import (
+    GriffeLoader,
+    ModulesCollection,
+    LinesCollection,
+    Parser,
+)
+
+from .._griffe_compat import AliasResolutionError
 from functools import partial
 from textwrap import indent
 
@@ -43,7 +47,7 @@
 def _auto_package(mod: dc.Module) -> list[Section]:
     """Create default sections for the given package."""
 
-    import griffe.docstrings.dataclasses as ds
+    from quartodoc._griffe_compat import docstrings as ds
 
     has_all = "__all__" in mod.members
 

quartodoc/inventory.py

@@ -2,7 +2,7 @@
 
 import sphobjinv as soi
 
-from griffe import dataclasses as dc
+from ._griffe_compat import dataclasses as dc
 from plum import dispatch
 from quartodoc import layout
 

quartodoc/layout.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-import griffe.dataclasses as dc
+from ._griffe_compat import dataclasses as dc
 import logging
 
 from enum import Enum

quartodoc/renderers/md_renderer.py

@@ -4,9 +4,9 @@
 
 from contextlib import contextmanager
 from functools import wraps
-from griffe.docstrings import dataclasses as ds
-from griffe import dataclasses as dc
-from griffe import expressions as expr
+from .._griffe_compat import docstrings as ds
+from .._griffe_compat import dataclasses as dc
+from .._griffe_compat import expressions as expr
 from tabulate import tabulate
 from plum import dispatch
 from typing import Tuple, Union, Optional
@@ -153,8 +153,6 @@ def signature(self, el: layout.Doc):
 
         return res
 
-
-
     @dispatch
     def signature(self, el: dc.Alias, source: Optional[dc.Alias] = None):
         return self.signature(el.final_target, el)
@@ -335,14 +333,14 @@ def render(self, el: Union[layout.DocClass, layout.DocModule]):
                         [self.render(x) for x in raw_meths if isinstance(x, layout.Doc)]
                     )
 
-
         str_sig = self.signature(el)
         sig_part = [str_sig] if self.show_signature else []
 
         body = self.render(el.obj)
 
-
-        return "\n\n".join([title, *sig_part, body, *attr_docs, *class_docs, *meth_docs])
+        return "\n\n".join(
+            [title, *sig_part, body, *attr_docs, *class_docs, *meth_docs]
+        )
 
     @dispatch
     def render(self, el: Union[layout.DocFunction, layout.DocAttribute]):

quartodoc/tests/test_ast.py

@@ -1,9 +1,9 @@
 import quartodoc.ast as qast
 import pytest
 
-from griffe.docstrings import dataclasses as ds
-from griffe import dataclasses as dc
-from griffe.docstrings.parsers import parse_numpy
+from quartodoc._griffe_compat import docstrings as ds
+from quartodoc._griffe_compat import dataclasses as dc
+from quartodoc._griffe_compat import parse_numpy
 
 from quartodoc import get_object
 

quartodoc/tests/test_basic.py

@@ -1,8 +1,8 @@
 import pytest
 
 from quartodoc import get_object, get_function, MdRenderer
-from griffe.docstrings import dataclasses as ds
-from griffe import dataclasses as dc
+from quartodoc._griffe_compat import docstrings as ds
+from quartodoc._griffe_compat import dataclasses as dc
 
 # TODO: rename to test_autosummary (or refactor autosummary into parts)
 

quartodoc/tests/test_builder_blueprint.py

@@ -1,5 +1,5 @@
 from functools import partial
-from griffe.exceptions import AliasResolutionError
+from quartodoc._griffe_compat import AliasResolutionError
 from quartodoc import get_object
 from quartodoc import layout as lo
 from quartodoc.builder.blueprint import (