feat: add support for serialization FluxTable into JSON

Author: bednar

examples/README.md

@@ -11,6 +11,7 @@
 ## Queries
 - [query.py](query.py) - How to query data into `FluxTable`s, `Stream` and `CSV`
 - [query_from_file.py](query_from_file.py) - How to use a Flux query defined in a separate file
+- [query_response_to_json.py](query_response_to_json.py) - How to serialize Query response to JSON
 
 
 ## Management API

examples/query_response_to_json.py

@@ -0,0 +1,26 @@
+from influxdb_client import InfluxDBClient, Point
+from influxdb_client.client.write_api import SYNCHRONOUS
+
+with InfluxDBClient(url="http://localhost:8086", token="my-token", org="my-org") as client:
+
+    """
+    Prepare data
+    """
+    _point1 = Point("my_measurement").tag("location", "Prague").field("temperature", 25.3)
+    _point2 = Point("my_measurement").tag("location", "New York").field("temperature", 24.3)
+
+    client.write_api(write_options=SYNCHRONOUS).write(bucket="my-bucket", record=[_point1, _point2])
+
+    """
+    Query: using Table structure
+    """
+    tables = client.query_api().query('from(bucket:"my-bucket") |> range(start: -10m)')
+
+    """
+    Serialize to JSON
+    """
+    import json
+    from influxdb_client.client.flux_table import FluxStructureEncoder
+
+    output = json.dumps(tables, cls=FluxStructureEncoder, indent=2)
+    print(output)

influxdb_client/client/flux_table.py

@@ -3,6 +3,7 @@
 
 The data model consists of tables, records, columns.
 """
+from json import JSONEncoder
 
 
 class FluxStructure:
@@ -11,8 +12,32 @@ class FluxStructure:
     pass
 
 
+class FluxStructureEncoder(JSONEncoder):
+    """The FluxStructure encoder to encode query results to JSON."""
+
+    def default(self, obj):
+        """Return serializable objects for JSONEncoder."""
+        import datetime
+        if isinstance(obj, FluxStructure):
+            return obj.__dict__
+        elif isinstance(obj, (datetime.datetime, datetime.date)):
+            return obj.isoformat()
+        return super().default(obj)
+
+
 class FluxTable(FluxStructure):
-    """A table is set of records with a common set of columns and a group key."""
+    """
+    A table is set of records with a common set of columns and a group key.
+
+    The table can be serialized into JSON by::
+
+        import json
+        from influxdb_client.client.flux_table import FluxStructureEncoder
+
+        output = json.dumps(tables, cls=FluxStructureEncoder, indent=2)
+        print(output)
+
+    """
 
     def __init__(self) -> None:
         """Initialize defaults."""