feat: add InvocableScripts API (influxdata#404)

Author: bednar

Diff for: CHANGELOG.md

@@ -2,7 +2,8 @@
 
 ### Features
 1. [#412](https://github.com/influxdata/influxdb-client-python/pull/412): `DeleteApi` uses default value from `InfluxDBClient.org` if an `org` parameter is not specified
-2. [#405](https://github.com/influxdata/influxdb-client-python/pull/405): Add `InfluxLoggingHandler`. A handler to use the client in native python logging.
+1. [#405](https://github.com/influxdata/influxdb-client-python/pull/405): Add `InfluxLoggingHandler`. A handler to use the client in native python logging.
+1. [#404](https://github.com/influxdata/influxdb-client-python/pull/404): Add `InvocableScriptsApi` to create, update, list, delete and invoke scripts by seamless way
 
 ### CI
 1. [#411](https://github.com/influxdata/influxdb-client-python/pull/411): Use new Codecov uploader for reporting code coverage
@@ -46,11 +47,10 @@ This release introduces a support for new version of InfluxDB OSS API definition
 1. [#408](https://github.com/influxdata/influxdb-client-python/pull/408): Improve error message when the client cannot find organization by name
 1. [#407](https://github.com/influxdata/influxdb-client-python/pull/407): Use `pandas.concat()` instead of deprecated `DataFrame.append()` [DataFrame]
 
- 
 ## 1.25.0 [2022-01-20]
 
 ### Features
-1. [#393](https://github.com/influxdata/influxdb-client-python/pull/393): Added callback function for getting profilers output with example and test
+1. [#393](https://github.com/influxdata/influxdb-client-python/pull/393): Add callback function for getting profilers output with example and test
 
 ### Bug Fixes
 1. [#375](https://github.com/influxdata/influxdb-client-python/pull/375): Construct `InfluxDBError` without HTTP response 

Diff for: docs/api.rst

@@ -62,6 +62,17 @@ TasksApi
 .. autoclass:: influxdb_client.domain.Task
    :members:
 
+InvocableScriptsApi
+"""""""""""""""""""
+.. autoclass:: influxdb_client.InvocableScriptsApi
+   :members:
+
+.. autoclass:: influxdb_client.domain.Script
+   :members:
+
+.. autoclass:: influxdb_client.domain.ScriptCreateRequest
+   :members:
+
 DeleteApi
 """""""""
 .. autoclass:: influxdb_client.DeleteApi

Diff for: examples/invocable_scripts.py

@@ -3,8 +3,9 @@
 """
 import datetime
 
-from influxdb_client import InfluxDBClient, InvocableScriptsService, ScriptCreateRequest, ScriptInvocationParams, \
-    ScriptLanguage
+from influxdb_client import InfluxDBClient, ScriptCreateRequest, ScriptLanguage, \
+    ScriptUpdateRequest, Point
+from influxdb_client.client.write_api import SYNCHRONOUS
 
 """
 Define credentials
@@ -14,48 +15,79 @@
 bucket_name = '...'
 org_name = '...'
 
-with InfluxDBClient(url=influx_cloud_url, token=influx_cloud_token, org=org_name, debug=False, timeout=20_000) as client:
+with InfluxDBClient(url=influx_cloud_url, token=influx_cloud_token, org=org_name, debug=False,
+                    timeout=20_000) as client:
     uniqueId = str(datetime.datetime.now())
+
+    """
+    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=bucket_name, record=[_point1, _point2])
+
     """
     Find Organization ID by Organization API.
     """
     org = client.organizations_api().find_organizations(org=org_name)[0]
 
-    scripts_service = InvocableScriptsService(api_client=client.api_client)
+    scripts_api = client.invocable_scripts_api()
 
     """
     Create Invocable Script
     """
     print(f"------- Create -------\n")
-    create_request = ScriptCreateRequest(name=f"my_scrupt_{uniqueId}",
+    create_request = ScriptCreateRequest(name=f"my_script_{uniqueId}",
                                          description="my first try",
                                          language=ScriptLanguage.FLUX,
-                                         org_id=org.id,
                                          script=f"from(bucket: params.bucket_name) |> range(start: -30d) |> limit(n:2)")
 
-    created_script = scripts_service.post_scripts(script_create_request=create_request)
+    created_script = scripts_api.create_script(create_request=create_request)
+    print(created_script)
+
+    """
+    Update Invocable Script
+    """
+    print(f"------- Update -------\n")
+    update_request = ScriptUpdateRequest(description="my updated description")
+    created_script = scripts_api.update_script(script_id=created_script.id, update_request=update_request)
     print(created_script)
 
     """
     Invoke a script
     """
-    print(f"\n------- Invoke -------\n")
-    response = scripts_service.post_scripts_id_invoke(script_id=created_script.id,
-                                                      script_invocation_params=ScriptInvocationParams(
-                                                          params={"bucket_name": bucket_name}))
-    print(response)
+    # FluxRecords
+    print(f"\n------- Invoke to FluxRecords -------\n")
+    tables = scripts_api.invoke_scripts(script_id=created_script.id, params={"bucket_name": bucket_name})
+    for table in tables:
+        for record in table.records:
+            print(f'FluxRecord {record}')
+    # Pandas DataFrame
+    print(f"\n------- Invoke to PandasData Frame -------\n")
+    data_frame = scripts_api.invoke_scripts_data_frame(script_id=created_script.id, params={"bucket_name": bucket_name})
+    print(data_frame.to_string())
+    # CSV
+    print(f"\n------- Invoke to CSV-------\n")
+    csv_lines = scripts_api.invoke_scripts_csv(script_id=created_script.id, params={"bucket_name": bucket_name})
+    for csv_line in csv_lines:
+        if not len(csv_line) == 0:
+            print(f'CSV row: {csv_line}')
+    # RAW
+    print(f"\n------- Invoke to Raw-------\n")
+    raw = scripts_api.invoke_scripts_raw(script_id=created_script.id, params={"bucket_name": bucket_name})
+    print(f'RAW output:\n {raw}')
 
     """
     List scripts
     """
     print(f"\n------- List -------\n")
-    scripts = scripts_service.get_scripts().scripts
+    scripts = scripts_api.find_scripts()
     print("\n".join([f" ---\n ID: {it.id}\n Name: {it.name}\n Description: {it.description}" for it in scripts]))
     print("---")
 
     """
     Delete previously created Script
     """
     print(f"------- Delete -------\n")
-    scripts_service.delete_scripts_id(script_id=created_script.id)
+    scripts_api.delete_script(script_id=created_script.id)
     print(f" Successfully deleted script: '{created_script.name}'")

Diff for: examples/query.py

@@ -3,7 +3,7 @@
 from influxdb_client import InfluxDBClient, Point, Dialect
 from influxdb_client.client.write_api import SYNCHRONOUS
 
-with InfluxDBClient(url="http://localhost:8086", token="my-token", org="my-org",debug=True) as client:
+with InfluxDBClient(url="http://localhost:8086", token="my-token", org="my-org", debug=False) as client:
 
     write_api = client.write_api(write_options=SYNCHRONOUS)
 

Diff for: influxdb_client/__init__.py

@@ -376,6 +376,7 @@
 from influxdb_client.client.authorizations_api import AuthorizationsApi
 from influxdb_client.client.bucket_api import BucketsApi
 from influxdb_client.client.delete_api import DeleteApi
+from influxdb_client.client.invocable_scripts_api import InvocableScriptsApi
 from influxdb_client.client.labels_api import LabelsApi
 from influxdb_client.client.organizations_api import OrganizationsApi
 from influxdb_client.client.query_api import QueryApi

Diff for: influxdb_client/client/flux_csv_parser.py

@@ -34,22 +34,32 @@ class FluxCsvParserException(Exception):
 
 
 class FluxSerializationMode(Enum):
-    """The type how we wan't to serialize data."""
+    """The type how we want to serialize data."""
 
     tables = 1
     stream = 2
     dataFrame = 3
 
 
+class FluxResponseMetadataMode(Enum):
+    """The configuration for expected amount of metadata respons from InfluxDB."""
+
+    full = 1
+    # useful for Invocable scripts
+    only_names = 2
+
+
 class FluxCsvParser(object):
     """Parse to processing response from InfluxDB to FluxStructures or DataFrame."""
 
     def __init__(self, response: HTTPResponse, serialization_mode: FluxSerializationMode,
-                 data_frame_index: List[str] = None, query_options=None) -> None:
+                 data_frame_index: List[str] = None, query_options=None,
+                 response_metadata_mode: FluxResponseMetadataMode = FluxResponseMetadataMode.full) -> None:
         """Initialize defaults."""
         self._response = response
         self.tables = []
         self._serialization_mode = serialization_mode
+        self._response_metadata_mode = response_metadata_mode
         self._data_frame_index = data_frame_index
         self._data_frame_values = []
         self._profilers = query_options.profilers if query_options is not None else None
@@ -97,8 +107,9 @@ def _parse_flux_response(self):
                 raise FluxQueryException(error, reference_value)
 
             token = csv[0]
-            # start    new    table
-            if token in ANNOTATIONS and not start_new_table:
+            # start new table
+            if (token in ANNOTATIONS and not start_new_table) or \
+                    (self._response_metadata_mode is FluxResponseMetadataMode.only_names and not table):
 
                 # Return already parsed DataFrame
                 if (self._serialization_mode is FluxSerializationMode.dataFrame) & hasattr(self, '_data_frame'):
@@ -127,6 +138,10 @@ def _parse_flux_response(self):
             else:
                 # parse column names
                 if start_new_table:
+                    # Invocable scripts doesn't supports dialect => all columns are string
+                    if not table.columns and self._response_metadata_mode is FluxResponseMetadataMode.only_names:
+                        self.add_data_types(table, list(map(lambda column: 'string', csv)))
+                        groups = list(map(lambda column: 'false', csv))
                     self.add_groups(table, groups)
                     self.add_column_names_and_tags(table, csv)
                     start_new_table = False

Diff for: influxdb_client/client/influxdb_client.py

@@ -8,7 +8,8 @@
 import base64
 import warnings
 
-from influxdb_client import Configuration, ApiClient, HealthCheck, HealthService, Ready, ReadyService, PingService
+from influxdb_client import Configuration, ApiClient, HealthCheck, HealthService, Ready, ReadyService, PingService, \
+    InvocableScriptsApi
 from influxdb_client.client.authorizations_api import AuthorizationsApi
 from influxdb_client.client.bucket_api import BucketsApi
 from influxdb_client.client.delete_api import DeleteApi
@@ -337,13 +338,21 @@ def retry(self, conf: (str, str, str), data: str, exception: InfluxDBError):
 
     def query_api(self, query_options: QueryOptions = QueryOptions()) -> QueryApi:
         """
-        Create a Query API instance.
+        Create an Query API instance.
 
         :param query_options: optional query api configuration
         :return: Query api instance
         """
         return QueryApi(self, query_options)
 
+    def invocable_scripts_api(self) -> InvocableScriptsApi:
+        """
+        Create an InvocableScripts API instance.
+
+        :return: InvocableScripts API instance
+        """
+        return InvocableScriptsApi(self)
+
     def close(self):
         """Shutdown the client."""
         self.__del__()