Merge pull request #278 from squat/type_connect

nats: add typing to main connect function

Author: wallyqs

nats/__init__.py

@@ -11,11 +11,15 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+from typing import List, Union
 
 from .aio.client import Client as NATS
 
 
-async def connect(servers=["nats://localhost:4222"], **options) -> NATS:
+async def connect(
+    servers: Union[str, List[str]] = ["nats://localhost:4222"],
+    **options
+) -> NATS:
     """
     :param servers: List of servers to connect.
     :param options: NATS connect options.

nats/aio/client.py

@@ -219,7 +219,7 @@ def __init__(self) -> None:
 
     async def connect(
         self,
-        servers: List[str] = ["nats://127.0.0.1:4222"],
+        servers: Union[str, List[str]] = ["nats://localhost:4222"],
         error_cb: Optional[ErrorCallback] = None,
         disconnected_cb: Optional[Callback] = None,
         closed_cb: Optional[Callback] = None,
@@ -1083,11 +1083,11 @@ def _setup_server_pool(self, connect_url: Union[str, List[str]]) -> None:
             try:
                 if "nats://" in connect_url or "tls://" in connect_url:
                     # Closer to how the Go client handles this.
-                    # e.g. nats://127.0.0.1:4222
+                    # e.g. nats://localhost:4222
                     uri = urlparse(connect_url)
                 elif ":" in connect_url:
                     # Expand the scheme for the user
-                    # e.g. 127.0.0.1:4222
+                    # e.g. localhost:4222
                     uri = urlparse(f"nats://{connect_url}")
                 else:
                     # Just use the endpoint with the default NATS port.