feat: allow option to be configurable

Author: elfkuzco

src/mkdocstrings_handlers/python/handler.py

@@ -116,6 +116,7 @@ class PythonHandler(BaseHandler):
         "annotations_path": "brief",
         "preload_modules": None,
         "allow_inspection": True,
+        "force_inspection": False,
         "summary": False,
         "show_labels": True,
         "unwrap_annotated": False,
@@ -127,6 +128,7 @@ class PythonHandler(BaseHandler):
     Attributes: General options:
         find_stubs_package (bool): Whether to load stubs package (package-stubs) when extracting docstrings. Default `False`.
         allow_inspection (bool): Whether to allow inspecting modules when visiting them is not possible. Default: `True`.
+        force_inspection (bool): Whether to force using dynamic analysis when loading data. Default: `False`.
         show_bases (bool): Show the base classes of a class. Default: `True`.
         show_inheritance_diagram (bool): Show the inheritance diagram of a class using Mermaid. Default: `False`.
         show_source (bool): Show the source code of this object. Default: `True`.
@@ -242,7 +244,11 @@ def __init__(
         paths = paths or []
 
         # Expand paths with glob patterns.
-        glob_base_dir = os.path.dirname(os.path.abspath(config_file_path)) if config_file_path else "."
+        glob_base_dir = (
+            os.path.dirname(os.path.abspath(config_file_path))
+            if config_file_path
+            else "."
+        )
         with chdir(glob_base_dir):
             resolved_globs = [glob.glob(path) for path in paths]
         paths = [path for glob_list in resolved_globs for path in glob_list]
@@ -257,7 +263,9 @@ def __init__(
         for path in reversed(paths):
             # If it's not absolute, make path relative to the config file path, then make it absolute.
             if not os.path.isabs(path) and config_file_path:
-                path = os.path.abspath(os.path.join(os.path.dirname(config_file_path), path))  # noqa: PLW2901
+                path = os.path.abspath(
+                    os.path.join(os.path.dirname(config_file_path), path),
+                )
             # Don't add duplicates.
             if path not in search_paths:
                 search_paths.insert(0, path)
@@ -297,7 +305,11 @@ def load_inventory(
         for item in Inventory.parse_sphinx(in_file, domain_filter=domains).values():
             yield item.name, posixpath.join(base_url, item.uri)
 
-    def collect(self, identifier: str, config: Mapping[str, Any]) -> CollectorItem:  # noqa: D102
+    def collect(
+        self,
+        identifier: str,
+        config: Mapping[str, Any],
+    ) -> CollectorItem:
         module_name = identifier.split(".", 1)[0]
         unknown_module = module_name not in self._modules_collection
         if config.get("fallback", False) and unknown_module:
@@ -309,7 +321,9 @@ def collect(self, identifier: str, config: Mapping[str, Any]) -> CollectorItem:
         parser = parser_name and Parser(parser_name)
 
         if unknown_module:
-            extensions = self.normalize_extension_paths(final_config.get("extensions", []))
+            extensions = self.normalize_extension_paths(
+                final_config.get("extensions", []),
+            )
             loader = GriffeLoader(
                 extensions=load_extensions(*extensions),
                 search_paths=self._paths,
@@ -318,6 +332,7 @@ def collect(self, identifier: str, config: Mapping[str, Any]) -> CollectorItem:
                 modules_collection=self._modules_collection,
                 lines_collection=self._lines_collection,
                 allow_inspection=final_config["allow_inspection"],
+                force_inspection=final_config["force_inspection"],
             )
             try:
                 for pre_loaded_module in final_config.get("preload_modules") or []:
@@ -339,7 +354,9 @@ def collect(self, identifier: str, config: Mapping[str, Any]) -> CollectorItem:
                 external=self._load_external_modules,
             )
             if unresolved:
-                logger.debug(f"{len(unresolved)} aliases were still unresolved after {iterations} iterations")
+                logger.debug(
+                    f"{len(unresolved)} aliases were still unresolved after {iterations} iterations",
+                )
                 logger.debug(f"Unresolved aliases: {', '.join(sorted(unresolved))}")
 
         try:
@@ -357,7 +374,11 @@ def collect(self, identifier: str, config: Mapping[str, Any]) -> CollectorItem:
 
         return doc_object
 
-    def render(self, data: CollectorItem, config: Mapping[str, Any]) -> str:  # noqa: D102 (ignore missing docstring)
+    def render(
+        self,
+        data: CollectorItem,
+        config: Mapping[str, Any],
+    ) -> str:
         final_config = ChainMap(config, self.default_config)  # type: ignore[arg-type]
 
         template_name = rendering.do_get_template(self.env, data)
@@ -368,7 +389,9 @@ def render(self, data: CollectorItem, config: Mapping[str, Any]) -> str:  # noqa
         # than as an item in a dictionary.
         heading_level = final_config["heading_level"]
         try:
-            final_config["members_order"] = rendering.Order(final_config["members_order"])
+            final_config["members_order"] = rendering.Order(
+                final_config["members_order"],
+            )
         except ValueError as error:
             choices = "', '".join(item.value for item in rendering.Order)
             raise PluginError(
@@ -377,7 +400,8 @@ def render(self, data: CollectorItem, config: Mapping[str, Any]) -> str:  # noqa
 
         if final_config["filters"]:
             final_config["filters"] = [
-                (re.compile(filtr.lstrip("!")), filtr.startswith("!")) for filtr in final_config["filters"]
+                (re.compile(filtr.lstrip("!")), filtr.startswith("!"))
+                for filtr in final_config["filters"]
             ]
 
         summary = final_config["summary"]
@@ -439,9 +463,14 @@ def update_env(self, md: Markdown, config: dict) -> None:
         self.env.filters["as_classes_section"] = rendering.do_as_classes_section
         self.env.filters["as_modules_section"] = rendering.do_as_modules_section
         self.env.globals["AutorefsHook"] = rendering.AutorefsHook
-        self.env.tests["existing_template"] = lambda template_name: template_name in self.env.list_templates()
+        self.env.tests["existing_template"] = (
+            lambda template_name: template_name in self.env.list_templates()
+        )
 
-    def get_anchors(self, data: CollectorItem) -> tuple[str, ...]:  # noqa: D102 (ignore missing docstring)
+    def get_anchors(
+        self,
+        data: CollectorItem,
+    ) -> tuple[str, ...]:
         anchors = [data.path]
         try:
             if data.canonical_path != data.path: