K-Dense-AI/scientific-agent-skills / skills/scientific-writing
scientific-writing
VerifiedDrafts, revises, and audits scientific manuscripts or reports with explicit evidence provenance, reporting-guideline coverage, authorship accountability, confidentiality controls, and local consistency checks. Use for manuscript sections, references, declarations, tables, figures, or submission preparation when scientific accuracy and traceability matter.
scripts/_common.py
View on GitHub"""Shared, dependency-free safety helpers for scientific-writing CLIs."""
from __future__ import annotations
import csv
import io
import json
import sys
from collections.abc import Iterable
from dataclasses import asdict, dataclass
from datetime import date
from pathlib import Path
from typing import Any
MAX_FILE_BYTES = 5_000_000
MAX_RECORDS = 10_000
MAX_JSON_NODES = 100_000
MAX_JSON_DEPTH = 50
MAX_CSV_FIELD_BYTES = 100_000
class InputError(ValueError):
"""Raised when a local input fails a bounded safety check."""
@dataclass(frozen=True)
class Issue:
severity: str
code: str
location: str | None = None
item_id: str | None = None
def to_dict(self) -> dict[str, str]:
return {key: value for key, value in asdict(self).items() if value is not None}
def _checked_file(path_value: str | Path, suffixes: Iterable[str]) -> Path:
path = Path(path_value)
allowed = {suffix.lower() for suffix in suffixes}
if path.is_symlink():
raise InputError("symbolic-link inputs are not accepted")
if not path.is_file():
raise InputError("input must be an existing regular file")
if path.suffix.lower() not in allowed:
raise InputError(
f"input extension must be one of: {', '.join(sorted(allowed))}"
)
if path.stat().st_size > MAX_FILE_BYTES:
raise InputError(f"input exceeds {MAX_FILE_BYTES} bytes")
return path
def read_text(path_value: str | Path, suffixes: Iterable[str]) -> str:
path = _checked_file(path_value, suffixes)
try:
return path.read_text(encoding="utf-8")
except UnicodeDecodeError as exc:
raise InputError("input must be UTF-8 text") from exc
def _reject_duplicate_keys(pairs: list[tuple[str, Any]]) -> dict[str, Any]:
result: dict[str, Any] = {}
for key, value in pairs:
if key in result:
raise InputError("JSON contains a duplicate object key")
result[key] = value
return result
def _reject_nonfinite_json(_value: str) -> None:
raise InputError("JSON non-finite numbers are not accepted")
def _check_json_bounds(value: Any, depth: int = 0) -> int:
if depth > MAX_JSON_DEPTH:
raise InputError(f"JSON nesting exceeds {MAX_JSON_DEPTH} levels")
count = 1
if isinstance(value, dict):
for child in value.values():
count += _check_json_bounds(child, depth + 1)
elif isinstance(value, list):
if len(value) > MAX_RECORDS:
raise InputError(f"JSON array exceeds {MAX_RECORDS} records")
for child in value:
count += _check_json_bounds(child, depth + 1)
if count > MAX_JSON_NODES:
raise InputError(f"JSON exceeds {MAX_JSON_NODES} nodes")
return count
def read_json(path_value: str | Path) -> Any:
text = read_text(path_value, {".json"})
try:
value = json.loads(
text,
object_pairs_hook=_reject_duplicate_keys,
parse_constant=_reject_nonfinite_json,
)
except (json.JSONDecodeError, RecursionError) as exc:
raise InputError("input is not valid bounded JSON") from exc
_check_json_bounds(value)
return value
def read_csv(path_value: str | Path) -> tuple[list[str], list[dict[str, str]]]:
text = read_text(path_value, {".csv"})
csv.field_size_limit(MAX_CSV_FIELD_BYTES)
try:
reader = csv.DictReader(io.StringIO(text, newline=""))
fields = list(reader.fieldnames or [])
if not fields or any(not field for field in fields):
raise InputError("CSV requires a non-empty header row")
if len(set(fields)) != len(fields):
raise InputError("CSV contains duplicate header names")
rows: list[dict[str, str]] = []
for index, row in enumerate(reader, start=1):
if index > MAX_RECORDS:
raise InputError(f"CSV exceeds {MAX_RECORDS} data rows")
if None in row:
raise InputError("CSV row has more fields than the header")
rows.append({key: value or "" for key, value in row.items()})
except csv.Error as exc:
raise InputError("input is not valid bounded CSV") from exc
return fields, rows
def issue(
severity: str,
code: str,
*,
location: str | None = None,
item_id: str | None = None,
) -> Issue:
if severity not in {"error", "warning", "info"}:
raise ValueError("unsupported issue severity")
return Issue(severity=severity, code=code, location=location, item_id=item_id)
def emit_report(
tool: str,
issues: Iterable[Issue],
*,
summary: dict[str, Any] | None = None,
) -> int:
ordered = sorted(
issues,
key=lambda item: (
{"error": 0, "warning": 1, "info": 2}[item.severity],
item.code,
item.location or "",
item.item_id or "",
),
)
error_count = sum(item.severity == "error" for item in ordered)
warning_count = sum(item.severity == "warning" for item in ordered)
payload = {
"tool": tool,
"status": "fail" if error_count else "pass",
"summary": {
"errors": error_count,
"warnings": warning_count,
**(summary or {}),
},
"issues": [item.to_dict() for item in ordered],
}
print(json.dumps(payload, indent=2, sort_keys=True))
return 1 if error_count else 0
def emit_input_error(tool: str, exc: Exception) -> int:
return emit_report(
tool,
[issue("error", "INVALID_INPUT", location=type(exc).__name__)],
)
def require_object(value: Any, label: str = "root") -> dict[str, Any]:
if not isinstance(value, dict):
raise InputError(f"{label} must be a JSON object")
return value
def require_list(value: Any, label: str) -> list[Any]:
if not isinstance(value, list):
raise InputError(f"{label} must be a JSON array")
if len(value) > MAX_RECORDS:
raise InputError(f"{label} exceeds {MAX_RECORDS} records")
return value
def is_nonempty_string(value: Any) -> bool:
return isinstance(value, str) and bool(value.strip())
def is_iso_date(value: Any) -> bool:
"""Accept an actual calendar date in the exact YYYY-MM-DD form."""
if not isinstance(value, str):
return False
try:
return date.fromisoformat(value).isoformat() == value
except ValueError:
return False
def is_placeholder(value: Any) -> bool:
if not isinstance(value, str):
return False
lowered = value.strip().lower()
return (
not lowered
or "[[todo" in lowered
or lowered in {"todo", "tbd", "tk", "replace_me", "unknown"}
)
def write_new_text(
path_value: str | Path, content: str, suffixes: Iterable[str]
) -> Path:
path = Path(path_value)
allowed = {suffix.lower() for suffix in suffixes}
if path.suffix.lower() not in allowed:
raise InputError(
f"output extension must be one of: {', '.join(sorted(allowed))}"
)
if path.exists() or path.is_symlink():
raise InputError("output already exists; refusing to overwrite")
parent = path.parent
if not parent.is_dir() or parent.is_symlink():
raise InputError("output parent must be an existing regular directory")
encoded = content.encode("utf-8")
if len(encoded) > MAX_FILE_BYTES:
raise InputError(f"output exceeds {MAX_FILE_BYTES} bytes")
with path.open("x", encoding="utf-8", newline="\n") as handle:
handle.write(content)
return path
def main_guard(tool: str, callback: Any) -> int:
try:
return int(callback())
except (InputError, OSError, ValueError) as exc:
return emit_input_error(tool, exc)
def run(tool: str, callback: Any) -> None:
raise SystemExit(main_guard(tool, callback))
if __name__ == "__main__":
print("This module is imported by the scientific-writing command-line tools.")
sys.exit(0)
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |