One Checker Guide
passing_checker = OneChecker("PassingExample")
@app.post("/check-unique", response_model=CheckResponse) async def check_uniqueness(request: CheckRequest): """API endpoint to check if a field is unique across all items""" seen = set() duplicates = []
def clean_check(): return passing_checker.check_unique_primary_key(clean_data, 'id') one checker
def generate_report(self) -> str: """Generate a formatted report of all check results""" if not self.results: return "No checks have been run yet." summary = { CheckerResult.PASS: 0, CheckerResult.FAIL: 0, CheckerResult.WARNING: 0, CheckerResult.ERROR: 0 } report_lines = [f"\n{'='*60}", f"One Checker Report: {self.name}", f"{'='*60}\n"] for result in self.results: summary[result.result] += 1 status_icon = { CheckerResult.PASS: "✓", CheckerResult.FAIL: "✗", CheckerResult.WARNING: "⚠", CheckerResult.ERROR: "!" }.get(result.result, "?") report_lines.append(f"{status_icon} [{result.result.value.upper()}] {result.check_name}") report_lines.append(f" {result.message}") if result.details: report_lines.append(f" Details: {json.dumps(result.details, indent=2)}") report_lines.append("") report_lines.append(f"{'='*60}") report_lines.append(f"Summary: {summary[CheckerResult.PASS]} passed, " f"{summary[CheckerResult.FAIL]} failed, " f"{summary[CheckerResult.WARNING]} warnings, " f"{summary[CheckerResult.ERROR]} errors") return "\n".join(report_lines) if name == " main ": # Create a OneChecker instance checker = OneChecker("DataConsistencyChecker")
class OneChecker: """ A feature that verifies if a system maintains "one" of something: - One source of truth - One active configuration - One unique identifier - One consistent state """ passing_checker = OneChecker("PassingExample")
@app
def run_all_checks(self) -> List[OneCheckReport]: """Execute all registered checks""" self.results = [] # Built-in checks that can be customized via registration for name, check_func in self.checks: result = check_func() self.results.append(result) return self.results
def __init__(self, name: str = "SystemOneChecker"): self.name = name self.checks: List[Callable] = [] self.results: List[OneCheckReport] = [] 'id')
def generate_report(self) ->
Here's a practical implementation of a feature: