simple_jsonpath 0.1.2__tar.gz → 0.3.3__tar.gz

{simple_jsonpath-0.1.2 → simple_jsonpath-0.3.3}/.github/workflows/CI.yml

@@ -7,9 +7,6 @@ name: CI
 
 on:
   push:
-    branches:
-      - main
-      - master
     tags:
       - '*'
   pull_request:
@@ -40,7 +37,7 @@ jobs:
       - uses: actions/checkout@v6
       - uses: actions/setup-python@v6
         with:
-          python-version: 3.x
+          python-version: '>=3.10 <3.15'
       - name: Build wheels
         uses: PyO3/maturin-action@v1
         with:
@@ -71,7 +68,7 @@ jobs:
       - uses: actions/checkout@v6
       - uses: actions/setup-python@v6
         with:
-          python-version: 3.x
+          python-version: '>=3.10 <3.15'
       - name: Build wheels
         uses: PyO3/maturin-action@v1
         with:
@@ -103,7 +100,7 @@ jobs:
       - uses: actions/checkout@v6
       - uses: actions/setup-python@v6
         with:
-          python-version: 3.13
+          python-version: '>=3.10 <3.15'
           architecture: ${{ matrix.platform.python_arch }}
       - name: Build wheels
         uses: PyO3/maturin-action@v1
@@ -130,7 +127,7 @@ jobs:
       - uses: actions/checkout@v6
       - uses: actions/setup-python@v6
         with:
-          python-version: 3.x
+          python-version: '>=3.10 <3.15'
       - name: Build wheels
         uses: PyO3/maturin-action@v1
         with:

{simple_jsonpath-0.1.2 → simple_jsonpath-0.3.3}/.gitignore

@@ -70,3 +70,7 @@ docs/_build/
 
 # Pyenv
 .python-version
+
+path.py
+device.json
+ben

{simple_jsonpath-0.1.2 → simple_jsonpath-0.3.3}/Cargo.lock

@@ -231,17 +231,6 @@ dependencies = [
  "syn",
 ]
 
-[[package]]
-name = "pythonize"
-version = "0.28.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0b79f670c9626c8b651c0581011b57b6ba6970bb69faf01a7c4c0cfc81c43f95"
-dependencies = [
- "pyo3",
- "serde",
- "serde_json",
-]
-
 [[package]]
 name = "quote"
 version = "1.0.45"
@@ -427,13 +416,14 @@ dependencies = [
 
 [[package]]
 name = "simple_jsonpath"
-version = "0.1.2"
+version = "0.3.3"
 dependencies = [
  "pyo3",
- "pythonize",
  "rstest",
+ "serde",
  "serde_json",
  "serde_json_path",
+ "serde_json_path_core",
 ]
 
 [[package]]

{simple_jsonpath-0.1.2 → simple_jsonpath-0.3.3}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "simple_jsonpath"
-version = "0.1.2"
+version = "0.3.3"
 edition = "2024"
 readme = "README.md"
 
@@ -12,9 +12,14 @@ crate-type = ["cdylib"]
 [dependencies]
 pyo3 = { version = "0.28.2", features = ["serde"] }
 serde_json_path = { git = "https://github.com/seojumper/serde_json_path.git", branch = "quotes" }
+serde_json_path_core = { git = "https://github.com/seojumper/serde_json_path.git", branch = "quotes" }
 serde_json = "1.0.149"
-pythonize = { version = "0.28.0", features = ["serde_json"] }
+serde = { version = "1.0.228", features = ["derive"] }
 
 
 [dev-dependencies]
 rstest = "0.26.1"
+
+[profile.release]
+lto = true
+codegen-units = 1

simple_jsonpath-0.3.3/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2026 Jeremy Spencer
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

simple_jsonpath-0.3.3/PKG-INFO

@@ -0,0 +1,324 @@
+Metadata-Version: 2.4
+Name: simple_jsonpath
+Version: 0.3.3
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+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
+Author-email: Jeremy Spencer <seojumper@gmail.com>
+License-Expression: MIT
+Requires-Python: >=3.10, <3.15
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Homepage, https://github.com/seojumper/simple_jsonpath
+
+# simple_jsonpath
+
+## Installation
+
+```bash
+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.
+
+## Use
+
+This module exposes a single simple type - a ***JsonPath*** which has two methods after instantiation.
+
+- ***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
+
+### 'Find' Example
+
+```python
+from simple_jsonpath import JsonPath
+
+
+json_data = {
+    "address": {
+        "prefix-list": [
+            {
+                "prefix": "2001:db8::1/64",
+                "eui-64": [
+                    None
+                ]
+            }
+        ],
+        "link-local-address": [
+            {
+                "address": "fe80::1",
+                "link-local": [
+                    None
+                ]
+            }
+        ]
+    }
+}
+
+# Instantiates the primary class
+finder = JsonPath()
+
+# Sets the data that is desired to be queried against
+finder.set_data(json_data)
+
+# A path is provided to query against the 'set' data.  The path is internally parsed > used to qeury against the 'set' dataset.
+# Notice that this implementaion allows for escaping of specials characters shorthand path syntax with single or double quotes
+results = finder.find("$.address.'prefix-list'[*].prefix")
+
+for data in results:
+    # Access the found node. 
+    print(f"{data}")
+    # 2001:db8::1/64
+
+```
+
+The inner implementation stores previously parsed 'paths'. This allows repeatedly used paths to bypass the parsing step invovled.
+
+This is ideal for situations where multiple similar JSON documents will be searched in succession.
+
+The same ***JsonPath*** object can then be reused with new data sets by calling ***set_data()*** on it again, and any previously parsed paths by the object will be retained.
+
+Only when moving onto data of differing structure would it be potentially advisable to instantiate a new ***JsonPath*** object.
+
+### 'Find Located' Example
+
+```python
+from simple_jsonpath import JsonPath, LocatedNode
+
+
+json_data = {
+    "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
+                        ]
+                    }
+                ]
+            }
+        }
+    ]
+}
+
+# Instantiates the primary class
+finder = JsonPath()
+
+# Sets the data that is desired to be queried against
+finder.set_data(json_data)
+
+# Now we are interested in the path information where matches were found as well as the data
+results: list[LocatedNode] = finder.find_located("$.items[*].address.'prefix-list'[*].prefix")
+
+# Iterate through each found LocatedNode object
+for data in results:
+
+    # Print the normalized full path where the node was found
+    print(f"{data.full_path}")
+    # $['items'][0]['address']['prefix-list'][0]['prefix']
+
+    # 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])}")
+    # $, items, 0, adddress, prefix-list, 0, prefix
+
+    # Access the found node. 
+    print(f"{data.node}")
+    # 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)
+
+```
+