csonpath 0.0.1__tar.gz → 0.0.3__tar.gz

csonpath-0.0.3/PKG-INFO

@@ -0,0 +1,126 @@
+Metadata-Version: 2.4
+Name: csonpath
+Version: 0.0.3
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=8.3.5; extra == "dev"
+Dynamic: license-file
+
+# csonpath
+
+> that's not my path, that's not your path, but csonpath
+
+[![Project Sandbox](https://docs.outscale.com/fr/userguide/_images/Project-Sandbox-yellow.svg)](https://docs.outscale.com/en/userguide/Open-Source-Projects.html)
+
+**csonpath** is a partial [JSONPath](https://goessner.net/articles/JsonPath/) implementation in C, with Python bindings. It allows you to query, update, and remove data from JSON objects using path expressions.
+
+## 🌐 Links
+
+- Project website: https://github.com/outscale/csonpath
+- Join our community on [Discord](https://discord.gg/HUVtY5gT6s)
+
+
+## 📄 Table of Contents
+
+- [Overview](#-overview)
+- [Requirements](#-requirements)
+- [Installation](#-installation)
+- [Configuration](#-configuration)
+- [Usage](#-usage)
+- [Examples](#-examples)
+- [License](#-license)
+- [Contributing](#-contributing)
+
+
+## 🚀 Features
+
+- **Find First**: Retrieve the first value matching a path.
+- **Find All**: Retrieve all values matching a path.
+- **Update or Create**: Update values or create new ones according to the path.
+- **Remove**: Remove values matching a path.
+- **Update or Create Callback**: Update values or create new ones according to the path, using a user-define callback.
+- **Callback**: Call a callback according to the path.
+- **Supports both C (using json-c) and Python objects.**
+
+## ✅ Getting Started
+
+### Prerequisites
+
+- C compiler (gcc/clang)
+- [json-c](https://github.com/json-c/json-c) library for C usage
+- Python 3.x (for Python bindings)
+
+### Build
+
+To build the C tests and examples:
+
+```sh
+make
+```
+
+### Usage (json-c)
+
+See examples in [`tests/json-c/get-a.c`](tests/json-c/get-a.c):
+
+```c
+#include "csonpath_json-c.h"
+
+const char *json_str = "{ \"a\": \"value\", \"array\": [1,2,3] }";
+struct csonpath p;
+struct json_object *jobj = json_tokener_parse(json_str);
+struct json_object *ret;
+
+csonpath_init(&p, "$.a");
+ret = csonpath_find_first(&p, jobj);
+// ret now points to "value"
+```
+
+### Usage (Python)
+
+```python
+import csonpath
+
+d = { "a": "value", "array": [1,2,3] }
+o = csonpath.CsonPath("$.a")
+print(o.find_first(d))  # Output: "value"
+```
+
+#### Avaible methodes:
+- `CsonPath(path)`: create a new csonpath object.
+- `OBJ.find_first(self, json)`: take a json, return first found occurrence.
+- `OBJ.find_all(self, json)`: take a json, return all found occurrence in a list.
+- `OBJ.remove(self, json)`: take a json, remove all found occurrence from it.
+- `OBJ.update_or_create(self, json, value)`: take a json, replace all found occurrence from it, by the value, if doesn't found something, create it.
+- `OBJ.update_or_create_callback(self, json, callback, callback_data)`: take a json, if it doesn't find a parent object, create it, then it calls a callback.
+- `OBJ.callback(self, json, callback, callback_data)`: take a json, call a callback, an all occurrence.
+
+`callback` is a function that take 4 arguments: `parent`, `idx`, `cur_value` and `callback_data`
+
+Check [`tests`](tests/python/) for more examples
+
+### Backends and Direct Usage
+
+csonpath is inspired by JSONPath, but is designed to be backend-agnostic: it can work with any C library or environment that manipulates array, object, and scalar types—not just JSON. Out of the box, backends for Python and json-c are provided, but you can create your own backend for other formats such as YAML, or any custom data structure.
+
+To use csonpath with a different data type or library, simply define the required macros and types in a header file (similar to `csonpath_json-c.h` or `csonpath_python.c`), then include your backend header before `csonpath.h`. This approach allows you to adapt csonpath for manipulating data in any format that supports array/object semantics, giving you full flexibility beyond just JSON.
+
+## Directory Structure
+
+- `csonpath.h`, `csonpath_do.h` - Main implementation files
+- `csonpath_json-c.h` - Json-C implementation, use it by including "csonpath_json-c.h" directly in your source
+- `csonpath_python.c` - python implementation, use it like a python lib (so `pip install .`)
+- `tests/` - Contains tests
+- `bench//` - Some benchmarks
+
+## 🤝 Contributing
+
+We welcome contributions!
+
+Please read our [Contributing Guidelines](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md) before submitting a pull request.
+
+Feel free to open issues or pull requests!
+
+## 📜 License
+BSD 3-Clause. See [LICENSE](LICENSE).
+

{csonpath-0.0.1 → csonpath-0.0.3}/README.md

@@ -69,8 +69,6 @@ ret = csonpath_find_first(&p, jobj);
 
 ### Usage (Python)
 
-Check [`dump-test.py`](dump-test.py) for examples:
-
 ```python
 import csonpath
 
@@ -79,6 +77,19 @@ o = csonpath.CsonPath("$.a")
 print(o.find_first(d))  # Output: "value"
 ```
 
+#### Avaible methodes:
+- `CsonPath(path)`: create a new csonpath object.
+- `OBJ.find_first(self, json)`: take a json, return first found occurrence.
+- `OBJ.find_all(self, json)`: take a json, return all found occurrence in a list.
+- `OBJ.remove(self, json)`: take a json, remove all found occurrence from it.
+- `OBJ.update_or_create(self, json, value)`: take a json, replace all found occurrence from it, by the value, if doesn't found something, create it.
+- `OBJ.update_or_create_callback(self, json, callback, callback_data)`: take a json, if it doesn't find a parent object, create it, then it calls a callback.
+- `OBJ.callback(self, json, callback, callback_data)`: take a json, call a callback, an all occurrence.
+
+`callback` is a function that take 4 arguments: `parent`, `idx`, `cur_value` and `callback_data`
+
+Check [`tests`](tests/python/) for more examples
+
 ### Backends and Direct Usage
 
 csonpath is inspired by JSONPath, but is designed to be backend-agnostic: it can work with any C library or environment that manipulates array, object, and scalar types—not just JSON. Out of the box, backends for Python and json-c are provided, but you can create your own backend for other formats such as YAML, or any custom data structure.

csonpath-0.0.3/csonpath.egg-info/PKG-INFO

@@ -0,0 +1,126 @@
+Metadata-Version: 2.4
+Name: csonpath
+Version: 0.0.3
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=8.3.5; extra == "dev"
+Dynamic: license-file
+
+# csonpath
+
+> that's not my path, that's not your path, but csonpath
+
+[![Project Sandbox](https://docs.outscale.com/fr/userguide/_images/Project-Sandbox-yellow.svg)](https://docs.outscale.com/en/userguide/Open-Source-Projects.html)
+
+**csonpath** is a partial [JSONPath](https://goessner.net/articles/JsonPath/) implementation in C, with Python bindings. It allows you to query, update, and remove data from JSON objects using path expressions.
+
+## 🌐 Links
+
+- Project website: https://github.com/outscale/csonpath
+- Join our community on [Discord](https://discord.gg/HUVtY5gT6s)
+
+
+## 📄 Table of Contents
+
+- [Overview](#-overview)
+- [Requirements](#-requirements)
+- [Installation](#-installation)
+- [Configuration](#-configuration)
+- [Usage](#-usage)
+- [Examples](#-examples)
+- [License](#-license)
+- [Contributing](#-contributing)
+
+
+## 🚀 Features
+
+- **Find First**: Retrieve the first value matching a path.
+- **Find All**: Retrieve all values matching a path.
+- **Update or Create**: Update values or create new ones according to the path.
+- **Remove**: Remove values matching a path.
+- **Update or Create Callback**: Update values or create new ones according to the path, using a user-define callback.
+- **Callback**: Call a callback according to the path.
+- **Supports both C (using json-c) and Python objects.**
+
+## ✅ Getting Started
+
+### Prerequisites
+
+- C compiler (gcc/clang)
+- [json-c](https://github.com/json-c/json-c) library for C usage
+- Python 3.x (for Python bindings)
+
+### Build
+
+To build the C tests and examples:
+
+```sh
+make
+```
+
+### Usage (json-c)
+
+See examples in [`tests/json-c/get-a.c`](tests/json-c/get-a.c):
+
+```c
+#include "csonpath_json-c.h"
+
+const char *json_str = "{ \"a\": \"value\", \"array\": [1,2,3] }";
+struct csonpath p;
+struct json_object *jobj = json_tokener_parse(json_str);
+struct json_object *ret;
+
+csonpath_init(&p, "$.a");
+ret = csonpath_find_first(&p, jobj);
+// ret now points to "value"
+```
+
+### Usage (Python)
+
+```python
+import csonpath
+
+d = { "a": "value", "array": [1,2,3] }
+o = csonpath.CsonPath("$.a")
+print(o.find_first(d))  # Output: "value"
+```
+
+#### Avaible methodes:
+- `CsonPath(path)`: create a new csonpath object.
+- `OBJ.find_first(self, json)`: take a json, return first found occurrence.
+- `OBJ.find_all(self, json)`: take a json, return all found occurrence in a list.
+- `OBJ.remove(self, json)`: take a json, remove all found occurrence from it.
+- `OBJ.update_or_create(self, json, value)`: take a json, replace all found occurrence from it, by the value, if doesn't found something, create it.
+- `OBJ.update_or_create_callback(self, json, callback, callback_data)`: take a json, if it doesn't find a parent object, create it, then it calls a callback.
+- `OBJ.callback(self, json, callback, callback_data)`: take a json, call a callback, an all occurrence.
+
+`callback` is a function that take 4 arguments: `parent`, `idx`, `cur_value` and `callback_data`
+
+Check [`tests`](tests/python/) for more examples
+
+### Backends and Direct Usage
+
+csonpath is inspired by JSONPath, but is designed to be backend-agnostic: it can work with any C library or environment that manipulates array, object, and scalar types—not just JSON. Out of the box, backends for Python and json-c are provided, but you can create your own backend for other formats such as YAML, or any custom data structure.
+
+To use csonpath with a different data type or library, simply define the required macros and types in a header file (similar to `csonpath_json-c.h` or `csonpath_python.c`), then include your backend header before `csonpath.h`. This approach allows you to adapt csonpath for manipulating data in any format that supports array/object semantics, giving you full flexibility beyond just JSON.
+
+## Directory Structure
+
+- `csonpath.h`, `csonpath_do.h` - Main implementation files
+- `csonpath_json-c.h` - Json-C implementation, use it by including "csonpath_json-c.h" directly in your source
+- `csonpath_python.c` - python implementation, use it like a python lib (so `pip install .`)
+- `tests/` - Contains tests
+- `bench//` - Some benchmarks
+
+## 🤝 Contributing
+
+We welcome contributions!
+
+Please read our [Contributing Guidelines](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md) before submitting a pull request.
+
+Feel free to open issues or pull requests!
+
+## 📜 License
+BSD 3-Clause. See [LICENSE](LICENSE).
+

{csonpath-0.0.1 → csonpath-0.0.3}/csonpath.h

@@ -1,9 +1,28 @@
+#if !defined(CSONPATH_JSON) || !defined(CSONPATH_NULL) || !defined(CSONPATH_GET) || \
+  !defined(CSONPATH_AT) || !defined(CSONPATH_IS_OBJ) || !defined(CSONPATH_IS_ARRAY) || \
+  !defined(CSONPATH_CALLBACK) || !defined(CSONPATH_CALLBACK_DATA) || \
+  !defined(CSONPATH_EQUAL_STR) || !defined(CSONPATH_CALL_CALLBACK) || \
+  !defined(CSONPATH_FOREACH_EXT) || !defined(CSONPATH_APPEND_AT) || \
+  !defined(CSONPATH_REMOVE_CHILD) || !defined(CSONPATH_NEED_FOREACH_REDO) || \
+  !defined(CSONPATH_ARRAY_APPEND_INCREF) || !defined(CSONPATH_REMOVE)
+# error "some defined are missing"
+#endif
+
 #define CSONPATH_UNUSED __attribute__((unused))
 #define MAY_ALIAS __attribute__((__may_alias__))
 
-#define CSONPATH_FOREACH(obj, el, code)			\
-	CSONPATH_FOREACH_EXT(obj, el, code, key_idx)
+#ifndef CSONPATH_FOREACH
+# define CSONPATH_FOREACH(obj, el, code)	\
+  CSONPATH_FOREACH_EXT(obj, el, code, key_idx)
+#endif
+
+#ifndef CSONPATH_FIND_ALL_RET
+#define CSONPATH_FIND_ALL_RET CSONPATH_JSON
+#endif
 
+#ifndef CSONPATH_FIND_ALL_RET_INIT
+#define CSONPATH_FIND_ALL_RET_INIT CSONPATH_NEW_ARRAY
+#endif
 
 enum csonpath_instuction_raw {
 	CSONPATH_INST_ROOT,
@@ -54,11 +73,12 @@ struct csonpath_instruction {
 #define CSONPATH_INST_MIN_ALLOC (1 << 7)
 
 struct csonpath {
-	char *path;
-	struct csonpath_instruction *inst_lst;
-	int compiled;
-	int inst_idx;
-	int inst_size;
+    char *path;
+    char *compile_error;
+    struct csonpath_instruction *inst_lst;
+    int compiled;
+    int inst_idx;
+    int inst_size;
 };
 
 struct csonpath_child_info {
@@ -69,13 +89,23 @@ struct csonpath_child_info {
 	};
 };
 
-#define CSONPATH_CLASSIC_ERR(args...) do {	\
-		fprintf(stderr, args);		\
-		goto error;			\
-	} while (0)
+/* I'm assuming error message won't be longer than 125 */
+#define CSONPATH_COMPILE_ERR(tmp, idx, args...) do {			\
+	int ltmp  = strlen(tmp), lidx, oidx = idx;			\
+	if (cjp->compile_error)						\
+	    free(cjp->compile_error);					\
+	cjp->compile_error = malloc(ltmp * 2 + 1024);			\
+	lidx = snprintf(cjp->compile_error, 1024, "colum %d:\n", oidx); \
+	strcpy(cjp->compile_error + lidx, tmp);				\
+	ltmp += lidx;							\
+	cjp->compile_error[ltmp++] = '\n';				\
+	for (; oidx; --oidx) {cjp->compile_error[ltmp++] = ' ';} \
+	snprintf(cjp->compile_error + ltmp, 1024 - lidx, "\\-- "args);	\
+	goto error;							\
+    } while (0)
 
 static inline struct csonpath_child_info *csonpath_child_info_set(struct csonpath_child_info *child_info,
-								  const CSONPATH_JSON j, const intptr_t key)
+								  CSONPATH_JSON j, const intptr_t key)
 {
 	if (CSONPATH_IS_OBJ(j)) {
 		*child_info = (struct csonpath_child_info){.key=(const char *)key, .type=CSONPATH_STR};
@@ -89,7 +119,8 @@ static inline void csonpath_destroy(struct csonpath cjp[static 1])
 {
 	free(cjp->path);
 	free(cjp->inst_lst);
-	cjp->path = NULL;
+	free(cjp->compile_error);
+	*cjp = (struct csonpath){};
 }
 
 static inline int csonpath_init(struct csonpath cjp[static 1],
@@ -107,6 +138,7 @@ static inline int csonpath_set_path(struct csonpath cjp[static 1],
 				    const char path[static 1])
 {
 	free(cjp->path);
+	free(cjp->compile_error);
 	free(cjp->inst_lst);
 	return csonpath_init(cjp, path);
 }
@@ -125,14 +157,18 @@ void csonpath_push_inst(struct csonpath cjp[static 1], int inst)
 int csonpath_compile(struct csonpath cjp[static 1])
 {
 	char *walker = cjp->path;
+	char *orig = walker;
 	char *next;
 	char to_check;
+	char *tmp;
 
 	if (cjp->compiled)
 		return 0;
-root_again:
+
+	tmp = strdup(cjp->path);
+ root_again:
 	if (*walker != '$') {
-		CSONPATH_CLASSIC_ERR("'$' needed");
+	    CSONPATH_COMPILE_ERR(tmp, walker - orig, "%s", "'$' needed");
 	}
 	++walker;
 	csonpath_push_inst(cjp, CSONPATH_INST_ROOT);
@@ -150,7 +186,7 @@ again:
 		if (*walker == '*') {
 			csonpath_push_inst(cjp, CSONPATH_INST_GET_ALL);
 			if (walker[1] != ']') {
-				CSONPATH_CLASSIC_ERR("unclose bracket\n");
+			    CSONPATH_COMPILE_ERR(tmp, walker - orig, "%s", "unclose bracket\n");
 			}
 			cjp->inst_lst[cjp->inst_idx - 1].next = 2;
 			walker += 2;
@@ -227,12 +263,14 @@ again:
 			next = walker;
 			do {
 				if (*next < '0' || *next > '9') {
-					CSONPATH_CLASSIC_ERR("unexpected '%c', sting, filter or number require\n", *next);
+					CSONPATH_COMPILE_ERR(tmp, walker - orig,
+							     "unexpected '%c', sting, filter or number require\n", *next);
 				}
 				next++;
 			} while (*next && *next != ']');
 			if (!*next) {
-				CSONPATH_CLASSIC_ERR("unclose bracket\n");
+			    CSONPATH_COMPILE_ERR(tmp, walker - orig,
+						 "%s", "unclose bracket\n");
 			}
 			*next = 0;
 			num = atoi(walker);
@@ -269,7 +307,8 @@ again:
 			*next = 0;
 			++next;
 			if (*next != ']')
-				CSONPATH_CLASSIC_ERR("']' require instead of '%c'\n", *next);
+				CSONPATH_COMPILE_ERR(tmp, walker - orig,
+						     "']' require instead of '%c'\n", *next);
 
 			csonpath_push_inst(cjp, CSONPATH_INST_GET_OBJ);
 			cjp->inst_lst[cjp->inst_idx - 1].next = next - walker + 1;
@@ -310,10 +349,12 @@ again:
 	if (*walker == 0) {
 		csonpath_push_inst(cjp, CSONPATH_INST_END);
 		cjp->compiled = 1;
+		free(tmp);
 		return 0;
 	}
 error:
 	cjp->inst_lst[0] = (struct csonpath_instruction){.inst=CSONPATH_INST_BROKEN};
+	free(tmp);
 	return -1;
 }
 
@@ -362,7 +403,7 @@ need_reloop_in = 0;
 /* Find All */
 
 #define CSONPATH_DO_PRE_OPERATION		\
-  CSONPATH_JSON ret_ar = CSONPATH_NEW_ARRAY();
+  CSONPATH_FIND_ALL_RET ret_ar = CSONPATH_FIND_ALL_RET_INIT();
 
 #define CSONPATH_DO_POST_OPERATION		\
   if (ret == CSONPATH_NULL) CSONPATH_REMOVE(ret_ar)
@@ -371,7 +412,7 @@ need_reloop_in = 0;
 	int nb_res = 0;
 
 #define CSONPATH_DO_FUNC_NAME find_all
-#define CSONPATH_DO_RET_TYPE CSONPATH_JSON
+#define CSONPATH_DO_RET_TYPE CSONPATH_FIND_ALL_RET
 #define CSONPATH_DO_RETURN ({CSONPATH_ARRAY_APPEND_INCREF(ret_ar, tmp); return ret_ar;})
 
 #define CSONPATH_DO_FIND_ALL						\
@@ -385,7 +426,7 @@ need_reloop_in = 0;
 	return ret_ar;
 
 #define CSONPATH_DO_EXTRA_ARGS_IN , ret_ar
-#define CSONPATH_DO_EXTRA_DECLATION , CSONPATH_JSON ret_ar
+#define CSONPATH_DO_EXTRA_DECLATION , CSONPATH_FIND_ALL_RET ret_ar
 
 
 #include "csonpath_do.h"

{csonpath-0.0.1 → csonpath-0.0.3}/csonpath_do.h

@@ -134,7 +134,7 @@ static CSONPATH_DO_RET_TYPE csonpath_do_dotdot(struct csonpath cjp[static 1],
 					  CSONPATH_DO_EXTRA_ARGS_NEESTED);
 		CSONPATH_DO_FIND_ALL;
 	    }
-	});
+	})
     CSONPATH_DO_FIND_ALL_OUT;
     return tret;
 }
@@ -173,8 +173,8 @@ static CSONPATH_DO_RET_TYPE csonpath_do_internal(struct csonpath cjp[static 1],
 			CSONPATH_JSON el2;
 
 			CSONPATH_DO_FILTER_LOOP_PRE_SET
-			if (cjp->inst_lst[idx].inst != CSONPATH_INST_FILTER_OPERAND_STR)
-			    CSONPATH_GETTER_ERR("filter support only comparaiso with STR");
+			    if (cjp->inst_lst[idx].inst != CSONPATH_INST_FILTER_OPERAND_STR)
+				CSONPATH_GETTER_ERR("filter support only comparaison with STR");
 
 			CSONPATH_FOREACH_EXT(el, el2, {
 				if (!strcmp((char *)neested_key, filter_key)) {
@@ -281,7 +281,7 @@ static CSONPATH_DO_RET_TYPE csonpath_do_(struct csonpath cjp[static 1],
     (void)ctx;
     csonpath_compile(cjp);
     if (cjp->inst_lst[0].inst == CSONPATH_INST_BROKEN) {
-	CSONPATH_GETTER_ERR("fail to compile\n");
+	CSONPATH_GETTER_ERR("fail to compile: %s\n", cjp->compile_error);
 	return CSONPATH_NONE_FOUND_RET;
     }
 

{csonpath-0.0.1 → csonpath-0.0.3}/csonpath_python.c

@@ -148,7 +148,9 @@ static PyObject *PyCsonPath_new(PyTypeObject *subtype, PyObject* args,
     return PyErr_NoMemory();
 
   if (csonpath_compile(ret) < 0) {
-    PyErr_Format(PyExc_ValueError, "Fail to compile %s", s);
+    char *error = ret->compile_error;
+    PyErr_Format(PyExc_ValueError, "compilation fail %s", error);
+    csonpath_destroy(ret);
     return NULL;
   }
   self->cp = ret;

{csonpath-0.0.1 → csonpath-0.0.3}/pyproject.toml

@@ -4,7 +4,8 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "csonpath"
-version = "0.0.1"
+version = "0.0.3"
+readme = "README.md"
 
 [tool.setuptools]
 packages = []  # no Python packages, just an extension

csonpath-0.0.1/PKG-INFO

@@ -1,7 +0,0 @@
-Metadata-Version: 2.4
-Name: csonpath
-Version: 0.0.1
-License-File: LICENSE
-Provides-Extra: dev
-Requires-Dist: pytest>=8.3.5; extra == "dev"
-Dynamic: license-file

csonpath-0.0.1/csonpath.egg-info/PKG-INFO

@@ -1,7 +0,0 @@
-Metadata-Version: 2.4
-Name: csonpath
-Version: 0.0.1
-License-File: LICENSE
-Provides-Extra: dev
-Requires-Dist: pytest>=8.3.5; extra == "dev"
-Dynamic: license-file