python-agents-examples/check_agent_example_coverage.py at main · ctxadm/python-agents-examples · GitHub

History

147 lines (118 loc) · 4.31 KB

Raw

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

#!/usr/bin/env python

"""

check_agent_example_coverage.py

────────────────────────────────

Scan every .py file beneath the current directory (or the paths you provide)

and report which public methods of livekit.agents.voice.Agent and

AgentSession are already exercised or overridden in the example code.

USAGE

=====

# Scan the whole repo

python check_agent_example_coverage.py

# Or cherry-pick folders

python check_agent_example_coverage.py basics/ pipeline-stt/

# Just print warnings for uncovered methods

python check_agent_example_coverage.py --warn-only

# Return non-zero exit code if coverage incomplete (for CI)

python check_agent_example_coverage.py --fail-on-incomplete

The report looks like:

Agent (7/9 methods used)

✔ generate_reply

✔ on_enter

✘ on_exit

…

AgentSession (5/8 methods used)

✔ start

✔ stop

✘ reconnect

…

"""

from __future__ import annotations

import argparse

import inspect

import sys

from pathlib import Path

from collections import defaultdict

from livekit.agents.voice import Agent, AgentSession

EXCLUDE_DIRS = {

".git",

".hg",

".svn",

"__pycache__",

"venv",

".venv",

"env",

".env",

"build",

"dist",

}

def _public_methods(cls) -> set[str]:

return {

name

for name, obj in inspect.getmembers(cls, inspect.isfunction)

if not name.startswith("_")

}

AGENT_METHODS = _public_methods(Agent)

SESSION_METHODS = _public_methods(AgentSession)

def _scan(paths: list[Path]):

"""Return a dict {'Agent': {m: bool}, 'AgentSession': {m: bool}}."""

found = {

"Agent": defaultdict(bool, {m: False for m in AGENT_METHODS}),

"AgentSession": defaultdict(bool, {m: False for m in SESSION_METHODS}),

}

for base in paths:

for py in base.rglob("*.py"):

if any(part in EXCLUDE_DIRS for part in py.parts):

continue

try:

code = py.read_text(encoding="utf-8", errors="ignore")

except Exception:

continue

for m in AGENT_METHODS:

call_pat = f".{m}("

def_pat = f"def {m}("

if call_pat in code or def_pat in code:

found["Agent"][m] = True

for m in SESSION_METHODS:

call_pat = f".{m}("

def_pat = f"def {m}("

if call_pat in code or def_pat in code:

found["AgentSession"][m] = True

return found

def _report(found: dict[str, dict[str, bool]], warn_only=False):

incomplete = False

uncovered_methods = []

for cls, methods in found.items():

total = len(methods)

used = sum(methods.values())

if used < total:

incomplete = True

if not warn_only:

print(f"\n{cls} ({used}/{total} methods used)")

for m in sorted(methods):

tick = "✔" if methods[m] else "✘"

print(f" {tick} {m}")

if not methods[m]:

uncovered_methods.append(f"{cls}.{m}")

elif used < total:

print(f"\nWARNING: {cls} has uncovered methods ({used}/{total} covered)")

for m in sorted(methods):

if not methods[m]:

print(f" Missing: {cls}.{m}")

uncovered_methods.append(f"{cls}.{m}")

return incomplete, uncovered_methods

if __name__ == "__main__":

parser = argparse.ArgumentParser(description="Check Agent API coverage in examples")

parser.add_argument("paths", nargs="*", default=[Path.cwd()],

help="Paths to scan (default: current directory)")

parser.add_argument("--warn-only", action="store_true",

help="Only show warnings for uncovered methods")

parser.add_argument("--fail-on-incomplete", action="store_true",

help="Return non-zero exit code if coverage is incomplete")

args = parser.parse_args()

bases = [Path(p) for p in args.paths]

coverage = _scan(bases)

incomplete, uncovered = _report(coverage, warn_only=args.warn_only)

if incomplete and args.fail_on_incomplete:

print(f"\nERROR: Found {len(uncovered)} uncovered methods. Add examples that use these methods.")

sys.exit(1)

python-agents-examples/check_agent_example_coverage.py at main · ctxadm/python-agents-examples · GitHub

Expand file tree

Breadcrumbs

check_agent_example_coverage.py

Latest commit

History

Breadcrumbs

check_agent_example_coverage.py

File metadata and controls