PyJSON5

https://pyjson5.readthedocs.io/en/latest/
Admin
PyJSON5 is a serializer and parser library for Python 3.7 and later, designed to handle JSON5 data...
Tokens:21,436
Snippets:94
Trust Score:8.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install PyJSON5

Source: https://pyjson5.readthedocs.io/en/latest/_sources/index

This command installs the PyJSON5 library using pip, the Python package installer. Ensure you have Python and pip installed.

```bash
pip install pyjson5
```

--------------------------------

### PyJSON5 Version 1.6.1 PEP 517 Installation

Source: https://pyjson5.readthedocs.io/en/latest/changelog

This release fixes PEP 517-like installation using the 'build' package, with a contribution from Tomasz Kłoczko.

```python
1.6.1 (2022-01-18)
  * Fix [PEP 517](https://www.python.org/dev/peps/pep-0517/)-like installation using [build](https://github.com/pypa/build) (by [Tomasz Kłoczko](https://github.com/kloczek))
```

--------------------------------

### pyjson5 Version 1.6.1 Installation Fix

Source: https://pyjson5.readthedocs.io/en/latest/_sources/changelog

Implements PEP 517-like installation for pyjson5 using the `build` tool. This improves the installation process, especially in modern Python environments.

```python
# Fix PEP 517-like installation using build (by [Tomasz Kłoczko](https://github.com/kloczek))
```

--------------------------------

### HTML Safe Serialization Example

Source: https://pyjson5.readthedocs.io/en/latest/index

Demonstrates how to use PyJSON5's serializer to create HTML-safe data by encoding special characters.

```python
<a onclick='alert(" + encode(data) + ")'>show message</a>
```

--------------------------------

### HTML Safe Serialization Example

Source: https://pyjson5.readthedocs.io/en/latest/encoder

Demonstrates how to use PyJSON5's `encode` function to create HTML-safe strings by encoding special characters.

```python
<a onclick='alert(" + encode(data) + ")'>show message</a>
```

--------------------------------

### PyJSON5 Version 1.6.9 Update

Source: https://pyjson5.readthedocs.io/en/latest/changelog

This update addresses an issue with installation on Termux by removing an unused import. It was contributed by veka0 and addresses issue #105.

```python
1.6.9 (2025-05-12)
  * Remove unused import to fix installation on Termux (by veka0, [#105](https://github.com/Kijewski/pyjson5/pull/105))
```

--------------------------------

### pyjson5 Version 1.4.7 Identifier and String Parsing

Source: https://pyjson5.readthedocs.io/en/latest/_sources/changelog

Enhances parsing capabilities by allowing `\uXXXX` sequences in identifier names and literal keys, and understanding numbers like "0.". It also includes optimizations, CI setup, and stricter string parsing rules.

```python
# Allow `\uXXXX` sequences in identifier names
# Update to Unicode 12.1.0
# Optimized encoder and decoder for a little better speed
# Setup basic CI environment
# Parse `\uXXXX` in literal keys
# Understand "0."
# Add CI tests
# Reject unescaped newlines in strings per spec
# Allow overriding default quotation mark
# Make Options objects pickle-able
# Bump major version number
```

--------------------------------

### PyJSON5 Encoder API Reference

Source: https://pyjson5.readthedocs.io/en/latest/encoder

Provides a summary of the PyJSON5 encoder functions, their parameters, and their purposes. Includes functions for serialization to strings, bytes, callbacks, and file objects, as well as testing serializability and handling exceptions.

```APIDOC
encode(data, *[, options]) | Serializes a Python object as a JSON5 compatible string.
encode_bytes(data, *[, options]) | Serializes a Python object to a JSON5 compatible bytes string.
encode_callback(data, cb[, supply_bytes, ...]) | Serializes a Python object into a callback function.
encode_io(data, fp[, supply_bytes, options]) | Serializes a Python object into a file-object.
encode_noop(data, *[, options]) | Test if the input is serializable.
dump(obj, fp, **kw) | Serializes a Python object to a JSON5 compatible string.
dumps(obj, **kw) | Serializes a Python object to a JSON5 compatible string.
Options | Customizations for the `encoder_*(...)` function family.
Json5EncoderException | Base class of any exception thrown by the serializer.
Json5UnstringifiableType([message, ...]) | The encoder was not able to stringify the input, or it was told not to by the supplied `Options`.
```

--------------------------------

### PyJSON5 Core Components

Source: https://pyjson5.readthedocs.io/en/latest/_sources/index

This lists essential components of the PyJSON5 library, including the Options class for configuration and exception classes for handling errors during decoding and encoding.

```python
pyjson5.Options
pyjson5.Json5EncoderException
pyjson5.Json5DecoderException
```

--------------------------------

### pyjson5 Decoder API

Source: https://pyjson5.readthedocs.io/en/latest/decoder

API documentation for pyjson5 decoder functions. Includes `load` for file-like objects and `loads` for strings, with details on parameters and return types. Recommends using `decode_io` and `decode` respectively.

