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.1.3.tar.gz (2.7 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for json_fix-0.1.3.tar.gz
Algorithm Hash digest
SHA256 d999ac74f51441fdebef4a8ce90fbfb5520b29edc73d220b92ee7fefc1476b3b
MD5 a3f7c9a40ce57c3501e7db68cbea94e5
BLAKE2b-256 4c6b10454f1915ed0ebd4950018b58faa30a55130afc64149505e4210c8948a3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: json_fix-0.1.3-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.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.8.6

File hashes

Hashes for json_fix-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ed9df777998527f4ea50cc771700c4ef8ead2b56284c40f486ed685971241981
MD5 4f20cffc7743d0acaac1bcfb2af4b2f7
BLAKE2b-256 5b5d93b9adbe0e277c60fd37b91ba7fcd7a538045c6db11b15203c0dfaccdcea

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