PR feedback: async with host.run()

libp2p/__init__.py

@@ -1,14 +1,9 @@
-from typing import AsyncIterator, Sequence
-
-from async_generator import asynccontextmanager
-from async_service import background_trio_service
-
 from libp2p.crypto.keys import KeyPair
 from libp2p.crypto.rsa import create_new_key_pair
 from libp2p.host.basic_host import BasicHost
 from libp2p.host.host_interface import IHost
 from libp2p.host.routed_host import RoutedHost
-from libp2p.network.network_interface import INetwork, INetworkService
+from libp2p.network.network_interface import INetworkService
 from libp2p.network.swarm import Swarm
 from libp2p.peer.id import ID
 from libp2p.peer.peerstore import PeerStore
@@ -32,14 +27,14 @@ def generate_peer_id_from(key_pair: KeyPair) -> ID:
     return ID.from_pubkey(public_key)
 
 
-def initialize_default_swarm(
+def new_swarm(
     key_pair: KeyPair = None,
     muxer_opt: TMuxerOptions = None,
     sec_opt: TSecurityOptions = None,
     peerstore_opt: IPeerStore = None,
 ) -> INetworkService:
     """
-    initialize swarm when no swarm is passed in.
+    Create a swarm instance based on the parameters.
 
     :param key_pair: optional choice of the ``KeyPair``
     :param muxer_opt: optional choice of stream muxer
@@ -48,7 +43,7 @@ def initialize_default_swarm(
     :return: return a default swarm instance
     """
 
-    if not key_pair:
+    if key_pair is None:
         key_pair = generate_new_rsa_identity()
 
     id_opt = generate_peer_id_from(key_pair)
@@ -72,45 +67,32 @@ def initialize_default_swarm(
     return Swarm(id_opt, peerstore, upgrader, transport)
 
 
-def _new_host(swarm_opt: INetwork, disc_opt: IPeerRouting = None) -> IHost:
-    """
-    create new libp2p host.
-
-    :param swarm_opt: optional swarm
-    :param disc_opt: optional discovery
-    :return: return a host instance
-    """
-    # TODO enable support for other host type
-    # TODO routing unimplemented
-    host: IHost  # If not explicitly typed, MyPy raises error
-    if disc_opt:
-        host = RoutedHost(swarm_opt, disc_opt)
-    else:
-        host = BasicHost(swarm_opt)
-
-    return host
-
-
-@asynccontextmanager
-async def new_host_trio(
-    listen_addrs: Sequence[str],
+def new_host(
     key_pair: KeyPair = None,
-    swarm_opt: INetwork = None,
     muxer_opt: TMuxerOptions = None,
     sec_opt: TSecurityOptions = None,
     peerstore_opt: IPeerStore = None,
     disc_opt: IPeerRouting = None,
-) -> AsyncIterator[IHost]:
-    swarm = initialize_default_swarm(
+) -> IHost:
+    """
+    Create a new libp2p host based on the given parameters.
+
+    :param key_pair: optional choice of the ``KeyPair``
+    :param muxer_opt: optional choice of stream muxer
+    :param sec_opt: optional choice of security upgrade
+    :param peerstore_opt: optional peerstore
+    :param disc_opt: optional discovery
+    :return: return a host instance
+    """
+    swarm = new_swarm(
         key_pair=key_pair,
         muxer_opt=muxer_opt,
         sec_opt=sec_opt,
         peerstore_opt=peerstore_opt,
     )
-    async with background_trio_service(swarm):
-        await swarm.listen(*listen_addrs)
-        host = _new_host(swarm_opt=swarm, disc_opt=disc_opt)
-        yield host
-
-
-# TODO: Support asyncio
+    host: IHost
+    if disc_opt:
+        host = RoutedHost(swarm, disc_opt)
+    else:
+        host = BasicHost(swarm)
+    return host

libp2p/host/basic_host.py

@@ -1,12 +1,14 @@
 import logging
-from typing import TYPE_CHECKING, List, Sequence
+from typing import TYPE_CHECKING, AsyncIterator, List, Sequence
 
+from async_generator import asynccontextmanager
+from async_service import background_trio_service
 import multiaddr
 
 from libp2p.crypto.keys import PrivateKey, PublicKey
 from libp2p.host.defaults import get_default_protocols
 from libp2p.host.exceptions import StreamFailure
-from libp2p.network.network_interface import INetwork
+from libp2p.network.network_interface import INetworkService
 from libp2p.network.stream.net_stream_interface import INetStream
 from libp2p.peer.id import ID
 from libp2p.peer.peerinfo import PeerInfo
@@ -39,7 +41,7 @@ class BasicHost(IHost):
     right after a stream is initialized.
     """
 
-    _network: INetwork
+    _network: INetworkService
     peerstore: IPeerStore
 
     multiselect: Multiselect
@@ -47,7 +49,7 @@ class BasicHost(IHost):
 
     def __init__(
         self,
-        network: INetwork,
+        network: INetworkService,
         default_protocols: "OrderedDict[TProtocol, StreamHandlerFn]" = None,
     ) -> None:
         self._network = network
@@ -70,7 +72,7 @@ class BasicHost(IHost):
     def get_private_key(self) -> PrivateKey:
         return self.peerstore.privkey(self.get_id())
 
-    def get_network(self) -> INetwork:
+    def get_network(self) -> INetworkService:
         """
         :return: network instance of host
         """
@@ -101,6 +103,20 @@ class BasicHost(IHost):
                 addrs.append(addr.encapsulate(p2p_part))
         return addrs
 
+    @asynccontextmanager
+    async def run(
+        self, listen_addrs: Sequence[multiaddr.Multiaddr]
+    ) -> AsyncIterator[None]:
+        """
+        run the host instance and listen to ``listen_addrs``.
+
+        :param listen_addrs: a sequence of multiaddrs that we want to listen to
+        """
+        network = self.get_network()
+        async with background_trio_service(network):
+            await network.listen(*listen_addrs)
+            yield
+
     def set_stream_handler(
         self, protocol_id: TProtocol, stream_handler: StreamHandlerFn
     ) -> None:

libp2p/host/host_interface.py

@@ -1,10 +1,10 @@
 from abc import ABC, abstractmethod
-from typing import Any, List, Sequence
+from typing import Any, AsyncContextManager, List, Sequence
 
 import multiaddr
 
 from libp2p.crypto.keys import PrivateKey, PublicKey
-from libp2p.network.network_interface import INetwork
+from libp2p.network.network_interface import INetworkService
 from libp2p.network.stream.net_stream_interface import INetStream
 from libp2p.peer.id import ID
 from libp2p.peer.peerinfo import PeerInfo
@@ -31,7 +31,7 @@ class IHost(ABC):
         """
 
     @abstractmethod
-    def get_network(self) -> INetwork:
+    def get_network(self) -> INetworkService:
         """
         :return: network instance of host
         """
@@ -49,6 +49,16 @@ class IHost(ABC):
         :return: all the multiaddr addresses this host is listening to
         """
 
+    @abstractmethod
+    def run(
+        self, listen_addrs: Sequence[multiaddr.Multiaddr]
+    ) -> AsyncContextManager[None]:
+        """
+        run the host instance and listen to ``listen_addrs``.
+
+        :param listen_addrs: a sequence of multiaddrs that we want to listen to
+        """
+
     @abstractmethod
     def set_stream_handler(
         self, protocol_id: TProtocol, stream_handler: StreamHandlerFn

libp2p/host/routed_host.py

@@ -1,6 +1,6 @@
 from libp2p.host.basic_host import BasicHost
 from libp2p.host.exceptions import ConnectionFailure
-from libp2p.network.network_interface import INetwork
+from libp2p.network.network_interface import INetworkService
 from libp2p.peer.peerinfo import PeerInfo
 from libp2p.routing.interfaces import IPeerRouting
 
@@ -10,7 +10,7 @@ from libp2p.routing.interfaces import IPeerRouting
 class RoutedHost(BasicHost):
     _router: IPeerRouting
 
-    def __init__(self, network: INetwork, router: IPeerRouting):
+    def __init__(self, network: INetworkService, router: IPeerRouting):
         super().__init__(network)
         self._router = router