jsonjsc

A Python library for parsing out C/Javascript style comments in JSON files.

Install

pip install jsonjsc

Features

• Simple and easy to use library with no other dependencies.
• Supports C/JS block (/* */) and single line (//) comments.
• Retains the line number and character column of JSON content after parsing, letting syntax error positions get properly reported by the normal Python JSON decoder.
• Is easily dropped into existing JSON library usage as a decoder class.
• Test backed via unittest.

Python 2

jsonjsc v1.1.2 is the last version to support Python 2.7.

pip install jsonjsc==1.1.2

Example

import json
import jsonjsc

TEST_JSON_DECODER = r'''{
    /*
    This is a test of the JSON decoder in full
    */
    "test1": "message1", // this comment should parse out.

    // "junk1": "message",

    /*
    "junk2": "another message",
    */

    "test2": "message2"
}'''

test = json.loads(TEST_JSON_DECODER, cls=jsonjsc.JSONCommentDecoder)

print(test["test1"])

if "junk1" not in test:
    print("I guess junk1 was commented out?")

if "junk2" not in test:
    print("I guess junk2 was commented out too!")

print(test["test2"])

Development

jsonjsc uses Hatchling as a build backend and flake8 as a style guide.

$ pip install -e .

Hatch is the primary project manager of choice, but any project adhering to PEP 621 (pyproject.toml specification) can be used.

$ hatch shell

Tests

Tests can be ran with pytest. Hatch scripts are included for linting and testing.

# Lint
$ hatch run lint:all

# Test with current Python version
$ hatch run full
# Test with all Python versions
$ hatch run test:full

TODOs

Implementation could probably be sped up significantly as it uses character by character searches to test if comments are in string values or not. No performance metrics have been taken.

License

Licensed under the MIT License. See LICENSE for more information.