Giter Club home page Giter Club logo

dataclass-marshal's Introduction

dataclass-marshal

Python package for marshalling (serializing) instances of classes decorated with @dataclass.

Supported serialization types

  • Simple types: bool, int, float, complex, str, bytes, bytearray
  • Container types: Tuple, List, Set, Dict
  • Other types: Decimal, datetime, UUID

Usage

from typing import Any, Dict
from dataclass_marshal import dataclass, marshal, unmarshal

@dataclass
class Product:
    id: int
    attributes: Dict[str, Any]


product = Product(1, {'weight': 10})

marshalled = marshal(product)
# {'id': 1, 'attributes': {'weight': 10}}
unmarshalled = unmarshal(marshalled, Product)
# Product(id=1, attributes={'weight': 10})

Support for custom (un)marshallers

For custom types and non-@dataclass definitions it's possible to register custom marshaller/unmarshaller.

from dataclass_marshal import register, marshal

class Dimensions:
    def __init__(self, height, width, depth):
        self.height = height
        self.width = width
        self.depth = depth


register(Dimensions, marshaller=lambda x: x.__dict__, unmarshaller=lambda x: Dimensions(**x))
marshalled = marshal(Dimensions(1,2,4))
# {'height': 1, 'width': 2, 'depth': 4}

dataclass-marshal's People

Contributors

crtomirmajer avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.