Unfinished changes from discussion

src/_pytask/vscode.py

@@ -32,12 +32,30 @@
 
 
 def send_logging_info(url: str, data: dict[str, Any], timeout: float) -> None:
-    """Send logging information to the provided port."""
+    """Send logging information to the provided port.
+
+    TODO(@max): Explain why we need to suppress URLError and TimeoutError. Ideally, add
+    link to StackOverflow or similar.
+
+    """
     with contextlib.suppress(URLError, TimeoutError):
         response = json.dumps(data).encode("utf-8")
         req = Request(url, data=response)  # noqa: S310
         req.add_header("Content-Type", "application/json; charset=utf-8")
         urlopen(req, timeout=timeout)  # noqa: S310
+
+
+def validate_and_return_port(port: str) -> int:
+    """Validate the port number."""
+    try:
+        port = int(port)
+    except ValueError as e:
+        # TODO(@max):
+        # (1) Add comment to docstring, explaining why we do this
+        # (2) Raise ValueError with "good" error message
+        msg = f"Invalid port number: {port}, must be an integer."
+        raise ValueError(msg) from e
+    return port
 
 
 @hookimpl(tryfirst=True)
@@ -49,10 +67,8 @@ def pytask_collect_log(
         os.environ.get("PYTASK_VSCODE") is not None
         and session.config["command"] == "collect"
     ):
-        try:
-            port = int(os.environ["PYTASK_VSCODE"])
-        except ValueError:
-            port = DEFAULT_VSCODE_PORT
+
+        port = validate_and_return_port(os.environ["PYTASK_VSCODE"])
 
         exitcode = "OK"
         for report in reports:
@@ -82,10 +98,8 @@ def pytask_execute_task_log_end(
 ) -> None:
     """Start threads to send logging information for executed tasks."""
     if os.environ.get("PYTASK_VSCODE") is not None:
-        try:
-            port = int(os.environ["PYTASK_VSCODE"])
-        except ValueError:
-            port = DEFAULT_VSCODE_PORT
+
+        port = validate_and_return_port(os.environ["PYTASK_VSCODE"])
 
         result = {
             "name": report.task.name,

tests/test_vscode.py

@@ -4,11 +4,20 @@
 import textwrap
 
 import pytest
-from _pytask.vscode import send_logging_info
+from _pytask.vscode import send_logging_info, validate_and_return_port
 from pytask import ExitCode
 from pytask import cli
 
 
+def test_validate_and_return_port_valid_port():
+    assert validate_and_return_port("6000") == 6000
+
+
+def test_validate_and_return_port_invalid_port():
+    with pytest.raises(ValueError):
+        validate_and_return_port("not_an_integer")
+
+
 @pytest.mark.end_to_end()
 def test_vscode_collect_failed(runner, tmp_path):
     source = """