refactor: collection.results.[ViewExecutionResult, ExecutionResult]."context" -> "metadata" (to ommit confusing naming overlap with newly added contextualisation functionality); views.exposed_functions pylint warnings resolved

Author: ds-jakub-cierocki

src/dbally/audit/event_handlers/cli_event_handler.py

@@ -127,5 +127,5 @@ async def request_end(self, output: RequestEnd, request_context: Optional[dict]
         self._print_syntax("[green bold]REQUEST OUTPUT:")
         self._print_syntax(f"Number of rows: {len(output.result.results)}")
 
-        if "sql" in output.result.context:
-            self._print_syntax(f"{output.result.context['sql']}", "psql")
+        if "sql" in output.result.metadata:
+            self._print_syntax(f"{output.result.metadata['sql']}", "psql")

src/dbally/audit/event_handlers/langsmith_event_handler.py

@@ -101,5 +101,5 @@ async def request_end(self, output: RequestEnd, request_context: RunTree) -> Non
             output: The output of the request. In this case - PSQL query.
             request_context: Optional context passed from request_start method
         """
-        request_context.end(outputs={"sql": output.result.context["sql"]})
+        request_context.end(outputs={"sql": output.result.metadata["sql"]})
         request_context.post(exclude_child_runs=False)

src/dbally/collection/collection.py

@@ -234,7 +234,7 @@ async def ask(
 
         result = ExecutionResult(
             results=view_result.results,
-            context=view_result.context,
+            metadata=view_result.metadata,
             execution_time=time.monotonic() - start_time,
             execution_time_view=end_time_view - start_time_view,
             view_name=selected_view,

src/dbally/collection/results.py

@@ -14,7 +14,7 @@ class ViewExecutionResult:
     """
 
     results: List[Dict[str, Any]]
-    context: Dict[str, Any]
+    metadata: Dict[str, Any]
 
 
 @dataclass
@@ -37,7 +37,7 @@ class ExecutionResult:
     """
 
     results: List[Dict[str, Any]]
-    context: Dict[str, Any]
+    metadata: Dict[str, Any]
     execution_time: float
     execution_time_view: float
     view_name: str

src/dbally/context/context.py

@@ -17,7 +17,7 @@ class BaseCallerContext(ABC):
     a class implementing this interface, selected based on the filter method signature (type hints).
     """
 
-    _alias: str = "AskerContext"
+    alias: str = "AskerContext"
 
     @classmethod
     def select_context(cls, contexts: Iterable[CustomContext]) -> Self:
@@ -58,7 +58,5 @@ def is_context_call(cls, node: ast.expr) -> bool:
         """
 
         return (
-            isinstance(node, ast.Call)
-            and isinstance(node.func, ast.Name)
-            and node.func.id in [cls._alias, cls.__name__]
+            isinstance(node, ast.Call) and isinstance(node.func, ast.Name) and node.func.id in [cls.alias, cls.__name__]
         )

src/dbally/gradio/gradio_interface.py

@@ -114,7 +114,7 @@ async def _ui_ask_query(
             execution_result = await self.collection.ask(
                 question=question_query, return_natural_response=natural_language_flag
             )
-            generated_query = str(execution_result.context)
+            generated_query = str(execution_result.metadata)
             data = self._load_results_into_dataframe(execution_result.results)
             textual_response = str(execution_result.textual_response) if natural_language_flag else textual_response
         except UnsupportedQueryError:

src/dbally/iql_generator/prompt.py

@@ -74,7 +74,7 @@ def __init__(
                 "You MUST use only these methods:\n"
                 "\n{filters}\n"
                 "It is VERY IMPORTANT not to use methods other than those listed above."
-                "Finally, if a called function argument value is not directly specified in the query but instead requires some additional execution context, than substitute that argument value by: AskerContext()."
+                "Finally, if a called function argument value is not directly specified in the query but instead requires some additional execution context, than substitute that argument value with: AskerContext()."
                 'The typical input phrase suggesting that the additional execution context need to be referenced contains words like: "I", "my", "mine", "current", "the" etc..'
                 'For example: "my position name", "my company valuation", "current day", "the ongoing project".'
                 "In that case, the part of the output will look like this:"

src/dbally/nl_responder/nl_responder.py

@@ -70,7 +70,7 @@ async def generate_response(
         if tokens_count > self._max_tokens_count:
             prompt_format = QueryExplanationPromptFormat(
                 question=question,
-                context=result.context,
+                metadata=result.metadata,
                 results=result.results,
             )
             formatted_prompt = self._explainer_prompt_template.format_prompt(prompt_format)

src/dbally/nl_responder/prompts.py

@@ -1,4 +1,4 @@
-from typing import Any, Dict, List
+from typing import Any, Dict, List, Optional
 
 import pandas as pd
 
@@ -40,9 +40,9 @@ def __init__(
         self,
         *,
         question: str,
-        context: Dict[str, Any],
+        metadata: Dict[str, Any],
         results: List[Dict[str, Any]],
-        examples: List[FewShotExample] = None,
+        examples: Optional[List[FewShotExample]] = None,
     ) -> None:
         """
         Constructs a new QueryExplanationPromptFormat instance.
@@ -55,7 +55,7 @@ def __init__(
         """
         super().__init__(examples)
         self.question = question
-        self.query = next((context.get(key) for key in ("iql", "sql", "query") if context.get(key)), question)
+        self.query = next((metadata.get(key) for key in ("iql", "sql", "query") if metadata.get(key)), question)
         self.number_of_results = len(results)
 
 

src/dbally/prompt/template.py

@@ -1,6 +1,6 @@
 import copy
 import re
-from typing import Callable, Dict, Generic, List, TypeVar
+from typing import Callable, Dict, Generic, List, Optional, TypeVar
 
 from typing_extensions import Self
 
@@ -55,7 +55,7 @@ class PromptFormat:
     Generic format for prompts allowing to inject few shot examples into the conversation.
     """
 
-    def __init__(self, examples: List[FewShotExample] = None) -> None:
+    def __init__(self, examples: Optional[List[FewShotExample]] = None) -> None:
         """
         Constructs a new PromptFormat instance.