Add JSONiq magic.

Author: Ghislain Fourny

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "jsoniq"
-version = "0.2.0a1"
+version = "0.2.0a2"
 description = "Python edition of RumbleDB, a JSONiq engine"
 requires-python = ">=3.11"
 dependencies = [

src/jsoniq/__init__.py

@@ -1,3 +1,8 @@
 from jsoniq.session import RumbleSession
+from jsoniq.magic import JSONiqMagic
 
-__all__ = ["RumbleSession"]
+__all__ = ["RumbleSession", "JSONiqMagic"]
+
+def load_ipython_extension(ipython):
+    rumble = RumbleSession.builder.getOrCreate();
+    ipython.register_magics(JSONiqMagic)

src/jsoniq/magic.py

@@ -0,0 +1,57 @@
+from IPython.core.magic import Magics, cell_magic, magics_class
+import time, json
+from .session import RumbleSession
+from py4j.protocol import Py4JJavaError
+
+@magics_class
+class JSONiqMagic(Magics):
+    def run(self, line, cell=None, timed=False):
+        if cell is None:
+            data = line
+        else:
+            data = cell
+
+        start = time.time()
+        try:
+            rumble = RumbleSession.builder.getOrCreate();
+            response = rumble.jsoniq(data);
+        except Py4JJavaError as e:
+            print(e.java_exception.getMessage())
+            return
+        except Exception as e:
+            print("Query unsuccessful.")
+            print("Usual reasons: firewall, misconfigured proxy.")
+            print("Error message:")
+            print(e.args[0])
+            return
+        except:
+            print("Query unsuccessful.")
+            print("Usual reasons: firewall, misconfigured proxy.")
+            return
+        end = time.time()
+        if(timed):
+           print("Response time: %s ms" % (end - start))
+
+        if ("DataFrame" in response.availableOutputs()):
+            print(response.pdf())
+        elif ("Local" in response.availableOutputs()):
+            count = response.getAsRDD().count()
+            if count > 200:
+                print("The query output %s items, which is too many to display. Displaying the first 200 items:" % count)
+                for e in response.first():
+                    print(json.dumps(json.loads(e.serializeAsJSON()), indent=2))
+            else:
+                for e in response.json():
+                    print(json.dumps(e, indent=2))
+        elif ("PUL" in response.availableOutputs()):
+            print("The query output a Pending Update List.")
+        else:
+            print("No output available.")
+
+    @cell_magic
+    def jsoniq(self, line, cell=None):
+        return self.run(line, cell, False)
+
+    @cell_magic
+    def timedjsoniq(self, line, cell=None):
+        return self.run(line, cell, True)