Compare commits
1 Commits
step35/96-
...
step35/109
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
80f82c9ecd |
@@ -1,203 +0,0 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Docstring Generator — find and add missing docstrings.
|
||||
|
||||
Scans Python files for functions/async functions lacking docstrings.
|
||||
Generates Google-style docstrings from function signature and body.
|
||||
Inserts them in place.
|
||||
|
||||
Usage:
|
||||
python3 docstring_generator.py scripts/ # Fix in place
|
||||
python3 docstring_generator.py --dry-run scripts/ # Preview changes
|
||||
python3 docstring_generator.py --json scripts/ # Machine-readable output
|
||||
python3 docstring_generator.py path/to/file.py
|
||||
"""
|
||||
|
||||
import argparse
|
||||
import ast
|
||||
import json
|
||||
import os
|
||||
import sys
|
||||
from pathlib import Path
|
||||
from typing import Optional, Tuple, List
|
||||
|
||||
|
||||
# --- Helper: turn snake_case into Title Case phrase ---
|
||||
def name_to_title(name: str) -> str:
|
||||
"""Convert snake_case function name to a Title Case description."""
|
||||
words = name.replace('_', ' ').split()
|
||||
if not words:
|
||||
return ''
|
||||
titled = []
|
||||
for w in words:
|
||||
if len(w) <= 2:
|
||||
titled.append(w.upper())
|
||||
else:
|
||||
titled.append(w[0].upper() + w[1:])
|
||||
return ' '.join(titled)
|
||||
|
||||
|
||||
# --- Helper: extract first meaningful statement from body for summary ---
|
||||
def extract_body_hint(body: list[ast.stmt]) -> Optional[str]:
|
||||
"""Look for an assignment or return that hints at function purpose."""
|
||||
for stmt in body:
|
||||
if isinstance(stmt, ast.Expr) and isinstance(stmt.value, ast.Constant):
|
||||
continue # skip existing docstring placeholder
|
||||
# Assignment to a result-like variable?
|
||||
if isinstance(stmt, ast.Assign):
|
||||
for target in stmt.targets:
|
||||
if isinstance(target, ast.Name):
|
||||
var_name = target.id
|
||||
if var_name in ('result', 'msg', 'output', 'retval', 'value', 'response', 'data'):
|
||||
val = ast.unparse(stmt.value).strip()
|
||||
if val:
|
||||
return f"Compute or return {val}"
|
||||
# Return statement
|
||||
if isinstance(stmt, ast.Return) and stmt.value:
|
||||
ret = ast.unparse(stmt.value).strip()
|
||||
if ret:
|
||||
return f"Return {ret}"
|
||||
break
|
||||
return None
|
||||
|
||||
|
||||
# --- Generate a docstring string for a function ---
|
||||
def generate_docstring(func_node: ast.FunctionDef | ast.AsyncFunctionDef) -> str:
|
||||
"""Build a Google-style docstring for the given function node."""
|
||||
parts: list[str] = []
|
||||
|
||||
# Summary line
|
||||
summary = name_to_title(func_node.name)
|
||||
body_hint = extract_body_hint(func_node.body)
|
||||
if body_hint:
|
||||
summary = f"{summary}. {body_hint}"
|
||||
parts.append(summary)
|
||||
|
||||
# Args section if there are parameters (excluding self/cls)
|
||||
args = func_node.args.args
|
||||
if args:
|
||||
arg_lines = []
|
||||
for arg in args:
|
||||
if arg.arg in ('self', 'cls'):
|
||||
continue
|
||||
type_ann = ast.unparse(arg.annotation) if arg.annotation else 'Any'
|
||||
arg_lines.append(f"{arg.arg} ({type_ann}): Parameter {arg.arg}")
|
||||
if arg_lines:
|
||||
parts.append("\nArgs:\n " + "\n ".join(arg_lines))
|
||||
|
||||
# Returns section
|
||||
if func_node.returns:
|
||||
ret_type = ast.unparse(func_node.returns)
|
||||
parts.append(f"\nReturns:\n {ret_type}: Return value")
|
||||
elif any(isinstance(s, ast.Return) and s.value is not None for s in ast.walk(func_node)):
|
||||
parts.append("\nReturns:\n Return value")
|
||||
|
||||
return '"""' + '\n'.join(parts) + '\n"""'
|
||||
|
||||
|
||||
# --- Transform source AST ---
|
||||
def process_source(source: str, filename: str) -> Tuple[str, List[str]]:
|
||||
"""Add docstrings to all undocumented functions. Returns (new_source, [func_names])."""
|
||||
try:
|
||||
tree = ast.parse(source)
|
||||
except SyntaxError as e:
|
||||
print(f" WARNING: Could not parse {filename}: {e}", file=sys.stderr)
|
||||
return source, []
|
||||
|
||||
class DocstringInserter(ast.NodeTransformer):
|
||||
def __init__(self):
|
||||
self.modified_funcs: list[str] = []
|
||||
|
||||
def visit_FunctionDef(self, node: ast.FunctionDef) -> ast.FunctionDef:
|
||||
return self._process(node)
|
||||
|
||||
def visit_AsyncFunctionDef(self, node: ast.AsyncFunctionDef) -> ast.AsyncFunctionDef:
|
||||
return self._process(node)
|
||||
|
||||
def _process(self, node):
|
||||
existing_doc = ast.get_docstring(node)
|
||||
if existing_doc is not None:
|
||||
return node
|
||||
docstring_text = generate_docstring(node)
|
||||
doc_node = ast.Expr(value=ast.Constant(value=docstring_text))
|
||||
node.body.insert(0, doc_node)
|
||||
ast.fix_missing_locations(node)
|
||||
self.modified_funcs.append(node.name)
|
||||
return node
|
||||
|
||||
inserter = DocstringInserter()
|
||||
new_tree = inserter.visit(tree)
|
||||
if inserter.modified_funcs:
|
||||
return ast.unparse(new_tree), inserter.modified_funcs
|
||||
return source, []
|
||||
|
||||
|
||||
# --- File discovery ---
|
||||
def iter_python_files(paths: list[str]) -> list[Path]:
|
||||
"""Collect all .py files from provided paths."""
|
||||
files: set[Path] = set()
|
||||
for p in paths:
|
||||
path = Path(p)
|
||||
if not path.exists():
|
||||
print(f"WARNING: Path not found: {p}", file=sys.stderr)
|
||||
continue
|
||||
if path.is_file() and path.suffix == '.py':
|
||||
files.add(path.resolve())
|
||||
elif path.is_dir():
|
||||
for child in path.rglob('*.py'):
|
||||
if '.git' in child.parts or '__pycache__' in child.parts:
|
||||
continue
|
||||
files.add(child.resolve())
|
||||
return sorted(files)
|
||||
|
||||
|
||||
def main():
|
||||
parser = argparse.ArgumentParser(description="Generate docstrings for functions missing them")
|
||||
parser.add_argument('paths', nargs='+', help='Python files or directories to process')
|
||||
parser.add_argument('--dry-run', action='store_true', help='Show what would change without writing')
|
||||
parser.add_argument('--json', action='store_true', help='Output machine-readable JSON summary')
|
||||
parser.add_argument('-v', '--verbose', action='store_true', help='Print each file processed')
|
||||
|
||||
args = parser.parse_args()
|
||||
|
||||
files = iter_python_files(args.paths)
|
||||
if not files:
|
||||
print("No Python files found to process", file=sys.stderr)
|
||||
sys.exit(1)
|
||||
|
||||
results = []
|
||||
total_funcs = 0
|
||||
|
||||
for pyfile in files:
|
||||
try:
|
||||
original = pyfile.read_text(encoding='utf-8')
|
||||
except Exception as e:
|
||||
print(f" ERROR reading {pyfile}: {e}", file=sys.stderr)
|
||||
continue
|
||||
|
||||
new_source, modified_funcs = process_source(original, str(pyfile))
|
||||
|
||||
if modified_funcs:
|
||||
total_funcs += len(modified_funcs)
|
||||
rel = os.path.relpath(pyfile)
|
||||
if args.verbose:
|
||||
print(f" {rel}: +{len(modified_funcs)} docstrings")
|
||||
results.append({'file': str(pyfile), 'functions': modified_funcs})
|
||||
if not args.dry_run:
|
||||
pyfile.write_text(new_source, encoding='utf-8')
|
||||
elif args.verbose:
|
||||
print(f" {rel}: no changes")
|
||||
|
||||
if args.json:
|
||||
summary = {'total_files_modified': len(results), 'total_functions': total_funcs, 'files': results}
|
||||
print(json.dumps(summary, indent=2))
|
||||
else:
|
||||
print(f"Generated docstrings for {total_funcs} functions across {len(results)} files")
|
||||
if args.dry_run:
|
||||
print(" (dry run — no files written)")
|
||||
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
sys.exit(main())
|
||||
212
scripts/test_update_checker.py
Normal file
212
scripts/test_update_checker.py
Normal file
@@ -0,0 +1,212 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Tests for update_checker.py — 5.3: Update Checker
|
||||
|
||||
Acceptance criteria verified:
|
||||
✓ Compares installed vs latest
|
||||
✓ Reports major/minor/patch updates
|
||||
✓ Flags breaking changes (major)
|
||||
✓ Output: update report
|
||||
"""
|
||||
|
||||
import json
|
||||
import os
|
||||
import subprocess
|
||||
import sys
|
||||
import tempfile
|
||||
from datetime import datetime
|
||||
from pathlib import Path
|
||||
from unittest.mock import patch, MagicMock
|
||||
|
||||
# Add scripts dir to path
|
||||
sys.path.insert(0, os.path.join(os.path.dirname(__file__), "..", "scripts"))
|
||||
|
||||
import update_checker as uc
|
||||
|
||||
|
||||
def test_parse_version():
|
||||
assert uc.parse_version("1.2.3") == (1, 2, 3)
|
||||
assert uc.parse_version("2.0.0") == (2, 0, 0)
|
||||
assert uc.parse_version("0.9.0") == (0, 9, 0)
|
||||
assert uc.parse_version("1.2") == (1, 2, 0)
|
||||
assert uc.parse_version("1") == (1, 0, 0)
|
||||
assert uc.parse_version("invalid") == (0, 0, 0)
|
||||
print("PASS: parse_version")
|
||||
|
||||
|
||||
def test_classify_update_patch():
|
||||
result = uc.classify_update("1.2.3", "1.2.4")
|
||||
assert result is not None
|
||||
assert result['update_type'] == 'patch'
|
||||
assert result['breaking_change'] is False
|
||||
assert result['severity'] == 'low'
|
||||
print("PASS: classify_update_patch")
|
||||
|
||||
|
||||
def test_classify_update_minor():
|
||||
result = uc.classify_update("1.2.3", "1.3.0")
|
||||
assert result is not None
|
||||
assert result['update_type'] == 'minor'
|
||||
assert result['breaking_change'] is False
|
||||
assert result['severity'] == 'medium'
|
||||
print("PASS: classify_update_minor")
|
||||
|
||||
|
||||
def test_classify_update_major():
|
||||
result = uc.classify_update("1.2.3", "2.0.0")
|
||||
assert result is not None
|
||||
assert result['update_type'] == 'major'
|
||||
assert result['breaking_change'] is True
|
||||
assert result['severity'] == 'high'
|
||||
print("PASS: classify_update_major")
|
||||
|
||||
|
||||
def test_classify_update_no_change():
|
||||
result = uc.classify_update("1.2.3", "1.2.3")
|
||||
assert result is None
|
||||
print("PASS: classify_update_no_change")
|
||||
|
||||
|
||||
def test_classify_update_multiple_major():
|
||||
result = uc.classify_update("1.0.0", "3.0.0")
|
||||
assert result is not None
|
||||
assert result['update_type'] == 'major'
|
||||
assert result['breaking_change'] is True
|
||||
print("PASS: classify_update_multiple_major")
|
||||
|
||||
|
||||
def test_text_report_format():
|
||||
updates = [{
|
||||
'package': 'requests',
|
||||
'installed': '2.28.0',
|
||||
'latest': '2.31.0',
|
||||
'update_type': 'minor',
|
||||
'breaking_change': False,
|
||||
'severity': 'medium',
|
||||
}]
|
||||
report = uc.generate_text_report(updates)
|
||||
assert 'DEPENDENCY UPDATE REPORT' in report
|
||||
assert 'requests' in report
|
||||
assert '2.28.0' in report
|
||||
assert '2.31.0' in report
|
||||
assert 'MINOR' in report
|
||||
assert 'MEDIUM' in report
|
||||
print("PASS: text_report_format")
|
||||
|
||||
|
||||
def test_text_report_shows_breaking():
|
||||
updates = [{
|
||||
'package': 'flask',
|
||||
'installed': '2.0.0',
|
||||
'latest': '3.0.0',
|
||||
'update_type': 'major',
|
||||
'breaking_change': True,
|
||||
'severity': 'high',
|
||||
}]
|
||||
report = uc.generate_text_report(updates)
|
||||
assert 'BREAKING CHANGE' in report.upper() or '⚠' in report
|
||||
print("PASS: text_report_shows_breaking")
|
||||
|
||||
|
||||
def test_json_report_structure():
|
||||
updates = [
|
||||
{
|
||||
'package': 'pytest',
|
||||
'installed': '8.0.0',
|
||||
'latest': '8.2.0',
|
||||
'update_type': 'minor',
|
||||
'breaking_change': False,
|
||||
'severity': 'medium',
|
||||
},
|
||||
{
|
||||
'package': 'flask',
|
||||
'installed': '2.0.0',
|
||||
'latest': '3.0.0',
|
||||
'update_type': 'major',
|
||||
'breaking_change': True,
|
||||
'severity': 'high',
|
||||
}
|
||||
]
|
||||
report_json = uc.generate_json_report(updates)
|
||||
data = json.loads(report_json)
|
||||
assert 'generated_at' in data
|
||||
assert data['total_updates'] == 2
|
||||
assert 'summary' in data
|
||||
assert data['summary']['major'] == 1
|
||||
assert data['summary']['minor'] == 1
|
||||
assert data['summary']['breaking'] == 1
|
||||
print("PASS: json_report_structure")
|
||||
|
||||
|
||||
def test_no_updates_report():
|
||||
report = uc.generate_text_report([])
|
||||
assert 'up to date' in report.lower() or 'all packages' in report.lower()
|
||||
print("PASS: no_updates_report")
|
||||
|
||||
|
||||
def test_end_to_end_integration():
|
||||
"""End-to-end: check_updates with mocked data produces valid report."""
|
||||
fake_installed = {
|
||||
"test-pkg-old": "1.0.0",
|
||||
"another-pkg": "2.5.3",
|
||||
}
|
||||
|
||||
def fake_get_latest(pkg):
|
||||
if pkg == "test-pkg-old":
|
||||
return "1.2.4"
|
||||
elif pkg == "another-pkg":
|
||||
return "3.0.0"
|
||||
return None
|
||||
|
||||
with patch('update_checker.get_installed_packages', return_value=fake_installed):
|
||||
with patch('update_checker.get_latest_version', side_effect=fake_get_latest):
|
||||
updates = uc.check_updates()
|
||||
|
||||
assert len(updates) == 2
|
||||
|
||||
test_pkg = next(u for u in updates if u['package'] == 'test-pkg-old')
|
||||
assert test_pkg['update_type'] == 'minor'
|
||||
assert test_pkg['breaking_change'] is False
|
||||
|
||||
another = next(u for u in updates if u['package'] == 'another-pkg')
|
||||
assert another['update_type'] == 'major'
|
||||
assert another['breaking_change'] is True
|
||||
|
||||
report = uc.generate_text_report(updates)
|
||||
assert 'DEPENDENCY UPDATE REPORT' in report
|
||||
assert 'MINOR' in report
|
||||
assert 'BREAKING CHANGE' in report.upper()
|
||||
|
||||
print(f"PASS: end_to_end_integration ({len(updates)} updates)")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
passed = 0
|
||||
failed = 0
|
||||
tests = [
|
||||
test_parse_version,
|
||||
test_classify_update_patch,
|
||||
test_classify_update_minor,
|
||||
test_classify_update_major,
|
||||
test_classify_update_no_change,
|
||||
test_classify_update_multiple_major,
|
||||
test_text_report_format,
|
||||
test_text_report_shows_breaking,
|
||||
test_json_report_structure,
|
||||
test_no_updates_report,
|
||||
test_end_to_end_integration,
|
||||
]
|
||||
for test_func in tests:
|
||||
try:
|
||||
test_func()
|
||||
passed += 1
|
||||
except AssertionError as e:
|
||||
print(f"FAIL: {test_func.__name__} — {e}")
|
||||
failed += 1
|
||||
except Exception as e:
|
||||
print(f"ERROR: {test_func.__name__} — {e}")
|
||||
import traceback
|
||||
traceback.print_exc()
|
||||
failed += 1
|
||||
print(f"\n{passed} passed, {failed} failed")
|
||||
sys.exit(0 if failed == 0 else 1)
|
||||
246
scripts/update_checker.py
Normal file
246
scripts/update_checker.py
Normal file
@@ -0,0 +1,246 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
5.3: Update Checker — Compare installed vs latest package versions
|
||||
|
||||
Check if dependencies have newer versions available. Query PyPI for each
|
||||
installed package, compare versions, and generate an update report with
|
||||
major/minor/patch classification and breaking change flags.
|
||||
|
||||
Usage:
|
||||
python3 scripts/update_checker.py
|
||||
python3 scripts/update_checker.py --json
|
||||
python3 scripts/update_checker.py --output updates.md
|
||||
python3 scripts/update_checker.py --package requests,pytest
|
||||
"""
|
||||
|
||||
import argparse
|
||||
import json
|
||||
import subprocess
|
||||
import sys
|
||||
from datetime import datetime
|
||||
from pathlib import Path
|
||||
from typing import Dict, List, Optional, Tuple
|
||||
from urllib.request import urlopen
|
||||
from urllib.error import URLError, HTTPError
|
||||
|
||||
|
||||
def get_installed_packages() -> Dict[str, str]:
|
||||
"""Get all installed packages via pip list --format=json."""
|
||||
try:
|
||||
result = subprocess.run(
|
||||
['pip', 'list', '--format=json'],
|
||||
capture_output=True, text=True, timeout=30
|
||||
)
|
||||
if result.returncode != 0:
|
||||
print(f"Warning: pip list failed: {result.stderr}", file=sys.stderr)
|
||||
return {}
|
||||
packages = json.loads(result.stdout)
|
||||
return {p['name'].lower(): p['version'] for p in packages}
|
||||
except (json.JSONDecodeError, subprocess.TimeoutExpired, KeyError) as e:
|
||||
print(f"Warning: failed to parse pip list: {e}", file=sys.stderr)
|
||||
return {}
|
||||
|
||||
|
||||
def get_latest_version(package_name: str) -> Optional[str]:
|
||||
"""Query PyPI JSON API for the latest version of a package."""
|
||||
url = f"https://pypi.org/pypi/{package_name}/json"
|
||||
try:
|
||||
with urlopen(url, timeout=10) as resp:
|
||||
if resp.status == 200:
|
||||
data = json.loads(resp.read())
|
||||
return data.get('info', {}).get('version')
|
||||
except (URLError, HTTPError, json.JSONDecodeError, TimeoutError):
|
||||
pass
|
||||
return None
|
||||
|
||||
|
||||
def parse_version(version_str: str) -> Tuple[int, int, int]:
|
||||
"""Parse semantic version string into (major, minor, patch)."""
|
||||
# Strip any extras like dev, post, rc
|
||||
cleaned = version_str.split('.')[0:3]
|
||||
# Pad to 3 parts
|
||||
while len(cleaned) < 3:
|
||||
cleaned.append('0')
|
||||
try:
|
||||
major = int(cleaned[0]) if cleaned[0].isdigit() else 0
|
||||
minor = int(cleaned[1]) if len(cleaned) > 1 and cleaned[1].isdigit() else 0
|
||||
patch = int(cleaned[2]) if len(cleaned) > 2 and cleaned[2].isdigit() else 0
|
||||
return (major, minor, patch)
|
||||
except (ValueError, IndexError):
|
||||
return (0, 0, 0)
|
||||
|
||||
|
||||
def classify_update(installed: str, latest: str) -> Optional[Dict]:
|
||||
"""Determine update type between installed and latest versions."""
|
||||
if not latest:
|
||||
return None
|
||||
|
||||
inst_ver = parse_version(installed)
|
||||
latest_ver = parse_version(latest)
|
||||
|
||||
if inst_ver == latest_ver:
|
||||
return None # Already up to date
|
||||
|
||||
# Calculate delta
|
||||
major_diff = latest_ver[0] - inst_ver[0]
|
||||
minor_diff = latest_ver[1] - inst_ver[1]
|
||||
patch_diff = latest_ver[2] - inst_ver[2]
|
||||
|
||||
# Determine update type
|
||||
if major_diff > 0:
|
||||
update_type = 'major'
|
||||
breaking = True
|
||||
severity = 'high'
|
||||
elif minor_diff > 0:
|
||||
update_type = 'minor'
|
||||
breaking = False
|
||||
severity = 'medium'
|
||||
elif patch_diff > 0:
|
||||
update_type = 'patch'
|
||||
breaking = False
|
||||
severity = 'low'
|
||||
else:
|
||||
# Shouldn't happen but handle weird cases
|
||||
return None
|
||||
|
||||
return {
|
||||
'package': None, # filled by caller
|
||||
'installed': installed,
|
||||
'latest': latest,
|
||||
'update_type': update_type,
|
||||
'breaking_change': breaking,
|
||||
'severity': severity,
|
||||
}
|
||||
|
||||
|
||||
def check_updates(packages: Dict[str, str] = None,
|
||||
filter_packages: List[str] = None) -> List[Dict]:
|
||||
"""
|
||||
Check all installed packages (or filtered subset) for updates.
|
||||
|
||||
Args:
|
||||
packages: Dict of {name: version}. If None, queries pip list.
|
||||
filter_packages: Optional list of package names to check only.
|
||||
|
||||
Returns:
|
||||
List of update report dicts sorted by severity.
|
||||
"""
|
||||
if packages is None:
|
||||
packages = get_installed_packages()
|
||||
|
||||
if filter_packages:
|
||||
packages = {k: v for k, v in packages.items()
|
||||
if k.lower() in [p.lower() for p in filter_packages]}
|
||||
|
||||
updates = []
|
||||
print(f"Checking {len(packages)} packages...", file=sys.stderr)
|
||||
|
||||
for pkg_name, installed_ver in packages.items():
|
||||
latest_ver = get_latest_version(pkg_name)
|
||||
if not latest_ver:
|
||||
continue
|
||||
|
||||
update_info = classify_update(installed_ver, latest_ver)
|
||||
if update_info:
|
||||
update_info['package'] = pkg_name
|
||||
updates.append(update_info)
|
||||
|
||||
# Sort: breaking first, then severity, then package name
|
||||
updates.sort(key=lambda u: (
|
||||
-1 if u['breaking_change'] else 0,
|
||||
{'high': 0, 'medium': 1, 'low': 2}[u['severity']],
|
||||
u['package']
|
||||
))
|
||||
|
||||
return updates
|
||||
|
||||
|
||||
def generate_text_report(updates: List[Dict]) -> str:
|
||||
"""Generate human-readable text report."""
|
||||
lines = []
|
||||
lines.append("=" * 60)
|
||||
lines.append("DEPENDENCY UPDATE REPORT")
|
||||
lines.append(f"Generated: {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}")
|
||||
lines.append("=" * 60)
|
||||
lines.append("")
|
||||
|
||||
if not updates:
|
||||
lines.append("✓ All packages are up to date.")
|
||||
return "\n".join(lines)
|
||||
|
||||
lines.append(f"Found {len(updates)} package(s) with available updates:")
|
||||
lines.append("")
|
||||
|
||||
for u in updates:
|
||||
breaking_marker = " ⚠ BREAKING CHANGE" if u['breaking_change'] else ""
|
||||
lines.append(f" {u['package']}:")
|
||||
lines.append(f" Installed: {u['installed']}")
|
||||
lines.append(f" Latest: {u['latest']}")
|
||||
lines.append(f" Update: {u['update_type'].upper()}{breaking_marker}")
|
||||
lines.append(f" Severity: {u['severity'].upper()}")
|
||||
lines.append("")
|
||||
|
||||
lines.append("=" * 60)
|
||||
lines.append("Recommendation: Review breaking changes carefully before upgrading.")
|
||||
lines.append("Consider pinning versions or using a virtual environment.")
|
||||
return "\n".join(lines)
|
||||
|
||||
|
||||
def generate_json_report(updates: List[Dict]) -> str:
|
||||
"""Generate JSON report compatible with machine consumption."""
|
||||
report = {
|
||||
'generated_at': datetime.now().isoformat(),
|
||||
'total_updates': len(updates),
|
||||
'updates': updates,
|
||||
'summary': {
|
||||
'major': sum(1 for u in updates if u['update_type'] == 'major'),
|
||||
'minor': sum(1 for u in updates if u['update_type'] == 'minor'),
|
||||
'patch': sum(1 for u in updates if u['update_type'] == 'patch'),
|
||||
'breaking': sum(1 for u in updates if u['breaking_change']),
|
||||
}
|
||||
}
|
||||
return json.dumps(report, indent=2)
|
||||
|
||||
|
||||
def main():
|
||||
parser = argparse.ArgumentParser(
|
||||
description="Check dependencies for available updates"
|
||||
)
|
||||
parser.add_argument(
|
||||
'--json', action='store_true',
|
||||
help='Output JSON report for machine consumption'
|
||||
)
|
||||
parser.add_argument(
|
||||
'--output', '-o', type=str,
|
||||
help='Write report to file instead of stdout'
|
||||
)
|
||||
parser.add_argument(
|
||||
'--package', '-p', type=str,
|
||||
help='Comma-separated list of specific packages to check'
|
||||
)
|
||||
args = parser.parse_args()
|
||||
|
||||
# Build filter list if provided
|
||||
filter_list = None
|
||||
if args.package:
|
||||
filter_list = [p.strip() for p in args.package.split(',') if p.strip()]
|
||||
|
||||
# Run checks
|
||||
updates = check_updates(filter_packages=filter_list)
|
||||
|
||||
# Generate report
|
||||
if args.json:
|
||||
report = generate_json_report(updates)
|
||||
else:
|
||||
report = generate_text_report(updates)
|
||||
|
||||
# Output
|
||||
if args.output:
|
||||
Path(args.output).write_text(report)
|
||||
print(f"Report written to {args.output}", file=sys.stderr)
|
||||
else:
|
||||
print(report)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
@@ -1,128 +0,0 @@
|
||||
"""Tests for docstring_generator module (Issue #96)."""
|
||||
|
||||
import ast
|
||||
import sys
|
||||
import tempfile
|
||||
from pathlib import Path
|
||||
|
||||
import pytest
|
||||
|
||||
sys.path.insert(0, str(Path(__file__).parent.parent / "scripts"))
|
||||
|
||||
from docstring_generator import (
|
||||
name_to_title,
|
||||
extract_body_hint,
|
||||
generate_docstring,
|
||||
process_source,
|
||||
iter_python_files,
|
||||
)
|
||||
|
||||
|
||||
class TestNameToTitle:
|
||||
def test_snake_to_title(self):
|
||||
assert name_to_title("validate_fact") == "Validate Fact"
|
||||
assert name_to_title("docstring_generator") == "Docstring Generator"
|
||||
assert name_to_title("main") == "Main"
|
||||
assert name_to_title("__init__") == "Init"
|
||||
|
||||
|
||||
class TestExtractBodyHint:
|
||||
def test_assignment_hint(self):
|
||||
body = [ast.parse("result = compute()").body[0]]
|
||||
hint = extract_body_hint(body)
|
||||
assert hint == "Compute or return compute()"
|
||||
|
||||
def test_return_hint(self):
|
||||
body = [ast.parse("return data").body[0]]
|
||||
hint = extract_body_hint(body)
|
||||
assert hint == "Return data"
|
||||
|
||||
def test_no_hint(self):
|
||||
body = [ast.parse("pass").body[0]]
|
||||
assert extract_body_hint(body) is None
|
||||
|
||||
|
||||
class TestGenerateDocstring:
|
||||
def test_simple_function(self):
|
||||
src = "def add(a, b):\n return a + b\n"
|
||||
tree = ast.parse(src)
|
||||
func = tree.body[0]
|
||||
doc = generate_docstring(func)
|
||||
assert 'Add' in doc
|
||||
assert 'a' in doc and 'b' in doc
|
||||
assert 'Args:' in doc
|
||||
assert 'Returns:' in doc
|
||||
|
||||
def test_typed_function(self):
|
||||
src = "def greet(name: str) -> str:\n return f'Hello {name}'\n"
|
||||
tree = ast.parse(src)
|
||||
func = tree.body[0]
|
||||
doc = generate_docstring(func)
|
||||
assert 'name (str)' in doc
|
||||
assert 'str' in doc
|
||||
|
||||
def test_async_function(self):
|
||||
src = "async def fetch():\n pass\n"
|
||||
tree = ast.parse(src)
|
||||
func = tree.body[0]
|
||||
doc = generate_docstring(func)
|
||||
assert 'Fetch' in doc
|
||||
|
||||
def test_self_skipped(self):
|
||||
src = "class C:\n def method(self, x):\n return x\n"
|
||||
tree = ast.parse(src)
|
||||
cls = tree.body[0]
|
||||
method = cls.body[0]
|
||||
doc = generate_docstring(method)
|
||||
# 'self' should not appear in Args section
|
||||
args_start = doc.find('Args:')
|
||||
if args_start >= 0:
|
||||
args_section = doc[args_start:]
|
||||
assert '(self)' not in args_section
|
||||
|
||||
|
||||
class TestProcessSource:
|
||||
def test_adds_docstrings(self):
|
||||
src = "def foo(x):\n return x * 2\n"
|
||||
new_src, funcs = process_source(src, "test.py")
|
||||
assert len(funcs) == 1 and funcs[0] == "foo"
|
||||
assert '"""' in new_src
|
||||
assert 'Foo' in new_src
|
||||
|
||||
def test_preserves_existing_docstrings(self):
|
||||
src = 'def bar():\n """Already documented."""\n return 1\n'
|
||||
new_src, funcs = process_source(src, "test.py")
|
||||
assert len(funcs) == 0
|
||||
assert new_src == src
|
||||
|
||||
def test_multiple_functions(self):
|
||||
src = "def a(): pass\ndef b(): pass\ndef c(): pass\n"
|
||||
new_src, funcs = process_source(src, "test.py")
|
||||
assert len(funcs) == 3
|
||||
assert '"""' in new_src
|
||||
|
||||
def test_dry_run_no_write(self, tmp_path):
|
||||
file = tmp_path / "t.py"
|
||||
file.write_text("def f(): pass\n")
|
||||
original_mtime = file.stat().st_mtime
|
||||
new_src, funcs = process_source(file.read_text(), str(file))
|
||||
assert funcs # detected
|
||||
# When caller handles write, dry-run leaves file unchanged
|
||||
current_mtime = file.stat().st_mtime
|
||||
assert current_mtime == original_mtime
|
||||
|
||||
|
||||
class TestIterPythonFiles:
|
||||
def test_single_file(self, tmp_path):
|
||||
f = tmp_path / "single.py"
|
||||
f.write_text("x = 1")
|
||||
files = iter_python_files([str(f)])
|
||||
assert len(files) == 1
|
||||
assert files[0].name == "single.py"
|
||||
|
||||
def test_directory_recursion(self, tmp_path):
|
||||
(tmp_path / "sub").mkdir()
|
||||
(tmp_path / "sub" / "a.py").write_text("a=1")
|
||||
(tmp_path / "b.py").write_text("b=2")
|
||||
files = iter_python_files([str(tmp_path)])
|
||||
assert len(files) == 2
|
||||
212
tests/test_update_checker.py
Normal file
212
tests/test_update_checker.py
Normal file
@@ -0,0 +1,212 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Tests for update_checker.py — 5.3: Update Checker
|
||||
|
||||
Acceptance criteria verified:
|
||||
✓ Compares installed vs latest
|
||||
✓ Reports major/minor/patch updates
|
||||
✓ Flags breaking changes (major)
|
||||
✓ Output: update report
|
||||
"""
|
||||
|
||||
import json
|
||||
import os
|
||||
import subprocess
|
||||
import sys
|
||||
import tempfile
|
||||
from datetime import datetime
|
||||
from pathlib import Path
|
||||
from unittest.mock import patch, MagicMock
|
||||
|
||||
# Add scripts dir to path
|
||||
sys.path.insert(0, os.path.join(os.path.dirname(__file__), "..", "scripts"))
|
||||
|
||||
import update_checker as uc
|
||||
|
||||
|
||||
def test_parse_version():
|
||||
assert uc.parse_version("1.2.3") == (1, 2, 3)
|
||||
assert uc.parse_version("2.0.0") == (2, 0, 0)
|
||||
assert uc.parse_version("0.9.0") == (0, 9, 0)
|
||||
assert uc.parse_version("1.2") == (1, 2, 0)
|
||||
assert uc.parse_version("1") == (1, 0, 0)
|
||||
assert uc.parse_version("invalid") == (0, 0, 0)
|
||||
print("PASS: parse_version")
|
||||
|
||||
|
||||
def test_classify_update_patch():
|
||||
result = uc.classify_update("1.2.3", "1.2.4")
|
||||
assert result is not None
|
||||
assert result['update_type'] == 'patch'
|
||||
assert result['breaking_change'] is False
|
||||
assert result['severity'] == 'low'
|
||||
print("PASS: classify_update_patch")
|
||||
|
||||
|
||||
def test_classify_update_minor():
|
||||
result = uc.classify_update("1.2.3", "1.3.0")
|
||||
assert result is not None
|
||||
assert result['update_type'] == 'minor'
|
||||
assert result['breaking_change'] is False
|
||||
assert result['severity'] == 'medium'
|
||||
print("PASS: classify_update_minor")
|
||||
|
||||
|
||||
def test_classify_update_major():
|
||||
result = uc.classify_update("1.2.3", "2.0.0")
|
||||
assert result is not None
|
||||
assert result['update_type'] == 'major'
|
||||
assert result['breaking_change'] is True
|
||||
assert result['severity'] == 'high'
|
||||
print("PASS: classify_update_major")
|
||||
|
||||
|
||||
def test_classify_update_no_change():
|
||||
result = uc.classify_update("1.2.3", "1.2.3")
|
||||
assert result is None
|
||||
print("PASS: classify_update_no_change")
|
||||
|
||||
|
||||
def test_classify_update_multiple_major():
|
||||
result = uc.classify_update("1.0.0", "3.0.0")
|
||||
assert result is not None
|
||||
assert result['update_type'] == 'major'
|
||||
assert result['breaking_change'] is True
|
||||
print("PASS: classify_update_multiple_major")
|
||||
|
||||
|
||||
def test_text_report_format():
|
||||
updates = [{
|
||||
'package': 'requests',
|
||||
'installed': '2.28.0',
|
||||
'latest': '2.31.0',
|
||||
'update_type': 'minor',
|
||||
'breaking_change': False,
|
||||
'severity': 'medium',
|
||||
}]
|
||||
report = uc.generate_text_report(updates)
|
||||
assert 'DEPENDENCY UPDATE REPORT' in report
|
||||
assert 'requests' in report
|
||||
assert '2.28.0' in report
|
||||
assert '2.31.0' in report
|
||||
assert 'MINOR' in report
|
||||
assert 'MEDIUM' in report
|
||||
print("PASS: text_report_format")
|
||||
|
||||
|
||||
def test_text_report_shows_breaking():
|
||||
updates = [{
|
||||
'package': 'flask',
|
||||
'installed': '2.0.0',
|
||||
'latest': '3.0.0',
|
||||
'update_type': 'major',
|
||||
'breaking_change': True,
|
||||
'severity': 'high',
|
||||
}]
|
||||
report = uc.generate_text_report(updates)
|
||||
assert 'BREAKING CHANGE' in report.upper() or '⚠' in report
|
||||
print("PASS: text_report_shows_breaking")
|
||||
|
||||
|
||||
def test_json_report_structure():
|
||||
updates = [
|
||||
{
|
||||
'package': 'pytest',
|
||||
'installed': '8.0.0',
|
||||
'latest': '8.2.0',
|
||||
'update_type': 'minor',
|
||||
'breaking_change': False,
|
||||
'severity': 'medium',
|
||||
},
|
||||
{
|
||||
'package': 'flask',
|
||||
'installed': '2.0.0',
|
||||
'latest': '3.0.0',
|
||||
'update_type': 'major',
|
||||
'breaking_change': True,
|
||||
'severity': 'high',
|
||||
}
|
||||
]
|
||||
report_json = uc.generate_json_report(updates)
|
||||
data = json.loads(report_json)
|
||||
assert 'generated_at' in data
|
||||
assert data['total_updates'] == 2
|
||||
assert 'summary' in data
|
||||
assert data['summary']['major'] == 1
|
||||
assert data['summary']['minor'] == 1
|
||||
assert data['summary']['breaking'] == 1
|
||||
print("PASS: json_report_structure")
|
||||
|
||||
|
||||
def test_no_updates_report():
|
||||
report = uc.generate_text_report([])
|
||||
assert 'up to date' in report.lower() or 'all packages' in report.lower()
|
||||
print("PASS: no_updates_report")
|
||||
|
||||
|
||||
def test_end_to_end_integration():
|
||||
"""End-to-end: check_updates with mocked data produces valid report."""
|
||||
fake_installed = {
|
||||
"test-pkg-old": "1.0.0",
|
||||
"another-pkg": "2.5.3",
|
||||
}
|
||||
|
||||
def fake_get_latest(pkg):
|
||||
if pkg == "test-pkg-old":
|
||||
return "1.2.4"
|
||||
elif pkg == "another-pkg":
|
||||
return "3.0.0"
|
||||
return None
|
||||
|
||||
with patch('update_checker.get_installed_packages', return_value=fake_installed):
|
||||
with patch('update_checker.get_latest_version', side_effect=fake_get_latest):
|
||||
updates = uc.check_updates()
|
||||
|
||||
assert len(updates) == 2
|
||||
|
||||
test_pkg = next(u for u in updates if u['package'] == 'test-pkg-old')
|
||||
assert test_pkg['update_type'] == 'minor'
|
||||
assert test_pkg['breaking_change'] is False
|
||||
|
||||
another = next(u for u in updates if u['package'] == 'another-pkg')
|
||||
assert another['update_type'] == 'major'
|
||||
assert another['breaking_change'] is True
|
||||
|
||||
report = uc.generate_text_report(updates)
|
||||
assert 'DEPENDENCY UPDATE REPORT' in report
|
||||
assert 'MINOR' in report
|
||||
assert 'BREAKING CHANGE' in report.upper()
|
||||
|
||||
print(f"PASS: end_to_end_integration ({len(updates)} updates)")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
passed = 0
|
||||
failed = 0
|
||||
tests = [
|
||||
test_parse_version,
|
||||
test_classify_update_patch,
|
||||
test_classify_update_minor,
|
||||
test_classify_update_major,
|
||||
test_classify_update_no_change,
|
||||
test_classify_update_multiple_major,
|
||||
test_text_report_format,
|
||||
test_text_report_shows_breaking,
|
||||
test_json_report_structure,
|
||||
test_no_updates_report,
|
||||
test_end_to_end_integration,
|
||||
]
|
||||
for test_func in tests:
|
||||
try:
|
||||
test_func()
|
||||
passed += 1
|
||||
except AssertionError as e:
|
||||
print(f"FAIL: {test_func.__name__} — {e}")
|
||||
failed += 1
|
||||
except Exception as e:
|
||||
print(f"ERROR: {test_func.__name__} — {e}")
|
||||
import traceback
|
||||
traceback.print_exc()
|
||||
failed += 1
|
||||
print(f"\n{passed} passed, {failed} failed")
|
||||
sys.exit(0 if failed == 0 else 1)
|
||||
Reference in New Issue
Block a user