Skip to content

Coverage

lcp.coverage

Coverage module for analyzing documentation completeness.

UndocumentedSymbol dataclass

A symbol missing documentation.

Source code in src/lcp/coverage.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
@dataclass
class UndocumentedSymbol:
    """A symbol missing documentation."""

    kind: str
    module: str
    entity: str
    source_file: str | None = None

    def to_dict(self) -> dict:
        """Convert to dictionary."""
        result = {
            "kind": self.kind,
            "module": self.module,
            "entity": self.entity,
        }
        if self.source_file:
            result["source_file"] = self.source_file
        return result

to_dict 

to_dict() -> dict

Convert to dictionary.

Source code in src/lcp/coverage.py 
21
22
23
24
25
26
27
28
29
30
def to_dict(self) -> dict:
    """Convert to dictionary."""
    result = {
        "kind": self.kind,
        "module": self.module,
        "entity": self.entity,
    }
    if self.source_file:
        result["source_file"] = self.source_file
    return result

KindStats dataclass

Statistics for a specific symbol kind.

Source code in src/lcp/coverage.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
@dataclass
class KindStats:
    """Statistics for a specific symbol kind."""

    total: int = 0
    documented: int = 0
    undocumented: int = 0

    def to_dict(self) -> dict:
        """Convert to dictionary."""
        return {
            "total": self.total,
            "documented": self.documented,
            "undocumented": self.undocumented,
        }

to_dict 

to_dict() -> dict

Convert to dictionary.

Source code in src/lcp/coverage.py 
41
42
43
44
45
46
47
def to_dict(self) -> dict:
    """Convert to dictionary."""
    return {
        "total": self.total,
        "documented": self.documented,
        "undocumented": self.undocumented,
    }

CoverageSummary dataclass

Summary of documentation coverage.

Source code in src/lcp/coverage.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
@dataclass
class CoverageSummary:
    """Summary of documentation coverage."""

    total_symbols: int = 0
    documented: int = 0
    undocumented: int = 0
    coverage_percent: float = 0.0
    by_kind: dict[str, KindStats] = field(default_factory=dict)

    def to_dict(self) -> dict:
        """Convert to dictionary."""
        return {
            "total_symbols": self.total_symbols,
            "documented": self.documented,
            "undocumented": self.undocumented,
            "coverage_percent": round(self.coverage_percent, 1),
            "by_kind": {k: v.to_dict() for k, v in self.by_kind.items()},
        }

to_dict 

to_dict() -> dict

Convert to dictionary.

Source code in src/lcp/coverage.py 
60
61
62
63
64
65
66
67
68
def to_dict(self) -> dict:
    """Convert to dictionary."""
    return {
        "total_symbols": self.total_symbols,
        "documented": self.documented,
        "undocumented": self.undocumented,
        "coverage_percent": round(self.coverage_percent, 1),
        "by_kind": {k: v.to_dict() for k, v in self.by_kind.items()},
    }

CoverageReport dataclass

Documentation coverage report for a package.

