splurge-safe-io 2025.1.1

A safe, atomic, and cross-platform way to handle text file I/O in Python.

splurge-safe-io

A small, secure, and deterministic text file I/O helper library.

Key features

• Deterministic newline normalization (LF) for text reads/writes.
• Secure path validation utilities to avoid traversal and dangerous characters.
• Streaming reader with incremental decoding and a safe fallback for tricky encodings.
• Clear, small exception hierarchy for stable error handling.

Quick start

from splurge_safe_io.safe_text_file_reader import SafeTextFileReader
from splurge_safe_io.safe_text_file_writer import open_safe_text_writer

# Read lines
reader = SafeTextFileReader('data.csv')
rows = reader.readlines()

# Write via context manager
with open_safe_text_writer('out.txt') as buf:
    buf.write('\n'.join(['one','two','three']))

⚠️ BREAKING CHANGE for v2025.1.0: SafeTextFileReader.read() now returns a str containing the entire normalized file content instead of a list[str] of lines. Use SafeTextFileReader.readlines() to get a list of lines.

See docs/README-DETAILS.md for a complete guide and usage examples.