simple_jsonpath 0.2.2__tar.gz → 0.4.2__tar.gz

{simple_jsonpath-0.2.2 → simple_jsonpath-0.4.2}/.gitignore

@@ -72,4 +72,6 @@ docs/_build/
 .python-version
 
 path.py
-device.json
+device.json
+ben
+uv.lock

{simple_jsonpath-0.2.2 → simple_jsonpath-0.4.2}/Cargo.lock

@@ -2,6 +2,18 @@
 # It is not intended for manual editing.
 version = 4
 
+[[package]]
+name = "ahash"
+version = "0.8.12"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5a15f179cd60c4584b8a8c596927aadc462e27f2ca70c04e0071964a73ba7a75"
+dependencies = [
+ "cfg-if",
+ "once_cell",
+ "version_check",
+ "zerocopy",
+]
+
 [[package]]
 name = "aho-corasick"
 version = "1.1.4"
@@ -11,6 +23,18 @@ dependencies = [
  "memchr",
 ]
 
+[[package]]
+name = "bitflags"
+version = "2.11.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "843867be96c8daad0d758b57df9392b6d8d271134fce549de6ce169ff98a92af"
+
+[[package]]
+name = "byteorder"
+version = "1.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1fd0f2584146f6f2ef48085050886acf353beff7305ebd1ae69500e27c67f64b"
+
 [[package]]
 name = "cfg-if"
 version = "1.0.4"
@@ -108,12 +132,27 @@ version = "1.0.17"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "92ecc6618181def0457392ccd0ee51198e065e016d1d527a7ac1b6dc7c1f09d2"
 
+[[package]]
+name = "lazy_static"
+version = "1.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "bbd2bcb4c963f2ddae06a2efc7e9f3591312473c50c6685e1f298068316e66fe"
+
 [[package]]
 name = "libc"
 version = "0.2.183"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "b5b646652bf6661599e1da8901b3b9522896f01e736bad5f723fe7a3a27f899d"
 
+[[package]]
+name = "lock_api"
+version = "0.4.14"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "224399e74b87b5f3557511d98dff8b14089b3dadafcab6bb93eab67d3aace965"
+dependencies = [
+ "scopeguard",
+]
+
 [[package]]
 name = "memchr"
 version = "2.8.0"
@@ -142,6 +181,29 @@ version = "1.21.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
 
+[[package]]
+name = "parking_lot"
+version = "0.12.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "93857453250e3077bd71ff98b6a65ea6621a19bb0f559a85248955ac12c45a1a"
+dependencies = [
+ "lock_api",
+ "parking_lot_core",
+]
+
+[[package]]
+name = "parking_lot_core"
+version = "0.9.12"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2621685985a2ebf1c516881c026032ac7deafcda1a2c9b7850dc81e3dfcb64c1"
+dependencies = [
+ "cfg-if",
+ "libc",
+ "redox_syscall",
+ "smallvec",
+ "windows-link",
+]
+
 [[package]]
 name = "pin-project-lite"
 version = "0.2.17"
@@ -240,6 +302,15 @@ dependencies = [
  "proc-macro2",
 ]
 
+[[package]]
+name = "redox_syscall"
+version = "0.5.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ed2bf2547551a7053d6fdfafda3f938979645c44812fbfcda098faae3f1a362d"
+dependencies = [
+ "bitflags",
+]
+
 [[package]]
 name = "regex"
 version = "1.12.3"
@@ -319,6 +390,12 @@ version = "1.0.22"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "b39cdef0fa800fc44525c84ccb54a029961a8215f9619753635a9c0d2538d46d"
 
+[[package]]
+name = "scopeguard"
+version = "1.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "94143f37725109f92c262ed2cf5e59bce7498c01bcc1502d7b9afe439a4e9f49"
+
 [[package]]
 name = "semver"
 version = "1.0.27"