```APIDOC
pyjson5.load(_fp_ , _** kw_)
    Decodes JSON5 serialized data from a file-like object.
    Use [`decode_io(…)`](https://pyjson5.readthedocs.io/en/latest/decoder.html#pyjson5.decode_io) instead!

    Parameters:
      * **fp** (_IOBase_) – A file-like object to parse from.
      * **kw** – Silently ignored.
    Returns:
      see [`decode_io(…)`](https://pyjson5.readthedocs.io/en/latest/decoder.html#pyjson5.decode_io)
    Return type:
      [object](https://docs.python.org/3.13/library/functions.html#object "(in Python v3.13)")

pyjson5.loads(_s_ , _*_ , _encoding ='UTF-8'_, _** kw_)
    Decodes JSON5 serialized data from a string.
    Use [`decode(…)`](https://pyjson5.readthedocs.io/en/latest/decoder.html#pyjson5.decode) instead!

    Parameters:
      * **s** ([_object_](https://docs.python.org/3.13/library/functions.html#object "(in Python v3.13)")) – Unless the argument is an `str`, it gets decoded according to the parameter `encoding`.
      * **encoding** ([_str_](https://docs.python.org/3.13/library/stdtypes.html#str "(in Python v3.13)")) – Codec to use if `s` is not an `str`.
      * **kw** – Silently ignored.
    Returns:
      see [`decode(…)`](https://pyjson5.readthedocs.io/en/latest/decoder.html#pyjson5.decode)
    Return type:
      [object](https://docs.python.org/3.13/library/functions.html#object "(in Python v3.13)")
```

--------------------------------

### pyjson5 Loading Functions

Source: https://pyjson5.readthedocs.io/en/latest/genindex

Details the functions used for loading JSON5 data, including loading from a file-like object and from a string.

```python
load()
loads()
```

--------------------------------

### pyjson5 Options and Attributes

Source: https://pyjson5.readthedocs.io/en/latest/genindex

Describes the Options class and its attributes for configuring JSON5 encoding and decoding behavior.

```python
Options
mappingtypes
quotationmark
tojson
update()
message
unstringifiable
result
value
```

--------------------------------

### PyJSON5 Compatibility Requirements

Source: https://pyjson5.readthedocs.io/en/latest/index

Specifies the minimum version requirements for CPython/PyPy and the C++ compiler needed to use PyJSON5.

```APIDOC
Compatibility:
  At least CPython / PyPy 3.7, and a C++11 compatible compiler (such as GCC 5.2+) is needed.
```

--------------------------------

### pyjson5 Options Class

Source: https://pyjson5.readthedocs.io/en/latest/_sources/encoder

Describes the `Options` class in pyjson5, which allows customization of the encoding process. It includes parameters for controlling various aspects of JSON5 serialization.

```python
class pyjson5.Options:
    # Members related to encoding options
```

--------------------------------

### PyJSON5 Version 1.5.3 PEP 484 Type Hints

Source: https://pyjson5.readthedocs.io/en/latest/changelog

This version adds PEP 484 type hints, contributed by Pascal Corpet, and updates the JSONTestSuite.

```python
1.5.3 (2021-11-16)
  * Add [PEP 484](https://www.python.org/dev/peps/pep-0484/) type hints (by [Pascal Corpet](https://github.com/pcorpet))
  * Update [JSONTestSuite](https://github.com/nst/JSONTestSuite)
```

--------------------------------

### pyjson5 Version 1.5.3 Type Hints

Source: https://pyjson5.readthedocs.io/en/latest/_sources/changelog

Adds PEP 484 type hints to the pyjson5 library, improving code clarity and enabling static analysis. Also updates the library's compatibility with the JSONTestSuite.

```python
# Add PEP 484 type hints (by [Pascal Corpet](https://github.com/pcorpet))
# Update [JSONTestSuite](https://github.com/nst/JSONTestSuite)
```

--------------------------------

### PyJSON5 Benchmark Comparison Table

Source: https://pyjson5.readthedocs.io/en/latest/_sources/performance

Presents a benchmark comparison of PyJSON5 against json, ujson, and orjson for encoding and decoding various data structures. The table quantifies performance differences.

```APIDOC
Benchmark Comparison (Higher is better):

| Data Type                  | Operation | json    | pyjson5 | ujson   | orjson  |
|----------------------------|-----------|---------|---------|---------|---------|
| Array with 256 doubles     | encode    | 6,425   | 81,202  | 28,966  | 83,836  |
|                            | decode    | 16,759  | 34,801  | 34,794  | 80,655  |
| Array with 256 strings     | encode    | 36,969  | 73,165  | 35,574  | 113,082 |
|                            | decode    | 42,730  | 38,542  | 38,386  | 60,732  |
| Array with 256 UTF-8 strings| encode    | 3,458   | 3,134   | 4,024   | 31,677  |
|                            | decode    | 2,428   | 2,498   | 2,491   | 1,750   |
| Array with 256 True values | encode    | 130,441 | 282,703 | 131,279 | 423,371 |
|                            | decode    | 220,657 | 262,690 | 264,485 | 262,283 |
| Array with 256 dicts       | encode    | N/A     | N/A     | N/A     | N/A     |
|                            | decode    | N/A     | N/A     | N/A     | N/A     |
```

--------------------------------

### PyJSON5 Encoder Options and Exceptions

Source: https://pyjson5.readthedocs.io/en/latest/index

Defines customization options for the JSON5 encoder and base classes for exceptions raised during encoding and decoding processes.

```python
Options
Json5EncoderException
Json5DecoderException
```

