json-repair 0.29.2__tar.gz → 0.29.4__tar.gz

{json_repair-0.29.2/src/json_repair.egg-info → json_repair-0.29.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: json_repair
-Version: 0.29.2
+Version: 0.29.4
 Summary: A package to repair broken json strings
 Author-email: Stefano Baccianella <4247706+mangiucugna@users.noreply.github.com>
 License: MIT License
@@ -45,21 +45,6 @@ This simple package can be used to fix an invalid json string. To know all cases
 
 Inspired by https://github.com/josdejong/jsonrepair
 
----
-# How to cite
-If you are using this library in your academic work (as I know many folks are) please find the BibTex here:
-
-    @software{Baccianella_JSON_Repair_-_2024,
-        author = {Baccianella, Stefano},
-        month = aug,
-        title = {{JSON Repair - A python module to repair invalid JSON, commonly used to parse the output of LLMs}},
-        url = {https://github.com/mangiucugna/json_repair},
-        version = {0.28.3},
-        year = {2024}
-    }
-
-Thank you for citing my work and please send me a link to the paper if you can!
-
 ---
 # Offer me a beer
 If you find this library useful, you can help me by donating toward my monthly beer budget here: https://github.com/sponsors/mangiucugna
@@ -79,7 +64,30 @@ I searched for a lightweight python package that was able to reliably fix this p
 
 *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)
@@ -185,6 +193,23 @@ To ensure that you only pin the major version of this library in your `requireme
 
 In this example, any version that starts with `0.` will be acceptable, allowing for updates on minor and patch versions.
 
+---
+# How to cite
+If you are using this library in your academic work (as I know many folks are) please find the BibTex here:
+
+    @software{Baccianella_JSON_Repair_-_2024,
+        author = {Baccianella, Stefano},
+        month = aug,
+        title = {{JSON Repair - A python module to repair invalid JSON, commonly used to parse the output of LLMs}},
+        url = {https://github.com/mangiucugna/json_repair},
+        version = {0.28.3},
+        year = {2024}
+    }
+
+Thank you for citing my work and please send me a link to the paper if you can!
+
+---
+
 # How it works
 This module will parse the JSON file following the BNF definition:
 

{json_repair-0.29.2 → json_repair-0.29.4}/README.md

@@ -7,21 +7,6 @@ This simple package can be used to fix an invalid json string. To know all cases
 
 Inspired by https://github.com/josdejong/jsonrepair
 
----
-# How to cite
-If you are using this library in your academic work (as I know many folks are) please find the BibTex here:
-
-    @software{Baccianella_JSON_Repair_-_2024,
-        author = {Baccianella, Stefano},
-        month = aug,
-        title = {{JSON Repair - A python module to repair invalid JSON, commonly used to parse the output of LLMs}},
-        url = {https://github.com/mangiucugna/json_repair},
-        version = {0.28.3},
-        year = {2024}
-    }
-
-Thank you for citing my work and please send me a link to the paper if you can!
-
 ---
 # Offer me a beer
 If you find this library useful, you can help me by donating toward my monthly beer budget here: https://github.com/sponsors/mangiucugna
@@ -41,7 +26,30 @@ I searched for a lightweight python package that was able to reliably fix this p
 
 *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)
@@ -147,6 +155,23 @@ To ensure that you only pin the major version of this library in your `requireme
 
 In this example, any version that starts with `0.` will be acceptable, allowing for updates on minor and patch versions.
 
+---
+# How to cite
+If you are using this library in your academic work (as I know many folks are) please find the BibTex here:
+
+    @software{Baccianella_JSON_Repair_-_2024,
+        author = {Baccianella, Stefano},
+        month = aug,
+        title = {{JSON Repair - A python module to repair invalid JSON, commonly used to parse the output of LLMs}},
+        url = {https://github.com/mangiucugna/json_repair},
+        version = {0.28.3},
+        year = {2024}
+    }
+
+Thank you for citing my work and please send me a link to the paper if you can!
+
+---
+
 # How it works
 This module will parse the JSON file following the BNF definition:
 

{json_repair-0.29.2 → json_repair-0.29.4}/pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools>=61.0"]
 build-backend = "setuptools.build_meta"
 [project]
 name = "json_repair"
-version = "0.29.2"
+version = "0.29.4"
 license = {file = "LICENSE"}
 authors = [
   { name="Stefano Baccianella", email="4247706+mangiucugna@users.noreply.github.com" },

json_repair-0.29.4/src/json_repair/json_context.py

@@ -0,0 +1,45 @@
+from enum import Enum, auto
+from typing import List, Optional
+
+
+class ContextValues(Enum):
+    OBJECT_KEY = auto()
+    OBJECT_VALUE = auto()
+    ARRAY = auto()
+
+
+class JsonContext:
+    def __init__(self) -> None:
+        self.context: List[ContextValues] = []
+        self.current: Optional[ContextValues] = None
+        self.empty: bool = True
+
+    def set(self, value: ContextValues) -> None:
+        """
+        Set a new context value.
+
+        Args:
+            value (ContextValues): The context value to be added.
+
+        Returns:
+            None
+        """
+        # If a value is provided update the context variable and save in stack
+        if value:
+            self.context.append(value)
+            self.current = value
+            self.empty = False
+
+    def reset(self) -> None:
+        """
+        Remove the most recent context value.
+
+        Returns:
+            None
+        """
+        try:
+            self.context.pop()
+            self.current = self.context[-1]
+        except IndexError:
+            self.current = None
+            self.empty = True