@@ -416,7 +493,7 @@ dependencies = [
 
 [[package]]
 name = "simple_jsonpath"
-version = "0.2.2"
+version = "0.4.2"
 dependencies = [
  "pyo3",
  "rstest",
@@ -424,6 +501,7 @@ dependencies = [
  "serde_json",
  "serde_json_path",
  "serde_json_path_core",
+ "ustr",
 ]
 
 [[package]]
@@ -432,6 +510,12 @@ version = "0.4.12"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "0c790de23124f9ab44544d7ac05d60440adc586479ce501c1d6d7da3cd8c9cf5"
 
+[[package]]
+name = "smallvec"
+version = "1.15.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "67b1b7a3b5fe4f1376887184045fcf45c69e92af734b7aaddc05fb777b6fbd03"
+
 [[package]]
 name = "syn"
 version = "2.0.117"
@@ -505,6 +589,30 @@ version = "1.0.24"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75"
 
+[[package]]
+name = "ustr"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "18b19e258aa08450f93369cf56dd78063586adf19e92a75b338a800f799a0208"
+dependencies = [
+ "ahash",
+ "byteorder",
+ "lazy_static",
+ "parking_lot",
+]
+
+[[package]]
+name = "version_check"
+version = "0.9.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0b928f33d975fc6ad9f86c8f283853ad26bdd5b10b7f1542aa2fa15e2289105a"
+
+[[package]]
+name = "windows-link"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f0805222e57f7521d6a62e36fa9163bc891acd422f971defe97d64e70d0a4fe5"
+
 [[package]]
 name = "winnow"
 version = "0.7.15"
@@ -514,6 +622,26 @@ dependencies = [
  "memchr",
 ]
 
+[[package]]
+name = "zerocopy"
+version = "0.8.47"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "efbb2a062be311f2ba113ce66f697a4dc589f85e78a4aea276200804cea0ed87"
+dependencies = [
+ "zerocopy-derive",
+]
+
+[[package]]
+name = "zerocopy-derive"
+version = "0.8.47"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0e8bc7269b54418e7aeeef514aa68f8690b8c0489a06b0136e5f57c4c5ccab89"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
 [[package]]
 name = "zmij"
 version = "1.0.21"

{simple_jsonpath-0.2.2 → simple_jsonpath-0.4.2}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "simple_jsonpath"
-version = "0.2.2"
+version = "0.4.2"
 edition = "2024"
 readme = "README.md"
 
@@ -15,7 +15,7 @@ serde_json_path = { git = "https://github.com/seojumper/serde_json_path.git", br
 serde_json_path_core = { git = "https://github.com/seojumper/serde_json_path.git", branch = "quotes" }
 serde_json = "1.0.149"
 serde = { version = "1.0.228", features = ["derive"] }
-
+ustr = "1.1.0"
 
 [dev-dependencies]
 rstest = "0.26.1"

{simple_jsonpath-0.2.2 → simple_jsonpath-0.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simple_jsonpath
-Version: 0.2.2
+Version: 0.4.2
 Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: Implementation :: CPython
@@ -11,6 +11,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: orjson>=3.11.7
 License-File: LICENSE
 Summary: A simple - yet quick - JSONPath implementation for querying JSON data.
 Keywords: jsonpath
@@ -30,7 +31,8 @@ pip install simple_jsonpath
 
 ## About
 
-This module is a JSONPath [RFC9535 - JSONPath: Query Expressions for JSON](https://datatracker.ietf.org/doc/html/rfc9535) utility library.
+This module is a JSONPath [RFC9535 - JSONPath: Query Expressions for JSON](https://datatracker.ietf.org/doc/html/rfc9535) utility library that supports performing querying for data in a JSON document.  It does **NOT** supporting modifying data
+in place.
 
 ## Use
 
@@ -39,6 +41,29 @@ This module exposes a single simple type - a ***JsonPath*** which has two method
 - ***set_data()***: sets the data that will be queried against. If multiple queries will be performed against a single piece of JSON data, this helps with the type conversion cost involved. This function can be called with providing new data whenever the inner data held is wished to be changed while retaining already complied paths (useful for querying multiple similarly structured documents).
 - ***find()***: given a path that is wished to be found in the previously set data, this function will perform the query logic. Mulitple calls to **find()** will query against the previously 'set' data.
 - ***find_located()***: given a path that is wished to be found in the previously set data, this function can return a list of ***LocatedNode*** objects.  Each ***LocatedNode*** object will have attributes related to the path where the node was located as well as their corresponding data. This method is slower than ***find()***, so should ideally only be used when path information for the found nodes is needed.
+- ***child()***: spawns a child instance of the ***JsonPath*** object that does not inherit its data, but maintains shared mutable access to the collection of
+compiled paths.
+
+## Child behavior
+
+When the ***child()*** method is invoked, a child will be spawned from the current instance of the ***JsonPath*** object.
+
+The child will not inherit the data from the parent, so a call to ***set_data()*** needa to be called on it for it to function.
+
+It does however retain shared mutable access to the parent's collection of pre-parsed path objects which is shared across all spawned children.
+
+This is useful for the pattern of:
+
+1. Searching a document for a path query.
+
+2. Then using those results returned as the basis of a new 'root element' for 'deeper' searches into a document.
+
+Instead of assigning the query results to current instance, it can be beneficial to spawn a child for each result, and assign the result
+data to the child or multiple children if more than one query result was returned.
+
+With this pattern the 'base' parent object will automatically contain all parsed paths for the document that were searched by any descendant instance spawned from it, and children will have access to updates to the 'base' instance that any of their siblings make.
+
+Then the 'base' parent object can be efficiently used on the next similarly structured document as all previously complied queries against the document are retained.
 
 ## Examples
 
@@ -158,12 +183,16 @@ results: list[LocatedNode] = finder.find_located("$.items[*].address.'prefix-lis
 for data in results:
 
     # Print the normalized full path where the node was found
-    print(f"{data.full_path}")
+    print(f"{data.path}")
     # $['items'][0]['address']['prefix-list'][0]['prefix']
 
+    # Print the normalized full path of the parent where the node was found
+    print(f"{data.parent_path}")
+    # $['items'][0]['address']['prefix-list'][0]
+
     # Iterate over the components of the found path
     # Returned elements will either be a 'str' for keys or 'int' for index values
-    print(f"{', '.join([str(component) for component in data.path_components])}")
+    print(f"{', '.join([str(component) for component in data.path])}")
     # $, items, 0, adddress, prefix-list, 0, prefix
 
     # Access the found node. 
@@ -171,3 +200,130 @@ for data in results:
     # 2001:db8::1/64
 ```
 
+### 'Child' Example
+
+The child pattern can be useful for speeding up processing of multiple similarly structured documents to avoid overhead
+of parsing the same query strings many times.  Children are independent objects from the 'base' instancee, and children
+can also spawn their own children.
+
+```python
+from simple_jsonpath import JsonPath
+
+
+json_data_1 = {
+    "items": [
+        {
+            "address": {
+                "prefix-list": [
+                    {
+                        "prefix": "2001:db8::1/64",
+                        "eui-64": [
+                            None
+                        ]
+                    }
+                ],
+                "link-local-address": [
+                    {
+                        "address": "fe80::1",
+                        "link-local": [
+                            None
+                        ]
+                    }
+                ]
+            }
+        },
+        {
+            "address": {
+                "prefix-list": [
+                    {
+                        "prefix": "2001:db8::1/64",
+                        "eui-64": [
+                            None
+                        ]
+                    }
+                ],
+                "link-local-address": [
+                    {
+                        "address": "fe80::1",
+                        "link-local": [
+                            None
+                        ]
+                    }
+                ]
+            }
+        }
+    ]
+}
+
+json_data_2 = {
+    "items": [
+        {
+            "address": {
+                "prefix-list": [
+                    {
+                        "prefix": "2001:db8::2/64",
+                        "eui-64": [
+                            None
+                        ]
+                    }
+                ]
+            }
+        },
+        {
+            "address": {
+                "prefix-list": [
+                    {
+                        "prefix": "2001:db8::2/64",
+                        "eui-64": [
+                            None
+                        ]
+                    }
+                ]
+            }
+        }
+    ]
+}
+
+def process_document(data, finder: JsonPath)
+    # The 'base' instance was instantiated outside of this fn below.
+
+    # Sets the data that is desired to be queried against
+    finder.set_data(json_data)
+
+    # Search for interested data. This pattern will be cached in the base instance, which will
+    # then be availble to all descendents of the base instance.
+    results: list[Any] = finder.find("$.items[*]")
+
+    # Iterate through each found result
+    for data in results:
+        # Spwn a child for each result
+        child = finder.child()
+        # Set the result data for the child
+        child.set_data(data)
+
+        # The first child that requests to find a pattern that has not yet been seen by the 'base' instance
+        # will parse the pattern and insert it into the 'base' instance's cache of compiled patterns.
+        #
+        # The 'base' instance now has the pre-compiled pattern should it need to search for it.
+        # 
+        # All descendants of the 'base' instance now have access to the pre-compiled pattern to include
+        # the child that will be spawned on the next iteration of this loop which will allow it to
+        # process its own searches faster.
+        results = child.find("$.address.'prefix-list'[*]")
+
+        # .... further procesing....
+all_documents = [json_data_1, json_data_2]
+
+# create a single base JsonPath
+finder = JsonPath()
+
+for document in all_documents:
+    # For each document that will be processed known to be similar in structure > pass in the same 'base' instance.
+    #
+    # By the time it has processed the first document (depending on how deep either iteself, or its child instnaces were able to traverse the document)
+    # some/most/all of the possible paths that will need to be compiled have been. Which makes processing the next document in the series
+    # quicker.
+    process_document(document, finder)
+
+```
+