xixu-me/tzst

0 Fork 0

Files

T

xixu-me ef5d06cb0e Enhance documentation for tzst library

- Updated the introduction to provide a clearer overview of tzst's capabilities and features.
- Expanded the Key Features section with detailed descriptions and icons for better readability.
- Improved the Quick Example section to include both command line and Python API usage.
- Added installation options with detailed steps for PyPI, standalone binaries, and source installation.
- Enhanced the Quick Start Guide with structured installation methods and basic usage examples.
- Introduced advanced features like security filters, conflict resolution, and performance optimization.
- Provided comprehensive error handling and common patterns for backup scripts and archive verification.
- Updated the requirements and reference links for better navigation.

2025-06-06 17:31:08 +08:00

2.7 KiB

Raw Blame History

API Reference

This section contains the complete API documentation for tzst, providing detailed information about classes, functions, and exceptions.

:maxdepth: 2

core
cli
exceptions

Overview

The tzst library provides both high-level convenience functions and a comprehensive class-based API for working with .tzst/.tar.zst archives. The library is designed with security, performance, and ease of use in mind.

Main Components

{doc}core: Core functionality including TzstArchive class and convenience functions for archive operations
{doc}cli: Command-line interface functions and utilities for batch operations
{doc}exceptions: Custom exception classes for comprehensive error handling and debugging

Architecture Overview

The tzst library follows a layered architecture:

High-Level API: Convenience functions for common operations
Class-Based API: TzstArchive class for advanced control
CLI Interface: Command-line tools for interactive and scripted use
Exception System: Comprehensive error handling for robust applications

Quick Reference

Core Classes

.. currentmodule:: tzst

.. autosummary::
   :nosignatures:
   
   TzstArchive

The main class for archive manipulation with context manager support and comprehensive functionality.

Convenience Functions

.. autosummary::
   :nosignatures:
   
   create_archive
   extract_archive
   list_archive
   test_archive

High-level functions that provide simple interfaces for common archive operations.

CLI Functions

.. currentmodule:: tzst.cli

.. autosummary::
   :nosignatures:
   
   main
   create_parser
   print_banner
   format_size
   validate_compression_level

Command-line interface utilities for interactive and batch operations.

Exception Classes

.. currentmodule:: tzst.exceptions

.. autosummary::
   :nosignatures:
   
   TzstError
   TzstArchiveError
   TzstCompressionError
   TzstDecompressionError

Exception hierarchy for comprehensive error handling and debugging support.

Key Features

🛡️ Security First

Built-in path traversal protection
Multiple security filter options
Safe extraction by default

⚡ High Performance

Zstandard compression with configurable levels
Streaming support for large archives
Memory-efficient operations

🔧 Developer Friendly

Clean, Pythonic API
Comprehensive error handling
Context manager support
Extensive documentation and examples

🌐 Cross-Platform

Works on Windows, macOS, and Linux
Consistent behavior across platforms
Native performance optimizations

2.7 KiB Raw Blame History