zerum 0.1.0

Deterministic-first Python code governance: native checks (ZR001–ZR010), CLI, and SARIF/JSON reporters
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

use crate::config::Config;
use crate::core::{CheckContext, CheckRegistry, Issue};
use crate::parser::{PythonParser, RustPythonParser};
use anyhow::{Context, Result};
use std::path::{Path, PathBuf};

pub struct DeterministicAnalyzer {
    registry: CheckRegistry,
    parser: RustPythonParser,
}

#[derive(Debug, Default)]
pub struct AnalyzeResult {
    pub issues: Vec<Issue>,
    pub file_errors: Vec<FileError>,
}

#[derive(Debug, Clone)]
pub struct FileError {
    pub path: PathBuf,
    pub message: String,
}

impl Default for DeterministicAnalyzer {
    fn default() -> Self {
        Self::new()
    }
}

impl DeterministicAnalyzer {
    pub fn new() -> Self {
        Self {
            registry: CheckRegistry::new(),
            parser: RustPythonParser,
        }
    }

    pub fn registry(&self) -> &CheckRegistry {
        &self.registry
    }

    pub fn analyze_file(&self, path: &Path, config: &Config) -> Result<Vec<Issue>> {
        let source = std::fs::read_to_string(path)
            .with_context(|| format!("read {}", path.display()))?;
        let parsed = self
            .parser
            .parse_file(&source, path)
            .with_context(|| format!("parse {}", path.display()))?;
        let ctx = CheckContext {
            path,
            source: &source,
            parsed: &parsed,
            config,
        };
        let mut issues = Vec::new();
        for check in self.registry.iter() {
            if config.is_check_enabled(check.id()) {
                issues.extend(check.run(&ctx));
            }
        }
        issues.sort_by(|a, b| {
            (
                &a.file,
                a.line,
                a.column,
                &a.id,
                &a.message,
            )
                .cmp(&(&b.file, b.line, b.column, &b.id, &b.message))
        });
        Ok(issues)
    }

    pub fn analyze_paths(&self, paths: &[PathBuf], config: &Config) -> AnalyzeResult {
        let mut result = AnalyzeResult::default();
        for path in paths {
            match self.analyze_file(path, config) {
                Ok(mut issues) => result.issues.append(&mut issues),
                Err(err) => {
                    eprintln!("warning: {err:#}");
                    result.file_errors.push(FileError {
                        path: path.clone(),
                        message: format!("{err:#}"),
                    });
                }
            }
        }
        result.issues.sort_by(|a, b| {
            (
                &a.file,
                a.line,
                a.column,
                &a.id,
                &a.message,
            )
                .cmp(&(&b.file, b.line, b.column, &b.id, &b.message))
        });
        result
    }
}