File: backchannel.py

package info (click to toggle)
debugpy 1.6.6%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,264 kB
  • sloc: python: 13,833; sh: 244; makefile: 25
file content (72 lines) | stat: -rw-r--r-- 1,732 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See LICENSE in the project root
# for license information.

"""Imported from test code that runs under debugpy, and allows that code
to communcate back to the test. Works in conjunction with debug_session
fixture and its backchannel method."""

__all__ = ["port", "receive", "send"]

import atexit
import os
import socket

import debuggee
from debugpy.common import log, messaging


def send(value):
    _stream.write_json(value)


def receive():
    return _stream.read_json()


def close():
    global _socket, _stream
    if _socket is None:
        return

    log.info("Shutting down {0}...", name)
    try:
        _socket.shutdown(socket.SHUT_RDWR)
    except Exception:
        pass
    finally:
        _socket = None
        try:
            _stream.close()
        except Exception:
            pass
        finally:
            _stream = None


class _stream:
    def _error(*_):
        raise AssertionError("Backchannel is not set up for this process")

    read_json = write_json = _error
    close = lambda: None


name = f"backchannel-{debuggee.session_id}"
port = os.environ.pop("DEBUGPY_TEST_BACKCHANNEL_PORT", None)
if port is not None:
    port = int(port)
    log.info("Connecting {0} to port {1}...", name, port)

    _socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
    try:
        _socket.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
        _socket.connect(("localhost", port))
    except Exception:
        _socket.close()
        raise
    else:
        _stream = messaging.JsonIOStream.from_socket(  # noqa
            _socket, name="backchannel"
        )
        atexit.register(close)