Introduce TrinityBootInfo to cleanup API

Author: cburgdorf

trinity/extensibility/__init__.py

@@ -9,6 +9,7 @@
     BaseSyncStopPlugin,
     DebugPlugin,
     PluginContext,
+    TrinityBootInfo,
 )
 from trinity.extensibility.plugin_manager import (  # noqa: F401
     BaseManagerProcessScope,

trinity/extensibility/plugin.py

@@ -15,6 +15,7 @@
 from typing import (
     Any,
     Dict,
+    NamedTuple
 )
 
 from lahja import (
@@ -49,6 +50,12 @@
 )
 
 
+class TrinityBootInfo(NamedTuple):
+    args: Namespace
+    trinity_config: TrinityConfig
+    boot_kwargs: Dict[str, Any] = None
+
+
 class PluginContext:
     """
     The ``PluginContext`` holds valuable contextual information such as the parsed
@@ -58,11 +65,11 @@ class PluginContext:
     Each plugin gets a ``PluginContext`` injected during startup.
     """
 
-    def __init__(self, endpoint: Endpoint) -> None:
+    def __init__(self, endpoint: Endpoint, boot_info: TrinityBootInfo) -> None:
         self.event_bus = endpoint
-        self.boot_kwargs: Dict[str, Any] = None
-        self.args: Namespace = None
-        self.trinity_config: TrinityConfig = None
+        self.boot_kwargs: Dict[str, Any] = boot_info.boot_kwargs
+        self.args: Namespace = boot_info.args
+        self.trinity_config: TrinityConfig = boot_info.trinity_config
 
     def shutdown_host(self, reason: str) -> None:
         self.event_bus.broadcast(

trinity/extensibility/plugin_manager.py

@@ -37,6 +37,7 @@
     BasePlugin,
     BaseSyncStopPlugin,
     PluginContext,
+    TrinityBootInfo,
 )
 
 
@@ -58,9 +59,7 @@ def is_responsible_for_plugin(self, plugin: BasePlugin) -> bool:
     @abstractmethod
     def create_plugin_context(self,
                               plugin: BasePlugin,
-                              args: Namespace,
-                              trinity_config: TrinityConfig,
-                              boot_kwargs: Dict[str, Any]) -> PluginContext:
+                              boot_info: TrinityBootInfo) -> PluginContext:
         """
         Create the ``PluginContext`` for a given plugin.
         """
@@ -78,19 +77,14 @@ def is_responsible_for_plugin(self, plugin: BasePlugin) -> bool:
 
     def create_plugin_context(self,
                               plugin: BasePlugin,
-                              args: Namespace,
-                              trinity_config: TrinityConfig,
-                              boot_kwargs: Dict[str, Any]) -> PluginContext:
+                              boot_info: TrinityBootInfo) -> PluginContext:
 
         if isinstance(plugin, BaseIsolatedPlugin):
             # Isolated plugins get an entirely new endpoint to be passed into that new process
-            context = PluginContext(
-                self.event_bus.create_endpoint(plugin.name)
+            return PluginContext(
+                self.event_bus.create_endpoint(plugin.name),
+                boot_info,
             )
-            context.args = args
-            context.trinity_config = trinity_config
-            context.boot_kwargs = boot_kwargs
-            return context
 
         # A plugin that overtakes the main process never gets far enough to even get a context.
         # For now it should be safe to just return `None`. Maybe reconsider in the future.
@@ -107,16 +101,10 @@ def is_responsible_for_plugin(self, plugin: BasePlugin) -> bool:
 
     def create_plugin_context(self,
                               plugin: BasePlugin,
-                              args: Namespace,
-                              trinity_config: TrinityConfig,
-                              boot_kwargs: Dict[str, Any]) -> PluginContext:
+                              boot_info: TrinityBootInfo) -> PluginContext:
 
         # Plugins that run in a shared process all share the endpoint of the plugin manager
-        context = PluginContext(self.endpoint)
-        context.args = args
-        context.trinity_config = trinity_config
-        context.boot_kwargs = boot_kwargs
-        return context
+        return PluginContext(self.endpoint, boot_info)
 
 
 class PluginManager:
@@ -173,7 +161,10 @@ def prepare(self,
             if not self._scope.is_responsible_for_plugin(plugin):
                 continue
 
-            context = self._scope.create_plugin_context(plugin, args, trinity_config, boot_kwargs)
+            context = self._scope.create_plugin_context(
+                plugin,
+                TrinityBootInfo(args, trinity_config, boot_kwargs)
+            )
             plugin.set_context(context)
             plugin.ready()