mdbernard/pyserde

Yet another serialization library on top of dataclasses, inspired by serde-rs.

pyserde

Yet another serialization library on top of dataclasses, inspired by serde-rs.

Guide | API Docs | Examples

Overview

Declare a class with pyserde's @serde decorator.

@serde
@dataclass
class Foo:
    i: int
    s: str
    f: float
    b: bool

You can serialize Foo object into JSON.

>>> to_json(Foo(i=10, s='foo', f=100.0, b=True))
'{"i":10,"s":"foo","f":100.0,"b":true}'

You can deserialize JSON into Foo object.

>>> from_json(Foo, '{"i": 10, "s": "foo", "f": 100.0, "b": true}')
Foo(i=10, s='foo', f=100.0, b=True)

Features

• Supported data formats
  • dict
  • tuple
  • JSON
  • Yaml
  • Toml
  • MsgPack
  • Pickle
• Supported types
  • Primitives (int, float, str, bool)
  • Containers
    • List, Set, Tuple, Dict
    • FrozenSet, DefaultDict
  • typing.Optional
  • typing.Union
  • User defined class with @dataclass
  • typing.NewType for primitive types
  • typing.Any
  • typing.Literal
  • typing.Generic
  • typing.ClassVar
  • dataclasses.InitVar
  • Enum and IntEnum
  • Standard library
    • pathlib.Path
    • decimal.Decimal
    • uuid.UUID
    • datetime.date, datetime.time, datetime.datetime
    • ipaddress
  • PyPI library
    • numpy types
• Class Attributes
• Field Attributes
• Decorators
• Type Check
• Union Representation
• Forward reference
• PEP563 Postponed Evaluation of Annotations
• PEP585 Type Hinting Generics In Standard Collections
• PEP604 Allow writing union types as X | Y
• PEP681 Data Class Transform
• Case Conversion
• Rename
• Alias
• Skip (de)serialization (skip, skip_if, skip_if_false, skip_if_default)
• Custom class (de)serializer
• Custom field (de)serializer
• Flatten

Contributors ✨

Thanks goes to these wonderful people (emoji key):

yukinarit 💻	Alexander Miskaryan 💻	ydylla 💻	Kevin Squire 💻 📖	Yushi OMOTE 💻	Yuji Kanagawa 💻	Weiliang Li 💻
Mauve 💻	adsharma 💻	Guilhem C. 📖	Pierre Tardy 💻	Raphael Nestler 📖	Pranav V P 💻	andreymal 💻
Johann Fuechsl 💻	DoeringChristian 💻	Stuart Axelbrooke 💻	Jakub Beránek 💻	Fredrik Reinholdsen 💻	Bruno Oliveira 📖	Kyle Kosic 💻
Gajo Petrovic 📖	m472 💻	acolley-gel 💻
Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!

LICENSE

This project is licensed under the MIT license.