Source code in src/lcp/coverage.py 
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
@dataclass
class CoverageReport:
    """Documentation coverage report for a package."""

    package: str
    version: str
    generated_at: datetime
    summary: CoverageSummary
    undocumented: list[UndocumentedSymbol] = field(default_factory=list)

    def to_dict(self) -> dict:
        """Convert to dictionary suitable for JSON serialization."""
        return {
            "package": self.package,
            "version": self.version,
            "generated_at": self.generated_at.isoformat(),
            "summary": self.summary.to_dict(),
            "undocumented": [s.to_dict() for s in self.undocumented],
        }

    def to_json(self, indent: int = 2) -> str:
        """Convert to JSON string."""
        return json.dumps(self.to_dict(), indent=indent)

    def to_markdown(self) -> str:
        """Convert to Markdown format."""
        lines = [
            "# Documentation Coverage Report",
            "",
            f"**Package:** {self.package}  ",
            f"**Version:** {self.version}  ",
            f"**Generated:** {self.generated_at.strftime('%Y-%m-%d %H:%M:%S')}",
            "",
            "## Summary",
            "",
            "| Kind | Total | Documented | Undocumented | Coverage |",
            "|------|-------|------------|--------------|----------|",
        ]

        # Add rows for each kind
        for kind, stats in sorted(self.summary.by_kind.items()):
            if stats.total > 0:
                coverage = (stats.documented / stats.total) * 100
                lines.append(
                    f"| {kind} | {stats.total} | {stats.documented} | "
                    f"{stats.undocumented} | {coverage:.1f}% |"
                )

        # Add total row
        lines.append(
            f"| **Total** | **{self.summary.total_symbols}** | "
            f"**{self.summary.documented}** | **{self.summary.undocumented}** | "
            f"**{self.summary.coverage_percent:.1f}%** |"
        )

        # Add undocumented symbols section
        if self.undocumented:
            lines.extend(["", "## Undocumented Symbols", ""])

            # Group by kind
            by_kind: dict[str, list[UndocumentedSymbol]] = {}
            for symbol in self.undocumented:
                by_kind.setdefault(symbol.kind, []).append(symbol)

            for kind in sorted(by_kind.keys()):
                symbols = by_kind[kind]
                kind_title = kind.capitalize() + "s" if not kind.endswith("s") else kind.capitalize()
                lines.extend([f"### {kind_title} ({len(symbols)})", ""])

                for symbol in symbols:
                    source_info = f" - `{symbol.source_file}`" if symbol.source_file else ""
                    lines.append(f"- `{symbol.module}:{symbol.entity}`{source_info}")

                lines.append("")

        return "\n".join(lines)

    def to_file(self, path: str, format: str | None = None) -> None:
        """Write report to a file.

        Args:
            path: Output file path.
            format: Output format ('json' or 'markdown'). If None, inferred from extension.
        """
        if format is None:
            format = "markdown" if path.endswith(".md") else "json"

        content = self.to_markdown() if format == "markdown" else self.to_json()

        with open(path, "w", encoding="utf-8") as f:
            f.write(content)

to_dict 

to_dict() -> dict

Convert to dictionary suitable for JSON serialization.

Source code in src/lcp/coverage.py 
81
82
83
84
85
86
87
88
89
def to_dict(self) -> dict:
    """Convert to dictionary suitable for JSON serialization."""
    return {
        "package": self.package,
        "version": self.version,
        "generated_at": self.generated_at.isoformat(),
        "summary": self.summary.to_dict(),
        "undocumented": [s.to_dict() for s in self.undocumented],
    }

to_json 

to_json(indent: int = 2) -> str

Convert to JSON string.

Source code in src/lcp/coverage.py 
91
92
93
def to_json(self, indent: int = 2) -> str:
    """Convert to JSON string."""
    return json.dumps(self.to_dict(), indent=indent)

to_markdown 

to_markdown() -> str

Convert to Markdown format.

Source code in src/lcp/coverage.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
def to_markdown(self) -> str:
    """Convert to Markdown format."""
    lines = [
        "# Documentation Coverage Report",
        "",
        f"**Package:** {self.package}  ",
        f"**Version:** {self.version}  ",
        f"**Generated:** {self.generated_at.strftime('%Y-%m-%d %H:%M:%S')}",
        "",
        "## Summary",
        "",
        "| Kind | Total | Documented | Undocumented | Coverage |",
        "|------|-------|------------|--------------|----------|",
    ]

    # Add rows for each kind
    for kind, stats in sorted(self.summary.by_kind.items()):
        if stats.total > 0:
            coverage = (stats.documented / stats.total) * 100
            lines.append(
                f"| {kind} | {stats.total} | {stats.documented} | "
                f"{stats.undocumented} | {coverage:.1f}% |"
            )

    # Add total row
    lines.append(
        f"| **Total** | **{self.summary.total_symbols}** | "
        f"**{self.summary.documented}** | **{self.summary.undocumented}** | "
        f"**{self.summary.coverage_percent:.1f}%** |"
    )

    # Add undocumented symbols section
    if self.undocumented:
        lines.extend(["", "## Undocumented Symbols", ""])

        # Group by kind
        by_kind: dict[str, list[UndocumentedSymbol]] = {}
        for symbol in self.undocumented:
            by_kind.setdefault(symbol.kind, []).append(symbol)

        for kind in sorted(by_kind.keys()):
            symbols = by_kind[kind]
            kind_title = kind.capitalize() + "s" if not kind.endswith("s") else kind.capitalize()
            lines.extend([f"### {kind_title} ({len(symbols)})", ""])

            for symbol in symbols:
                source_info = f" - `{symbol.source_file}`" if symbol.source_file else ""
                lines.append(f"- `{symbol.module}:{symbol.entity}`{source_info}")

            lines.append("")

    return "\n".join(lines)

