JsonIO

🚀 Seamless JSON Handling in Python 🐍

Overview • Features • Installation • Documentation • Usage • Contributions • License

Overview

JsonIO is a high-level API for handling JSON serialization and deserialization in Python using the orjson library. It provides a simple and efficient way to work with JSON data, including support for custom types.

Features

• Fast Serialization: Built on orjson, offering high-performance JSON serialization.

• Custom Serialization: Easily extendable to handle non-standard data types with a custom encoder.

• Convenient File Operations: Load and save JSON data directly from/to files.

Installation

You can install the module via pip:

pip install ayrun-jsonio

Documentation

The documentation website is still under development.

Usage

Basic Functions

The module provides the following main functions:

• loads(data: Union[str, bytes]) -> Any: Deserialize a JSON string or bytes into a Python object.

• load(filepath: Union[str, Path]) -> Any: Read a JSON file and return the corresponding Python object.

• dumps(obj: Any, *, option: Optional[int] = None, default: Optional[Callable[[Any], Any]] = None) -> str: Serialize a Python object into a JSON string.

• dump(obj: Any, filepath: Union[str, Path], *, option: Optional[int] = None, default: Optional[Callable[[Any], Any]] = None) -> None: Serialize a Python object and write it to a JSON file.

Example Usage

import uuid
from datetime import datetime
from decimal import Decimal

import jsonio

# Sample data
data = {
    "name": "Alice",
    "age": 30,
    "balance": Decimal("1234.56"),  # Decimal support
    "tags": {"json", "python"},       # Set support
    "uuid": uuid.uuid4(),             # UUID support
    "timestamp": datetime.now()        # Datetime support
}

# Serialize to JSON string
json_str = jsonio.dumps(data, default=my_custom_encoder)
print(json_str)

# Deserialize from JSON string
loaded_data = jsonio.loads(json_str)
print(loaded_data)

# Save to a file
jsonio.dump(data, "data.json", default=my_custom_encoder)

# Load from a file
file_data = jsonio.load("data.json")
print(file_data)

Contributions

Contributions are welcome! Please feel free to submit a pull request or open an issue if you encounter any problems or have suggestions for improvements.

License

This project is licensed under the MIT License. See the LICENSE file for details.