3.5.5

Author: jeffreyaven

.gitignore

@@ -1,6 +1,7 @@
 # Miscellaneous
 /.stackql
 /.stackql/*
+.pypirc
 
 /.vscode
 /.vscode/*

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v3.5.5 (2024-04-17)
+
+### Updates
+
+ * modified dict response for `executeStmt`
+
 ## v3.5.4 (2024-04-11)
 
 ### Updates

README.rst

@@ -194,4 +194,4 @@ To publish the package to PyPI, run the following command:
 
 ::
 
-    twine upload dist/pystackql-3.5.4.tar.gz
+    twine upload dist/pystackql-3.5.5.tar.gz

docs/source/conf.py

@@ -26,7 +26,7 @@
 # The short X.Y version
 version = ''
 # The full version, including alpha/beta/rc tags
-release = '3.5.4'
+release = '3.5.5'
 
 
 # -- General configuration ---------------------------------------------------

pystackql/stackql.py

@@ -219,6 +219,11 @@ def _run_query(self, query):
 			}
 			output["exception"] = f"ERROR: {json.dumps(error_details)}"
 
+		# output = {'data': <stdout str>, 'error': <stderr str>, 'exception': <exception as a json string> }
+		# for a statement you would expect 'error' to exist
+		# for a query you would expect 'data' to exist
+		# 'exception' in output indicates an error occurred during the execution (statement or query)
+
 		return output
 
 	def __init__(self, 
@@ -482,6 +487,9 @@ def executeStmt(self, query):
 			else:
 				return result
 		else:
+			# returns either...
+			# {'error': '<error message>'} if something went wrong; or
+			# {'message': '<message>'} if the statement was executed successfully
 			result = self._run_query(query)
 			if "exception" in result:
 				return {"error": result["exception"]}
@@ -494,7 +502,7 @@ def executeStmt(self, query):
 			elif self.output == 'csv':
 				return message
 			else:
-				return [{'message': message}]			
+				return {'message': message}			
 
 	def execute(self, query, suppress_errors=True):
 		"""
@@ -508,7 +516,7 @@ def execute(self, query, suppress_errors=True):
 			suppress_errors (bool, optional): If set to True, the method will return an empty list if an error occurs.
 
 		Returns:
-			dict, pd.DataFrame, or str: The output of the query, which can be a dictionary, a Pandas DataFrame,
+			list(dict), pd.DataFrame, or str: The output of the query, which can be a list of dictionary objects, a Pandas DataFrame,
 			or a raw CSV string, depending on the configured output format.
 
 		Raises:
@@ -534,6 +542,10 @@ def execute(self, query, suppress_errors=True):
 			else:  # Assume 'dict' output
 				return result
 		else:
+			# returns either...
+			# {'error': <error json str>} if something went wrong; or
+			# [{<data>}] if the statement was executed successfully, messages to stderr are ignored
+
 			output = self._run_query(query)
 			if "exception" in output:
 				return {"error": output["exception"]}

setup.py

@@ -10,7 +10,7 @@
 
 setup(
     name='pystackql',
-    version='3.5.4',
+    version='3.5.5',
     description='A Python interface for StackQL',
     long_description=readme,
     author='Jeffrey Aven',