Skip to content

📏 FileSizeLib

A unified storage unit library for Python with cross-platform file size support

🚀 What is FileSizeLib?

FileSizeLib is a powerful and intuitive Python storage unit library that makes it easy to handle calculations, conversions, and operations with various storage sizes. Whether you're working with file sizes, network bandwidth, or storage capacity, FileSizeLib makes these tasks simple and elegant.

✨ Core Features

  • 🧮 Smart Arithmetic with Unit Preservation

    Same-unit operations preserve units (1 GB + 2 GB = 3 GB), different units convert automatically

    View arithmetic operations

  • 📝 Flexible String Parsing

    Parse multiple string formats with case-insensitive support and various separators

    Learn string parsing

  • 🔗 Cross-Platform File Operations

    Get file and directory sizes using pathlib with platform-specific optimizations

    File operations guide

  • ⚡ Platform Optimizations

    Platform-specific performance optimizations for Windows, Linux, and macOS

    Platform support details

  • 🔒 Type Safety

    Complete type annotations for better IDE support and code safety

    API Reference

  • 🎯 Zero Dependencies

    Uses only Python standard library, no external dependencies required

    Quick Start

🎯 Quick Example

from filesizelib import Storage, StorageUnit, FileSizeLib

# Create storage values (Storage and FileSizeLib are identical)
file_size = Storage(1.5, StorageUnit.GB)
backup_size = FileSizeLib.parse("2.5 GB")  # FileSizeLib alias

# Smart arithmetic - same units preserve unit!
same_unit_total = file_size + backup_size
print(f"Same unit: {same_unit_total}")  # Output: 4.0 GB

# Configure decimal precision (eliminates scientific notation)
Storage.set_decimal_precision(5)
small_value = Storage(1.23456789e-5, StorageUnit.TB)
print(f"Precise: {small_value}")  # Output: 0.00001 TB (no scientific notation!)

# Convenient conversion methods
print(f"File size (MB): {file_size.convert_to_mb()}")  # 1500.0 MB
print(f"Backup size (GiB): {backup_size.convert_to_gib()}")  # 2.33 GiB

# File operations
dir_size = Storage.get_size_from_path("/path/to/directory")
print(f"Directory size: {dir_size.auto_scale()}")

# Reset precision to default
Storage.set_decimal_precision(20)

🛠️ Supported Unit Types

graph TD
    A[Storage Units] --> B[Binary Units]
    A --> C[Decimal Units]
    A --> D[Bit Units]

    B --> B1[BYTES]
    B --> B2[KiB, MiB, GiB]
    B --> B3[TiB, PiB, EiB]
    B --> B4[ZiB, YiB]

    C --> C1[KB, MB, GB]
    C --> C2[TB, PB, EB]
    C --> C3[ZB, YB]

    D --> D1[BITS]
    D --> D2[KILOBITS]
    D --> D3[MEGABITS]
    D --> D4[GIGABITS]
    D --> D5[TERABITS]

    style A fill:#e1f5fe
    style B fill:#f3e5f5
    style C fill:#e8f5e8
    style D fill:#fff3e0

🌟 Why Choose FileSizeLib?

Simple to Use

FileSizeLib's API is designed to be intuitive and follows Python best practices. You can accomplish complex storage unit operations with minimal code.

Performance Optimized

Built-in platform-specific optimizations ensure optimal performance across different operating systems.

Type Safe

Complete type annotation support makes your code more reliable and provides better IDE support.

Zero Dependencies

No third-party dependencies reduce project complexity and potential security risks.

🔄 Architecture Overview

graph LR
    A[User Code] --> B[Storage Class]
    B --> C[StorageUnit Enum]
    B --> D[Arithmetic Ops]
    B --> E[Conversion Methods]
    B --> F[String Parsing]
    B --> G[File Operations]

    G --> H[PlatformStorage]
    H --> I[WindowsStorage]
    H --> J[LinuxStorage]
    H --> K[MacStorage]

    style A fill:#e3f2fd
    style B fill:#f3e5f5
    style C fill:#e8f5e8
    style D fill:#fff3e0
    style E fill:#fce4ec
    style F fill:#f1f8e9
    style G fill:#e0f2f1
    style H fill:#e8eaf6

📚 Next Steps

Start your FileSizeLib journey Install Now