Introduce per-operation contexts.

Author: Andrey Zelenchuk

channels_graphql_ws/graphql_ws_consumer.py

@@ -58,7 +58,7 @@
 import promise
 import rx
 
-from .scope_as_context import ScopeAsContext
+from .operation_context import OperationContext
 from .serializer import Serializer
 
 # Module logger.
@@ -550,7 +550,7 @@ async def _on_gql_start(self, operation_id, payload):
 
             # Create object-like context (like in `Query` or `Mutation`)
             # from the dict-like one provided by the Channels.
-            context = ScopeAsContext(self.scope)
+            context = OperationContext(self.scope)
 
             # Adding channel name to the context because it seems to be
             # useful for some use cases, take a loot at the issue from

channels_graphql_ws/operation_context.py

@@ -0,0 +1,33 @@
+"""Just `OperationContext` class."""
+
+from channels_graphql_ws.scope_as_context import ScopeAsContext
+
+
+class OperationContext(ScopeAsContext):
+    """
+    The context intended to use in methods of Graphene classes as `info.context`.
+
+    This class provides two public properties:
+    1. `scope` - per-connection context. This is the `scope` of Django Channels.
+    2. `operation_context` - per-operation context. Empty. Fill free to store your's
+       data here.
+
+    For backward compatibility:
+    - Method `_asdict` returns the `scope`.
+    - Other attributes are routed to the `scope`.
+    """
+
+    def __init__(self, scope: dict):
+        """Nothing interesting here."""
+        super().__init__(scope)
+        self._operation_context: dict = {}
+
+    @property
+    def scope(self) -> dict:
+        """Return the scope."""
+        return self._scope
+
+    @property
+    def operation_context(self) -> dict:
+        """Return the per-operation context."""
+        return self._operation_context

channels_graphql_ws/scope_as_context.py

@@ -25,7 +25,7 @@
 class ScopeAsContext:
     """Wrapper to make Channels `scope` appear as an `info.context`."""
 
-    def __init__(self, scope):
+    def __init__(self, scope: dict):
         """Remember given `scope`."""
         self._scope = scope