to_file 

to_file(path: str, format: str | None = None) -> None

Write report to a file.

Parameters:

Name Type Description Default
path str

Output file path.

 required
format str | None

Output format ('json' or 'markdown'). If None, inferred from extension.

 None
Source code in src/lcp/coverage.py 
148
149
150
151
152
153
154
155
156
157
158
159
160
161
def to_file(self, path: str, format: str | None = None) -> None:
    """Write report to a file.

    Args:
        path: Output file path.
        format: Output format ('json' or 'markdown'). If None, inferred from extension.
    """
    if format is None:
        format = "markdown" if path.endswith(".md") else "json"

    content = self.to_markdown() if format == "markdown" else self.to_json()

    with open(path, "w", encoding="utf-8") as f:
        f.write(content)

generate_coverage 

generate_coverage(package_name: str, include_private: bool = False, recursive: bool = True) -> CoverageReport

Generate documentation coverage report for a package.

Parameters:

Name Type Description Default
package_name str

The name of an installed Python package to analyze.

 required
include_private bool

Include private symbols (starting with _).

 False
recursive bool

Scan submodules recursively.

 True

Returns:

Type Description
CoverageReport

A CoverageReport containing coverage statistics and undocumented symbols.

Raises:

Type Description
ImportError

If the package cannot be imported.
Example

from lcp import generate_coverage report = generate_coverage("requests") print(f"Coverage: {report.summary.coverage_percent}%") report.to_file("coverage.json")

Source code in src/lcp/coverage.py 
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
def generate_coverage(
    package_name: str,
    include_private: bool = False,
    recursive: bool = True,
) -> CoverageReport:
    """Generate documentation coverage report for a package.

    Args:
        package_name: The name of an installed Python package to analyze.
        include_private: Include private symbols (starting with _).
        recursive: Scan submodules recursively.

    Returns:
        A CoverageReport containing coverage statistics and undocumented symbols.

    Raises:
        ImportError: If the package cannot be imported.

    Example:
        >>> from lcp import generate_coverage
        >>> report = generate_coverage("requests")
        >>> print(f"Coverage: {report.summary.coverage_percent}%")
        >>> report.to_file("coverage.json")
    """
    scanned = scan_package(package_name, include_private, recursive)
    return _analyze_coverage(scanned)

generate_coverage_from_scanned 

generate_coverage_from_scanned(scanned: ScannedModule) -> CoverageReport

Generate coverage report from already scanned module data.

This is useful when you want to generate both LCP and coverage from the same scan, avoiding duplicate work.

Parameters:

Name Type Description Default
scanned ScannedModule

Pre-scanned module data from scan_package().

 required

Returns:

Type Description
CoverageReport

A CoverageReport containing coverage statistics.
Source code in src/lcp/coverage.py 
259
260
261
262
263
264
265
266
267
268
269
270
271
def generate_coverage_from_scanned(scanned: ScannedModule) -> CoverageReport:
    """Generate coverage report from already scanned module data.

    This is useful when you want to generate both LCP and coverage
    from the same scan, avoiding duplicate work.

    Args:
        scanned: Pre-scanned module data from scan_package().

    Returns:
        A CoverageReport containing coverage statistics.
    """
    return _analyze_coverage(scanned)