Skip to main content

allow custom class json behavior on builtin json object

Project description

What is this?

A patch to the built-in python json object that allows classes to specify how they should be serialized.

Why?

Because sometimes external code uses something like

import json
json.dumps(list_containing_your_object)

And it simply throws an error no matter how you customize your object

How do I use this?

pip install json-fix

import json_fix # import this before the JSON.dumps gets called

# same file, or different file
class YOUR_CLASS:
    def __json__(self):
        # YOUR CUSTOM CODE HERE
        #    you probably just want to do:
        #        return self.__dict__
        return "a built-in object that is natually json-able"

If you want control over classes that are defined externally (datetime, numpy.array, tensor, etc), use the override_table

import json_fix # import this before the JSON.dumps gets called
import json
import pandas as pd

SomeClassYouDidntDefine = pd.DataFrame

# create a boolean function for identifying the class
class_checker = lambda obj: isinstance(obj, SomeClassYouDidntDefine)
# then assign it to a function that does the converting
json.override_table[class_checker] = lambda obj_of_that_class: json.loads(obj_of_that_class.to_json())

json.dumps([ 1, 2, SomeClassYouDidntDefine() ], indent=2)

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

json_fix-0.4.1.tar.gz (2.7 kB view details)

Uploaded Source

Built Distribution

json_fix-0.4.1-py3-none-any.whl (2.6 kB view details)

Uploaded Python 3

File details

Details for the file json_fix-0.4.1.tar.gz.

File metadata

  • Download URL: json_fix-0.4.1.tar.gz
  • Upload date:
  • Size: 2.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.6

File hashes

Hashes for json_fix-0.4.1.tar.gz
Algorithm Hash digest
SHA256 e56ffc40ae755e4f13069f1c69900b87e76bc299d4a48e55dbbdcaec645a2575
MD5 5424da4ad66b05fa682b000fed483f3b
BLAKE2b-256 d96c4b56a861119ed8355be0ea76fae854ba7b9885cc7c3af59b5182f1630c19

See more details on using hashes here.

File details

Details for the file json_fix-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: json_fix-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 2.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.6

File hashes

Hashes for json_fix-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0e2b9f9fabebaf4d0203141d8ce4e77b9f8d4ad7f15d0c8a9a102fecf274f484
MD5 21e2fd6d7aa1c6e9a4bcc63deeb2f90a
BLAKE2b-256 da0f8de174ffeab05549a80aee170741c8997f6a48e4d13b48525f9021891ee7

See more details on using hashes here.

Supported by

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