--------------------------------

### PyJSON5 Version 0.4.3 Initial Release

Source: https://pyjson5.readthedocs.io/en/latest/changelog

This marks the initial release of the PyJSON5 library.

```python
0.4.3 (2018-05-03)
  * Initial release
```

--------------------------------

### PyJSON5 Version 1.5.0 Performance and Options

Source: https://pyjson5.readthedocs.io/en/latest/changelog

Version 1.5.0 introduces faster floating-point number encoding using the Dragonbox algorithm and removes several configuration options from pyjson5.Options().

```python
1.5.0 (2021-03-11)
  * Faster floating-point number encoding using [Junekey Jeon’s Dragonbox algorithm](https://github.com/abolz/Drachennest/blob/77f4889a4cd9d7f0b9da82a379f14beabcfba13e/src/dragonbox.cc) implemented by Alexander Bolz
  * Removed a lot of configuration options from pyjson5.Options()
```

--------------------------------

### PyJSON5 Exception Methods

Source: https://pyjson5.readthedocs.io/en/latest/genindex

Details methods available on various PyJSON5 exception classes, primarily focusing on the `add_note` method for adding contextual information to exceptions during decoding or encoding processes.

```python
add_note(note: str)
```

--------------------------------

### pyjson5 Decoder Compatibility Functions

Source: https://pyjson5.readthedocs.io/en/latest/decoder

Offers compatibility functions for loading JSON5 data, similar to standard JSON libraries. `load` reads from an I/O stream, while `loads` reads from a string.

```python
pyjson5.load(fp: IOBase, **kwargs)
pyjson5.loads(s: str, **kwargs)
```

--------------------------------

### pyjson5 Encoder Exceptions

Source: https://pyjson5.readthedocs.io/en/latest/encoder

Details the base exception for serializer errors and the specific exception for unstringifiable types.

```APIDOC
pyjson5.Json5EncoderException:
  Base class of any exception thrown by the serializer.
  add_note(note): Exception.add_note(note) – add a note to the exception
  message: Human readable error description
  with_traceback(tb): Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

pyjson5.Json5UnstringifiableType(_message=None, _unstringifiable=None):
  The encoder was not able to stringify the input, or it was told not to by the supplied Options.
  add_note(note): Exception.add_note(note) – add a note to the exception
  message: Human readable error description
  unstringifiable: The value that caused the problem.
  with_traceback(tb): Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
```

--------------------------------

### PyJSON5 Version 1.6.0 Serialization and Dependencies

Source: https://pyjson5.readthedocs.io/en/latest/changelog

Version 1.6.0 introduces fallback encoding for `vars(obj)` to serialize objects like dataclasses, updates documentation, uses dependabot for dependency management, and updates fast_double_parser.

```python
1.6.0 (2021-11-17)
  * Fallback to encode `vars(obj)` if `obj` is not stringifyable, e.g. to serialize [dataclasses](https://docs.python.org/3/library/dataclasses.html)
  * Update documentation to use newer [sphinx](https://www.sphinx-doc.org/) version
  * Use [dependabot](https://github.com/dependabot) to keep dependencies current
  * Update [fast_double_parser](https://github.com/lemire/fast_double_parser)
```

--------------------------------

### pyjson5 Decoder Exceptions API

Source: https://pyjson5.readthedocs.io/en/latest/decoder

API documentation for pyjson5 decoder exceptions. Covers base exception, nesting too deep, EOF, illegal character, and extra data exceptions with their attributes and methods.

```APIDOC
pyjson5.Json5DecoderException:
  Base class of any exception thrown by the parser.
  Attributes:
    message: Human readable error description
    result: Deserialized data up until now.
  Methods:
    add_note(note): Exception.add_note(note) – add a note to the exception
    with_traceback(tb): Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

pyjson5.Json5NestingTooDeep:
  The maximum nesting level on the input data was exceeded.
  Inherits from: pyjson5.Json5DecoderException
  Attributes:
    message: Human readable error description
    result: Deserialized data up until now.
  Methods:
    add_note(note): Exception.add_note(note) – add a note to the exception
    with_traceback(tb): Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

pyjson5.Json5EOF:
  The input ended prematurely.
  Inherits from: pyjson5.Json5DecoderException
  Attributes:
    message: Human readable error description
    result: Deserialized data up until now.
  Methods:
    add_note(note): Exception.add_note(note) – add a note to the exception
    with_traceback(tb): Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

pyjson5.Json5IllegalCharacter:
  An unexpected character was encountered.
  Inherits from: pyjson5.Json5DecoderException
  Attributes:
    message: Human readable error description
    result: Deserialized data up until now.
    character: Illegal character.
  Methods:
    add_note(note): Exception.add_note(note) – add a note to the exception
    with_traceback(tb): Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

pyjson5.Json5ExtraData:
  The input contained extranous data.
  Inherits from: pyjson5.Json5DecoderException
  Attributes:
    message: Human readable error description
    result: Deserialized data up until now.
    character: Extraneous character.
  Methods:
    add_note(note): Exception.add_note(note) – add a note to the exception
    with_traceback(tb): Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
```

--------------------------------

### pyjson5 Encoder Compatibility Functions

Source: https://pyjson5.readthedocs.io/en/latest/_sources/encoder

