_superjson

superjson._superjson.get_class_name_from_dumper_loader_method(func)

Get default value of class_name argument.

Because the third argument of dumper, loader method must be the class name.

superjson._superjson.is_dumper_method(func)

Test if it is a dumper method.

superjson._superjson.is_loader_method(func)

Test if it is a loader method.

superjson._superjson.is_compressed_json_file(abspath)

Test a file is a valid json file.

• *.json: uncompressed, utf-8 encode json file

• *.js: uncompressed, utf-8 encode json file

• *.gz: compressed, utf-8 encode json file

class superjson._superjson.BaseSuperJson

A extensable json encoder/decoder. You can easily custom converter for any types.

dumps(obj, indent: Optional[bool] = None, sort_keys: Optional[bool] = None, pretty: bool = False, float_precision: Optional[int] = None, ensure_ascii: bool = True, compress: bool = False, **kwargs)

Dump any object into json string.

Parameters

• pretty (bool) – if True, dump json into pretty indent and sorted key format.

• float_precision (int) – default None, limit floats to N-decimal points.

• compress (bool) – default False. If True, then compress encoded string.

loads(s: str, object_hook: Optional[bool] = None, decompress: bool = False, ignore_comments: bool = False, **kwargs)

load object from json encoded string.

Parameters

• decompress (bool) – default False. If True, then decompress string.

• ignore_comments (bool) – default False. If True, then ignore comments.

dump(obj, abspath: str, indent: Optional[bool] = None, sort_keys: Optional[bool] = None, pretty: bool = False, float_precision: Optional[int] = None, ensure_ascii: bool = True, overwrite: bool = False, verbose: bool = True, **kwargs)

Dump any object into file.

Parameters

• abspath (str) – if *.json, *.js** then do regular dump. if *.gz, then perform compression.

• pretty (bool) – if True, dump json into pretty indent and sorted key format.

• float_precision (int) – default None, limit floats to N-decimal points.

• overwrite (boolean) – default False, If True, when you dump to existing file, it silently overwrite it. If False, an alert message is shown. Default setting False is to prevent overwrite file by mistake.

• verbose (boolean) – default True, help-message-display trigger.

load(abspath: str, object_hook=None, ignore_comments: bool = False, verbose: bool = True, **kwargs)

load object from json file.

Parameters

• abspath (str) – if *.json, *.js** then do regular dump. if ``*.gz, then perform decompression.

• ignore_comments (bool) – default ``False. If True, then ignore comments.

• verbose (boolean) – default True, help-message-display trigger.

dump_bytes(obj, class_name='builtins.bytes')

btyes dumper.

load_bytes(dct, class_name='builtins.bytes')

btyes loader.

dump_datetime(obj, class_name='datetime.datetime')

datetime.datetime dumper.

load_datetime(dct, class_name='datetime.datetime')

datetime.datetime loader.

dump_date(obj, class_name='datetime.date')

datetime.date dumper.

load_date(dct, class_name='datetime.date')

datetime.date loader.

dump_set(obj, class_name='builtins.set')

set dumper.

load_set(dct, class_name='builtins.set')

set loader.

dump_deque(obj, class_name='collections.deque')

collections.deque dumper.

load_deque(dct, class_name='collections.deque')

collections.deque loader.

dump_OrderedDict(obj, class_name='collections.OrderedDict')

collections.OrderedDict dumper.

load_OrderedDict(dct, class_name='collections.OrderedDict')

collections.OrderedDict loader.

class superjson._superjson.SuperJson