refactoring

Author: tom-sapletta-com

code2docs/analyzers/docstring_extractor.py

@@ -67,6 +67,13 @@ def _classify_section(line: str) -> Optional[str]:
             return "examples"
         return None
 
+    _SECTION_PARSERS = {
+        "params": "_parse_param_line",
+        "returns": "_parse_returns_line",
+        "raises": "_parse_raises_line",
+        "examples": "_parse_examples_line",
+    }
+
     def _parse_sections(self, lines: List[str], info: DocstringInfo) -> None:
         """Walk remaining lines, dispatching content to the right section."""
         current_section = "description"
@@ -84,19 +91,33 @@ def _parse_sections(self, lines: List[str], info: DocstringInfo) -> None:
 
             if current_section == "description":
                 desc_lines.append(stripped)
-            elif current_section == "params" and stripped:
-                if ":" in stripped:
-                    pname, pdesc = stripped.split(":", 1)
-                    info.params[pname.strip()] = pdesc.strip()
-            elif current_section == "returns" and stripped:
-                info.returns = stripped
-            elif current_section == "raises" and stripped:
-                info.raises.append(stripped)
-            elif current_section == "examples" and stripped:
-                info.examples.append(stripped)
+            elif stripped and current_section in self._SECTION_PARSERS:
+                getattr(self, self._SECTION_PARSERS[current_section])(info, stripped)
 
         info.description = "\n".join(desc_lines).strip()
 
+    @staticmethod
+    def _parse_param_line(info: DocstringInfo, line: str) -> None:
+        """Parse a single param line: 'name: description'."""
+        if ":" in line:
+            pname, pdesc = line.split(":", 1)
+            info.params[pname.strip()] = pdesc.strip()
+
+    @staticmethod
+    def _parse_returns_line(info: DocstringInfo, line: str) -> None:
+        """Parse a returns line."""
+        info.returns = line
+
+    @staticmethod
+    def _parse_raises_line(info: DocstringInfo, line: str) -> None:
+        """Parse a raises line."""
+        info.raises.append(line)
+
+    @staticmethod
+    def _parse_examples_line(info: DocstringInfo, line: str) -> None:
+        """Parse an examples line."""
+        info.examples.append(line)
+
     def coverage_report(self, result: AnalysisResult) -> Dict[str, float]:
         """Calculate docstring coverage statistics."""
         total_funcs = len(result.functions)

code2docs/base.py

@@ -0,0 +1,46 @@
+"""Base generator interface and generation context."""
+
+from abc import ABC, abstractmethod
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Optional
+
+from code2llm.api import AnalysisResult
+
+from .config import Code2DocsConfig
+
+
+@dataclass
+class GenerateContext:
+    """Shared context passed to all generators during a run."""
+    project: Path
+    docs_dir: Path
+    dry_run: bool = False
+    verbose: bool = False
+
+
+class BaseGenerator(ABC):
+    """Abstract base for all documentation generators.
+
+    Subclasses must define ``name`` and implement ``should_run`` / ``run``.
+    Adding a new generator requires only creating a subclass and registering it
+    with the :class:`GeneratorRegistry`; no changes to ``cli.py`` needed.
+    """
+
+    name: str = ""
+
+    def __init__(self, config: Code2DocsConfig, result: AnalysisResult):
+        self.config = config
+        self.result = result
+
+    @abstractmethod
+    def should_run(self, *, readme_only: bool = False) -> bool:
+        """Return True if this generator should execute."""
+
+    @abstractmethod
+    def run(self, ctx: GenerateContext) -> Optional[str]:
+        """Execute generation and write output.
+
+        Returns a short status message (e.g. '✅ docs/api/ (12 files)')
+        or None if nothing was produced.
+        """

code2docs/cli.py

@@ -108,17 +108,11 @@ def _load_config(project_path: str, config_path: Optional[str] = None) -> Code2D
 
 def _run_generate(project_path: str, config: Code2DocsConfig,
                   readme_only: bool = False, dry_run: bool = False):
-    """Run full documentation generation."""
+    """Run full documentation generation via the generator registry."""
     from .analyzers.project_scanner import ProjectScanner
-    from .generators.readme_gen import ReadmeGenerator
-    from .generators.api_reference_gen import ApiReferenceGenerator
-    from .generators.module_docs_gen import ModuleDocsGenerator
-    from .generators.examples_gen import ExamplesGenerator
-    from .generators.architecture_gen import ArchitectureGenerator
-    from .generators.depgraph_gen import DepGraphGenerator
-    from .generators.coverage_gen import CoverageGenerator
-    from .generators.mkdocs_gen import MkDocsGenerator
-    from .generators.api_changelog_gen import ApiChangelogGenerator
+    from .base import GenerateContext
+    from .registry import GeneratorRegistry
+    from .generators._registry_adapters import ALL_ADAPTERS
 
     project = Path(project_path).resolve()
     click.echo(f"📖 code2docs: analyzing {project.name}...")
