Skip to main content

allow custom class json behavior on builtin json object

Project description

What is this?

A patch to the buildit 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

from json_fix import fix_it; fix_it() # only needs to be done once per runtime, NOT per-file

# 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 you didn't define yourself, use the converter table

from json_fix import fix_it; fix_it() # only needs to be done once per runtime, NOT per-file
import json
import pandas as pd

SomeClassYouDidntDefine = pd.DataFrame

# the key is a lambda checker, the value is the converter if the check==True
class_checker = lambda obj: isinstance(obj, SomeClassYouDidntDefine)
# the lambda here (the converter) needs to return a string
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.0.tar.gz (2.6 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: json_fix-0.1.0.tar.gz
  • Upload date:
  • Size: 2.6 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.0.tar.gz
Algorithm Hash digest
SHA256 a4acdcd4160118f1f5f656436b5d402ca600088f64644c5a0db717e590fa35e1
MD5 7406228004a048ed78a1229f90ef57d5
BLAKE2b-256 12b9e821c116d22507455684d489447baccd28db79865b903672fa2943aec0be

See more details on using hashes here.

File details

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

File metadata

  • Download URL: json_fix-0.1.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3d1a283237b13a23a29bbb41a6528fe1312216c314872b8590504c9cc2764922
MD5 51ffca9c89fa7984af6d0d75e8c02f83
BLAKE2b-256 3628298ba2c999bcd68409a43ce891b3ff5cf0a1947e3aa295415159b6e16455

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