Clarify return on select_records

pepkit · Nov 16, 2023 · dfa7616 · dfa7616
1 parent b414330
commit dfa7616
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 3 deletions.
diff --git a/pipestat/backends/db_backend/dbbackend.py b/pipestat/backends/db_backend/dbbackend.py
@@ -391,7 +391,12 @@ def select_records(
         :param int limit: maximum number of results to retrieve per page
         :param int cursor: cursor position to begin retrieving records
         :param bool bool_operator: Perform filtering with AND or OR Logic.
-        :return Dict[str, Any]
+        :return dict records_dict = {
+            "total_size": int,
+            "page_size": int,
+            "next_page_token": int,
+            "records": List[Dict[{key, Any}]],
+        }
         """
 
         ORM = self.get_model(table_name=self.table_name)

diff --git a/pipestat/backends/file_backend/filebackend.py b/pipestat/backends/file_backend/filebackend.py
@@ -431,7 +431,12 @@ def select_records(
         :param int limit: maximum number of results to retrieve per page
         :param int cursor: cursor position to begin retrieving records
         :param bool bool_operator: Perform filtering with AND or OR Logic.
-        :return Dict[str, Any]
+        :return dict records_dict = {
+            "total_size": int,
+            "page_size": int,
+            "next_page_token": int,
+            "records": List[Dict[{key, Any}]],
+        }
         """
         if cursor:
             _LOGGER.warning("Cursor not supported for FileBackend, ignoring cursor")

diff --git a/pipestat/pipestat.py b/pipestat/pipestat.py
@@ -579,7 +579,12 @@ def select_records(
         :param int limit: maximum number of results to retrieve per page
         :param int cursor: cursor position to begin retrieving records
         :param bool bool_operator: Perform filtering with AND or OR Logic.
-        :return Dict[str, Any]
+        :return dict records_dict = {
+            "total_size": int,
+            "page_size": int,
+            "next_page_token": int,
+            "records": List[Dict[{key, Any}]],
+        }
         """
 
         return self.backend.select_records(