@@ -132,99 +126,22 @@ def _run_generate(project_path: str, config: Code2DocsConfig,
         click.echo(f"  Classes: {len(result.classes)}")
         click.echo(f"  Modules: {len(result.modules)}")
 
-    # Step 2: Generate README
-    readme_gen = ReadmeGenerator(config, result)
-    readme_content = readme_gen.generate()
+    # Step 2: Build context and registry
+    docs_dir = project / config.output
+    if not dry_run and not readme_only:
+        docs_dir.mkdir(parents=True, exist_ok=True)
 
-    if dry_run:
-        click.echo(f"\n--- README.md ({len(readme_content)} chars) ---")
-        click.echo(readme_content[:500] + "..." if len(readme_content) > 500 else readme_content)
-    else:
-        readme_path = project / config.readme_output
-        readme_gen.write(str(readme_path), readme_content)
-        click.echo(f"  ✅ {readme_path.relative_to(project)}")
-
-    if readme_only:
-        return
+    ctx = GenerateContext(
+        project=project, docs_dir=docs_dir,
+        dry_run=dry_run, verbose=config.verbose,
+    )
 
-    # Step 3: Generate docs/
-    docs_dir = project / config.output
-    docs_dir.mkdir(parents=True, exist_ok=True)
-
-    if config.docs.api_reference:
-        api_gen = ApiReferenceGenerator(config, result)
-        files = api_gen.generate_all()
-        if not dry_run:
-            api_gen.write_all(str(docs_dir / "api"), files)
-            click.echo(f"  ✅ docs/api/ ({len(files)} files)")
-        else:
-            click.echo(f"  [dry-run] docs/api/ ({len(files)} files)")
-
-    if config.docs.module_docs:
-        mod_gen = ModuleDocsGenerator(config, result)
-        files = mod_gen.generate_all()
-        if not dry_run:
-            mod_gen.write_all(str(docs_dir / "modules"), files)
-            click.echo(f"  ✅ docs/modules/ ({len(files)} files)")
-        else:
-            click.echo(f"  [dry-run] docs/modules/ ({len(files)} files)")
-
-    if config.docs.architecture:
-        arch_gen = ArchitectureGenerator(config, result)
-        content = arch_gen.generate()
-        if not dry_run:
-            (docs_dir / "architecture.md").write_text(content, encoding="utf-8")
-            click.echo(f"  ✅ docs/architecture.md")
-        else:
-            click.echo(f"  [dry-run] docs/architecture.md")
-
-    # Step 4: Dependency graph
-    depgraph_gen = DepGraphGenerator(config, result)
-    content = depgraph_gen.generate()
-    if not dry_run:
-        (docs_dir / "dependency-graph.md").write_text(content, encoding="utf-8")
-        click.echo(f"  ✅ docs/dependency-graph.md")
-    else:
-        click.echo(f"  [dry-run] docs/dependency-graph.md")
-
-    # Step 5: Docstring coverage
-    cov_gen = CoverageGenerator(config, result)
-    content = cov_gen.generate()
-    if not dry_run:
-        (docs_dir / "coverage.md").write_text(content, encoding="utf-8")
-        click.echo(f"  ✅ docs/coverage.md")
-    else:
-        click.echo(f"  [dry-run] docs/coverage.md")
-
-    # Step 6: API changelog (diff with previous snapshot)
-    api_cl_gen = ApiChangelogGenerator(config, result)
-    content = api_cl_gen.generate(str(project))
-    if not dry_run:
-        (docs_dir / "api-changelog.md").write_text(content, encoding="utf-8")
-        api_cl_gen.save_snapshot(str(project))
-        click.echo(f"  ✅ docs/api-changelog.md")
-    else:
-        click.echo(f"  [dry-run] docs/api-changelog.md")
-
-    # Step 7: Generate examples/
-    if config.examples.auto_generate:
-        ex_gen = ExamplesGenerator(config, result)
-        files = ex_gen.generate_all()
-        if not dry_run:
-            examples_dir = project / "examples"
-            ex_gen.write_all(str(examples_dir), files)
-            click.echo(f"  ✅ examples/ ({len(files)} files)")
-        else:
-            click.echo(f"  [dry-run] examples/ ({len(files)} files)")
-
-    # Step 8: mkdocs.yml
-    mkdocs_gen = MkDocsGenerator(config, result)
-    content = mkdocs_gen.generate(str(docs_dir))
-    if not dry_run:
-        mkdocs_gen.write(str(project / "mkdocs.yml"), content)
-        click.echo(f"  ✅ mkdocs.yml")
-    else:
-        click.echo(f"  [dry-run] mkdocs.yml")
+    registry = GeneratorRegistry()
+    for adapter_cls in ALL_ADAPTERS:
+        registry.add(adapter_cls(config, result))
+
+    # Step 3: Run all generators
+    registry.run_all(ctx, readme_only=readme_only)
 
     click.echo("📖 Done!")