Description

[](https://pypi.org/project/json-repair/)  [](https://pypi.org/project/json-repair/) [](https://pepy.tech/projects/json-repair) [](https://github.com/sponsors/mangiucugna) [](https://github.com/mangiucugna/json_repair/stargazers) English | [中文](README.zh.md) This simple package can be used to fix an invalid json string. To know all cases in which this package will work, check out the unit test.  --- # Think about sponsoring this library! This library is free for everyone and it's maintained and developed as a side project so, if you find this library useful for your work, consider becoming a sponsor via this link: https://github.com/sponsors/mangiucugna ## Premium sponsors - [Icana-AI](https://github.com/Icana-AI) Makers of CallCoach, the world's best Call Centre AI Coach. Visit [https://www.icana.ai/](https://www.icana.ai/) - [mjharte](https://github.com/mjharte) --- # Demo If you are unsure if this library will fix your specific problem, or simply want your json validated online, you can visit the demo site on GitHub pages: https://mangiucugna.github.io/json_repair/ Or hear an [audio deepdive generate by Google's NotebookLM](https://notebooklm.google.com/notebook/05312bb3-f6f3-4e49-a99b-bd51db64520b/audio) for an introduction to the module --- # Motivation Some LLMs are a bit iffy when it comes to returning well formed JSON data, sometimes they skip a parentheses and sometimes they add some words in it, because that's what an LLM does. Luckily, the mistakes LLMs make are simple enough to be fixed without destroying the content. I searched for a lightweight python package that was able to reliably fix this problem but couldn't find any. *So I wrote one* # Supported use cases ### Fixing Syntax Errors in JSON - Missing quotes, misplaced commas, unescaped characters, and incomplete key-value pairs. - Missing quotation marks, improperly formatted values (true, false, null), and repairs corrupted key-value structures. ### Repairing Malformed JSON Arrays and Objects - Incomplete or broken arrays/objects by adding necessary elements (e.g., commas, brackets) or default values (null, ""). - The library can process JSON that includes extra non-JSON characters like comments or improperly placed characters, cleaning them up while maintaining valid structure. ### Auto-Completion for Missing JSON Values - Automatically completes missing values in JSON fields with reasonable defaults (like empty strings or null), ensuring validity. # How to use Install the library with pip pip install json-repair then you can use use it in your code like this from json_repair import repair_json good_json_string = repair_json(bad_json_string) # If the string was super broken this will return an empty string You can use this library to completely replace `json.loads()`: import json_repair decoded_object = json_repair.loads(json_string) or just import json_repair decoded_object = json_repair.repair_json(json_string, return_objects=True) ### Avoid this antipattern Some users of this library adopt the following pattern: obj = {} try: obj = json.loads(string) except json.JSONDecodeError as e: obj = json_repair.loads(string) ... This is wasteful because `json_repair` already does that strict `json.loads()` check for you by default. The normal flow is: - try the built-in `json.loads()` / `json.load()` first - if that succeeds, return the decoded object - if that fails, run the repair parser Use the default call unless you explicitly want to skip that initial validation step: ```python import json_repair decoded_object = json_repair.loads(json_string) ``` ### Read json from a file or file descriptor JSON repair provides also a drop-in replacement for `json.load()`: import json_repair try: file_descriptor = open(fname, 'rb') except OSError: ... with file_descriptor: decoded_object = json_repair.load(file_descriptor) and another method to read from a file: import json_repair try: decoded_object = json_repair.from_file(json_file) except OSError: ... except IOError: ... Keep in mind that the library will not catch any IO-related exception and those will need to be managed by you ### Non-Latin characters When working with non-Latin characters (such as Chinese, Japanese, or Korean), you need to pass `ensure_ascii=False` to `repair_json()` in order to preserve the non-Latin characters in the output. Here's an example using Chinese character