dos-mcp 0.1.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,21 @@
1
+ name: Test
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request:
7
+ branches: [main]
8
+ workflow_dispatch:
9
+
10
+ jobs:
11
+ test:
12
+ runs-on: ubuntu-latest
13
+ steps:
14
+ - uses: actions/checkout@v6
15
+ - uses: astral-sh/setup-uv@v7
16
+ - run: uv sync --locked --all-groups
17
+ - run: uv run ruff check .
18
+ - run: uv run mypy
19
+ - run: uv run pytest
20
+ - run: uv build
21
+
@@ -0,0 +1,9 @@
1
+ .venv/
2
+ __pycache__/
3
+ *.py[cod]
4
+ .mypy_cache/
5
+ .pytest_cache/
6
+ .ruff_cache/
7
+ dist/*
8
+ !dist/.gitignore
9
+
@@ -0,0 +1,6 @@
1
+ # Agent instructions
2
+
3
+ - `$GHIDRA_INSTALL_DIR` identifies the installation
4
+ - Use `$GHIDRA_SOURCE_DIR` and/or `$DOSBOX_X_SOURCE_DIR` when source can replace guesswork
5
+ - Record public-contract changes in `CHANGELOG.md`; release via `tools/release <major|minor|patch>`, following semver
6
+
@@ -0,0 +1,7 @@
1
+ # Changelog
2
+
3
+ ## Unreleased
4
+
5
+ ## 0.1.1
6
+ - Add bounded DOSBox-X QMP control, input, capture, memory, and state tools.
7
+ - Add host-side floppy image swapping for multi-disk guest workflows.
@@ -0,0 +1 @@
1
+ AGENTS.md
dos_mcp-0.1.1/LICENSE ADDED
@@ -0,0 +1,190 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ Copyright 2026 Saverio Proto
179
+
180
+ Licensed under the Apache License, Version 2.0 (the "License");
181
+ you may not use this file except in compliance with the License.
182
+ You may obtain a copy of the License at
183
+
184
+ http://www.apache.org/licenses/LICENSE-2.0
185
+
186
+ Unless required by applicable law or agreed to in writing, software
187
+ distributed under the License is distributed on an "AS IS" BASIS,
188
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
+ See the License for the specific language governing permissions and
190
+ limitations under the License.
dos_mcp-0.1.1/NOTICE ADDED
@@ -0,0 +1,3 @@
1
+ dos-mcp
2
+ Copyright 2026 Saverio Proto
3
+
dos_mcp-0.1.1/PKG-INFO ADDED
@@ -0,0 +1,67 @@
1
+ Metadata-Version: 2.5
2
+ Name: dos-mcp
3
+ Version: 0.1.1
4
+ Summary: DOSBox-X control tools for DOS malware analysis
5
+ License-Expression: Apache-2.0
6
+ License-File: LICENSE
7
+ License-File: NOTICE
8
+ Requires-Python: >=3.10
9
+ Requires-Dist: mcp==1.28.1
10
+ Description-Content-Type: text/markdown
11
+
12
+ # dos-mcp
13
+
14
+ Small MCP tools for a loopback-only DOSBox-X QMP server. Ghidra's maintained
15
+ GDB TraceRMI agent owns debugger state; this server supplies emulator control,
16
+ paced keyboard input, bounded memory reads, screenshots, and snapshots.
17
+
18
+ ## Tools
19
+
20
+ - `dosbox_status`, `dosbox_pause`, `dosbox_resume`, and `dosbox_reset`
21
+ - `dosbox_swap_floppy`
22
+ - `dosbox_send_keys`, `dosbox_key_event`, and `dosbox_type_text`
23
+ - `dosbox_break_on_next_exec`
24
+ - `dosbox_read_memory` and `dosbox_capture_screen`
25
+ - `dosbox_save_state` and `dosbox_load_state`
26
+
27
+ Inline memory responses are capped at 4 KiB and returned as hex. Reads up to
28
+ 64 KiB can instead be written to an absolute `output_path`. Typed text is paced
29
+ and capped at 128 US-ASCII characters; it is convenient shell input, not a
30
+ cycle-deterministic keyboard primitive. Use `dosbox_key_event` to hold and
31
+ release keys. The guest must actively consume its BIOS keyboard ring while text
32
+ is sent; a busy program can silently lose input. State paths must be absolute
33
+ ASCII paths, and saves do not replace an existing file unless `overwrite=true`.
34
+
35
+ Input, reset, state, and capture operations require running execution. QMP
36
+ memory reads default to requiring a paused emulator because a running read can
37
+ be torn; `allow_running=true` opts into that explicitly. QMP pause can be
38
+ resumed through `dosbox_resume`; a GDB stop must be continued through GDB.
39
+ DOSBox-X zero-fills unreadable physical addresses, so an unmapped byte cannot be
40
+ distinguished from a real zero through this QMP interface.
41
+ `dosbox_swap_floppy` advances the pre-mounted image list for A: or B: without
42
+ injecting a host-side keyboard shortcut.
43
+
44
+ Each tool call opens one local QMP session, completes the QMP handshake, performs
45
+ its commands serially, and disconnects. Requests are never retried: a timed-out
46
+ mutation may already have happened, so inspect emulator state before repeating
47
+ it.
48
+
49
+ This server requires the companion DOSBox-X build made with
50
+ `--enable-remotedebug` and configured with `[dosbox] qmpserver=true`. DOSBox-X
51
+ accepts one QMP client at a time; do not attach another monitor while using this
52
+ MCP server.
53
+
54
+ ## Configuration
55
+
56
+ The server uses `127.0.0.1` and never accepts a remote QMP host.
57
+
58
+ - `DOSBOX_X_QMP_PORT` defaults to `4444`.
59
+ - `DOSBOX_X_QMP_TIMEOUT` defaults to `35` seconds.
60
+
61
+ Run with:
62
+
63
+ ```sh
64
+ uv run dos-mcp
65
+ ```
66
+
67
+ Apache-2.0.
@@ -0,0 +1,56 @@
1
+ # dos-mcp
2
+
3
+ Small MCP tools for a loopback-only DOSBox-X QMP server. Ghidra's maintained
4
+ GDB TraceRMI agent owns debugger state; this server supplies emulator control,
5
+ paced keyboard input, bounded memory reads, screenshots, and snapshots.
6
+
7
+ ## Tools
8
+
9
+ - `dosbox_status`, `dosbox_pause`, `dosbox_resume`, and `dosbox_reset`
10
+ - `dosbox_swap_floppy`
11
+ - `dosbox_send_keys`, `dosbox_key_event`, and `dosbox_type_text`
12
+ - `dosbox_break_on_next_exec`
13
+ - `dosbox_read_memory` and `dosbox_capture_screen`
14
+ - `dosbox_save_state` and `dosbox_load_state`
15
+
16
+ Inline memory responses are capped at 4 KiB and returned as hex. Reads up to
17
+ 64 KiB can instead be written to an absolute `output_path`. Typed text is paced
18
+ and capped at 128 US-ASCII characters; it is convenient shell input, not a
19
+ cycle-deterministic keyboard primitive. Use `dosbox_key_event` to hold and
20
+ release keys. The guest must actively consume its BIOS keyboard ring while text
21
+ is sent; a busy program can silently lose input. State paths must be absolute
22
+ ASCII paths, and saves do not replace an existing file unless `overwrite=true`.
23
+
24
+ Input, reset, state, and capture operations require running execution. QMP
25
+ memory reads default to requiring a paused emulator because a running read can
26
+ be torn; `allow_running=true` opts into that explicitly. QMP pause can be
27
+ resumed through `dosbox_resume`; a GDB stop must be continued through GDB.
28
+ DOSBox-X zero-fills unreadable physical addresses, so an unmapped byte cannot be
29
+ distinguished from a real zero through this QMP interface.
30
+ `dosbox_swap_floppy` advances the pre-mounted image list for A: or B: without
31
+ injecting a host-side keyboard shortcut.
32
+
33
+ Each tool call opens one local QMP session, completes the QMP handshake, performs
34
+ its commands serially, and disconnects. Requests are never retried: a timed-out
35
+ mutation may already have happened, so inspect emulator state before repeating
36
+ it.
37
+
38
+ This server requires the companion DOSBox-X build made with
39
+ `--enable-remotedebug` and configured with `[dosbox] qmpserver=true`. DOSBox-X
40
+ accepts one QMP client at a time; do not attach another monitor while using this
41
+ MCP server.
42
+
43
+ ## Configuration
44
+
45
+ The server uses `127.0.0.1` and never accepts a remote QMP host.
46
+
47
+ - `DOSBOX_X_QMP_PORT` defaults to `4444`.
48
+ - `DOSBOX_X_QMP_TIMEOUT` defaults to `35` seconds.
49
+
50
+ Run with:
51
+
52
+ ```sh
53
+ uv run dos-mcp
54
+ ```
55
+
56
+ Apache-2.0.
@@ -0,0 +1 @@
1
+ *
@@ -0,0 +1,43 @@
1
+ [project]
2
+ name = "dos-mcp"
3
+ version = "0.1.1"
4
+ description = "DOSBox-X control tools for DOS malware analysis"
5
+ readme = "README.md"
6
+ requires-python = ">=3.10"
7
+ license = "Apache-2.0"
8
+ dependencies = ["mcp==1.28.1"]
9
+
10
+ [project.scripts]
11
+ dos-mcp = "dos_mcp.__main__:main"
12
+
13
+ [build-system]
14
+ requires = ["hatchling"]
15
+ build-backend = "hatchling.build"
16
+
17
+ [tool.hatch.build.targets.wheel]
18
+ packages = ["src/dos_mcp"]
19
+
20
+ [dependency-groups]
21
+ dev = [
22
+ "mypy>=1.17,<2",
23
+ "pytest>=8.4,<9",
24
+ "ruff>=0.12,<1",
25
+ ]
26
+
27
+ [tool.pytest.ini_options]
28
+ testpaths = ["tests"]
29
+ addopts = "-ra"
30
+
31
+ [tool.ruff]
32
+ line-length = 88
33
+ target-version = "py310"
34
+
35
+ [tool.ruff.lint]
36
+ select = ["E", "F", "I", "UP", "B", "SIM"]
37
+
38
+ [tool.mypy]
39
+ python_version = "3.10"
40
+ strict = true
41
+ packages = ["dos_mcp"]
42
+ mypy_path = "src"
43
+
@@ -0,0 +1,12 @@
1
+ """DOSBox-X tools for DOS malware analysis."""
2
+
3
+ from importlib.metadata import PackageNotFoundError
4
+ from importlib.metadata import version as _installed_version
5
+
6
+ __all__ = ["__version__"]
7
+
8
+ try:
9
+ __version__ = _installed_version("dos-mcp")
10
+ except PackageNotFoundError: # pragma: no cover - bare checkout
11
+ __version__ = "0.0.0+unknown"
12
+
@@ -0,0 +1,18 @@
1
+ """Console entry point."""
2
+
3
+ from __future__ import annotations
4
+
5
+ import os
6
+
7
+ from .config import Settings
8
+ from .server import create_server
9
+
10
+
11
+ def main() -> None:
12
+ settings = Settings.from_environ(os.environ)
13
+ create_server(settings).run(transport="stdio")
14
+
15
+
16
+ if __name__ == "__main__":
17
+ main()
18
+
@@ -0,0 +1,37 @@
1
+ """Validated environment-backed settings."""
2
+
3
+ from __future__ import annotations
4
+
5
+ import math
6
+ from collections.abc import Mapping
7
+ from dataclasses import dataclass
8
+
9
+
10
+ @dataclass(frozen=True)
11
+ class Settings:
12
+ qmp_port: int
13
+ qmp_timeout: float
14
+
15
+ @classmethod
16
+ def from_environ(cls, environ: Mapping[str, str]) -> Settings:
17
+ port_text = environ.get("DOSBOX_X_QMP_PORT", "4444")
18
+ try:
19
+ port = int(port_text, 10)
20
+ except ValueError as error:
21
+ raise ValueError("DOSBOX_X_QMP_PORT must be an integer") from error
22
+ if not 1 <= port <= 65535:
23
+ raise ValueError("DOSBOX_X_QMP_PORT must be between 1 and 65535")
24
+
25
+ timeout_text = environ.get("DOSBOX_X_QMP_TIMEOUT", "35")
26
+ try:
27
+ timeout = float(timeout_text)
28
+ except ValueError as error:
29
+ raise ValueError(
30
+ "DOSBOX_X_QMP_TIMEOUT must be a finite positive number"
31
+ ) from error
32
+ if not math.isfinite(timeout) or timeout <= 0:
33
+ raise ValueError(
34
+ "DOSBOX_X_QMP_TIMEOUT must be a finite positive number"
35
+ )
36
+ return cls(qmp_port=port, qmp_timeout=timeout)
37
+
@@ -0,0 +1,29 @@
1
+ """Caller-visible error categories."""
2
+
3
+ from __future__ import annotations
4
+
5
+
6
+ class DosMcpError(RuntimeError):
7
+ """Base class for expected DOS MCP failures."""
8
+
9
+
10
+ class QmpTransportError(DosMcpError):
11
+ """The local QMP server could not complete a request."""
12
+
13
+
14
+ class QmpProtocolError(DosMcpError):
15
+ """The peer did not speak the expected bounded QMP subset."""
16
+
17
+
18
+ class QmpCommandError(DosMcpError):
19
+ """DOSBox-X rejected a QMP command."""
20
+
21
+ def __init__(self, error_class: str, description: str) -> None:
22
+ super().__init__(f"{error_class}: {description}")
23
+ self.error_class = error_class
24
+ self.description = description
25
+
26
+
27
+ class RequestError(DosMcpError, ValueError):
28
+ """A tool request is invalid or exceeds a safety bound."""
29
+
@@ -0,0 +1,158 @@
1
+ """Small synchronous client for DOSBox-X's loopback QMP subset."""
2
+
3
+ from __future__ import annotations
4
+
5
+ import json
6
+ import socket
7
+ import threading
8
+ import time
9
+ from collections.abc import Iterator, Mapping, Sequence
10
+ from contextlib import ExitStack, contextmanager, suppress
11
+ from typing import Any, BinaryIO, cast
12
+
13
+ from .errors import QmpCommandError, QmpProtocolError, QmpTransportError
14
+
15
+ MAX_RESPONSE_BYTES = 24 * 1024 * 1024
16
+ Command = tuple[str, Mapping[str, object] | None]
17
+
18
+
19
+ class QmpClient:
20
+ """Open a fresh, serialized QMP session for each public tool call."""
21
+
22
+ def __init__(self, port: int, timeout: float) -> None:
23
+ self._port = port
24
+ self._timeout = timeout
25
+ self._lock = threading.Lock()
26
+
27
+ def execute(
28
+ self,
29
+ command: str,
30
+ arguments: Mapping[str, object] | None = None,
31
+ ) -> object:
32
+ return self.execute_many([(command, arguments)])[0]
33
+
34
+ def execute_many(
35
+ self,
36
+ commands: Sequence[Command],
37
+ *,
38
+ delay_seconds: float = 0,
39
+ ) -> list[object]:
40
+ if not commands:
41
+ return []
42
+ with self.session() as session:
43
+ return session.execute_many(commands, delay_seconds=delay_seconds)
44
+
45
+ @contextmanager
46
+ def session(self) -> Iterator[QmpSession]:
47
+ """Hold the client lock and one QMP connection for an atomic tool call."""
48
+
49
+ with self._lock:
50
+ resources = ExitStack()
51
+ try:
52
+ connection = resources.enter_context(
53
+ socket.create_connection(
54
+ ("127.0.0.1", self._port), timeout=self._timeout
55
+ )
56
+ )
57
+ connection.settimeout(self._timeout)
58
+ raw_stream = resources.enter_context(connection.makefile("rwb"))
59
+ stream = cast(BinaryIO, raw_stream)
60
+ greeting = self._read_object(stream)
61
+ if not isinstance(greeting.get("QMP"), dict):
62
+ raise QmpProtocolError("QMP greeting is missing")
63
+ self._write_object(stream, {"execute": "qmp_capabilities"})
64
+ self._return_value(self._read_object(stream))
65
+ except (QmpCommandError, QmpProtocolError):
66
+ resources.close()
67
+ raise
68
+ except (OSError, TimeoutError) as error:
69
+ resources.close()
70
+ raise QmpTransportError(
71
+ f"DOSBox-X QMP at 127.0.0.1:{self._port} failed: {error}"
72
+ ) from error
73
+
74
+ try:
75
+ yield QmpSession(stream, self._port)
76
+ except BaseException:
77
+ with suppress(OSError):
78
+ resources.close()
79
+ raise
80
+ else:
81
+ try:
82
+ resources.close()
83
+ except (OSError, TimeoutError) as error:
84
+ raise QmpTransportError(
85
+ f"DOSBox-X QMP at 127.0.0.1:{self._port} failed: {error}"
86
+ ) from error
87
+
88
+ @staticmethod
89
+ def _write_object(stream: BinaryIO, value: Mapping[str, object]) -> None:
90
+ payload = json.dumps(value, separators=(",", ":")).encode("utf-8") + b"\r\n"
91
+ stream.write(payload)
92
+ stream.flush()
93
+
94
+ @staticmethod
95
+ def _read_object(stream: BinaryIO) -> dict[str, Any]:
96
+ line = stream.readline(MAX_RESPONSE_BYTES + 1)
97
+ if not line:
98
+ raise ConnectionError("QMP peer closed before replying")
99
+ if len(line) > MAX_RESPONSE_BYTES or not line.endswith(b"\n"):
100
+ raise QmpProtocolError("QMP response exceeds the size limit")
101
+ try:
102
+ value = json.loads(line)
103
+ except (UnicodeDecodeError, json.JSONDecodeError) as error:
104
+ raise QmpProtocolError("QMP response is not valid JSON") from error
105
+ if not isinstance(value, dict):
106
+ raise QmpProtocolError("QMP response must be an object")
107
+ return value
108
+
109
+ @staticmethod
110
+ def _return_value(response: Mapping[str, object]) -> object:
111
+ error = response.get("error")
112
+ if isinstance(error, dict):
113
+ error_class = error.get("class", "GenericError")
114
+ description = error.get("desc", "QMP command failed")
115
+ raise QmpCommandError(str(error_class), str(description))
116
+ if "return" not in response:
117
+ raise QmpProtocolError("QMP response has neither return nor error")
118
+ return response["return"]
119
+
120
+
121
+ class QmpSession:
122
+ """A handshaken connection owned by one QmpClient session context."""
123
+
124
+ def __init__(self, stream: BinaryIO, port: int) -> None:
125
+ self._stream = stream
126
+ self._port = port
127
+
128
+ def execute(
129
+ self,
130
+ command: str,
131
+ arguments: Mapping[str, object] | None = None,
132
+ ) -> object:
133
+ return self.execute_many([(command, arguments)])[0]
134
+
135
+ def execute_many(
136
+ self,
137
+ commands: Sequence[Command],
138
+ *,
139
+ delay_seconds: float = 0,
140
+ ) -> list[object]:
141
+ # DOSBox-X discards pipelined JSON after the first object. Keep this
142
+ # strictly request/response: write one command, then read one reply.
143
+ try:
144
+ results: list[object] = []
145
+ for name, arguments in commands:
146
+ request: dict[str, object] = {"execute": name}
147
+ if arguments is not None:
148
+ request["arguments"] = dict(arguments)
149
+ QmpClient._write_object(self._stream, request)
150
+ response = QmpClient._read_object(self._stream)
151
+ results.append(QmpClient._return_value(response))
152
+ if delay_seconds and len(results) < len(commands):
153
+ time.sleep(delay_seconds)
154
+ return results
155
+ except (OSError, TimeoutError) as error:
156
+ raise QmpTransportError(
157
+ f"DOSBox-X QMP at 127.0.0.1:{self._port} failed: {error}"
158
+ ) from error