disarm 0.11.0

Unicode canonicalization and TR39 visual confusable analysis: building blocks for text-security pipelines (homoglyph/bidi/zalgo handling) plus standards-based phonetic transliteration
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
101
102
103
104
105
106
107
108
109
110
111
112
113

//! PyO3 shims for `crate::presets` (Layer-1) — the precompiled-pipeline presets.
//!
//! Each shim is a thin wrapper over a Layer-1 preset core. The cores compose
//! other modules' transforms and live in `src/presets.rs` (pyo3-free,
//! `pub(crate)`); these shims validate at the boundary and convert the native
//! `ErrorRepr` to a Python exception via `?`. See #38.

use pyo3::prelude::*;

/// Security-focused text canonicalization.
///
/// Pipeline: NFKC → strip bidi/format → strip invisible classes (#413) →
/// strip_control → strip_zero_width → collapse_whitespace → cap combining marks
/// (anti-zalgo, #429) → NFC → confusables → NFC (confusables sandwiched between
/// NFC passes for idempotency, #416).
#[pyfunction]
#[pyo3(signature = (text,))]
pub fn _canonicalize(text: &str) -> PyResult<String> {
    Ok(crate::presets::canonicalize(text)?.into_owned())
}

/// ML/NLP text normalization pipeline.
///
/// Pipeline: NFKC → emoji→text → transliterate → strip_accents → fold_case →
/// collapse_whitespace.
#[pyfunction]
#[pyo3(signature = (text, *, lang=None, emoji_style="cldr"))]
pub fn _ml_normalize(text: &str, lang: Option<&str>, emoji_style: &str) -> PyResult<String> {
    Ok(crate::presets::ml_normalize(text, lang, emoji_style)?.into_owned())
}

/// Library catalog key generation pipeline.
#[pyfunction]
#[pyo3(signature = (text, *, lang=None, strict_iso9=false))]
pub fn _catalog_key(text: &str, lang: Option<&str>, strict_iso9: bool) -> PyResult<String> {
    Ok(crate::presets::catalog_key(text, lang, strict_iso9)?.into_owned())
}

/// Search index key generation pipeline.
#[pyfunction]
#[pyo3(signature = (text, *, lang=None))]
pub fn _search_key(text: &str, lang: Option<&str>) -> PyResult<String> {
    Ok(crate::presets::search_key(text, lang)?.into_owned())
}

/// Sort key generation pipeline.
#[pyfunction]
#[pyo3(signature = (text, *, lang=None))]
pub fn _sort_key(text: &str, lang: Option<&str>) -> PyResult<String> {
    Ok(crate::presets::sort_key(text, lang)?.into_owned())
}

/// Strip bidi/format and invisible-injection vectors from rendered content.
///
/// Infallible: strip bidi/format → strip invisibles → collapse_whitespace.
#[pyfunction]
#[pyo3(signature = (text,))]
pub fn _strip_format(text: &str) -> String {
    crate::presets::strip_format(text).into_owned()
}

/// Strip bidirectional override and formatting characters (UAX #9).
///
/// Removes: soft hyphen (U+00AD), Arabic Letter Mark (U+061C),
/// LRM/RLM (U+200E/F), bidi embeddings/overrides (U+202A–U+202E),
/// bidi isolates (U+2066–U+2069). Infallible.
#[pyfunction]
#[pyo3(signature = (text,))]
pub fn _strip_bidi(text: &str) -> String {
    crate::presets::strip_bidi(text)
}

/// `strip_tags(text) -> str` (#413), preserving valid emoji flag sequences.
#[pyfunction]
#[pyo3(signature = (text,))]
pub fn _strip_tags(text: &str) -> String {
    crate::api::strip_tags(text)
}

/// `strip_variation_selectors(text) -> str` (#413).
#[pyfunction]
#[pyo3(signature = (text,))]
pub fn _strip_variation_selectors(text: &str) -> String {
    crate::api::strip_variation_selectors(text)
}

/// `strip_noncharacters(text) -> str` (#413).
#[pyfunction]
#[pyo3(signature = (text,))]
pub fn _strip_noncharacters(text: &str) -> String {
    crate::api::strip_noncharacters(text)
}

/// `strip_pua(text) -> str` (#413).
#[pyfunction]
#[pyo3(signature = (text,))]
pub fn _strip_pua(text: &str) -> String {
    crate::api::strip_pua(text)
}

/// Strict canonicalization of user input — Unicode hygiene, **not** a sanitizer.
#[pyfunction]
#[pyo3(signature = (text,))]
pub fn _canonicalize_strict(text: &str) -> PyResult<String> {
    Ok(crate::presets::canonicalize_strict(text)?.into_owned())
}

/// Maximum-strength text deobfuscation pipeline.
#[pyfunction]
#[pyo3(signature = (text,))]
pub fn _strip_obfuscation(text: &str) -> PyResult<String> {
    Ok(crate::presets::strip_obfuscation(text)?.into_owned())
}