Better encapsulation + API name changes

Author: cburgdorf

trinity/extensibility/plugin.py

@@ -115,18 +115,18 @@ def configure_parser(self, arg_parser: ArgumentParser, subparser: _SubParsersAct
         """
         pass
 
-    def boot(self) -> None:
+    def start(self) -> None:
         """
         Prepare the plugin to get started and eventually cause ``start`` to get called.
         """
         self.running = True
-        self.start()
+        self._start()
         self.event_bus.broadcast(
             PluginStartedEvent(type(self))
         )
         self.logger.info("Plugin started: %s", self.name)
 
-    def start(self) -> None:
+    def _start(self) -> None:
         """
         The ``start`` method is called only once when the plugin is started. In the case
         of an `BaseIsolatedPlugin` this method will be launched in a separate process.
@@ -138,18 +138,40 @@ class BaseSyncStopPlugin(BasePlugin):
     """
     A ``BaseSyncStopPlugin`` unwinds synchronoulsy, hence blocks until shut down is done.
     """
-    def stop(self) -> None:
+    def _stop(self) -> None:
+        """
+        Stop the plugin. Should be overwritten by subclasses.
+        """
         pass
 
+    def stop(self) -> None:
+        """
+        Stop the plugin by delegating to
+        :meth:`~trinity.extensibility.plugin.BaseSyncStopPlugin._stop`
+        """
+        self._stop()
+        self.running = False
+
 
 class BaseAsyncStopPlugin(BasePlugin):
     """
     A ``BaseAsyncStopPlugin`` unwinds asynchronoulsy, hence needs to be awaited.
     """
 
-    async def stop(self) -> None:
+    async def _stop(self) -> None:
+        """
+        Asynchronously stop the plugin. Should be overwritten by subclasses.
+        """
         pass
 
+    async def stop(self) -> None:
+        """
+        Asynchronously stop the plugin by delegating to
+        :meth:`~trinity.extensibility.plugin.BaseAsyncStopPlugin._stop`
+        """
+        await self._stop()
+        self.running = False
+
 
 class BaseMainProcessPlugin(BasePlugin):
     """
@@ -170,7 +192,7 @@ class BaseIsolatedPlugin(BaseSyncStopPlugin):
 
     _process: Process = None
 
-    def boot(self) -> None:
+    def start(self) -> None:
         """
         Prepare the plugin to get started and eventually cause ``start`` to get called.
         """
@@ -190,9 +212,9 @@ def _prepare_start(self) -> None:
         self.event_bus.broadcast(
             PluginStartedEvent(type(self))
         )
-        self.start()
+        self._start()
 
-    def stop(self) -> None:
+    def _stop(self) -> None:
         self.context.event_bus.stop()
         kill_process_gracefully(self._process, self.logger)
 
@@ -212,7 +234,7 @@ def configure_parser(self, arg_parser: ArgumentParser, subparser: _SubParsersAct
     def handle_event(self, activation_event: BaseEvent) -> None:
         self.logger.info("Debug plugin: handle_event called: %s", activation_event)
 
-    def start(self) -> None:
+    def _start(self) -> None:
         self.logger.info("Debug plugin: start called")
         asyncio.ensure_future(self.count_forever())
 
@@ -223,5 +245,5 @@ async def count_forever(self) -> None:
             i += 1
             await asyncio.sleep(1)
 
-    async def stop(self) -> None:
+    async def _stop(self) -> None:
         self.logger.info("Debug plugin: stop called")

trinity/extensibility/plugin_manager.py

@@ -195,7 +195,6 @@ def shutdown_blocking(self) -> None:
             try:
                 self._logger.info("Stopping plugin: %s", plugin.name)
                 plugin.stop()
-                plugin.running = False
                 self._logger.info("Successfully stopped plugin: %s", plugin.name)
             except Exception:
                 self._logger.exception("Exception thrown while stopping plugin %s", plugin.name)
@@ -224,7 +223,6 @@ async def shutdown(self) -> None:
                     'Exception thrown while stopping plugin %s: %s', plugin.name, result
                 )
             else:
-                plugin.running = False
                 self._logger.info("Successfully stopped plugin: %s", plugin.name)
 
     def _stop_plugins(self,

trinity/plugins/builtin/ethstats/plugin.py

@@ -101,9 +101,9 @@ def ready(self) -> None:
         self.node_id = args.ethstats_node_id
         self.node_contact = args.ethstats_node_contact
 
-        self.boot()
+        self.start()
 
-    def start(self) -> None:
+    def _start(self) -> None:
         service = EthstatsService(
             self.context,
             self.server_url,

trinity/plugins/builtin/json_rpc/plugin.py

@@ -35,7 +35,7 @@ def name(self) -> str:
 
     def ready(self) -> None:
         if not self.context.args.disable_rpc:
-            self.boot()
+            self.start()
 
     def configure_parser(self, arg_parser: ArgumentParser, subparser: _SubParsersAction) -> None:
         arg_parser.add_argument(
@@ -44,7 +44,7 @@ def configure_parser(self, arg_parser: ArgumentParser, subparser: _SubParsersAct
             help="Disables the JSON-RPC Server",
         )
 
-    def start(self) -> None:
+    def _start(self) -> None:
         db_manager = create_db_manager(self.context.trinity_config.database_ipc_path)
         db_manager.connect()
 

trinity/plugins/builtin/light_peer_chain_bridge/plugin.py

@@ -55,14 +55,14 @@ def should_start(self) -> bool:
     def handle_event(self, event: ResourceAvailableEvent) -> None:
         if event.resource_type is BaseChain:
             self.chain = event.resource
-            self.boot()
+            self.start()
 
-    def start(self) -> None:
+    def _start(self) -> None:
         chain = cast(LightDispatchChain, self.chain)
         self.handler = LightPeerChainEventBusHandler(chain._peer_chain, self.context.event_bus)
         asyncio.ensure_future(self.handler.run())
 
-    async def stop(self) -> None:
+    async def _stop(self) -> None:
         # This isn't really needed for the standard shutdown case as the LightPeerChain will
         # automatically shutdown whenever the `CancelToken` it was chained with is triggered.
         # It may still be useful to stop the LightPeerChain Bridge plugin individually though.

trinity/plugins/builtin/tx_pool/plugin.py

@@ -75,9 +75,9 @@ def handle_event(self, event: ResourceAvailableEvent) -> None:
             self.chain = event.resource
 
         if all((self.peer_pool is not None, self.chain is not None, self.is_enabled)):
-            self.boot()
+            self.start()
 
-    def start(self) -> None:
+    def _start(self) -> None:
         if isinstance(self.chain, BaseMainnetChain):
             validator = DefaultTransactionValidator(self.chain, BYZANTIUM_MAINNET_BLOCK)
         elif isinstance(self.chain, BaseRopstenChain):
@@ -90,7 +90,7 @@ def start(self) -> None:
         self.tx_pool = TxPool(self.peer_pool, validator, self.cancel_token)
         asyncio.ensure_future(self.tx_pool.run())
 
-    async def stop(self) -> None:
+    async def _stop(self) -> None:
         # This isn't really needed for the standard shutdown case as the TxPool will automatically
         # shutdown whenever the `CancelToken` it was chained with is triggered. It may still be
         # useful to stop the TxPool plugin individually though.