feat: Add option to disallow inspection

BlueGlassBlock · web-flow · commit 40f2f2688763 · 2023-05-04T13:25:33.000+02:00
Issue #68: #68 PR #69: #69
diff --git a/src/mkdocstrings_handlers/python/handler.py b/src/mkdocstrings_handlers/python/handler.py
@@ -109,6 +109,7 @@ class PythonHandler(BaseHandler):
         "annotations_path": "brief",
         "preload_modules": None,
         "load_external_modules": False,
+        "allow_inspection": True,
     }
     """
     Attributes: Headings options:
@@ -169,6 +170,7 @@ class PythonHandler(BaseHandler):
             of the importing module.
 
             The modules must be listed as an array of strings. Default: `None`.
+        allow_inspection (bool): Whether to allow inspecting modules when visiting them is not possible. Default: `True`.
 
     """
 
@@ -257,6 +259,7 @@ def collect(self, identifier: str, config: Mapping[str, Any]) -> CollectorItem:
                 docstring_options=parser_options,
                 modules_collection=self._modules_collection,
                 lines_collection=self._lines_collection,
+                allow_inspection=final_config["allow_inspection"],
             )
             try:
                 for pre_loaded_module in final_config.get("preload_modules") or []:
