Skip to main content

Pythonic implementation of Golang struct (un)marshalling

Project description

PyMarshal

pymarshal replicates the feature of (un)marshalling structs in Golang. Rather than replicating the exact feature as it exists in Go, pymarshal aims for elegant, Pythonic simplicity, and to fix the flaws in Go's implementation such as:

  • extra keys being silently ignored
  • lack of mandatory fields
  • lack of default values See control variables for the many options that can be configured per-class.

PyMarshal v2.0+

Support for the following has been removed:

  • YAML docstring API docs format
  • Python2

If you need any of these, use 1.6.2

Currently supported serialization formats

As YAML is compatible with JSON, use PyYAML to load or dump data with the pymarshal.json module, there is no explicit YAML module.

Installation

It is recommended that you install from PyPI using pip install pymarshal

Overview

The only modification required to your class code is to use the type_assert functions to assign __init__ arguments to class fields of the same name. pymarshal provides the type_assert functions to both enforce the type, and to unmarshal nested objects.

Example:

class MyModel:
    def __init__(
        self,
        a,
        b=5,
    ):
        self.a = type_assert(a, str)
        self.b = type_assert(b, int)

>>> from pymarshal.json import *
>>> x = marshal_json(MyModel("test", 6))
>>> x
{"a": "test", "b": 6}
>>> y = unmarshal_json(x, MyModel)
>>> y.a
"test"

NOTE: Your classes must not implement __call__ (which is an antipattern anyway). Whatever you would've implemented with __call__ should just be a normal, named method.

Your __init__ methods should only use simple assignment through the type_assert functions. If you have a use-case for a constructor that does more than simple assignment, use a separate 'factory' static method.

There is also:

  • type_assert_iter for iterables
  • type_assert_dict for anything that implements .items() -> k, v

Rather than using the Golang "tag" syntax, simply create a _marshal_key_swap and _unmarshal_key_swap dict in your class, and any re-named keys will be swapped before being passed to the class constructor or before being marshalled to JSON. The full list of control variables are documented HERE.

Examples

See the documentation folder

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pymarshal-2.2.3.tar.gz (14.9 kB view details)

Uploaded Source

Built Distribution

pymarshal-2.2.3-py3-none-any.whl (16.4 kB view details)

Uploaded Python 3

File details

Details for the file pymarshal-2.2.3.tar.gz.

File metadata

  • Download URL: pymarshal-2.2.3.tar.gz
  • Upload date:
  • Size: 14.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.7

File hashes

Hashes for pymarshal-2.2.3.tar.gz
Algorithm Hash digest
SHA256 43161a7b03dbc3b1e28630dbbab3684177502c691f10d21665fb0253a33f0bd2
MD5 03b1183cfe04e06bac90a6e38f377e96
BLAKE2b-256 805e50cb3d0d7428ee29d14e8ec1e2aa261141a83ec1e9d352da01326c630d78

See more details on using hashes here.

File details

Details for the file pymarshal-2.2.3-py3-none-any.whl.

File metadata

  • Download URL: pymarshal-2.2.3-py3-none-any.whl
  • Upload date:
  • Size: 16.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.7

File hashes

Hashes for pymarshal-2.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 48b7947871e9d160fc36f6b543fa635fa0310d46067e2970e8ccdff9f47067dd
MD5 891ae0049e875225c62e4dc50e03fd18
BLAKE2b-256 a6e18f1653cd615d39afae7c4f9bfe66d49151835f58017c25f21b96fafc5210

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page