Skip to main content

pii-shield-wasi

PII redaction scanner powered by the core Go engine compiled to WebAssembly (WASI). It runs in-process — no network hop — using hybrid heuristic and entropy-based detection.

Installation

pip install pii-shield-wasi

Usage

from pii_shield import PiiShield, PiiShieldConfig

# Initialize the scanner with optional configuration overrides
shield = PiiShield(PiiShieldConfig(
    entropy_threshold=4.0,
    confidence_score=0.8
))

text = "Connecting to DB with password: MySuperSecretPassword123!"
redacted_text = shield.redact(text)

print(redacted_text)
# Output might redact the high entropy secret based on context

Configuration

PiiShieldConfig accepts these overrides. Any field left unset keeps the core scanner default, so redaction matches the CLI for the same config.

Option Type Description
entropy_threshold float Shannon entropy cut-off for candidate tokens.
confidence_score float Hybrid-validation confidence threshold.
salt str HMAC salt for deterministic [HIDDEN:xxxxxx] tokens. Set it to correlate across processes.
min_secret_length int Minimum candidate token length before entropy checks apply.
sensitive_keys list[str] Key names whose values are always redacted (case-insensitive). Replaces the defaults.
disable_bigram_check bool Disable English bigram analysis (useful for non-English logs).
adaptive_threshold bool Enable the experimental statistical adaptive-threshold mode.
entity_type_labels bool Emit [HIDDEN:<type>:<hash>] markers, where <type> names the detector that fired (card, key, context, url, regex, entropy). Off by default; the hash is unchanged.
sensitive_key_patterns list[str] Regex patterns matched against key names (equivalent to PII_SENSITIVE_KEY_PATTERNS).
custom_regexes list[dict] Rules forcing redaction: [{"pattern": ..., "name": ...}] (equivalent to PII_CUSTOM_REGEX_LIST).
safe_regexes list[dict] Whitelist rules exempting matching tokens (equivalent to PII_SAFE_REGEX_LIST).
fail_policy "open" | "closed" On an internal error, open returns the input unchanged; closed returns a drop marker. Handled in this wrapper.

Invalid regex handling

The CLI fails fast on an invalid pattern at startup. The SDK deliberately does not: an invalid sensitive_key_patterns, custom_regexes, or safe_regexes entry is ignored and the default is kept, so a bad pattern can never terminate your Python process. Validate patterns before passing them if you need strictness.

Features

  • In-process: runs the Go WASM binary inside Python via Wasmtime — no network hop by construction.
  • Low-allocation hot path: the scan loop is optimized to reduce garbage-collection overhead during large log streaming.
  • Hybrid scoring: combines static whitelists, regex heuristics, and Shannon entropy, which helps avoid false positives on structured values like UUIDs and IPv6 addresses.

Metadata

Release files for pii-shield-wasi 2.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pii-shield-wasi 2.2.0
File Size Uploaded
pii_shield_wasi-2.2.0.tar.gz 1.2 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for pii-shield-wasi 2.2.0
File Interpreter ABI Platform
pii_shield_wasi-2.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 2.4 MB

Release files / pii_shield_wasi-2.2.0.tar.gz

Download URL pii_shield_wasi-2.2.0.tar.gz
Size 1.2 MB
Tags Source
SHA-256 checksum
How to use checksums
5896ab024d00461354980c2a142c5bbc8d57fed4a410ed784b8371cf3cf9a25b
BLAKE2b-256 checksum
How to use checksums
b7443ef2db8495cb7e5a98564d797ddbc9939db7cf2ce074b8ee9d27fe1e3de3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 18, 2026.

Transparency log

Release files / pii_shield_wasi-2.2.0-py3-none-any.whl

Download URL pii_shield_wasi-2.2.0-py3-none-any.whl
Size 1.2 MB
Tags Python 3
SHA-256 checksum
How to use checksums
bb93006e499c8cf1ee4a088e53c24c667100e8a0fd5437fb8146fd74254d5e49
BLAKE2b-256 checksum
How to use checksums
ed9c70ba531a1072369bd1851af6804867c75877ae09cbc9d784f52fae7ab616
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 18, 2026.

Transparency log

Release history Release notifications | RSS feed

2.2.7

2 release files

2.2.6

2 release files

2.2.5

2 release files

2.2.4

2 release files

2.2.3

2 release files

2.2.2

2 release files

2.2.1

2 release files

This release

2.2.0 This release

2 release files

2.1.1

2 release files

2.1.0

2 release files

2.0.5

2 release files

2.0.4

2 release files

2.0.3

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.4.2

2 release files

1.4.0

2 release files

1.3.9

2 release files

1.3.8

2 release files

1.3.7

2 release files

1.3.6

2 release files

1.3.5

2 release files

1.3.4

2 release files

1.3.3

2 release files

1.3.2

2 release files

1.3.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page