README.rst
1pyjson5
2-------
3
4A Python implementation of the JSON5 data format.
5
6`JSON5 <https://github.com/aseemk/json5>`_ extends the
7`JSON <http://www.json.org>`_ data interchange format to make it
8slightly more usable as a configuration language:
9
10* JavaScript-style comments (both single and multi-line) are legal.
11
12* Object keys may be unquoted if they are legal ECMAScript identifiers
13
14* Objects and arrays may end with trailing commas.
15
16* Strings can be single-quoted, and multi-line string literals are allowed.
17
18There are a few other more minor extensions to JSON; see the above page for
19the full details.
20
21This project implements a reader and writer implementation for Python;
22where possible, it mirrors the
23`standard Python JSON API <https://docs.python.org/library/json.html>`_
24package for ease of use.
25
26This is an early release. It has been reasonably well-tested, but it is
27*SLOW*. It can be 1000-6000x slower than the C-optimized JSON module,
28and is 200x slower (or more) than the pure Python JSON module.
29
30Known issues
31------------
32
33* The `cls` keyword argument that json.load()/json.loads() accepts to
34 specify a custom subclass of JSONDecoder is not and will not be supported,
35 because this implementation uses a completely different approach and
36 doesn't have anything like the JSONDecoder and JSONEncoder classes.
37