Skip to content

Scrapy, a fast high-level web crawling & scraping framework for Python.

Close telnet connection on exit() to avoid an unhandled error log (#8065)

Adrian9b3bef3315bd
diff --git a/scrapy/extensions/telnet.py b/scrapy/extensions/telnet.py
index 04eee35f5..a9a391843 100644
--- a/scrapy/extensions/telnet.py
+++ b/scrapy/extensions/telnet.py
@@ -38,6 +38,30 @@ logger = logging.getLogger(__name__)
update_telnet_vars = object()
+def _get_manhole_class() -> type[Any]:
+ # Imported here, not at module level, because twisted.conch.manhole
+ # indirectly imports twisted.internet.reactor.
+ from twisted.conch import manhole
+
+ class _ManholeInterpreter(manhole.ManholeInterpreter):
+ def runcode(self, *args: Any, **kwargs: Any) -> None:
+ try:
+ super().runcode(*args, **kwargs) # type: ignore[no-untyped-call]
+ except SystemExit:
+ # exit()/quit() would otherwise raise into the reactor and
+ # be logged as an unhandled error.
+ self.handler.terminal.loseConnection()
+
+ class _Manhole(manhole.Manhole):
+ def connectionMade(self) -> None:
+ super().connectionMade() # type: ignore[no-untyped-call]
+ self.interpreter = _ManholeInterpreter( # type: ignore[no-untyped-call]
+ self, self.namespace
+ )
+
+ return _Manhole
+
+
class TelnetConsole(protocol.ServerFactory):
def __init__(self, crawler: Crawler):
if not crawler.settings.getbool("TELNETCONSOLE_ENABLED"):
@@ -96,10 +120,10 @@ class TelnetConsole(protocol.ServerFactory):
):
return fail(ValueError("Invalid credentials"))
- from twisted.conch import manhole
-
protocol = telnet.TelnetBootstrapProtocol(
- insults.ServerProtocol, manhole.Manhole, self._get_telnet_vars()
+ insults.ServerProtocol,
+ _get_manhole_class(),
+ self._get_telnet_vars(),
)
return succeed((interfaces[0], protocol, lambda: None))
diff --git a/tests/test_extension_telnet.py b/tests/test_extension_telnet.py
index 1e8771d65..194b5b242 100644
--- a/tests/test_extension_telnet.py
+++ b/tests/test_extension_telnet.py
@@ -3,13 +3,18 @@ from __future__ import annotations
import socket
from contextlib import contextmanager
from typing import TYPE_CHECKING, Any
+from unittest import mock
import pytest
from twisted.conch.telnet import ITelnetProtocol
from twisted.cred import credentials
from scrapy import Spider
-from scrapy.extensions.telnet import TelnetConsole, update_telnet_vars
+from scrapy.extensions.telnet import (
+ TelnetConsole,
+ _get_manhole_class,
+ update_telnet_vars,
+)
from scrapy.utils.defer import maybe_deferred_to_future
from scrapy.utils.misc import build_from_crawler
from scrapy.utils.test import get_crawler
@@ -86,6 +91,16 @@ async def test_custom_credentials() -> None:
await maybe_deferred_to_future(d)
+def test_manhole_exit_closes_connection() -> None:
+ """exit()/quit() in the console must not raise SystemExit into the
+ reactor, where it would be logged as an unhandled error."""
+ manhole = _get_manhole_class()({})
+ manhole.terminal = mock.MagicMock()
+ manhole.connectionMade()
+ manhole.lineReceived(b"exit()")
+ manhole.terminal.loseConnection.assert_called_once()
+
+
def test_invalid_reversed_portrange() -> None:
settings = {"TELNETCONSOLE_PORT": [2, 1]}
console = build_from_crawler(TelnetConsole, _get_crawler(settings_dict=settings))