Merge pull request #5 from muehlemann-popp/4-get_query_from_queryset-not-works-if-value-passes

fix get_query_from_queryset

Author: Sheripov

django_materialized_view/base_model.py

@@ -1,7 +1,7 @@
 import datetime
 import logging
 import time
-from typing import Callable, Dict, Optional, Union
+from typing import Callable, Dict, Optional, Union, Tuple
 
 from django.conf import settings
 from django.db import DEFAULT_DB_ALIAS, connections, models
@@ -114,7 +114,7 @@ def refresh(cls, using: Optional[str] = None, concurrently: Optional[bool] = Non
         log.save()
 
     @classmethod
-    def view_definition(cls):
+    def view_definition(cls) -> Tuple[str, tuple]:
         return cls.__get_query()
 
     @classmethod
@@ -150,18 +150,18 @@ def get_query_from_queryset() -> QuerySet:
         pass
 
     @classmethod
-    def __get_query(cls) -> str:
+    def __get_query(cls, *args) -> Tuple[str, tuple]:
         queryset = cls.get_query_from_queryset()
-
         if isinstance(queryset, QuerySet):
-            sql_query = f"{queryset.query}; {cls.__create_index_for_primary_key()}"
-            return sql_query
+            query, args = queryset.query.sql_with_params()
+            sql_query = f"{query}; {cls.__create_index_for_primary_key()}"
+            return sql_query, args
         try:
             with open(cls.__get_sql_file_path(), "r") as sql_file:
                 sql_query = f"{sql_file.read()}; {cls.__create_index_for_primary_key()}"
         except FileNotFoundError as exc:
             raise FileNotFoundError(f"{exc}, - please create SQL file and put it to this directory")
-        return sql_query
+        return sql_query, args
 
     @classmethod
     def __get_class_name(cls) -> str:

django_materialized_view/processor.py

@@ -51,8 +51,8 @@ def mark_to_be_applied_new_views(self) -> None:
         view_models = self.__get_current_view_models()
         for (app_label, model_name), view_model in view_models.items():
             view_name = self.__get_view_name(app_label, model_name)
-            actual_view_definition = self.__get_actual_view_definition(view_name)
-            actual_view_definition_hash = self.__get_hash_from_string(actual_view_definition)
+            actual_view_definition, args = self.__get_actual_view_definition(view_name)
+            actual_view_definition_hash = self.__get_hash_from_string(actual_view_definition % args)
 
             previous_view_definition_hash = self.__get_previous_view_definition_hash(app_label, model_name)
 
@@ -127,10 +127,10 @@ def get_view_list_sorted_by_dependencies(self, views: Set[str]) -> OrderedDict[s
     def _create_view(self, view_name: str) -> bool:
         logger.debug(f"Creating view: {view_name}")
 
-        view_definition = self.__get_actual_view_definition(view_name)
+        view_definition, args = self.__get_actual_view_definition(view_name)
         with connection.cursor() as cursor:
             try:
-                cursor.execute(self.CREATE_COMMAND_TEMPLATE % (view_name, view_definition))
+                cursor.execute(self.CREATE_COMMAND_TEMPLATE % (view_name, view_definition), args)
             except ProgrammingError as exc:
                 logger.debug(f"Unable to create view: {view_name}. Error: {exc.args}")
                 if "already exists" in exc.args[0]:
@@ -224,11 +224,11 @@ def __get_ref_views(self, view_name: str) -> List[str]:
     def __get_actual_view_definition(self, view_name: str) -> str:
         view_model = DBViewsRegistry[view_name]
         if callable(view_model.view_definition):
-            raw_view_definition = view_model.view_definition()
+            raw_view_definition, args = view_model.view_definition()
         else:
-            raw_view_definition = view_model.view_definition
+            raise ValueError("view_definition must be callable")
         view_definition = self.__get_cleaned_view_definition_value(raw_view_definition)
-        return view_definition
+        return view_definition, args
 
     def __prioritize_view(self, view: str, related_views: List[str], dependencies_story: set[str]) -> None:
         if related_views:
@@ -277,7 +277,7 @@ def __get_related_views(self) -> List[Dict[str, str]]:
     def __get_cleaned_view_definition_value(view_definition: str) -> str:
         assert isinstance(
             view_definition, str
-        ), "View definition must be callable and return string or be itself a string."
+        ), "View definition must be callable and return Tuple[str, Optional[tuple]]."
         return view_definition.strip()
 
     @staticmethod

testproject/tests/test_base_mode_tests.py

@@ -91,7 +91,7 @@ def test__get_cleaned_view_definition_value__success(self):
     def test__get_cleaned_view_definition_value__invalid(self):
         with pytest.raises(AssertionError) as exc:
             self.view_processor._MaterializedViewsProcessor__get_cleaned_view_definition_value(1)
-        assert exc.value.args == ("View definition must be callable and return string or be itself a string.",)
+        assert exc.value.args == ("View definition must be callable and return Tuple[str, Optional[tuple]].",)
 
     @pytest.mark.django_db
     def test__get_related_views__success(self):
@@ -130,6 +130,7 @@ def test__get_actual_view_definition__success(self, mocker, subtests):
         test_view_definition = "test"
         with subtests.test(msg="view_definition callable"):
             test_view_mock = MagicMock()
+            test_view_mock.view_definition.return_value = ("test raw query", ())
             DBViewsRegistry[test_view_definition] = test_view_mock
             get_cleaned_view_mock = mocker.patch.object(
                 MaterializedViewsProcessor,
@@ -139,22 +140,8 @@ def test__get_actual_view_definition__success(self, mocker, subtests):
 
             result = self.view_processor._MaterializedViewsProcessor__get_actual_view_definition("test")
 
-            get_cleaned_view_mock.assert_called_once_with(test_view_mock.view_definition())
-            assert result == test_view_definition
-
-        with subtests.test(msg="view_definition is str"):
-            test_view_mock = MagicMock()
-            test_view_mock.view_definition = "test"
-            DBViewsRegistry[test_view_definition] = test_view_mock
-            get_cleaned_view_mock = mocker.patch.object(
-                MaterializedViewsProcessor,
-                "_MaterializedViewsProcessor__get_cleaned_view_definition_value",
-                return_value=test_view_definition,
-            )
-
-            result = self.view_processor._MaterializedViewsProcessor__get_actual_view_definition("test")
-            get_cleaned_view_mock.assert_called_once_with(test_view_mock.view_definition)
-            assert result == test_view_definition
+            get_cleaned_view_mock.assert_called_once_with("test raw query")
+            assert result == (test_view_definition, ())
 
     def test__get_ref_views__success(self, mocker):
         ref_view_name = "test_ref_view"
@@ -325,7 +312,7 @@ def test__create_view__success(self, mocker, subtests):
         test_view_name = "viewname"
         full_view_name = f"{test_app_name}_{test_view_name}"
 
-        view_definition = "SELECT * FROM pg_depend"
+        view_definition = "SELECT * FROM pg_depend", ()
         get_actual_view_definition_mock = mocker.patch.object(
             MaterializedViewsProcessor,
             "_MaterializedViewsProcessor__get_actual_view_definition",