Details the compatibility functions for dumping Python objects into JSON5 format. These are convenient wrappers for common serialization tasks.

```python
pyjson5.dump
pyjson5.dumps
```

--------------------------------

### pyjson5 Base Exception Details

Source: https://pyjson5.readthedocs.io/en/latest/_sources/exceptions

Provides detailed information about the base pyjson5 exception, including inherited members.

```python
.. autoexception:: pyjson5.Json5Exception
    :members:
    :inherited-members:
```

--------------------------------

### PyJSON5 Version 1.6.8 Requirements and Licensing

Source: https://pyjson5.readthedocs.io/en/latest/changelog

Version 1.6.8 updates the minimum Python version requirement to 3.7, updates dependencies, and relicenses the project under MIT OR Apache-2.0.

```python
1.6.8 (2025-01-03)
  * Requires at least Python 3.7
  * Update dependencies
  * Relicense to MIT OR Apache-2.0
```

--------------------------------

### PyJSON5 Version 1.6.5 Type Hint Improvement

Source: https://pyjson5.readthedocs.io/en/latest/changelog

This release focuses on improving type hinting, specifically for optional arguments within the library.

```python
1.6.5 (2023-12-04)
  * Fix type hints for optional arguments
```

--------------------------------

### PyJSON5 Version 1.5.2 Compilation and Unicode Updates

Source: https://pyjson5.readthedocs.io/en/latest/changelog

Version 1.5.2 adds file extensions to fix compilation with current Apple SDKs, updates fast_double_parser to v0.5.0, and updates to Unicode 14.0.0d18.

```python
1.5.2 (2021-07-09)
  * Add file extensions to fix compilation with current Apple SDKs
  * Update fast_double_parser to v0.5.0
  * Update to Unicode 14.0.0d18
```

--------------------------------

### pyjson5 load Function

Source: https://pyjson5.readthedocs.io/en/latest/decoder

Decodes JSON5 serialized data from a file-like object. This function is a compatibility wrapper and `decode_io` is recommended for new implementations. It takes a file-like object `fp` and ignores keyword arguments.

```python
load(fp) == decode_io(fp, None, False)
```

--------------------------------

### pyjson5 Encoder Exceptions

Source: https://pyjson5.readthedocs.io/en/latest/_sources/encoder

Lists and describes the custom exceptions raised by the pyjson5 encoder. These exceptions help in identifying and handling specific error conditions during serialization.

```python
pyjson5.Json5EncoderException
pyjson5.Json5UnstringifiableType
```

--------------------------------

### pyjson5 Exceptions

Source: https://pyjson5.readthedocs.io/en/latest/genindex

Lists the custom exceptions defined in the pyjson5 library for handling JSON5 parsing and encoding errors.

```python
Json5DecoderException
Json5EncoderException
Json5EOF
Json5Exception
Json5ExtraData
Json5IllegalCharacter
Json5IllegalType
Json5NestingTooDeep
Json5UnstringifiableType
```

--------------------------------

### PyJSON5 Performance Benchmark

Source: https://pyjson5.readthedocs.io/en/latest/performance

Benchmark results comparing PyJSON5, ujson, and orjson for encoding and decoding various data structures. Higher values indicate better performance.

```python
Data Type | PyJSON5 | ujson | orjson
---|---|---|---
Array with 256 doubles (encode) | 6,425 | 81,202 | 28,966
Array with 256 doubles (decode) | 16,759 | 34,801 | 34,794
Array with 256 strings (encode) | 36,969 | 73,165 | 35,574
Array with 256 strings (decode) | 42,730 | 38,542 | 38,386
Array with 256 UTF-8 strings (encode) | 3,458 | 3,134 | 4,024
Array with 256 UTF-8 strings (decode) | 2,428 | 2,498 | 2,491
Array with 256 True values (encode) | 130,441 | 282,703 | 131,279
Array with 256 True values (decode) | 220,657 | 262,690 | 264,485
Array with 256 dict{string, int} pairs (encode) | 11,621 | 10,014 | 18,148
Array with 256 dict{string, int} pairs (decode) | 17,802 | 19,406 | 19,391
Dict with 256 arrays with 256 dict{string, int} pairs (encode) | 40 | 38 | 68
Dict with 256 arrays with 256 dict{string, int} pairs (decode) | 43 | 49 | 48
Medium complex object (encode) | 8,704 | 11,922 | 15,319
Medium complex object (decode) | 12,567 | 14,042 | 13,985
Complex object (encode) | 672 | 909 | 731
Complex object (decode) | 462 | 700 | 700
```

--------------------------------

### pyjson5 Options Class

Source: https://pyjson5.readthedocs.io/en/latest/encoder

Defines customizations for pyjson5 encoder functions. It is immutable and can be updated using the update() method to create new instances with modified settings.

```python
class pyjson5.Options:
    """Customizations for the encoder_(...) function family. Immutable."""
    quotationmark: str | None
    tojson: str | False | None
    mappingtypes: Iterable[type] | False | None

    def update(self, *args, **kw):
        """Creates a new Options instance by modifying some members."""
        pass
```

--------------------------------

### PyJSON5 Decoder Performance vs. json.loads

Source: https://pyjson5.readthedocs.io/en/latest/performance

