feat: Release Insiders project

Author: pawamoy

README.md

@@ -14,7 +14,7 @@ and [installation instructions](https://mkdocstrings.github.io/griffe-autodocstr
 
 ## Usage
 
-[Enable(https://mkdocstrings.github.io/griffe/guide/users/extending/#using-extensions)] the `griffe_autodocstringstyle` extension. Now all packages loaded from a virtual environment will have their docstrings parsed with the `auto` style (automatically guessing the docstring style).
+[Enable](https://mkdocstrings.github.io/griffe/guide/users/extending/#using-extensions) the `griffe_autodocstringstyle` extension. Now all packages loaded from a virtual environment will have their docstrings parsed with the `auto` style (automatically guessing the docstring style).
 
 Use the `exclude` option to pass package names that shouldn't be considered. This can be useful if you must first install your sources as a package before loading/documenting them (meaning they end up in the virtual environment too).
 

src/griffe_autodocstringstyle/_internals/extension.py

@@ -1,7 +1,33 @@
 from __future__ import annotations
 
+import re
+from typing import Any
+
 import griffe
 
+_external = re.compile("/(.venv|site-packages)/")
+
 
 class AutoDocstringStyleExtension(griffe.Extension):
     """Set `auto` docstring style on external packages."""
+
+    def __init__(self, exclude: list[str] | None = None) -> None:
+        """Initialize the extension.
+
+        Parameters:
+            exclude: Package names to exclude.
+        """
+        self._exclude = set(exclude or ())
+
+    def on_instance(self, *, obj: griffe.Object, **kwargs: Any) -> None:  # noqa: ARG002
+        """Set docstring style to `auto` on all external Griffe objects.
+
+        Parameters:
+            obj: A Griffe object.
+            **kwargs: Additional arguments.
+        """
+        if not obj.docstring or isinstance(obj.filepath, list) or obj.package.name in self._exclude:
+            return
+        filepath = obj.filepath.resolve().as_posix()
+        if _external.search(filepath):
+            obj.docstring.parser = griffe.Parser.auto

tests/test_extension.py

@@ -2,8 +2,25 @@
 
 from __future__ import annotations
 
+import griffe
 
-def test_noop() -> None:
-    """Dummy test."""
-    assert True
 
+def test_extension() -> None:
+    """Load self and external package, assert styles."""
+    self_api = griffe.load("griffe_autodocstringstyle", extensions=griffe.load_extensions("griffe_autodocstringstyle"))
+    assert self_api.docstring
+    assert self_api.docstring.parser is None
+
+    pytest_api = griffe.load("pytest", extensions=griffe.load_extensions("griffe_autodocstringstyle"))
+    assert pytest_api.docstring
+    assert pytest_api.docstring.parser is griffe.Parser.auto
+
+
+def test_exclude_option() -> None:
+    """Excluded packages are untouched."""
+    pytest_api = griffe.load(
+        "pytest",
+        extensions=griffe.load_extensions({"griffe_autodocstringstyle": {"exclude": ["pytest"]}}),
+    )
+    assert pytest_api.docstring
+    assert pytest_api.docstring.parser is None