telnetlib3-client --connect-timeout (jquast#113)

* --connect-timeout, closes #30
* threw in typing fixes, too!

Author: jquast

README.rst

@@ -29,7 +29,8 @@
 Introduction
 ============
 
-``telnetlib3`` is a feature-rich Telnet Server and Client and Protocol library for Python 3.9 and newer.
+``telnetlib3`` is a feature-rich Telnet Server and Client Protocol library
+for Python 3.9 and newer.
 
 This library supports both modern asyncio_ *and* legacy `Blocking API`_.
 

docs/history.rst

@@ -1,5 +1,8 @@
 History
 =======
+*unreleased*
+  * new: ``connect_timeout`` arguments for client and ``--connect-timeout`` Client CLI argument.
+
 2.2.0
   * bugfix: workaround for Microsoft Telnet client crash on
     ``SB NEW_ENVIRON SEND``, :ghissue:`24`. Server now defers ``DO

pyproject.toml

@@ -139,10 +139,7 @@ ignore_missing_imports = true
 
 [[tool.mypy.overrides]]
 module = ["telnetlib3.tests.*"]
-disallow_untyped_defs = false
-disallow_incomplete_defs = false
-disallow_untyped_calls = false
-warn_return_any = false
+ignore_errors = true
 
 [[tool.mypy.overrides]]
 module = ["telnetlib3.telnetlib"]

telnetlib3/client.py

@@ -390,6 +390,7 @@ async def open_connection(  # pylint: disable=too-many-locals
     shell: Optional[ShellCallback] = None,
     connect_minwait: float = 2.0,
     connect_maxwait: float = 3.0,
+    connect_timeout: Optional[float] = None,
     waiter_closed: Optional[asyncio.Future[None]] = None,
     _waiter_connected: Optional[asyncio.Future[None]] = None,
     limit: Optional[int] = None,
@@ -445,6 +446,11 @@ async def open_connection(  # pylint: disable=too-many-locals
         otherwise confused by our demands, the shell continues anyway after the
         greater of this value has elapsed.  A client that is not answering
         option negotiation will delay the start of the shell by this amount.
+    :param connect_timeout: Timeout in seconds for the TCP connection to be
+        established.  When ``None`` (default), no timeout is applied and the
+        connection attempt may block indefinitely.  When specified, a
+        :exc:`ConnectionError` is raised if the connection is not established
+        within the given time.
 
     :param force_binary: When ``True``, the encoding is used regardless
         of BINARY mode negotiation.
@@ -480,14 +486,22 @@ def connection_factory() -> client_base.BaseClient:
             send_environ=send_environ,
         )
 
-    _, protocol = await asyncio.get_event_loop().create_connection(
-        connection_factory,
-        host or "localhost",
-        port,
-        family=family,
-        flags=flags,
-        local_addr=local_addr,
-    )
+    try:
+        _, protocol = await asyncio.wait_for(
+            asyncio.get_event_loop().create_connection(
+                connection_factory,
+                host or "localhost",
+                port,
+                family=family,
+                flags=flags,
+                local_addr=local_addr,
+            ),
+            timeout=connect_timeout,
+        )
+    except asyncio.TimeoutError as exc:
+        raise ConnectionError(
+            f"TCP connection to {host or 'localhost'}:{port}" f" timed out after {connect_timeout}s"
+        ) from exc
 
     await protocol._waiter_connected  # pylint: disable=protected-access
 
@@ -518,6 +532,7 @@ async def run_client() -> None:
         "force_binary": args["force_binary"],
         "encoding_errors": args["encoding_errors"],
         "connect_minwait": args["connect_minwait"],
+        "connect_timeout": args["connect_timeout"],
         "send_environ": args["send_environ"],
     }
 
@@ -564,6 +579,12 @@ def _get_argument_parser() -> argparse.ArgumentParser:
         type=float,
         help="timeout for pending negotiation",
     )
+    parser.add_argument(
+        "--connect-timeout",
+        default=None,
+        type=float,
+        help="timeout for TCP connection (seconds, default: no timeout)",
+    )
     parser.add_argument(
         "--send-environ",
         default="TERM,LANG,COLUMNS,LINES,COLORTERM",
@@ -586,6 +607,7 @@ def _transform_args(args: argparse.Namespace) -> Dict[str, Any]:
         "force_binary": args.force_binary,
         "encoding_errors": args.encoding_errors,
         "connect_minwait": args.connect_minwait,
+        "connect_timeout": args.connect_timeout,
         "send_environ": tuple(v.strip() for v in args.send_environ.split(",") if v.strip()),
     }
 

telnetlib3/client_shell.py

@@ -43,9 +43,7 @@ class Terminal:
             "ModeDef", ["iflag", "oflag", "cflag", "lflag", "ispeed", "ospeed", "cc"]
         )
 
-        def __init__(
-            self, telnet_writer: Union[TelnetWriter, TelnetWriterUnicode]
-        ) -> None:
+        def __init__(self, telnet_writer: Union[TelnetWriter, TelnetWriterUnicode]) -> None:
             self.telnet_writer = telnet_writer
             self._fileno = sys.stdin.fileno()
             self._istty = os.path.sameopenfile(0, 1)

telnetlib3/fingerprinting_display.py

@@ -919,7 +919,7 @@ def _normalize_color_hex(hex_color: str) -> str:
     )
 
     r, g, b = hex_to_rgb(hex_color)
-    return rgb_to_hex(r, g, b)
+    return str(rgb_to_hex(r, g, b))
 
 
 def _filter_terminal_detail(  # pylint: disable=too-complex,too-many-branches

telnetlib3/server_pty_shell.py

@@ -379,9 +379,7 @@ async def _bridge_loop(
             telnet_task: asyncio.Task[Union[bytes, str]] = asyncio.create_task(
                 self.reader.read(4096)
             )
-            pty_task: asyncio.Task[bool] = asyncio.create_task(
-                pty_read_event.wait()
-            )
+            pty_task: asyncio.Task[bool] = asyncio.create_task(pty_read_event.wait())
 
             done, pending = await asyncio.wait(
                 {telnet_task, pty_task},

telnetlib3/stream_writer.py

@@ -1456,9 +1456,7 @@ def handle_environ(self, env: dict[str, str]) -> None:
         """Receive environment variables as dict, :rfc:`1572`."""
         self.log.debug("Environment values are %r", env)
 
-    def handle_send_client_environ(
-        self, _keys: Any
-    ) -> dict[str, str]:
+    def handle_send_client_environ(self, _keys: Any) -> dict[str, str]:
         """
         Send environment variables as dict, :rfc:`1572`.
 

telnetlib3/sync.py

@@ -59,6 +59,8 @@ class TelnetConnection:
     :param port: Remote server port (default 23).
     :param timeout: Default timeout for operations in seconds.
     :param encoding: Character encoding (default 'utf8').
+    :param connect_timeout: Timeout in seconds for the TCP connection to be
+        established.  Passed to ``telnetlib3.open_connection()``.
     :param kwargs: Additional arguments passed to ``telnetlib3.open_connection()``.
 
     Example::

telnetlib3/tests/test_core.py

@@ -16,9 +16,7 @@
 import telnetlib3
 from telnetlib3.telopt import (
     DO,
-    IS,
     SB,
-    SE,
     IAC,
     SGA,
     ECHO,
@@ -28,7 +26,6 @@
     TTYPE,
     BINARY,
     CHARSET,
-    NEW_ENVIRON,
 )
 from telnetlib3.tests.accessories import (  # pylint: disable=unused-import
     bind_host,