Compares the decoding speed of pyjson5.decode() against Python's built-in json.loads() for pure JSON data. The benchmark uses a specific dataset and hardware configuration, indicating pyjson5 is faster.

```python
import json
import pyjson5

# Assuming 'content' holds the JSON data
# Example usage:
# json.loads(content) == pyjson5.loads(content)

# Performance data from documentation:
# pyjson5.decode(): 2.08 s ± 7.49 ms per loop
# json.loads(): 2.71 s ± 12.1 ms per loop
```

--------------------------------

### PyJSON5 Exception Hierarchy and Base Class

Source: https://pyjson5.readthedocs.io/en/latest/exceptions

Details the inheritance structure of PyJSON5 exceptions, with Json5Exception as the base class. It also outlines the methods available on the base exception.

```python
class Json5Exception(Exception):
    """Base class of any exception thrown by PyJSON5."""
    def __init__(_message=None, *_args):
        pass

    def add_note(_object, _/):
        """Exception.add_note(note) – add a note to the exception"""
        pass

    @property
    def message(self):
        """Human readable error description"""
        pass

    def with_traceback(_object, _/):
        """Exception.with_traceback(tb) – set self.__traceback__ to tb and return self."""
        pass
```

--------------------------------

### pyjson5 Encoder Compatibility Functions

Source: https://pyjson5.readthedocs.io/en/latest/encoder

Provides functions for serializing Python objects to JSON5 strings. dump serializes to a file-like object, while dumps serializes to a string. Both are compatible with encode_io and encode respectively.

```python
def pyjson5.dump(obj, fp, **kw):
    """Serializes a Python object to a JSON5 compatible string.
    Use encode_io(...) instead!
    dump(obj, fp) == encode_io(obj, fp)
    """
    pass

def pyjson5.dumps(obj, **kw):
    """Serializes a Python object to a JSON5 compatible string.
    Use encode(...) instead!
    dumps(obj) == encode(obj)
    """
    pass
```

--------------------------------

### PyJSON5 Version 0.4.4 Documentation and Optimization

Source: https://pyjson5.readthedocs.io/en/latest/changelog

Version 0.4.4 includes improved documentation and minor speed optimizations for the encoder.

```python
0.4.4 (2018-05-19)
  * Better documentation
  * Optimized encoder for a little better speed
```

--------------------------------

### PyJSON5 Version 1.6.6 load() Return Type Fix

Source: https://pyjson5.readthedocs.io/en/latest/changelog

Version 1.6.6 corrects the return type of the `load()` function, as reported and fixed by Q-ten in issue #88.

```python
1.6.6 (2024-02-09)
  * Fix return type of `load()` (by Q-ten, [#88](https://github.com/Kijewski/pyjson5/pull/88))
```

--------------------------------

### PyJSON5 Decoder Exceptions

Source: https://pyjson5.readthedocs.io/en/latest/decoder

Lists and describes the exceptions that can be raised by the PyJSON5 parser during the decoding process. These exceptions cover various error conditions such as nesting too deep, premature end of input, illegal characters, extra data, and illegal return values from callbacks.

```python
Json5DecoderException([message, result]) | Base class of any exception thrown by the parser.
Json5NestingTooDeep | The maximum nesting level on the input data was exceeded.
Json5EOF | The input ended prematurely.
Json5IllegalCharacter([message, result, ...]) | An unexpected character was encountered.
Json5ExtraData([message, result, character]) | The input contained extranous data.
Json5IllegalType([message, result, value]) | The user supplied callback function returned illegal data.
```

--------------------------------

### PyJSON5 Decoding Functions

Source: https://pyjson5.readthedocs.io/en/latest/decoder

Provides a summary of the various functions available in PyJSON5 for decoding JSON5 and JSON data from different sources like strings, bytes, buffers, and file-like objects. It also includes the maximum nesting depth and optional parameters for some functions.

```python
decode(data[, maxdepth, some]) | Decodes JSON5 serialized data from an str object.
decode_latin1(data[, maxdepth, some]) | Decodes JSON5 serialized data from a bytes object.
decode_buffer(obj[, maxdepth, some, wordlength]) | Decodes JSON5 serialized data from an object that supports the buffer protocol, e.g. bytearray.
decode_callback(cb[, maxdepth, some, args]) | Decodes JSON5 serialized data by invoking a callback.
decode_io(fp[, maxdepth, some]) | Decodes JSON5 serialized data from a file-like object.
load(fp, **kw) | Decodes JSON5 serialized data from a file-like object.
loads(s, *, encoding) | Decodes JSON5 serialized data from a string.
```

--------------------------------

### pyjson5 Decoder Exceptions

Source: https://pyjson5.readthedocs.io/en/latest/_sources/decoder

Details the exceptions raised by the pyjson5 decoder for various error conditions, including nesting depth, end-of-file, illegal characters, extra data, and type errors.

```python
import pyjson5

try:
    # Example that might raise an exception
    pyjson5.decode('invalid json')
except pyjson5.Json5DecoderException as e:
    print(f"A JSON5 decoding error occurred: {e}")
except pyjson5.Json5NestingTooDeep as e:
    print(f"Nesting too deep: {e}")
except pyjson5.Json5EOF as e:
    print(f"Unexpected end of file: {e}")
except pyjson5.Json5IllegalCharacter as e:
    print(f"Illegal character found: {e}")
except pyjson5.Json5ExtraData as e:
    print(f"Extra data found: {e}")
except pyjson5.Json5IllegalType as e:
    print(f"Illegal type encountered: {e}")
```

