add custom griffe extension for inspection of the Sync implementations

Author: alexluck-sift

python/griffe_extensions/__init__.py

@@ -0,0 +1,3 @@
+from griffe_extensions.sync_stubs_inspector import InspectSpecificObjects
+
+__all__ = ["InspectSpecificObjects"]

python/griffe_extensions/sync_stubs_inspector.py

@@ -0,0 +1,21 @@
+import griffe
+
+logger = griffe.get_logger("griffe_inspect_specific_objects")
+
+
+class InspectSpecificObjects(griffe.Extension):
+    """Only inspect specific objects (such as ones with stubs)"""
+
+    def __init__(self, paths: list[str]) -> None:
+        self.objects = paths
+
+    def on_instance(self, *, obj: griffe.Object, **kwargs) -> None:
+        if obj.path not in self.objects:
+            return
+
+        # Skip over the stub files themselves
+        if str(obj.filepath).endswith(".pyi"):
+            return
+        # Load the stub file instead of importing the .py
+        inspected_module = griffe.inspect(obj.module.path, filepath=obj.filepath)
+        obj.parent.set_member(obj.name, inspected_module[obj.name])

python/mkdocs.yml

@@ -39,16 +39,10 @@ plugins:
           options:
             load_external_modules: true
             show_source: false
-            allow_inspection: true
             find_stubs_package: true
             show_if_no_docstring: true
-            # TODO: custom griffe plugin instead
-            force_inspection: true # Needed for run-time generated sync_stubs
-            #            filters: [ "!^__", "!^_abc_", "!^_", "!TYPE_CHECKING" ]
             filters: "public"
             show_submodules: false
-            # Explicitly include stubs directory
-            search_path: [ "../lib" ]
             # Styling
             group_by_category: true
             docstring_section_style: spacy
@@ -62,18 +56,14 @@ plugins:
             show_symbol_type_heading: true
             show_symbol_type_toc: true
             summary: true
-            # Disabled until custom griffe plugin otherwise fails due to force_inspection
-  #            extensions:
-  #              - griffe_pydantic:
-  #                schema: true
+            # Custom Griffe extension to only inspect sync_stubs
+            extensions:
+              - griffe_extensions/sync_stubs_inspector.py:InspectSpecificObjects:
+                  paths:
+                    - sift_client.resources.sync_stubs
+
 
   - api-autonav:
       modules: [ lib/sift_client ] #, lib/sift ]
       exclude_private: true
       nav_item_prefix: ""
-      module_options:
-        # special filters to avoid rendering the async again
-        sift_client.resources.sync_stubs:
-          filters: [ "!Async$", "!^__", "!^_abc_", "!^generate" ]
-
-