Split up warning hook function to be more customization-friendly

Author: brodriguez8774

django_expanded_test_cases/test_cases/integration_test_case.py

@@ -2222,6 +2222,31 @@ def _hook_function_warning_check(self, user, *args, **kwargs):
         per-project, if needed.
         """
 
+        should_raise_warning = self._hook_function_warning_check_if_statement(user)
+        if should_raise_warning:
+            # No custom hooks have been implemented.
+            # Check if any args or kwargs have been provided.
+            if len(args) > 0 or len(kwargs) > 0:
+                # Either args or kwargs have been provided, which are exclusively meant for hook functions.
+                # But no hook functions have been implemented.
+                # Raise warning, as this is probably not an intended state.
+                warn_msg = (
+                    "Supplemental args/kwargs have been provided to an assertResponse statement. "
+                    "Any supplemental args/kwargs are exclusively used to provide custom data to "
+                    "built-in hook functions, but no hook functions seem to be implemented for your project. "
+                    "Either remove the use of args/kwargs in the assertion, or implement one of the hook functions."
+                )
+                # Create console warning message.
+                warnings.warn(warn_msg)
+                # Create logging warning message.
+                logging.warning(warn_msg)
+
+    def _hook_function_warning_check_if_statement(self, user):
+        """If statement to determine if hook functions should raise warning.
+
+        Separate function for maximum customizability per project.
+        """
+
         # Django imports here to avoid situational "Apps aren't loaded yet" error.
         from django.contrib.auth.models import AnonymousUser
 
@@ -2246,23 +2271,8 @@ def _hook_function_warning_check(self, user, *args, **kwargs):
             ):
                 should_raise_warning = True
 
-        if should_raise_warning:
-            # No custom hooks have been implemented.
-            # Check if any args or kwargs have been provided.
-            if len(args) > 0 or len(kwargs) > 0:
-                # Either args or kwargs have been provided, which are exclusively meant for hook functions.
-                # But no hook functions have been implemented.
-                # Raise warning, as this is probably not an intended state.
-                warn_msg = (
-                    "Supplemental args/kwargs have been provided to an assertResponse statement. "
-                    "Any supplemental args/kwargs are exclusively used to provide custom data to "
-                    "built-in hook functions, but no hook functions seem to be implemented for your project. "
-                    "Either remove the use of args/kwargs in the assertion, or implement one of the hook functions."
-                )
-                # Create console warning message.
-                warnings.warn(warn_msg)
-                # Create logging warning message.
-                logging.warning(warn_msg)
+        # Return calculated value.
+        return should_raise_warning
 
     # endregion Hook Functions
 

docs/source/test_cases/integration_test_case/other_functionality.rst

@@ -404,3 +404,27 @@ If any additional args/kwargs are provided to a **Response Assertion**
 are passed on to all hooks, so that the end-user can provide any additional
 data their project needs to function.
 
+
+Hook Warnings and Warning Customization
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If any supplemental args/kwargs are passed into any of the
+:doc:`Response Assertions<./response_assertions>` (beyond those the package
+is aware of), then they are assumed to be needed for one or more of the built-in
+hook functions.
+
+However, the hook functions do nothing by default, and are meant to be
+overridden.
+Thus, if supplemental args/kwargs are provided and no hooks functions are
+overridden, the package will raise warnings indicating such, to alert the
+programmer that one or more provided values are probably not
+working as expected.
+
+To customize how these warnings behave, override either
+``_hook_function_warning_check()`` (which displays the warning messages),
+or ``_hook_function_warning_check_if_statement()`` (which controls the
+if-statement that determines if the warnings should display).
+
+See source code for these functions for more details.
+They're both towards the bottom of the file
+`django_expanded_test_cases/test_cases/integration_test_case.py <https://github.com/brodriguez8774/django-expanded-test-cases/blob/main/django_expanded_test_cases/test_cases/integration_test_case.py>`_.