fix: Fix warnings for docstrings in builtin modules

mkdocstrings · Sep 9, 2023 · 6ba3e04 · 6ba3e04
1 parent 066a4a7
commit 6ba3e04
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/griffe/docstrings/utils.py b/src/griffe/docstrings/utils.py
@@ -7,6 +7,7 @@
 from typing import TYPE_CHECKING, Protocol
 
 from griffe.agents.nodes import safe_get_annotation
+from griffe.exceptions import BuiltinModuleError
 from griffe.logger import LogLevel, get_logger
 
 if TYPE_CHECKING:
@@ -42,6 +43,8 @@ def warn(docstring: Docstring, offset: int, message: str, log_level: LogLevel =
             prefix = docstring.parent.relative_filepath  # type: ignore[union-attr]
         except (AttributeError, ValueError):
             prefix = "<module>"
+        except BuiltinModuleError:
+            prefix = f"<module: {docstring.parent.module.name}>"
         log = getattr(logger, log_level.value)
         log(f"{prefix}:{(docstring.lineno or 0)+offset}: {message}")