chore: check jinja_env type during runtime

Author: kiendang

graphql_server/__init__.py

@@ -335,3 +335,17 @@ def format_execution_result(
             response = {"data": execution_result.data}
 
     return FormattedResult(response, status_code)
+
+
+def _check_jinja(jinja_env: Any) -> None:
+    try:
+        from jinja2 import Environment
+    except ImportError:
+        raise RuntimeError(
+            "Attempt to set 'jinja_env' to a value other than None while Jinja2 is not installed.\n"
+            "Please install Jinja2 to render GraphiQL with Jinja2.\n"
+            "Otherwise set 'jinja_env' to None to use the simple regex renderer."
+        )
+
+    if not isinstance(jinja_env, Environment):
+        raise TypeError("'jinja_env' has to be of type jinja2.Environment.")

graphql_server/aiohttp/graphqlview.py

@@ -12,6 +12,7 @@
 from graphql_server import (
     GraphQLParams,
     HttpQueryError,
+    _check_jinja,
     encode_execution_results,
     format_error_default,
     json_encode,
@@ -66,6 +67,9 @@ def __init__(self, **kwargs):
             if not isinstance(self.schema, GraphQLSchema):
                 raise TypeError("A Schema is required to be provided to GraphQLView.")
 
+        if self.jinja_env is not None:
+            _check_jinja(self.jinja_env)
+
     def get_root_value(self):
         return self.root_value
 

graphql_server/flask/graphqlview.py

@@ -12,6 +12,7 @@
 from graphql_server import (
     GraphQLParams,
     HttpQueryError,
+    _check_jinja,
     encode_execution_results,
     format_error_default,
     json_encode,
@@ -63,6 +64,9 @@ def __init__(self, **kwargs):
             if not isinstance(self.schema, GraphQLSchema):
                 raise TypeError("A Schema is required to be provided to GraphQLView.")
 
+        if self.jinja_env is not None:
+            _check_jinja(self.jinja_env)
+
     def get_root_value(self):
         return self.root_value
 

graphql_server/quart/graphqlview.py

@@ -14,6 +14,7 @@
 from graphql_server import (
     GraphQLParams,
     HttpQueryError,
+    _check_jinja,
     encode_execution_results,
     format_error_default,
     json_encode,
@@ -67,6 +68,9 @@ def __init__(self, **kwargs):
             if not isinstance(self.schema, GraphQLSchema):
                 raise TypeError("A Schema is required to be provided to GraphQLView.")
 
+        if self.jinja_env is not None:
+            _check_jinja(self.jinja_env)
+
     def get_root_value(self):
         return self.root_value
 

graphql_server/sanic/graphqlview.py

@@ -14,6 +14,7 @@
 from graphql_server import (
     GraphQLParams,
     HttpQueryError,
+    _check_jinja,
     encode_execution_results,
     format_error_default,
     json_encode,
@@ -68,6 +69,9 @@ def __init__(self, **kwargs):
             if not isinstance(self.schema, GraphQLSchema):
                 raise TypeError("A Schema is required to be provided to GraphQLView.")
 
+        if self.jinja_env is not None:
+            _check_jinja(self.jinja_env)
+
     def get_root_value(self):
         return self.root_value
 

graphql_server/webob/graphqlview.py

@@ -11,6 +11,7 @@
 from graphql_server import (
     GraphQLParams,
     HttpQueryError,
+    _check_jinja,
     encode_execution_results,
     format_error_default,
     json_encode,
@@ -62,6 +63,9 @@ def __init__(self, **kwargs):
             if not isinstance(self.schema, GraphQLSchema):
                 raise TypeError("A Schema is required to be provided to GraphQLView.")
 
+        if self.jinja_env is not None:
+            _check_jinja(self.jinja_env)
+
     def get_root_value(self):
         return self.root_value