👌 Move the resolution of __all__ into the renderer

Author: chrisjsewell

docs/apidocs/autodoc2/autodoc2.render.base.rst

@@ -23,7 +23,7 @@ Classes
 API
 ~~~
 
-.. py:class:: RendererBase(db: autodoc2.db.Database, config: autodoc2.config.Config, warn: typing.Callable[[str, autodoc2.utils.WarningSubtypes], None] | None = None, resolved_all: dict[str, autodoc2.utils.ResolvedDict] | None = None, standalone: bool = True)
+.. py:class:: RendererBase(db: autodoc2.db.Database, config: autodoc2.config.Config, warn: typing.Callable[[str, autodoc2.utils.WarningSubtypes], None] | None = None, standalone: bool = True)
    :canonical: autodoc2.render.base.RendererBase
 
    Bases: :py:obj:`abc.ABC`

docs/apidocs/autodoc2/autodoc2.render.myst_.rst

@@ -40,7 +40,7 @@ API
 
    .. autodoc2-docstring:: autodoc2.render.myst_._RE_DELIMS
 
-.. py:class:: MystRenderer(db: autodoc2.db.Database, config: autodoc2.config.Config, warn: typing.Callable[[str, autodoc2.utils.WarningSubtypes], None] | None = None, resolved_all: dict[str, autodoc2.utils.ResolvedDict] | None = None, standalone: bool = True)
+.. py:class:: MystRenderer(db: autodoc2.db.Database, config: autodoc2.config.Config, warn: typing.Callable[[str, autodoc2.utils.WarningSubtypes], None] | None = None, standalone: bool = True)
    :canonical: autodoc2.render.myst_.MystRenderer
 
    Bases: :py:obj:`autodoc2.render.base.RendererBase`

docs/apidocs/autodoc2/autodoc2.render.rst_.rst

@@ -40,7 +40,7 @@ API
 
    .. autodoc2-docstring:: autodoc2.render.rst_._RE_DELIMS
 
-.. py:class:: RstRenderer(db: autodoc2.db.Database, config: autodoc2.config.Config, warn: typing.Callable[[str, autodoc2.utils.WarningSubtypes], None] | None = None, resolved_all: dict[str, autodoc2.utils.ResolvedDict] | None = None, standalone: bool = True)
+.. py:class:: RstRenderer(db: autodoc2.db.Database, config: autodoc2.config.Config, warn: typing.Callable[[str, autodoc2.utils.WarningSubtypes], None] | None = None, standalone: bool = True)
    :canonical: autodoc2.render.rst_.RstRenderer
 
    Bases: :py:obj:`autodoc2.render.base.RendererBase`

src/autodoc2/render/base.py

@@ -7,7 +7,7 @@
 from collections import OrderedDict
 import typing as t
 
-from autodoc2.utils import WarningSubtypes
+from autodoc2.utils import WarningSubtypes, resolve_all
 
 if t.TYPE_CHECKING:
     from autodoc2.config import Config
@@ -26,7 +26,6 @@ def __init__(
         db: Database,
         config: Config,
         warn: t.Callable[[str, WarningSubtypes], None] | None = None,
-        resolved_all: dict[str, ResolvedDict] | None = None,
         standalone: bool = True,
     ) -> None:
         """Initialise the renderer.
@@ -41,7 +40,7 @@ def __init__(
         self._config = config
         self._standalone = standalone
         self._warn = warn or (lambda msg, type_: None)
-        self._resolved_all = resolved_all
+        self._resolved_all: dict[str, ResolvedDict] = {}
         self._resolve_all_warned: set[str] = set()
         """The full_names of modules that have already been warned about, regarding __all__ resolution"""
         self._is_hidden_cache: OrderedDict[str, bool] = OrderedDict()
@@ -93,6 +92,18 @@ def get_children(
                     f"__all__ missing or empty in {item['full_name']}",
                     WarningSubtypes.ALL_MISSING,
                 )
+
+            if item["full_name"] not in self._resolved_all:
+                # TODO perhaps here we should find the "highest ancestor" available in the db and use that?
+                self._resolved_all.update(
+                    {
+                        k: v
+                        for k, v in resolve_all(self._db, item["full_name"]).items()
+                        if any(
+                            pat.fullmatch(k) for pat in self.config.module_all_regexes
+                        )
+                    }
+                )
             resolved_data = (
                 self._resolved_all.get(item["full_name"])
                 if self._resolved_all

src/autodoc2/sphinx/extension.py

@@ -18,7 +18,7 @@
 from autodoc2.db import InMemoryDb, UniqueError
 from autodoc2.sphinx.docstring import DocstringRenderer
 from autodoc2.sphinx.logging_ import LOGGER, warn_sphinx
-from autodoc2.utils import ResolvedDict, WarningSubtypes, resolve_all, yield_modules
+from autodoc2.utils import WarningSubtypes, yield_modules
 
 try:
     from sphinx.util.display import status_iterator
@@ -177,7 +177,6 @@ def run_autodoc_package(app: Sphinx, config: Config, pkg_index: int) -> str | No
         autodoc2_cache[path.as_posix()] = {"hash": hash_str, "db": db}
 
     # find all the package/module, so we know what files to write
-    # To following __all__ strategy
     LOGGER.info("[Autodoc2] Determining files to write ...")
     to_write: t.List[str] = []
     stack = [root_module]
@@ -192,15 +191,6 @@ def run_autodoc_package(app: Sphinx, config: Config, pkg_index: int) -> str | No
             ]
         )
 
-    resolved_all: None | t.Dict[str, ResolvedDict] = None
-    if config.module_all_regexes:
-        LOGGER.info("[Autodoc2] Resolving __all__ imports ...")
-        resolved_all = {
-            k: v
-            for k, v in resolve_all(db, root_module).items()
-            if any(pat.fullmatch(k) for pat in config.module_all_regexes)
-        }
-
     def _warn_render(msg: str, type_: WarningSubtypes) -> None:
         warn_sphinx(msg, type_)
 
@@ -219,9 +209,7 @@ def _warn_render(msg: str, type_: WarningSubtypes) -> None:
             if pat.fullmatch(mod_name):
                 render_cls = cls
                 break
-        content = "\n".join(
-            render_cls(db, config, _warn_render, resolved_all).render_item(mod_name)
-        )
+        content = "\n".join(render_cls(db, config, _warn_render).render_item(mod_name))
         out_path = output / (mod_name + render_cls.EXTENSION)
         paths.append(out_path)
         if not (out_path.exists() and out_path.read_text("utf8") == content):

src/autodoc2/utils.py

@@ -138,11 +138,11 @@ class ResolvedDict(t.TypedDict):
 
 
 def resolve_all(db: Database, package_name: str) -> dict[str, ResolvedDict]:
-    """Give a module name, yield all names that would be imported by star."""
+    """Given a module name, yield all names that would be imported by star."""
     # see: https://docs.python.org/3/reference/simple_stmts.html#import
 
     # gather all the packages and modules in the database,
-    # that are, or begin with package_name
+    # that are/begin with package_name
     modules = {
         i["full_name"]: i
         for i in itertools.chain(db.get_by_type("module"), db.get_by_type("package"))