--------------------------------

### pyjson5 Version 0.4.4 Documentation and Optimization

Source: https://pyjson5.readthedocs.io/en/latest/_sources/changelog

Includes improvements to the project's documentation and minor optimizations to the encoder for slightly better performance.

```python
# Better documentation
# Optimized encoder for a little better speed
```

--------------------------------

### pyjson5 Version 1.5.0 Faster Float Encoding

Source: https://pyjson5.readthedocs.io/en/latest/_sources/changelog

Implements faster floating-point number encoding using Junekey Jeon's Dragonbox algorithm. This version also removes several configuration options from `pyjson5.Options()` for simplification.

```python
# Faster floating-point number encoding using [Junekey Jeon's Dragonbox algorithm](https://github.com/abolz/Drachennest/blob/77f4889a4cd9d7f0b9da82a379f14beabcfba13e/src/dragonbox.cc) implemented by Alexander Bolz
# Removed a lot of configuration options from pyjson5.Options()
```

--------------------------------

### pyjson5 loads Function

Source: https://pyjson5.readthedocs.io/en/latest/decoder

Decodes JSON5 serialized data from a string. This function is a compatibility wrapper and `decode` is recommended for new implementations. It accepts a string `s`, an optional `encoding`, and ignores keyword arguments.

```python
loads(s) == decode(s)
```

--------------------------------

### PyJSON5 Decoder Functions

Source: https://pyjson5.readthedocs.io/en/latest/genindex

Provides functions for decoding JSON5 data. Includes methods for decoding from strings, buffers, I/O streams, and handling specific encodings like latin1. Also includes callback-based decoding.

```python
decode(s: str, **kwargs)
decode_buffer(buf: bytes, **kwargs)
decode_callback(callback: Callable, **kwargs)
decode_io(fp: BinaryIO, **kwargs)
decode_latin1(s: str, **kwargs)
```

--------------------------------

### pyjson5 Exception with_traceback Methods

Source: https://pyjson5.readthedocs.io/en/latest/genindex

This section details the `with_traceback` method for various pyjson5 exceptions. The `with_traceback` method is a standard Python exception method used to associate a traceback with an exception instance.

```APIDOC
pyjson5.Json5DecoderException:
  with_traceback(tb):
    Set self.__traceback__ to tb, and return self.

pyjson5.Json5EncoderException:
  with_traceback(tb):
    Set self.__traceback__ to tb, and return self.

pyjson5.Json5EOF:
  with_traceback(tb):
    Set self.__traceback__ to tb, and return self.

pyjson5.Json5Exception:
  with_traceback(tb):
    Set self.__traceback__ to tb, and return self.

pyjson5.Json5ExtraData:
  with_traceback(tb):
    Set self.__traceback__ to tb, and return self.

pyjson5.Json5IllegalCharacter:
  with_traceback(tb):
    Set self.__traceback__ to tb, and return self.

pyjson5.Json5IllegalType:
  with_traceback(tb):
    Set self.__traceback__ to tb, and return self.

pyjson5.Json5NestingTooDeep:
  with_traceback(tb):
    Set self.__traceback__ to tb, and return self.

pyjson5.Json5UnstringifiableType:
  with_traceback(tb):
    Set self.__traceback__ to tb, and return self.
```

--------------------------------

### pyjson5 Decoder Exceptions

Source: https://pyjson5.readthedocs.io/en/latest/decoder

Details the exceptions raised during JSON5 decoding. `Json5DecoderException` is the base class for decoding errors, while `Json5NestingTooDeep` specifically handles excessive nesting levels.

```python
class Json5DecoderException(Exception):
    message: str
    result: Any
    character: str
    with_traceback(tb: TracebackType) -> 'Json5DecoderException'
    add_note(note: str) -> None

class Json5NestingTooDeep(Json5DecoderException):
    pass
```

--------------------------------

### PyJSON5 Decoder Performance vs json.loads

Source: https://pyjson5.readthedocs.io/en/latest/_sources/performance

Compares the decoding speed of pyjson5.loads against the standard json.loads module using a dataset of city lots. The results show pyjson5 is faster.

```python
import pyjson5
import json

# Assuming 'content' is loaded from the dataset
# Example usage:
# with open('sf-city-lots-json', 'r') as f:
#     content = f.read()

# pyjson5.loads(content)
# json.loads(content)
```

--------------------------------

### pyjson5 Decoder Functions

Source: https://pyjson5.readthedocs.io/en/latest/decoder

Provides core functions for decoding JSON5 data. Includes methods for direct decoding, decoding from Latin-1 encoded strings, decoding from byte buffers, using callback functions, and decoding from I/O streams.

```python
pyjson5.decode(text: str, **kwargs)
pyjson5.decode_latin1(text: str, **kwargs)
pyjson5.decode_buffer(buffer: bytes, **kwargs)
pyjson5.decode_callback(text: str, callback: Callable, **kwargs)
pyjson5.decode_io(io_obj: IOBase, **kwargs)
```

--------------------------------

### pyjson5 Encoder Functions

Source: https://pyjson5.readthedocs.io/en/latest/_sources/encoder

