{"library":"serial","title":"Serial","description":"The `serial` library provides a framework for simple and powerful serialization and deserialization of Python class instances to and from various data formats like JSON, YAML, and XML. It leverages schema definitions for robust type handling and validation. The current version is 0.0.97, and it maintains an active development pace, though it is still in a pre-1.0 state.","language":"python","status":"active","last_verified":"Fri Apr 17","install":{"commands":["pip install serial"],"cli":null},"imports":["from serial import Serializer","from serial import Deserializer","from serial import fields"],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"from serial import Serializer, Deserializer, fields\nimport json\n\n# Define a schema for a simple User object\nuser_schema = {\n    \"id\": fields.Integer(required=True),\n    \"name\": fields.String(required=True),\n    \"email\": fields.Email(required=False),\n    \"is_active\": fields.Boolean(default=True)\n}\n\n# Create a serializer instance for JSON\nuser_serializer = Serializer(user_schema, format=\"json\")\n\n# Create a deserializer instance for JSON\nuser_deserializer = Deserializer(user_schema, format=\"json\")\n\n# Example data to serialize\nuser_data = {\"id\": 1, \"name\": \"Alice Wonderland\", \"email\": \"alice@example.com\"}\n\n# Serialize the data\nserialized_output = user_serializer.serialize(user_data)\nprint(f\"Serialized JSON: {serialized_output}\")\n\n# Deserialize the data\ndeserialized_object = user_deserializer.deserialize(serialized_output)\nprint(f\"Deserialized Object: {deserialized_object}\")","lang":"python","description":"This quickstart demonstrates how to define a schema using `serial.fields`, instantiate `Serializer` and `Deserializer` for JSON format, and then serialize a Python dictionary into JSON and deserialize it back. It showcases basic schema validation and default value handling.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}