python-log-redactor 0.1.0

Lightweight sensitive data redaction for accidental printing of sensitive Python strings, dicts, and logs.

log-redactor

Small, dependency-free redaction helpers for Python logs and payloads.
log-redactor helps prevent accidental exposure of secrets in log messages, strings, and nested dictionaries.

Why use it?

• Redacts by key name and regex pattern value matching
• Supports nested dict / list / tuple structures
• Works with standard library logging and %s-style args
• Keeps runtime dependencies at zero (stdlib only)

Installation

pip install python-log-redactor

Quick start

import logging
from log_redactor import RedactingFilter, redact, redact_dict

logger = logging.getLogger("app")
logger.setLevel(logging.INFO)
logger.addFilter(RedactingFilter(patterns=["email", "jwt", "api_key"]))

logger.info("User %s used key %s", "[e-mail]", "sk-live-abc123")

print(redact("Contact: [e-mail]"))

payload = {
    "username": "alice",
    "password": "super-secret",
    "profile": {"email": "[e-mail]"},
}
print(redact_dict(payload))

API

from log_redactor import RedactingFilter, redact, redact_dict

• redact(text: str, patterns=None, custom_patterns=None, replacement="[REDACTED]") -> str
• redact_dict(data: dict, keys=None, patterns=None, custom_patterns=None, replacement="[REDACTED]") -> dict
• RedactingFilter(logging.Filter)

Built-in patterns

• email
• ipv4
• jwt
• bearer_token
• api_key
• url_token
• credit_card_basic

Built-in sensitive keys

• password
• passwd
• secret
• token
• access_token
• refresh_token
• api_key
• authorization

Development

python3 -m venv .venv
. .venv/bin/activate
pip install -e . pytest ruff
pytest
ruff check .

Security note

This package is intended to reduce accidental leakage, not guarantee perfect anonymization. Always validate your own threat model and pattern coverage for production systems.

License

MIT