Provides a summary of the primary encoding functions available in the pyjson5 library. These functions are used for serializing Python objects into JSON5 format with various options for output and handling.

```python
pyjson5.encode
pyjson5.encode_bytes
pyjson5.encode_callback
pyjson5.encode_io
pyjson5.encode_noop
```

--------------------------------

### pyjson5 Version 1.6.0 Dataclass Serialization

Source: https://pyjson5.readthedocs.io/en/latest/_sources/changelog

Introduces fallback serialization for `vars(obj)` when `obj` is not directly stringifiable, enabling support for objects like dataclasses. Also includes updates to documentation, dependency management via dependabot, and the fast_double_parser library.

```python
# Fallback to encode `vars(obj)` if `obj` is not stringifyable, e.g. to serialize [dataclasses](https://docs.python.org/3/library/dataclasses.html)
# Update documentation to use newer [sphinx](https://www.sphinx-doc.org/) version
# Use [dependabot](https://github.com/dependabot) to keep dependencies current
# Update [fast_double_parser](https://github.com/lemire/fast_double_parser)
```

--------------------------------

### pyjson5 Decoding Functions

Source: https://pyjson5.readthedocs.io/en/latest/_sources/decoder

Provides functions for decoding JSON5 and JSON data. Supports various input types including strings, bytes, and file-like objects. Includes functions for handling Latin-1 encoding and callbacks.

```python
import pyjson5

# Decode a JSON5 string
data = pyjson5.decode('{"key": "value"}')

# Decode a Latin-1 encoded string
data_latin1 = pyjson5.decode_latin1('{"key": "value"}')

# Decode from a byte buffer
byte_data = b'{"key": "value"}'
data_buffer = pyjson5.decode_buffer(byte_data)

# Decode using a callback function
def my_callback(obj):
    return obj
data_callback = pyjson5.decode_callback('{"key": "value"}', callback=my_callback)

# Decode from a file-like object
import io
file_obj = io.StringIO('{"key": "value"}')
data_io = pyjson5.decode_io(file_obj)

# Load JSON5 data from a file path
data_load = pyjson5.load('data.json5')

# Load JSON5 data from a string (alias for decode)
data_loads = pyjson5.loads('{"key": "value"}')
```

--------------------------------

### PyJSON5 Decoder Functions

Source: https://pyjson5.readthedocs.io/en/latest/index

Provides functions to decode JSON5 data from various sources like strings, buffers, callbacks, and file-like objects. Includes options for maximum depth and other parameters.

```python
decode(data[, maxdepth, some])
decode_buffer(obj[, maxdepth, some, wordlength])
decode_callback(cb[, maxdepth, some, args])
decode_io(fp[, maxdepth, some])
load(fp, **kw)
loads(s, *[, encoding])
```

--------------------------------

### pyjson5 Exception Hierarchy

Source: https://pyjson5.readthedocs.io/en/latest/_sources/exceptions

Displays the inheritance diagram for pyjson5 exceptions, showing the relationships between different error types.

```python
.. inheritance-diagram::
    pyjson5.Json5Exception
    pyjson5.Json5EncoderException
    pyjson5.Json5UnstringifiableType
    pyjson5.Json5DecoderException
    pyjson5.Json5NestingTooDeep
    pyjson5.Json5EOF
    pyjson5.Json5IllegalCharacter
    pyjson5.Json5ExtraData
    pyjson5.Json5IllegalType
```

--------------------------------

### PyJSON5 Encoder Performance vs. json.dumps

Source: https://pyjson5.readthedocs.io/en/latest/performance

Compares the encoding speed of pyjson5.encode() and pyjson5.encode_bytes() against Python's json.dumps(). It also includes a comparison with json.dumps() combined with xml.sax.saxutils.escape(). PyJSON5 is shown to be faster.

```python
import json
import pyjson5
from xml.sax.saxutils import escape

# Assuming 'obj' is a Python object to be serialized
# Example usage:
# obj == json.loads(pyjson5.encode(obj))

# Performance data from documentation:
# pyjson5.encode(): 1.37 s ± 19.2 per loop
# json.dumps(): 3.66 s ± 72.6 ms per loop
# json.dumps() + escape(): 4.01 s ± 21.3 ms per loop
```

--------------------------------

### PyJSON5 Version 1.4.7 Identifier, Unicode, and String Parsing

Source: https://pyjson5.readthedocs.io/en/latest/changelog

This release allows `\uXXXX` sequences in identifiers and literal keys, updates Unicode to 12.1.0, optimizes encoder/decoder, adds CI, understands '0.', rejects unescaped newlines, allows overriding quotation marks, and makes Options pickle-able.

```python
1.4.7 (2019-12-20)
  * Allow `\uXXXX` sequences in identifier names
  * Update to Unicode 12.1.0
  * Optimized encoder and decoder for a little better speed
  * Setup basic CI environment
  * Parse `\uXXXX` in literal keys
  * Understand “0.”
  * Add CI tests
  * Reject unescaped newlines in strings per spec
  * Allow overriding default quotation mark
  * Make Options objects pickle-able
  * Bump major version number
```

--------------------------------

### pyjson5 encode Callback Functionality

Source: https://pyjson5.readthedocs.io/en/latest/encoder

