Skip to main content

Robust JSON extraction and repair utilities for LLM-generated content.

Project description

🛠️ robust-json

Python Version License: MIT

Robust JSON extraction and repair utilities for LLM-generated content.

Parse JSON from messy LLM outputs with confidence. robust-json extracts and repairs JSON even when models mix commentary with structured data, use incorrect quotes, add trailing commas, include comments, or truncate responses mid-object.


✨ Why robust-json?

Large Language Models are powerful but inconsistent when generating JSON. They might:

  • 📝 Mix text and JSON: Embed JSON inside markdown code blocks or conversational responses
  • 💬 Add comments: Include // or # comments that break standard JSON parsers
  • 🔤 Use wrong quotes: Generate single quotes (') instead of double quotes (")
  • 🔚 Add trailing commas: Place commas after the last item in arrays/objects
  • ✂️ Truncate output: Stop mid-JSON due to token limits or errors

robust-json handles all these cases automatically, so you can focus on using the data instead of fighting with parser errors.


🚀 Features

  • 🔍 Smart extraction: Automatically finds JSON objects and arrays within free-form text
  • 🔧 Auto-repair: Fixes common LLM errors including:
    • Single-quoted strings → double quotes
    • Mixed quote types (e.g., 'text"'text')
    • Inline comments (// and #)
    • Trailing commas
    • Unclosed braces and brackets
  • 🎯 Multiple parsers: Falls back through jsonpyjson5ast.literal_eval for maximum compatibility
  • ⚡ Performance: Optional speedups with re2 (faster regex) and numba (JIT-compiled bracket scanning)
  • 🌍 Unicode support: Handles international characters and emoji seamlessly

📦 Installation

Basic installation:

pip install robust-json-parser

With performance optimizations:

pip install robust-json-parser[speedups]

With JSON5 support:

pip install robust-json-parser[pyjson5]

All extras:

pip install robust-json-parser[speedups,pyjson5]

Requirements: Python 3.9+


🎯 Quick Start

Basic Usage

from robust_json import loads

# LLM output with mixed formatting
llm_response = """
Sure! Here's the data you requested:
```json
{
  "name": "Alice",
  "age": 30,
  "hobbies": ["reading", "coding",],  // trailing comma
  "active": true,  # Python-style comment
}

Hope this helps!
"""

data = loads(llm_response)
print(data)
# {'name': 'Alice', 'age': 30, 'hobbies': ['reading', 'coding'], 'active': True}

Handling Malformed JSON

from robust_json import loads

# Mixed quotes, comments, and Chinese text
message = """
你好,我是招聘顾问。以下是岗位描述,用于你的匹配程度:
```json
{"id": "algo", "position": "大模型算法工程师",
# this is the keywords list used to analyze the candidate
 "keywords": {"positive": ["PEFT", "RLHF"], "negative": ["CNN", "RNN"]}, # negative keywords is supported
 "summary": '候选人具备一定AI背景,但经验不足。"
 }
"""

data = loads(message)
print(data["keywords"]["positive"])
# ['PEFT', 'RLHF']

Truncated/Partial JSON

from robust_json import loads

# JSON cut off mid-object
incomplete = '{"user": {"name": "Bob", "email": "bob@example.com"'

data = loads(incomplete)
print(data)
# {'user': {'name': 'Bob', 'email': 'bob@example.com'}}

Extract Multiple JSON Objects

from robust_json import extract_all, RobustJSONParser

text = """
First result: {"a": 1, "b": 2}
Some text in between...
Second result: {"x": 10, "y": 20}
"""

# Get all extractions with metadata
extractions = extract_all(text)
for extraction in extractions:
    print(f"Found at position {extraction.start}: {extraction.text}")

# Or just get the parsed objects
parser = RobustJSONParser()
objects = parser.parse_all(text)
print(objects)
# [{'a': 1, 'b': 2}, {'x': 10, 'y': 20}]

📚 API Reference

loads(source, *, allow_partial=True, default=None, strict=False)

Parse the first JSON object found in the source text.

Parameters:

  • source (str): Text containing JSON
  • allow_partial (bool): If True, auto-complete truncated JSON (default: True)
  • default (Optional): Return this value if no JSON found (default: None raises error)
  • strict (bool): If True, only extract from code blocks and brace-delimited content (default: False)

Returns: Parsed Python object (dict, list, etc.)

Raises: ValueError if no JSON found and no default provided


extract(source, *, allow_partial=True)

Extract the first JSON-like fragment with metadata.

Returns: Extraction object or None


extract_all(source, *, allow_partial=True)

Extract all JSON-like fragments from text.

Returns: List of Extraction objects


RobustJSONParser

Main parser class for advanced usage.

Methods:

  • extract(source, limit=None): Find JSON fragments (returns list of Extraction objects)
  • parse_first(source): Parse first JSON object (returns parsed object or None)
  • parse_all(source): Parse all JSON objects (returns list of parsed objects)

Parameters:

  • allow_partial (bool): Auto-complete truncated JSON (default: True)
  • strict (bool): Only extract from explicit JSON contexts (default: False)
  • prefer_json5 (bool): Try JSON5 parser before ast.literal_eval (default: True)

Extraction

Dataclass representing an extracted JSON candidate.

Attributes:

  • text (str): The extracted text
  • start (int): Starting position in source
  • end (int): Ending position in source
  • is_partial (bool): Whether the extraction appears truncated
  • repaired (Optional[str]): The repaired version after processing

🔧 How It Works

  1. 🔎 Extraction: Scans text for JSON patterns using:

    • Markdown code blocks (```json ... ```)
    • Brace-balanced regions ({...}, [...])
  2. 🛠️ Repair: Applies fixes in order:

    • Strip // and # comments
    • Fix mixed quote types (e.g., 'text"'text')
    • Normalize single quotes to double quotes
    • Remove trailing commas
    • Balance unclosed braces (if allow_partial=True)
  3. ✅ Parse: Attempts parsing with:

    • json.loads() (standard JSON)
    • pyjson5.decode() (if installed, for JSON5 support)
    • ast.literal_eval() (Python literals)
  4. 📊 Return: Returns first successful parse or continues to next candidate


🎨 Use Cases

  • 🤖 LLM Integration: Parse structured output from ChatGPT, Claude, Llama, etc.
  • 📊 Data Extraction: Extract JSON from logs, documentation, or mixed-format files
  • 🔄 API Responses: Handle malformed API responses gracefully
  • 🧪 Testing: Validate and repair JSON in test fixtures
  • 📝 Data Migration: Clean up inconsistent JSON during migrations

⚡ Performance Tips

  1. Install speedups for large-scale processing:

    pip install robust-json-parser[speedups]
    
  2. Use strict mode when JSON is always in code blocks:

    loads(text, strict=True)  # Faster, skips fallback attempts
    
  3. Disable partial completion if you know JSON is complete:

    loads(text, allow_partial=False)  # Skips brace-balancing step
    
  4. Reuse parser instance for multiple parses:

    parser = RobustJSONParser()
    for text in texts:
        data = parser.parse_first(text)
    

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

Development setup:

git clone https://github.com/callzhang/robust-json.git
cd robust-json
pip install -e ".[speedups,pyjson5,dev]"
pytest tests/

📝 License

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


🙏 Acknowledgments

Built for developers working with LLM-generated content who need reliability without sacrificing flexibility.


Made with ❤️ for the AI/LLM community

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

robust_json_parser-0.1.2.tar.gz (13.5 kB view details)

Uploaded Source

Built Distribution

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

robust_json_parser-0.1.2-py3-none-any.whl (9.5 kB view details)

Uploaded Python 3

File details

Details for the file robust_json_parser-0.1.2.tar.gz.

File metadata

  • Download URL: robust_json_parser-0.1.2.tar.gz
  • Upload date:
  • Size: 13.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.14

File hashes

Hashes for robust_json_parser-0.1.2.tar.gz
Algorithm Hash digest
SHA256 dbe283d7a0681178780f6e01ed6ea96b43fbeb086ff3a3bbfb9b0b576653f951
MD5 70ab0e5bef0c9939274c06caa7a3e11b
BLAKE2b-256 8fa9f3cb91e1c5a4e649cf7ad29117467b8c3cb4d8dc7eb5cf544ea5ba05c687

See more details on using hashes here.

File details

Details for the file robust_json_parser-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for robust_json_parser-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 308ebf6fb2ff2c0b6d26eaec274cc4652a91f8df9010f0b04002a98eed853d75
MD5 35866b8ce0855417644ceb3cf6eb3366
BLAKE2b-256 009b2b79c4f34128563875674ce377cb9e90b68086697728520a6e2d21cfa871

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