json-repair 0.29.2__py3-none-any.whl → 0.29.3__py3-none-any.whl

json_repair/string_file_wrapper.py

@@ -0,0 +1,98 @@
+import os
+from typing import TextIO, Union
+
+
+class StringFileWrapper:
+    # This is a trick to simplify the code, transform the filedescriptor handling into a string handling
+    def __init__(self, fd: TextIO, CHUNK_LENGTH: int) -> None:
+        """
+        Initialize the StringFileWrapper with a file descriptor and chunk length.
+
+        Args:
+            fd (TextIO): The file descriptor to wrap.
+            CHUNK_LENGTH (int): The length of each chunk to read from the file.
+
+        Attributes:
+            fd (TextIO): The wrapped file descriptor.
+            length (int): The total length of the file content.
+            buffers (dict[int, str]): Dictionary to store chunks of file content.
+            buffer_length (int): The length of each buffer chunk.
+        """
+        self.fd = fd
+        self.length: int = 0
+        # Buffers are 1MB strings that are read from the file
+        # and kept in memory to keep reads low
+        self.buffers: dict[int, str] = {}
+        # CHUNK_LENGTH is in bytes
+        if not CHUNK_LENGTH or CHUNK_LENGTH < 2:
+            CHUNK_LENGTH = 1_000_000
+        self.buffer_length = CHUNK_LENGTH
+
+    def get_buffer(self, index: int) -> str:
+        """
+        Retrieve or load a buffer chunk from the file.
+
+        Args:
+            index (int): The index of the buffer chunk to retrieve.
+
+        Returns:
+            str: The buffer chunk at the specified index.
+        """
+        if self.buffers.get(index) is None:
+            self.fd.seek(index * self.buffer_length)
+            self.buffers[index] = self.fd.read(self.buffer_length)
+            # Save memory by keeping max 2MB buffer chunks and min 2 chunks
+            if len(self.buffers) > max(2, 2_000_000 / self.buffer_length):
+                oldest_key = next(iter(self.buffers))
+                if oldest_key != index:
+                    self.buffers.pop(oldest_key)
+        return self.buffers[index]
+
+    def __getitem__(self, index: Union[int, slice]) -> str:
+        """
+        Retrieve a character or a slice of characters from the file.
+
+        Args:
+            index (Union[int, slice]): The index or slice of characters to retrieve.
+
+        Returns:
+            str: The character(s) at the specified index or slice.
+        """
+        # The buffer is an array that is seek like a RAM:
+        # self.buffers[index]: the row in the array of length 1MB, index is `i` modulo CHUNK_LENGTH
+        # self.buffures[index][j]: the column of the row that is `i` remainder CHUNK_LENGTH
+        if isinstance(index, slice):
+            buffer_index = index.start // self.buffer_length
+            buffer_end = index.stop // self.buffer_length
+            if buffer_index == buffer_end:
+                return self.get_buffer(buffer_index)[
+                    index.start % self.buffer_length : index.stop % self.buffer_length
+                ]
+            else:
+                start_slice = self.get_buffer(buffer_index)[
+                    index.start % self.buffer_length :
+                ]
+                end_slice = self.get_buffer(buffer_end)[
+                    : index.stop % self.buffer_length
+                ]
+                middle_slices = [
+                    self.get_buffer(i) for i in range(buffer_index + 1, buffer_end)
+                ]
+                return start_slice + "".join(middle_slices) + end_slice
+        else:
+            buffer_index = index // self.buffer_length
+            return self.get_buffer(buffer_index)[index % self.buffer_length]
+
+    def __len__(self) -> int:
+        """
+        Get the total length of the file.
+
+        Returns:
+            int: The total number of characters in the file.
+        """
+        if self.length < 1:
+            current_position = self.fd.tell()
+            self.fd.seek(0, os.SEEK_END)
+            self.length = self.fd.tell()
+            self.fd.seek(current_position)
+        return self.length

{json_repair-0.29.2.dist-info → json_repair-0.29.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: json_repair
-Version: 0.29.2
+Version: 0.29.3
 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.3.dist-info/RECORD

@@ -0,0 +1,13 @@
+json_repair/__init__.py,sha256=IIzSm1DsCRrr8seF3UeMZXwxcq-tE3j-8d1WBxvEJvE,178
+json_repair/__main__.py,sha256=EsJb-y89uZEvGQQg1GdIDWzfDwfOMvVekKEtdguQXCM,67
+json_repair/json_context.py,sha256=MOzT0z4Pc03SWhggwwEpDNXyeHm04kLfvDBOBd3xkVU,1782
+json_repair/json_parser.py,sha256=Gimn0LFUTpdGCFo9rOGjH3W39PEj00_Lrj4mPOSnBFU,25949
+json_repair/json_repair.py,sha256=GTg3OAXRbAJAHWs8oiQDqUHh4h6qKDVvWPXcrqafzLY,6100
+json_repair/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+json_repair/string_file_wrapper.py,sha256=EHLhNBWoyUitzT08thytYJiNZh_klEFwfT8zutPSdb4,3905
+json_repair-0.29.3.dist-info/LICENSE,sha256=wrjQo8MhNrNCicXtMe3MHmS-fx8AmQk1ue8AQwiiFV8,1076
+json_repair-0.29.3.dist-info/METADATA,sha256=tQ_crOtYbu3fseCXoc-VDIHIJq0HtGRA9SvmCIldvUE,10686
+json_repair-0.29.3.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+json_repair-0.29.3.dist-info/entry_points.txt,sha256=SNfge3zPSP-ASqriYU9r3NAPaXdseYr7ciPMKdV2uSw,57
+json_repair-0.29.3.dist-info/top_level.txt,sha256=7-VZwZN2CgB_n0NlSLk-rEUFh8ug21lESbsblOYuZqw,12
+json_repair-0.29.3.dist-info/RECORD,,

{json_repair-0.29.2.dist-info → json_repair-0.29.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (74.1.2)
+Generator: setuptools (75.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

json_repair-0.29.2.dist-info/RECORD

@@ -1,10 +0,0 @@
-json_repair/__init__.py,sha256=IIzSm1DsCRrr8seF3UeMZXwxcq-tE3j-8d1WBxvEJvE,178
-json_repair/__main__.py,sha256=EsJb-y89uZEvGQQg1GdIDWzfDwfOMvVekKEtdguQXCM,67
-json_repair/json_repair.py,sha256=anGQI5RxauBnZUO9QKoPU7JgN_sUaIddyiR4ecpMmm8,34060
-json_repair/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-json_repair-0.29.2.dist-info/LICENSE,sha256=wrjQo8MhNrNCicXtMe3MHmS-fx8AmQk1ue8AQwiiFV8,1076
-json_repair-0.29.2.dist-info/METADATA,sha256=Jtwl047L79Xj0CmA363Xc2EemzttgMWqYW0abi4a7fA,9787
-json_repair-0.29.2.dist-info/WHEEL,sha256=cVxcB9AmuTcXqmwrtPhNK88dr7IR_b6qagTj0UvIEbY,91
-json_repair-0.29.2.dist-info/entry_points.txt,sha256=SNfge3zPSP-ASqriYU9r3NAPaXdseYr7ciPMKdV2uSw,57
-json_repair-0.29.2.dist-info/top_level.txt,sha256=7-VZwZN2CgB_n0NlSLk-rEUFh8ug21lESbsblOYuZqw,12
-json_repair-0.29.2.dist-info/RECORD,,