Handles serialization of Python objects using a callback function. The callback receives either bytes or strings based on the supply_bytes parameter. This function returns the callback function itself.

```APIDOC
pyjson5.encode(_data_ , _cb_ , _supply_bytes =True_, _*_ , _options =None_, _** options_kw_)


    Parameters: 
        
      * **data** ([_object_](https://docs.python.org/3.13/library/functions.html#object "(in Python v3.13)")) – see [`encode(…)`](https://pyjson5.readthedocs.io/en/latest/encoder.html#pyjson5.encode "pyjson5.encode")
      * **cb** (_Callable_ _[__[__Union_ _[_[_bytes_](https://docs.python.org/3.13/library/stdtypes.html#bytes "(in Python v3.13)") _|_[_str_](https://docs.python.org/3.13/library/stdtypes.html#str "(in Python v3.13)") _]__]__,__None_ _]_) – A callback function. Depending on the truthyness of `supply_bytes` either [`bytes`](https://docs.python.org/3.13/library/stdtypes.html#bytes "(in Python v3.13)") or [`str`](https://docs.python.org/3.13/library/stdtypes.html#str "(in Python v3.13)") is supplied.
      * **supply_bytes** ([_bool_](https://docs.python.org/3.13/library/functions.html#bool "(in Python v3.13)")) – Call `cb(…)` with a [`bytes`](https://docs.python.org/3.13/library/stdtypes.html#bytes "(in Python v3.13)") argument if true, otherwise [`str`](https://docs.python.org/3.13/library/stdtypes.html#str "(in Python v3.13)").
      * **options** (_Optional_ _[_[_Options_](https://pyjson5.readthedocs.io/en/latest/encoder.html#pyjson5.Options "pyjson5.Options") _]_) – see [`encode(…)`](https://pyjson5.readthedocs.io/en/latest/encoder.html#pyjson5.encode "pyjson5.encode")
      * **options_kw** – see [`encode(…)`](https://pyjson5.readthedocs.io/en/latest/encoder.html#pyjson5.encode "pyjson5.encode")



    Raises: 
        
      * [**Json5EncoderException**](https://pyjson5.readthedocs.io/en/latest/encoder.html#pyjson5.Json5EncoderException "pyjson5.Json5EncoderException") – An exception occured while encoding.
      * [**TypeError**](https://docs.python.org/3.13/library/exceptions.html#TypeError "(in Python v3.13)") – An argument had a wrong type.



    Returns: 
        
The supplied argument `cb`.

    Return type: 
        
    Callable[[Union[[bytes](https://docs.python.org/3.13/library/stdtypes.html#bytes "(in Python v3.13)")|[str](https://docs.python.org/3.13/library/stdtypes.html#str "(in Python v3.13)")]]], None]


```

--------------------------------

### PyJSON5 Encoder Functions

Source: https://pyjson5.readthedocs.io/en/latest/index

Provides functions to serialize Python objects into JSON5 compatible strings or bytes. Supports various output methods including callbacks and file objects, with customizable options.

```python
encode(data, *[, options])
encode_bytes(data, *[, options])
encode_callback(data, cb[, supply_bytes, ...])
encode_io(data, fp[, supply_bytes, options])
encode_noop(data, *[, options])
dump(obj, fp, **kw)
dumps(obj, **kw)
```

--------------------------------

### pyjson5.Json5DecoderException Attributes

Source: https://pyjson5.readthedocs.io/en/latest/decoder

Explains the attributes available on the `Json5DecoderException` class. These attributes provide details about the decoding error, including a human-readable message, the deserialized data up to the error point, and the specific character causing the issue.

```python
Json5DecoderException.message: Human readable error description
Json5DecoderException.result: Deserialized data up until now.
Json5DecoderException.character: Extranous character.
```

--------------------------------

### PyJSON5 Version 1.4.8 Unicode, PyPy, and UTF8 Decoding

Source: https://pyjson5.readthedocs.io/en/latest/changelog

Version 1.4.8 updates Unicode support to 13.0.0, avoids non-standard `__uint128`, adds PyPy compatibility, and includes a `decode_utf8(byte-like)` function.

```python
1.4.8 (2020-12-23)
  * Update up Unicode 13.0.0
  * Don’t use non-standard `__uint128`
  * Add PyPy compatibility
  * Add `decode_utf8(byte-like)`
```

--------------------------------

### PyJSON5 Encoder Functions

Source: https://pyjson5.readthedocs.io/en/latest/genindex

Provides functions for encoding Python objects into JSON5 format. Supports encoding to strings, bytes, I/O streams, and includes callback-based encoding. Also includes a no-operation encoding function.

```python
encode(obj: Any, **kwargs)
encode_bytes(obj: Any, **kwargs)
encode_callback(callback: Callable, **kwargs)
encode_io(fp: BinaryIO, **kwargs)
encode_noop(obj: Any, **kwargs)
```

--------------------------------

### PyJSON5 Version 0.4.6 PyUnicode_AsUTF8AndSize Signature Fix

Source: https://pyjson5.readthedocs.io/en/latest/changelog

Version 0.4.6 corrects the signature for PyUnicode_AsUTF8AndSize().

```python
0.4.6 (2019-02-09)
  * Fix PyUnicode_AsUTF8AndSize()’s signature
```
Tokens:
Raw