updated statement output behaviour

Author: jeffreyaven

CHANGELOG.md

@@ -1,10 +1,11 @@
 # Changelog
 
-## v3.2.3 (2023-10-20)
+## v3.2.4 (2023-10-24)
 
 ### Updates
 
  * implemented non `server_mode` magic extension
+ * updated dataframe output for statements
  * `pandas` type updates
  * updated class parameters
  * added additional tests

README.rst

@@ -193,4 +193,4 @@ To publish the package to PyPI, run the following command:
 
 ::
 
-    twine upload dist/pystackql-3.2.3.tar.gz
+    twine upload dist/pystackql-3.2.4.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.2.3'
+release = '3.2.4'
 
 
 # -- General configuration ---------------------------------------------------

pystackql/stackql.py

@@ -393,7 +393,8 @@ def upgrade(self, showprogress=True):
 	def executeStmt(self, query):
 		"""Executes a query using the StackQL instance and returns the output as a string.  
 			This is intended for operations which do not return a result set, for example a mutation 
-			operation such as an `INSERT` or a `DELETE` or life cycle method such as an `EXEC` operation.
+			operation such as an `INSERT` or a `DELETE` or life cycle method such as an `EXEC` operation
+			or a `REGISTRY PULL` operation.
 
 		This method determines the mode of operation (server_mode or local execution) based 
 		on the `server_mode` attribute of the instance. If `server_mode` is True, it runs the query 
@@ -404,7 +405,7 @@ def executeStmt(self, query):
 
 		:return: The output result of the query in string format. If in `server_mode`, it 
 				returns a JSON string representation of the result. 
-		:rtype: str
+		:rtype: dict, Pandas DataFrame or str (for `csv` output)
 
 		Example:
 			>>> from pystackql import StackQL

setup.py

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

tests/pystackql_tests.py

@@ -1,4 +1,4 @@
-import sys, os, unittest, asyncio
+import sys, os, unittest, asyncio, re
 from unittest.mock import MagicMock
 sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
 from pystackql import StackQL, magic, magics, StackqlMagic, StackqlServerMagic
@@ -354,23 +354,36 @@ def run_magic_statement_test(self, line, cell, expect_none=False):
         # Validate the outcome.
         checks = []
         # Check that the output contains expected content
-        if not expect_none:
-            checks.append("OK" in result["message"].iloc[0])
+        if expect_none:
+            checks.append(result is None)
+        else:
+            if self.server_mode:
+                checks.append("OK" in result["message"].iloc[0])
+            else:
+                pattern = registry_pull_resp_pattern('github')
+                message = result["message"].iloc[0] if "message" in result.columns else ""
+                checks.append(bool(re.search(pattern, message)))        
+        # Check dataframe exists and is populated as expected
         checks.append('stackql_df' in self.shell.user_ns)
-        checks.append("OK" in self.shell.user_ns['stackql_df']["message"].iloc[0])
-        return checks
+        if self.server_mode:
+            checks.append("OK" in self.shell.user_ns['stackql_df']["message"].iloc[0])
+        else:
+            pattern = registry_pull_resp_pattern('github')
+            message = self.shell.user_ns['stackql_df']["message"].iloc[0] if 'stackql_df' in self.shell.user_ns else ""
+            checks.append(bool(re.search(pattern, message)))
+        return checks, result
 
     def test_line_magic_statement(self):
-        checks = self.run_magic_statement_test(line=self.statement, cell=None)
-        self.print_test_result(f"Line magic statement test\n{str(checks)}", *checks)
+        checks, result = self.run_magic_statement_test(line=self.statement, cell=None)
+        self.print_test_result(f"Line magic statement test\n{result}", *checks)
 
     def test_cell_magic_statement(self):
-        checks = self.run_magic_statement_test(line="", cell=self.statement)
-        self.print_test_result(f"Cell magic statement test\n{str(checks)}", *checks)
+        checks, result = self.run_magic_statement_test(line="", cell=self.statement)
+        self.print_test_result(f"Cell magic statement test\n{result}", *checks)
 
     def test_cell_magic_statement_no_output(self):
-        checks = self.run_magic_statement_test(line="--no-display", cell=self.statement, expect_none=True)
-        self.print_test_result(f"Cell magic statement test (with --no-display)\n{str(checks)}", *checks)
+        checks, result = self.run_magic_statement_test(line="--no-display", cell=self.statement, expect_none=True)
+        self.print_test_result(f"Cell magic statement test (with --no-display)\n{result}", *checks)
 
 class StackQLMagicTests(BaseStackQLMagicTests, unittest.TestCase):