Compare commits
1 Commits
step35/96-
...
step35/113
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
74aa9f8151 |
@@ -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())
|
||||
249
scripts/security_patch_applier.py
Normal file
249
scripts/security_patch_applier.py
Normal file
@@ -0,0 +1,249 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Security Patch Applier — 5.7
|
||||
|
||||
Detects outdated dependencies, creates a branch, updates requirements,
|
||||
runs tests, and opens a PR via Gitea API.
|
||||
|
||||
Usage:
|
||||
python3 scripts/security_patch_applier.py
|
||||
python3 scripts/security_patch_applier.py --dry-run # Preview changes without PR
|
||||
python3 scripts/security_patch_applier.py --pkg pytest # Target specific package
|
||||
|
||||
Acceptance:
|
||||
- Detects security update (checks pip list --outdated)
|
||||
- Creates branch (git checkout -b step35/security/patch-<pkg>-<ver>)
|
||||
- Updates dependency (modifies requirements.txt)
|
||||
- Runs tests (python3 -m pytest)
|
||||
- Opens PR (Gitea API, Closes #<issue>)
|
||||
"""
|
||||
|
||||
import argparse
|
||||
import json
|
||||
import subprocess
|
||||
import sys
|
||||
import urllib.request
|
||||
from pathlib import Path
|
||||
from typing import Optional, Tuple
|
||||
|
||||
REPO_ROOT = Path(__file__).resolve().parent.parent
|
||||
REQUIREMENTS_PATH = REPO_ROOT / "requirements.txt"
|
||||
GITEA_TOKEN_PATH = Path.home() / ".config" / "gitea" / "token"
|
||||
GITEA_API_BASE = "https://forge.alexanderwhitestone.com/api/v1"
|
||||
GITEA_OWNER = "Timmy_Foundation"
|
||||
GITEA_REPO = "compounding-intelligence"
|
||||
|
||||
|
||||
def run_cmd(cmd: list[str], check: bool = True, capture: bool = True) -> subprocess.CompletedProcess:
|
||||
"""Run a subprocess, return result."""
|
||||
result = subprocess.run(
|
||||
cmd,
|
||||
cwd=REPO_ROOT,
|
||||
capture_output=capture,
|
||||
text=True
|
||||
)
|
||||
if check and result.returncode != 0:
|
||||
print(f"ERROR: {' '.join(cmd)} failed with code {result.returncode}")
|
||||
print(result.stderr)
|
||||
sys.exit(result.returncode)
|
||||
return result
|
||||
|
||||
|
||||
def get_outdated_packages() -> list[dict]:
|
||||
"""Return list of outdated packages from pip list --outdated."""
|
||||
result = run_cmd([sys.executable, "-m", "pip", "list", "--outdated", "--format=json"])
|
||||
outdated = json.loads(result.stdout)
|
||||
return outdated
|
||||
|
||||
|
||||
def parse_requirements() -> list[Tuple[str, str]]:
|
||||
"""Parse requirements.txt into list of (raw_line, package_name_lower)."""
|
||||
if not REQUIREMENTS_PATH.exists():
|
||||
print(f"ERROR: requirements.txt not found at {REQUIREMENTS_PATH}")
|
||||
sys.exit(1)
|
||||
|
||||
lines = REQUIREMENTS_PATH.read_text().splitlines()
|
||||
parsed = []
|
||||
for line in lines:
|
||||
stripped = line.strip()
|
||||
if not stripped or stripped.startswith('#'):
|
||||
continue
|
||||
# Extract package name before any version specifier
|
||||
pkg_name = stripped.split()[0].split('>=')[0].split('==')[0].split('~=')[0].split('<')[0].split('>')[0].lower()
|
||||
parsed.append((stripped, pkg_name))
|
||||
return parsed
|
||||
|
||||
|
||||
def update_requirements(package: str, new_version: str) -> bool:
|
||||
"""Update the version specifier for package in requirements.txt. Return True if changed."""
|
||||
lines = REQUIREMENTS_PATH.read_text().splitlines()
|
||||
updated = False
|
||||
new_lines = []
|
||||
for line in lines:
|
||||
stripped = line.strip()
|
||||
if not stripped or stripped.startswith('#'):
|
||||
new_lines.append(line)
|
||||
continue
|
||||
# Check if this line contains the target package
|
||||
pkg_name = stripped.split()[0].split('>=')[0].split('==')[0].split('~=')[0].split('<')[0].split('>')[0].lower()
|
||||
if pkg_name == package.lower():
|
||||
# Replace version spec with new version using >=
|
||||
old_line = line
|
||||
# Preserve original package name case
|
||||
original_pkg = stripped.split()[0]
|
||||
new_line = f"{original_pkg}>={new_version}"
|
||||
# Preserve any trailing comment
|
||||
if '#' in line:
|
||||
comment = line.split('#', 1)[1]
|
||||
new_line += f" #{comment}"
|
||||
new_lines.append(new_line)
|
||||
updated = True
|
||||
else:
|
||||
new_lines.append(line)
|
||||
if updated:
|
||||
REQUIREMENTS_PATH.write_text('\n'.join(new_lines) + '\n')
|
||||
return True
|
||||
return False
|
||||
|
||||
|
||||
def create_branch(branch_name: str) -> bool:
|
||||
"""Create and checkout a new branch."""
|
||||
# Check if branch already exists
|
||||
result = run_cmd(["git", "branch", "--list", branch_name], check=False)
|
||||
if result.stdout.strip():
|
||||
print(f"Branch {branch_name} already exists.")
|
||||
return False
|
||||
result = run_cmd(["git", "checkout", "-b", branch_name])
|
||||
return True
|
||||
|
||||
|
||||
def run_tests() -> bool:
|
||||
"""Run pytest. Return True if all pass."""
|
||||
print("\nRunning tests...")
|
||||
result = run_cmd([sys.executable, "-m", "pytest", "tests/test_ci_config.py", "scripts/test_*.py", "-v"], check=False)
|
||||
return result.returncode == 0
|
||||
|
||||
|
||||
def get_gitea_token() -> str:
|
||||
"""Read Gitea token from file."""
|
||||
if not GITEA_TOKEN_PATH.exists():
|
||||
print(f"ERROR: Gitea token not found at {GITEA_TOKEN_PATH}")
|
||||
sys.exit(1)
|
||||
return GITEA_TOKEN_PATH.read_text().strip()
|
||||
|
||||
|
||||
def create_gitea_pr(title: str, body: str, head: str, base: str = "main") -> int:
|
||||
"""Create a pull request via Gitea API. Return PR number."""
|
||||
token = get_gitea_token()
|
||||
payload = json.dumps({
|
||||
"title": title,
|
||||
"body": body,
|
||||
"head": head,
|
||||
"base": base
|
||||
}).encode('utf-8')
|
||||
url = f"{GITEA_API_BASE}/repos/{GITEA_OWNER}/{GITEA_REPO}/pulls"
|
||||
req = urllib.request.Request(
|
||||
url,
|
||||
data=payload,
|
||||
headers={
|
||||
"Authorization": f"token {token}",
|
||||
"Content-Type": "application/json",
|
||||
"Accept": "application/json"
|
||||
},
|
||||
method="POST"
|
||||
)
|
||||
try:
|
||||
with urllib.request.urlopen(req, timeout=15) as resp:
|
||||
data = json.loads(resp.read())
|
||||
return data["number"]
|
||||
except urllib.error.HTTPError as e:
|
||||
body = e.read().decode('utf-8')
|
||||
print(f"ERROR: Gitea API returned {e.code}: {body}")
|
||||
sys.exit(1)
|
||||
|
||||
|
||||
def main():
|
||||
parser = argparse.ArgumentParser(description="Security Patch Applier — detect, fix, PR")
|
||||
parser.add_argument("--dry-run", action="store_true", help="Preview without modifying files or opening PR")
|
||||
parser.add_argument("--pkg", help="Target specific package (skip detection)")
|
||||
parser.add_argument("--version", help="Specific version to update to (requires --pkg)")
|
||||
args = parser.parse_args()
|
||||
|
||||
# Step 1: Detect outdated packages (security patches)
|
||||
if args.pkg:
|
||||
# Manual mode
|
||||
if not args.version:
|
||||
print("ERROR: --version required when using --pkg")
|
||||
sys.exit(1)
|
||||
outdated = [{"name": args.pkg, "latest_version": args.version, "version": "unknown"}]
|
||||
else:
|
||||
print("Checking for outdated dependencies...")
|
||||
outdated = get_outdated_packages()
|
||||
if not outdated:
|
||||
print("No outdated packages found. System is up-to-date.")
|
||||
sys.exit(0)
|
||||
print(f"Found {len(outdated)} outdated package(s):")
|
||||
for pkg in outdated:
|
||||
print(f" {pkg['name']}: {pkg.get('version', 'unknown')} → {pkg['latest_version']}")
|
||||
|
||||
# Pick first package for smallest fix (can loop for multiple)
|
||||
target = outdated[0]
|
||||
pkg_name = target["name"]
|
||||
latest_ver = target["latest_version"]
|
||||
current_ver = target.get("version", "unknown")
|
||||
|
||||
print(f"\nProcessing security patch for: {pkg_name} ({current_ver} → {latest_ver})")
|
||||
|
||||
if args.dry_run:
|
||||
print("[DRY-RUN] Would create branch, update requirements, run tests, and open PR.")
|
||||
sys.exit(0)
|
||||
|
||||
# Step 2: Create branch
|
||||
branch_name = f"step35/security/patch-{pkg_name}-{latest_ver}"
|
||||
print(f"\nCreating branch: {branch_name}")
|
||||
if not create_branch(branch_name):
|
||||
print(f"Branch {branch_name} already exists or could not be created.")
|
||||
# Continue anyway? Let's exit
|
||||
sys.exit(1)
|
||||
|
||||
# Step 3: Update requirements.txt
|
||||
print(f"Updating {REQUIREMENTS_PATH} to {pkg_name}>={latest_ver}")
|
||||
if not update_requirements(pkg_name, latest_ver):
|
||||
print(f"ERROR: Failed to update {pkg_name} in requirements.txt")
|
||||
sys.exit(1)
|
||||
print(f"Updated requirements.txt")
|
||||
|
||||
# Step 4: Run tests
|
||||
if not run_tests():
|
||||
print("ERROR: Tests failed. Aborting PR creation.")
|
||||
# Could revert branch? For minimal fix, just exit with error
|
||||
sys.exit(1)
|
||||
print("Tests passed.")
|
||||
|
||||
# Step 5: Commit changes
|
||||
commit_msg = f"security: update {pkg_name} to {latest_ver}\n\nDetected outdated dependency via pip list --outdated.\n\nRefs: #113"
|
||||
run_cmd(["git", "add", "requirements.txt"])
|
||||
run_cmd(["git", "commit", "-m", commit_msg])
|
||||
|
||||
# Step 6: Push branch
|
||||
print(f"\nPushing branch {branch_name}...")
|
||||
result = run_cmd(["git", "push", "origin", branch_name], check=False)
|
||||
if result.returncode != 0:
|
||||
print(f"ERROR: Push failed: {result.stderr}")
|
||||
sys.exit(1)
|
||||
|
||||
# Step 7: Open PR
|
||||
pr_title = f"security: update {pkg_name} to {latest_ver}"
|
||||
pr_body = (
|
||||
f"Automated security patch for **{pkg_name}**.\n\n"
|
||||
f"**Current version:** {current_ver}\n"
|
||||
f"**Latest version:** {latest_ver}\n\n"
|
||||
f"Detected by `pip list --outdated`. Tests passed locally.\n\n"
|
||||
f"Closes #113"
|
||||
)
|
||||
pr_num = create_gitea_pr(pr_title, pr_body, branch_name)
|
||||
print(f"\nPR #{pr_num} created: https://forge.alexanderwhitestone.com/{GITEA_OWNER}/{GITEA_REPO}/pulls/{pr_num}")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
21
scripts/test_security_patch_applier.py
Normal file
21
scripts/test_security_patch_applier.py
Normal file
@@ -0,0 +1,21 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Smoke test for security_patch_applier — verifies module imports and argument parsing."""
|
||||
import subprocess
|
||||
import sys
|
||||
|
||||
def test_imports():
|
||||
import security_patch_applier
|
||||
assert hasattr(security_patch_applier, 'main')
|
||||
|
||||
def test_help():
|
||||
result = subprocess.run(
|
||||
[sys.executable, 'scripts/security_patch_applier.py', '--help'],
|
||||
capture_output=True, text=True
|
||||
)
|
||||
assert result.returncode == 0
|
||||
assert 'Security Patch Applier' in result.stdout or '--dry-run' in result.stdout
|
||||
|
||||
if __name__ == '__main__':
|
||||
test_imports()
|
||||
test_help()
|
||||
print("OK")
|
||||
@@ -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
|
||||
Reference in New Issue
Block a user