Merge pull request #70 from tigergraph/empty-set-fix

fix(runInstalledQuery): change behavior to handle empty sets in v3.8

Author: parkererickson-tg

pyTigerGraph/pyTigerGraphBase.py

@@ -207,7 +207,7 @@ def _errorCheck(self, res: dict):
 
     def _req(self, method: str, url: str, authMode: str = "token", headers: dict = None,
             data: Union[dict, list, str] = None, resKey: str = "results", skipCheck: bool = False,
-            params: Union[dict, list, str] = None, strictJson: bool = True) -> Union[dict, list]:
+            params: Union[dict, list, str] = None, strictJson: bool = True, jsonData: bool = False) -> Union[dict, list]:
         """Generic REST++ API request.
 
         Args:
@@ -228,6 +228,10 @@ def _req(self, method: str, url: str, authMode: str = "token", headers: dict = N
                 action is not applicable. This argument skips error checking.
             params:
                 Request URL parameters.
+            strictJson:
+                If JSON should load the response in strict mode or not.
+            jsonData:
+                If data in data var is a JSON document.
 
         Returns:
             The (relevant part of the) response from the request (as a dictionary).
@@ -258,10 +262,14 @@ def _req(self, method: str, url: str, authMode: str = "token", headers: dict = N
             _data = None
 
         if self.useCert is True or self.certPath is not None:
-            res = requests.request(method, url, headers=_headers, data=_data, params=params,
-                verify=False)
+            verify = False
         else:
-            res = requests.request(method, url, headers=_headers, data=_data, params=params)
+            verify = True
+
+        if jsonData:
+            res = requests.request(method, url, headers=_headers, json=_data, params=params, verify=verify)
+        else:
+            res = requests.request(method, url, headers=_headers, data=_data, params=params, verify=verify)
 
         if res.status_code != 200:
             res.raise_for_status()
@@ -317,7 +325,7 @@ def _get(self, url: str, authMode: str = "token", headers: dict = None, resKey:
 
     def _post(self, url: str, authMode: str = "token", headers: dict = None,
             data: Union[dict, list, str, bytes] = None, resKey: str = "results", skipCheck: bool = False,
-            params: Union[dict, list, str] = None) -> Union[dict, list]:
+            params: Union[dict, list, str] = None, jsonData: bool = False) -> Union[dict, list]:
         """Generic POST method.
 
         Args:
@@ -344,7 +352,7 @@ def _post(self, url: str, authMode: str = "token", headers: dict = None,
         if logger.level == logging.DEBUG:
             logger.debug("params: " + self._locals(locals()))
 
-        res = self._req("POST", url, authMode, headers, data, resKey, skipCheck, params)
+        res = self._req("POST", url, authMode, headers, data, resKey, skipCheck, params, jsonData=jsonData)
 
         if logger.level == logging.DEBUG:
             logger.debug("return: " + str(res))

pyTigerGraph/pyTigerGraphQuery.py

@@ -125,7 +125,7 @@ def _parseQueryParameters(self, params: dict) -> str:
         return ret
 
     def runInstalledQuery(self, queryName: str, params: Union[str, dict] = None,
-            timeout: int = None, sizeLimit: int = None, usePost: bool = False, runAsync: bool = False,
+            timeout: int = None, sizeLimit: int = None, usePost: bool = True, runAsync: bool = False,
             replica: int = None, threadLimit: int = None) -> list:
         """Runs an installed query.
 
@@ -146,8 +146,9 @@ def runInstalledQuery(self, queryName: str, params: Union[str, dict] = None,
                 Maximum size of response (in bytes).
                 See xref:tigergraph-server:API:index.adoc#_response_size[Response size]
             usePost:
-                The RESTPP accepts a maximum URL length of 8192 characters. Use POST if additional parameters cause
-                you to exceed this limit.
+                Defaults to True. The RESTPP accepts a maximum URL length of 8192 characters. 
+                Use POST if additional parameters cause you to exceed this limit. You cannot pass
+                empty sets as parameters if usePost is False.
             runAsync:
                 Run the query in asynchronous mode. 
                 See xref:gsql-ref:querying:query-operations#_detached_mode_async_option[Async operation]
@@ -201,21 +202,20 @@ def runInstalledQuery(self, queryName: str, params: Union[str, dict] = None,
         if replica:
             headers["GSQL-REPLICA"] = str(replica)
         if threadLimit:
-            headers["GSQL-THREAD-LIMIT"] = str(threadLimit)
-
-        if isinstance(params, dict):
-            params = self._parseQueryParameters(params)
+            headers["GSQL-THREAD-LIMIT"] = str(threadLimit) 
 
         if usePost:
             ret = self._post(self.restppUrl + "/query/" + self.graphname + "/" + queryName,
-                data=params, headers=headers, resKey=res_key)
+                data=params, headers=headers, resKey=res_key, jsonData=True)
 
             if logger.level == logging.DEBUG:
                 logger.debug("return: " + str(ret))
             logger.info("exit: runInstalledQuery (POST)")
 
             return ret
         else:
+            if isinstance(params, dict):
+                params = self._parseQueryParameters(params)
             ret = self._get(self.restppUrl + "/query/" + self.graphname + "/" + queryName,
                 params=params, headers=headers, resKey=res_key)