ParticleJSONDecoder

class plasmapy.particles.serialization.ParticleJSONDecoder(*, object_hook=None, **kwargs)

Bases: json.decoder.JSONDecoder

A custom JSONDecoder class to deserialize JSON objects into the appropriate particle objects.

Parameters
  • object_hook – If specified, will be called with the result of every JSON object decoded and its return value will be used in place of the given dict. This can be used to provide custom deserializations (e.g. to support JSON-RPC class hinting). If not specified, then defaults to particle_hook.).

  • **kwargs – Any keyword accepted by JSONDecoder.

object_hook, if specified, will be called with the result of every JSON object decoded and its return value will be used in place of the given dict. This can be used to provide custom deserializations (e.g. to support JSON-RPC class hinting).

object_pairs_hook, if specified will be called with the result of every JSON object decoded with an ordered list of pairs. The return value of object_pairs_hook will be used instead of the dict. This feature can be used to implement custom decoders. If object_hook is also defined, the object_pairs_hook takes priority.

parse_float, if specified, will be called with the string of every JSON float to be decoded. By default this is equivalent to float(num_str). This can be used to use another datatype or parser for JSON floats (e.g. decimal.Decimal).

parse_int, if specified, will be called with the string of every JSON int to be decoded. By default this is equivalent to int(num_str). This can be used to use another datatype or parser for JSON integers (e.g. float).

parse_constant, if specified, will be called with one of the following strings: -Infinity, Infinity, NaN. This can be used to raise an exception if invalid JSON numbers are encountered.

If strict is false (true is the default), then control characters will be allowed inside strings. Control characters in this context are those with character codes in the 0-31 range, including '\t' (tab), '\n', '\r' and '\0'.

Methods Summary

decode(s[, _w])

Return the Python representation of s (a str instance containing a JSON document).

particle_hook(json_dict)

Decode JSON strings into the appropriate particle class.

raw_decode(s[, idx])

Decode a JSON document from s (a str beginning with a JSON document) and return a 2-tuple of the Python representation and the index in s where the document ended.

Methods Documentation

decode(s, _w=<built-in method match of re.Pattern object>)

Return the Python representation of s (a str instance containing a JSON document).

static particle_hook(json_dict)

Decode JSON strings into the appropriate particle class.

This method is an object_hook utilized by the json deserialization processes to decode json strings into a particle class (AbstractParticle, CustomParticle, DimensionlessParticle, Particle).

raw_decode(s, idx=0)

Decode a JSON document from s (a str beginning with a JSON document) and return a 2-tuple of the Python representation and the index in s where the document ended.

This can be used to decode a JSON document from a string that may have extraneous data at the end.