Skip to main content

Triple-JSON5 parser for Python

Project description

TJSON5 Parser

A high-performance Python parser for Triple-JSON5 (TJSON5) files implemented in Cython.

Features

  • Parses TJSON5 files into Python objects
  • Supports all standard JSON5 features:
    • Comments (single and multi-line)
    • Trailing commas in objects and arrays
    • Unquoted object keys
  • Triple-JSON5 extensions:
    • Triple-quoted strings (""") for multi-line text without escaping
    • Hexadecimal number literals (0xFF)
    • Binary number literals (0b1010)

Installation

# Install from source
git clone https://github.com/kristofmulier/triple-json5.git
cd triple-json5/python_tjson5
pip install -e .

Usage

import tjson5parser

# Parse a TJSON5 string
data = tjson5parser.parse("""
{
    // This is a comment
    name: "TJSON5 Example",
    description: """
        This is a multi-line
        description using triple quotes
    """,
    values: [1, 2, 0xFF, 0b1010,], // Trailing comma is allowed
}
""")

print(data["name"])  # "TJSON5 Example"
print(data["values"])  # [1, 2, 255, 10]

# Read from a file
with open("config.tjson5", "r") as f:
    config = tjson5parser.load(f)

# Write to JSON (standard JSON format)
with open("output.json", "w") as f:
    tjson5parser.dump(data, f, indent=2)

Building the Extension

# Install development dependencies
pip install cython

# Build the extension in place
python setup.py build_ext --inplace

# Run tests
python test_tjson5.py

How it Works

The parser uses a multi-stage process:

  1. Preprocesses triple-quoted strings, converting them to standard JSON strings
  2. Converts hex and binary numbers to decimal
  3. Removes comments
  4. Handles trailing commas
  5. Passes the processed JSON to Python's built-in JSON parser

All error positions are mapped back to the original source for accurate error reporting.

Performance

The Cython implementation provides near-native performance, making it suitable for parsing large TJSON5 files quickly.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

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

Source Distribution

tjson5-0.1.5.tar.gz (94.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tjson5-0.1.5-cp312-cp312-win_amd64.whl (47.7 kB view details)

Uploaded CPython 3.12Windows x86-64

File details

Details for the file tjson5-0.1.5.tar.gz.

File metadata

  • Download URL: tjson5-0.1.5.tar.gz
  • Upload date:
  • Size: 94.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for tjson5-0.1.5.tar.gz
Algorithm Hash digest
SHA256 ff0d3eff8a397509b70a002eeea49391a5effe12fcbd4c4d0ee2e26576832ab1
MD5 ac9cab74027f21ccbb5db54cfbaf5ab1
BLAKE2b-256 6f4a9799fb12d3b22a98478855b2fe6f029a374082f8675974a10f1ce628e4af

See more details on using hashes here.

File details

Details for the file tjson5-0.1.5-cp312-cp312-win_amd64.whl.

File metadata

  • Download URL: tjson5-0.1.5-cp312-cp312-win_amd64.whl
  • Upload date:
  • Size: 47.7 kB
  • Tags: CPython 3.12, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for tjson5-0.1.5-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 45b12ead7e77a3ec17f20b0b5c3c3e572acb6c1ebd319773421d0fb980a89027
MD5 d6ae7add7e679dc835e8c2620287bd76
BLAKE2b-256 c1a8672b5bf7b0790d090054d5bdaa975d1d9f7a6c593fdfc3f7f0ed8910f466

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page