Skip to main content

A wrapper to JSON parsers allowing comments, multiline strings and trailing commas

Project description

A wrapper to JSON parsers allowing comments, multiline strings and trailing commas


Dependencies

Python 2.7, 3.3

Optional

ujson 1.30+


Description

JSON Comment allows to parse JSON files or strings with:

  • Single and Multi line comments
  • Multi line data strings
  • Trailing commas in objects and arrays, after the last item

This package works with any JSON parser which supports:

  • load(fp, ...) to parse files
  • loads(s, ...) to parse strings

by adding a preprocessor to these calls.


Comments

  • # and ; are for single line comments
  • /* and */ enclose multiline comments

Inline comments are not supported


Multiline strings

Any string can be multiline, even object keys.

  • Multiline strings start and end with """, like in python
  • The preprocessor merges all lines to a single JSON standard string
  • A single trailing space per line is kept, if present
  • New line is not kept. To hard code new lines in the string, use \\n

Install

pip install jsoncomment

OR

  • Download source
  • python setup.py install

Usage

import json
from jsoncomment import JsonComment

string = "[]"
parser = JsonComment(json)
parsed_object = parser.loads(string)

Examples

Added in the /examples directory


Limitations

  • #, ; and /* may be preceded only by whitespaces or tabs on the same line
  • */ may be followed only by whitespaces or tabs on the same line
  • The trailing comma must be the last character on the same line

Source

Source code available with MIT license on Bitbucket.


API

Added in top level __init__.py

How to read the API

API is split in:

* `User Interface` for common use
* `Developer Interface` exposing some internals that could be useful

For each item ( function or class ), there are 2 blocks of comments, above and below item definition:

* The top describes the return values
* The bottom describes the item and call variables

If call variables have defaults or use duck typing, every allowed value is described

Example:

# return_value
    # description
from .some_module import SomeClass
    # SomeClass description
# (
    # variable_1,
        # description
    # variable_2 = something,
        # description

        # = Default
            # description of default value ( something )
        # = something_2
            # description of alternate form ( duck typing )
# )

describes return_value = SomeClass(variable_1, variable_2 = current_value)


Contact

Dando Real ITA @ Steam Profile

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
jsoncomment-0.3.0.win32.exe (206.2 kB) Copy SHA256 hash SHA256 Windows Installer any
jsoncomment-0.3.0.win-amd64.exe (237.5 kB) Copy SHA256 hash SHA256 Windows Installer any
jsoncomment-0.3.0.zip (13.5 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page