mcp-stata 1.21.0__cp311-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
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.
- mcp_stata/__init__.py +3 -0
- mcp_stata/__main__.py +4 -0
- mcp_stata/_native_ops.abi3.so +0 -0
- mcp_stata/config.py +20 -0
- mcp_stata/discovery.py +548 -0
- mcp_stata/graph_detector.py +601 -0
- mcp_stata/models.py +64 -0
- mcp_stata/native_ops.py +87 -0
- mcp_stata/server.py +1233 -0
- mcp_stata/smcl/smcl2html.py +88 -0
- mcp_stata/stata_client.py +4638 -0
- mcp_stata/streaming_io.py +264 -0
- mcp_stata/test_stata.py +56 -0
- mcp_stata/ui_http.py +999 -0
- mcp_stata/utils.py +159 -0
- mcp_stata-1.21.0.dist-info/METADATA +486 -0
- mcp_stata-1.21.0.dist-info/RECORD +20 -0
- mcp_stata-1.21.0.dist-info/WHEEL +5 -0
- mcp_stata-1.21.0.dist-info/entry_points.txt +2 -0
- mcp_stata-1.21.0.dist-info/licenses/LICENSE +661 -0
|
@@ -0,0 +1,4638 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
import asyncio
|
|
3
|
+
import io
|
|
4
|
+
import inspect
|
|
5
|
+
import json
|
|
6
|
+
import logging
|
|
7
|
+
import os
|
|
8
|
+
import pathlib
|
|
9
|
+
import platform
|
|
10
|
+
import re
|
|
11
|
+
import subprocess
|
|
12
|
+
import sys
|
|
13
|
+
import tempfile
|
|
14
|
+
import threading
|
|
15
|
+
import time
|
|
16
|
+
import uuid
|
|
17
|
+
import functools
|
|
18
|
+
from contextlib import contextmanager, redirect_stdout, redirect_stderr
|
|
19
|
+
from importlib.metadata import PackageNotFoundError, version
|
|
20
|
+
from io import StringIO
|
|
21
|
+
from typing import Any, Awaitable, Callable, Dict, Generator, List, Optional, Tuple
|
|
22
|
+
|
|
23
|
+
import anyio
|
|
24
|
+
from anyio import get_cancelled_exc_class
|
|
25
|
+
|
|
26
|
+
from .discovery import find_stata_candidates
|
|
27
|
+
from .config import MAX_LIMIT
|
|
28
|
+
from .models import (
|
|
29
|
+
CommandResponse,
|
|
30
|
+
ErrorEnvelope,
|
|
31
|
+
GraphExport,
|
|
32
|
+
GraphExportResponse,
|
|
33
|
+
GraphInfo,
|
|
34
|
+
GraphListResponse,
|
|
35
|
+
VariableInfo,
|
|
36
|
+
VariablesResponse,
|
|
37
|
+
)
|
|
38
|
+
from .smcl.smcl2html import smcl_to_markdown
|
|
39
|
+
from .streaming_io import FileTeeIO, TailBuffer
|
|
40
|
+
from .graph_detector import StreamingGraphCache
|
|
41
|
+
from .native_ops import fast_scan_log, compute_filter_indices
|
|
42
|
+
from .utils import get_writable_temp_dir, register_temp_file, register_temp_dir, is_windows
|
|
43
|
+
|
|
44
|
+
logger = logging.getLogger("mcp_stata")
|
|
45
|
+
|
|
46
|
+
_POLARS_AVAILABLE: Optional[bool] = None
|
|
47
|
+
_GRAPH_NAME_PATTERN = re.compile(r"name\(\s*(\"[^\"]+\"|'[^']+'|[^,\)\s]+)", re.IGNORECASE)
|
|
48
|
+
|
|
49
|
+
def _check_polars_available() -> bool:
|
|
50
|
+
"""
|
|
51
|
+
Check if Polars can be safely imported.
|
|
52
|
+
Must detect problematic platforms BEFORE attempting import,
|
|
53
|
+
since the crash is a fatal signal, not a catchable exception.
|
|
54
|
+
"""
|
|
55
|
+
if sys.platform == "win32" and platform.machine().lower() in ("arm64", "aarch64"):
|
|
56
|
+
return False
|
|
57
|
+
|
|
58
|
+
try:
|
|
59
|
+
import polars # noqa: F401
|
|
60
|
+
return True
|
|
61
|
+
except ImportError:
|
|
62
|
+
return False
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
def _get_polars_available() -> bool:
|
|
66
|
+
global _POLARS_AVAILABLE
|
|
67
|
+
if _POLARS_AVAILABLE is None:
|
|
68
|
+
_POLARS_AVAILABLE = _check_polars_available()
|
|
69
|
+
return _POLARS_AVAILABLE
|
|
70
|
+
|
|
71
|
+
# ============================================================================
|
|
72
|
+
# MODULE-LEVEL DISCOVERY CACHE
|
|
73
|
+
# ============================================================================
|
|
74
|
+
# This cache ensures Stata discovery runs exactly once per process lifetime
|
|
75
|
+
_discovery_lock = threading.Lock()
|
|
76
|
+
_discovery_result: Optional[Tuple[str, str]] = None # (path, edition)
|
|
77
|
+
_discovery_candidates: Optional[List[Tuple[str, str]]] = None
|
|
78
|
+
_discovery_attempted = False
|
|
79
|
+
_discovery_error: Optional[Exception] = None
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
def _get_discovery_candidates() -> List[Tuple[str, str]]:
|
|
83
|
+
"""
|
|
84
|
+
Get ordered discovery candidates, running discovery only once.
|
|
85
|
+
|
|
86
|
+
Returns:
|
|
87
|
+
List of (stata_executable_path, edition) ordered by preference.
|
|
88
|
+
|
|
89
|
+
Raises:
|
|
90
|
+
RuntimeError: If Stata discovery fails
|
|
91
|
+
"""
|
|
92
|
+
global _discovery_result, _discovery_candidates, _discovery_attempted, _discovery_error
|
|
93
|
+
|
|
94
|
+
with _discovery_lock:
|
|
95
|
+
# If we've already successfully discovered Stata, return cached result
|
|
96
|
+
if _discovery_result is not None:
|
|
97
|
+
return _discovery_candidates or [_discovery_result]
|
|
98
|
+
|
|
99
|
+
if _discovery_candidates is not None:
|
|
100
|
+
return _discovery_candidates
|
|
101
|
+
|
|
102
|
+
# If we've already attempted and failed, re-raise the cached error
|
|
103
|
+
if _discovery_attempted and _discovery_error is not None:
|
|
104
|
+
raise RuntimeError(f"Stata binary not found: {_discovery_error}") from _discovery_error
|
|
105
|
+
|
|
106
|
+
# This is the first attempt - run discovery
|
|
107
|
+
_discovery_attempted = True
|
|
108
|
+
|
|
109
|
+
try:
|
|
110
|
+
# Log environment state once at first discovery
|
|
111
|
+
env_path = os.getenv("STATA_PATH")
|
|
112
|
+
if env_path:
|
|
113
|
+
logger.info("STATA_PATH env provided (raw): %s", env_path)
|
|
114
|
+
else:
|
|
115
|
+
logger.info("STATA_PATH env not set; attempting auto-discovery")
|
|
116
|
+
|
|
117
|
+
# Run discovery
|
|
118
|
+
candidates = find_stata_candidates()
|
|
119
|
+
|
|
120
|
+
# Cache the successful result
|
|
121
|
+
_discovery_candidates = candidates
|
|
122
|
+
if candidates:
|
|
123
|
+
_discovery_result = candidates[0]
|
|
124
|
+
logger.info("Discovery found Stata at: %s (%s)", _discovery_result[0], _discovery_result[1])
|
|
125
|
+
else:
|
|
126
|
+
raise FileNotFoundError("No Stata candidates discovered")
|
|
127
|
+
|
|
128
|
+
return candidates
|
|
129
|
+
|
|
130
|
+
except FileNotFoundError as e:
|
|
131
|
+
_discovery_error = e
|
|
132
|
+
raise RuntimeError(f"Stata binary not found: {e}") from e
|
|
133
|
+
except PermissionError as e:
|
|
134
|
+
_discovery_error = e
|
|
135
|
+
raise RuntimeError(
|
|
136
|
+
f"Stata binary is not executable: {e}. "
|
|
137
|
+
"Point STATA_PATH directly to the Stata binary (e.g., .../Contents/MacOS/stata-mp)."
|
|
138
|
+
) from e
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
def _get_discovered_stata() -> Tuple[str, str]:
|
|
142
|
+
"""
|
|
143
|
+
Preserve existing API: return the highest-priority discovered Stata candidate.
|
|
144
|
+
"""
|
|
145
|
+
candidates = _get_discovery_candidates()
|
|
146
|
+
if not candidates:
|
|
147
|
+
raise RuntimeError("Stata binary not found: no candidates discovered")
|
|
148
|
+
return candidates[0]
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
class StataClient:
|
|
152
|
+
_initialized = False
|
|
153
|
+
_exec_lock: threading.Lock
|
|
154
|
+
_cache_init_lock = threading.Lock() # Class-level lock for cache initialization
|
|
155
|
+
_is_executing = False # Flag to prevent recursive Stata calls
|
|
156
|
+
MAX_DATA_ROWS = MAX_LIMIT
|
|
157
|
+
MAX_GRAPH_BYTES = 50 * 1024 * 1024 # Maximum graph exports (~50MB)
|
|
158
|
+
MAX_CACHE_SIZE = 100 # Maximum number of graphs to cache
|
|
159
|
+
MAX_CACHE_BYTES = 500 * 1024 * 1024 # Maximum cache size in bytes (~500MB)
|
|
160
|
+
LIST_GRAPHS_TTL = 0.075 # TTL for list_graphs cache (75ms)
|
|
161
|
+
|
|
162
|
+
def __init__(self):
|
|
163
|
+
self._exec_lock = threading.RLock()
|
|
164
|
+
self._is_executing = False
|
|
165
|
+
self._command_idx = 0 # Counter for user-initiated commands
|
|
166
|
+
self._initialized = False
|
|
167
|
+
self._persistent_log_path = None
|
|
168
|
+
self._persistent_log_name = None
|
|
169
|
+
self._last_emitted_graph_signatures: Dict[str, str] = {}
|
|
170
|
+
self._graph_signature_cache: Dict[str, str] = {}
|
|
171
|
+
self._graph_signature_cache_cmd_idx: Optional[int] = None
|
|
172
|
+
self._last_results = None
|
|
173
|
+
from .graph_detector import GraphCreationDetector
|
|
174
|
+
self._graph_detector = GraphCreationDetector(self)
|
|
175
|
+
|
|
176
|
+
def __new__(cls):
|
|
177
|
+
inst = super(StataClient, cls).__new__(cls)
|
|
178
|
+
inst._exec_lock = threading.RLock()
|
|
179
|
+
inst._is_executing = False
|
|
180
|
+
inst._command_idx = 0
|
|
181
|
+
inst._initialized = False
|
|
182
|
+
inst._persistent_log_path = None
|
|
183
|
+
inst._persistent_log_name = None
|
|
184
|
+
inst._graph_signature_cache = {}
|
|
185
|
+
inst._graph_signature_cache_cmd_idx = None
|
|
186
|
+
inst._last_results = None
|
|
187
|
+
from .graph_detector import GraphCreationDetector
|
|
188
|
+
inst._graph_detector = GraphCreationDetector(inst)
|
|
189
|
+
return inst
|
|
190
|
+
|
|
191
|
+
def _increment_command_idx(self) -> int:
|
|
192
|
+
"""Increment and return the command counter."""
|
|
193
|
+
self._command_idx += 1
|
|
194
|
+
self._graph_signature_cache = {}
|
|
195
|
+
self._graph_signature_cache_cmd_idx = self._command_idx
|
|
196
|
+
return self._command_idx
|
|
197
|
+
|
|
198
|
+
@contextmanager
|
|
199
|
+
def _redirect_io(self, out_buf, err_buf):
|
|
200
|
+
"""Safely redirect stdout/stderr for the duration of a Stata call."""
|
|
201
|
+
backup_stdout, backup_stderr = sys.stdout, sys.stderr
|
|
202
|
+
sys.stdout, sys.stderr = out_buf, err_buf
|
|
203
|
+
try:
|
|
204
|
+
yield
|
|
205
|
+
finally:
|
|
206
|
+
sys.stdout, sys.stderr = backup_stdout, backup_stderr
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
@staticmethod
|
|
210
|
+
def _stata_quote(value: str) -> str:
|
|
211
|
+
"""Return a Stata double-quoted string literal for value."""
|
|
212
|
+
# Stata uses doubled quotes to represent a quote character inside a string.
|
|
213
|
+
v = (value or "")
|
|
214
|
+
v = v.replace('"', '""')
|
|
215
|
+
# Use compound double quotes to avoid tokenization issues with spaces and
|
|
216
|
+
# punctuation in contexts like graph names.
|
|
217
|
+
return f'`"{v}"\''
|
|
218
|
+
|
|
219
|
+
@contextmanager
|
|
220
|
+
def _redirect_io_streaming(self, out_stream, err_stream):
|
|
221
|
+
backup_stdout, backup_stderr = sys.stdout, sys.stderr
|
|
222
|
+
sys.stdout, sys.stderr = out_stream, err_stream
|
|
223
|
+
try:
|
|
224
|
+
yield
|
|
225
|
+
finally:
|
|
226
|
+
sys.stdout, sys.stderr = backup_stdout, backup_stderr
|
|
227
|
+
|
|
228
|
+
@staticmethod
|
|
229
|
+
def _safe_unlink(path: str) -> None:
|
|
230
|
+
if not path:
|
|
231
|
+
return
|
|
232
|
+
try:
|
|
233
|
+
if os.path.exists(path):
|
|
234
|
+
os.unlink(path)
|
|
235
|
+
except Exception:
|
|
236
|
+
pass
|
|
237
|
+
|
|
238
|
+
def _create_smcl_log_path(
|
|
239
|
+
self,
|
|
240
|
+
*,
|
|
241
|
+
prefix: str = "mcp_smcl_",
|
|
242
|
+
max_hex: Optional[int] = None,
|
|
243
|
+
base_dir: Optional[str] = None,
|
|
244
|
+
) -> str:
|
|
245
|
+
hex_id = uuid.uuid4().hex if max_hex is None else uuid.uuid4().hex[:max_hex]
|
|
246
|
+
# Use provided base_dir if any, otherwise fall back to validated temp dir
|
|
247
|
+
base = pathlib.Path(base_dir) if base_dir else pathlib.Path(get_writable_temp_dir())
|
|
248
|
+
smcl_path = base / f"{prefix}{hex_id}.smcl"
|
|
249
|
+
register_temp_file(smcl_path)
|
|
250
|
+
self._safe_unlink(str(smcl_path))
|
|
251
|
+
return str(smcl_path)
|
|
252
|
+
|
|
253
|
+
@staticmethod
|
|
254
|
+
def _make_smcl_log_name() -> str:
|
|
255
|
+
return f"_mcp_smcl_{uuid.uuid4().hex[:8]}"
|
|
256
|
+
|
|
257
|
+
def _run_internal(self, code: str, echo: bool = False) -> str:
|
|
258
|
+
"""Run Stata code while strictly ensuring NO output reaches stdout."""
|
|
259
|
+
if not self._initialized:
|
|
260
|
+
self.init()
|
|
261
|
+
with self._exec_lock:
|
|
262
|
+
with redirect_stdout(sys.stderr), redirect_stderr(sys.stderr):
|
|
263
|
+
return self.stata.run(code, echo=echo)
|
|
264
|
+
|
|
265
|
+
def _open_smcl_log(self, smcl_path: str, log_name: str, *, quiet: bool = False, append: bool = False) -> bool:
|
|
266
|
+
path_for_stata = smcl_path.replace("\\", "/")
|
|
267
|
+
mode = "append" if append else "replace"
|
|
268
|
+
base_cmd = f"log using \"{path_for_stata}\", {mode} smcl name({log_name})"
|
|
269
|
+
|
|
270
|
+
# In multi-threaded environments (like pytest-xdist), we must be extremely
|
|
271
|
+
# careful with the singleton Stata instance.
|
|
272
|
+
from sfi import Scalar
|
|
273
|
+
|
|
274
|
+
try:
|
|
275
|
+
# Bundle both close and open to minimize roundtrips
|
|
276
|
+
# Use a unique scalar to capture the RC of the log using command
|
|
277
|
+
log_rc_scalar = f"_mcp_log_rc_{uuid.uuid4().hex[:8]}"
|
|
278
|
+
bundle = (
|
|
279
|
+
f"capture quietly log close {log_name}\n"
|
|
280
|
+
f"capture {'quietly ' if quiet else ''}{base_cmd}\n"
|
|
281
|
+
f"scalar {log_rc_scalar} = _rc"
|
|
282
|
+
)
|
|
283
|
+
logger.debug(f"Opening SMCL log with bundle: {bundle}")
|
|
284
|
+
self._run_internal(bundle, echo=False)
|
|
285
|
+
|
|
286
|
+
try:
|
|
287
|
+
rc_val = Scalar.getValue(log_rc_scalar)
|
|
288
|
+
logger.debug(f"Log RC: {rc_val}")
|
|
289
|
+
# Clean up scalar
|
|
290
|
+
self._run_internal(f"capture scalar drop {log_rc_scalar}", echo=False)
|
|
291
|
+
if rc_val == 0:
|
|
292
|
+
self._last_smcl_log_named = True
|
|
293
|
+
return True
|
|
294
|
+
except Exception as e:
|
|
295
|
+
logger.debug(f"Failed to get log scalar {log_rc_scalar}: {e}")
|
|
296
|
+
pass
|
|
297
|
+
|
|
298
|
+
# If still not open, try clearing other logs and retry
|
|
299
|
+
log_rc_scalar = f"_mcp_log_rc_retry_{uuid.uuid4().hex[:8]}"
|
|
300
|
+
bundle = (
|
|
301
|
+
"capture quietly log close\n"
|
|
302
|
+
f"capture {'quietly ' if quiet else ''}{base_cmd}\n"
|
|
303
|
+
f"scalar {log_rc_scalar} = _rc"
|
|
304
|
+
)
|
|
305
|
+
logger.debug(f"Retrying SMCL log with bundle: {bundle}")
|
|
306
|
+
self._run_internal(bundle, echo=False)
|
|
307
|
+
|
|
308
|
+
try:
|
|
309
|
+
rc_val = Scalar.getValue(log_rc_scalar)
|
|
310
|
+
logger.debug(f"Retry Log RC: {rc_val}")
|
|
311
|
+
# Clean up scalar
|
|
312
|
+
self._run_internal(f"capture scalar drop {log_rc_scalar}", echo=False)
|
|
313
|
+
if rc_val == 0:
|
|
314
|
+
self._last_smcl_log_named = True
|
|
315
|
+
return True
|
|
316
|
+
except Exception as e:
|
|
317
|
+
logger.debug(f"Failed to get retry log scalar {log_rc_scalar}: {e}")
|
|
318
|
+
pass
|
|
319
|
+
|
|
320
|
+
except Exception as e:
|
|
321
|
+
logger.warning("SMCL log open exception: %s", e)
|
|
322
|
+
|
|
323
|
+
return False
|
|
324
|
+
|
|
325
|
+
# Fallback to unnamed log
|
|
326
|
+
try:
|
|
327
|
+
unnamed_cmd = f"{'quietly ' if quiet else ''}log using \"{path_for_stata}\", replace smcl"
|
|
328
|
+
self._run_internal(f"capture quietly log close", echo=False)
|
|
329
|
+
self._run_internal(f"capture {unnamed_cmd}", echo=False)
|
|
330
|
+
try:
|
|
331
|
+
if Scalar.getValue("c(log)") == "on":
|
|
332
|
+
self._last_smcl_log_named = False
|
|
333
|
+
return True
|
|
334
|
+
except:
|
|
335
|
+
pass
|
|
336
|
+
except Exception:
|
|
337
|
+
pass
|
|
338
|
+
return False
|
|
339
|
+
|
|
340
|
+
def _close_smcl_log(self, log_name: str) -> None:
|
|
341
|
+
if log_name == "_mcp_session":
|
|
342
|
+
return
|
|
343
|
+
try:
|
|
344
|
+
use_named = getattr(self, "_last_smcl_log_named", None)
|
|
345
|
+
if use_named is False:
|
|
346
|
+
self._run_internal("capture quietly log close", echo=False)
|
|
347
|
+
else:
|
|
348
|
+
self._run_internal(f"capture quietly log close {log_name}", echo=False)
|
|
349
|
+
except Exception:
|
|
350
|
+
pass
|
|
351
|
+
|
|
352
|
+
def _restore_results_from_hold(self, hold_attr: str) -> None:
|
|
353
|
+
if not hasattr(self, hold_attr):
|
|
354
|
+
return
|
|
355
|
+
hold_name = getattr(self, hold_attr)
|
|
356
|
+
try:
|
|
357
|
+
self._run_internal(f"capture _return restore {hold_name}", echo=False)
|
|
358
|
+
self._last_results = None # Invalidate cache instead of fetching
|
|
359
|
+
except Exception:
|
|
360
|
+
pass
|
|
361
|
+
finally:
|
|
362
|
+
try:
|
|
363
|
+
delattr(self, hold_attr)
|
|
364
|
+
except Exception:
|
|
365
|
+
pass
|
|
366
|
+
|
|
367
|
+
def _create_streaming_log(self, *, trace: bool) -> tuple[tempfile.NamedTemporaryFile, str, TailBuffer, FileTeeIO]:
|
|
368
|
+
log_file = tempfile.NamedTemporaryFile(
|
|
369
|
+
prefix="mcp_stata_",
|
|
370
|
+
suffix=".log",
|
|
371
|
+
dir=get_writable_temp_dir(),
|
|
372
|
+
delete=False,
|
|
373
|
+
mode="w",
|
|
374
|
+
encoding="utf-8",
|
|
375
|
+
errors="replace",
|
|
376
|
+
buffering=1,
|
|
377
|
+
)
|
|
378
|
+
log_path = log_file.name
|
|
379
|
+
register_temp_file(log_path)
|
|
380
|
+
tail = TailBuffer(max_chars=200000 if trace else 20000)
|
|
381
|
+
tee = FileTeeIO(log_file, tail)
|
|
382
|
+
return log_file, log_path, tail, tee
|
|
383
|
+
|
|
384
|
+
def _init_streaming_graph_cache(
|
|
385
|
+
self,
|
|
386
|
+
auto_cache_graphs: bool,
|
|
387
|
+
on_graph_cached: Optional[Callable[[str, bool], Awaitable[None]]],
|
|
388
|
+
notify_log: Callable[[str], Awaitable[None]],
|
|
389
|
+
) -> Optional[StreamingGraphCache]:
|
|
390
|
+
if not auto_cache_graphs:
|
|
391
|
+
return None
|
|
392
|
+
graph_cache = StreamingGraphCache(self, auto_cache=True)
|
|
393
|
+
graph_cache_callback = self._create_graph_cache_callback(on_graph_cached, notify_log)
|
|
394
|
+
graph_cache.add_cache_callback(graph_cache_callback)
|
|
395
|
+
return graph_cache
|
|
396
|
+
|
|
397
|
+
def _capture_graph_state(
|
|
398
|
+
self,
|
|
399
|
+
graph_cache: Optional[StreamingGraphCache],
|
|
400
|
+
emit_graph_ready: bool,
|
|
401
|
+
) -> Optional[dict[str, str]]:
|
|
402
|
+
# Capture initial graph state BEFORE execution starts
|
|
403
|
+
self._graph_signature_cache = {}
|
|
404
|
+
self._graph_signature_cache_cmd_idx = None
|
|
405
|
+
graph_names: List[str] = []
|
|
406
|
+
if graph_cache or emit_graph_ready:
|
|
407
|
+
try:
|
|
408
|
+
graph_names = list(self.list_graphs(force_refresh=True))
|
|
409
|
+
except Exception as e:
|
|
410
|
+
logger.debug("Failed to capture initial graph state: %s", e)
|
|
411
|
+
graph_names = []
|
|
412
|
+
|
|
413
|
+
if graph_cache:
|
|
414
|
+
# Clear detection state for the new command (detected/removed sets)
|
|
415
|
+
# but preserve _last_graph_state signatures for modification detection.
|
|
416
|
+
graph_cache.detector.clear_detection_state()
|
|
417
|
+
graph_cache._initial_graphs = set(graph_names)
|
|
418
|
+
logger.debug(f"Initial graph state captured: {graph_cache._initial_graphs}")
|
|
419
|
+
|
|
420
|
+
graph_ready_initial = None
|
|
421
|
+
if emit_graph_ready:
|
|
422
|
+
graph_ready_initial = {name: self._get_graph_signature(name) for name in graph_names}
|
|
423
|
+
logger.debug("Graph-ready initial state captured: %s", set(graph_ready_initial))
|
|
424
|
+
return graph_ready_initial
|
|
425
|
+
|
|
426
|
+
async def _cache_new_graphs(
|
|
427
|
+
self,
|
|
428
|
+
graph_cache: Optional[StreamingGraphCache],
|
|
429
|
+
*,
|
|
430
|
+
notify_progress: Optional[Callable[[float, Optional[float], Optional[str]], Awaitable[None]]],
|
|
431
|
+
total_lines: int,
|
|
432
|
+
completed_label: str,
|
|
433
|
+
) -> None:
|
|
434
|
+
if not graph_cache or not graph_cache.auto_cache:
|
|
435
|
+
return
|
|
436
|
+
try:
|
|
437
|
+
cached_graphs = []
|
|
438
|
+
# Use detector to find new OR modified graphs
|
|
439
|
+
pystata_detected = await anyio.to_thread.run_sync(graph_cache.detector._detect_graphs_via_pystata)
|
|
440
|
+
|
|
441
|
+
# Combine with any pending graphs in queue
|
|
442
|
+
with graph_cache._lock:
|
|
443
|
+
to_process = set(pystata_detected) | set(graph_cache._graphs_to_cache)
|
|
444
|
+
graph_cache._graphs_to_cache.clear()
|
|
445
|
+
|
|
446
|
+
if to_process:
|
|
447
|
+
logger.info(f"Detected {len(to_process)} new or modified graph(s): {sorted(to_process)}")
|
|
448
|
+
|
|
449
|
+
for graph_name in to_process:
|
|
450
|
+
if graph_name in graph_cache._cached_graphs:
|
|
451
|
+
continue
|
|
452
|
+
|
|
453
|
+
try:
|
|
454
|
+
cache_result = await anyio.to_thread.run_sync(
|
|
455
|
+
self.cache_graph_on_creation,
|
|
456
|
+
graph_name,
|
|
457
|
+
)
|
|
458
|
+
if cache_result:
|
|
459
|
+
cached_graphs.append(graph_name)
|
|
460
|
+
graph_cache._cached_graphs.add(graph_name)
|
|
461
|
+
|
|
462
|
+
for callback in graph_cache._cache_callbacks:
|
|
463
|
+
try:
|
|
464
|
+
result = callback(graph_name, cache_result)
|
|
465
|
+
if inspect.isawaitable(result):
|
|
466
|
+
await result
|
|
467
|
+
except Exception:
|
|
468
|
+
pass
|
|
469
|
+
except Exception as e:
|
|
470
|
+
logger.error(f"Error caching graph {graph_name}: {e}")
|
|
471
|
+
|
|
472
|
+
if cached_graphs and notify_progress:
|
|
473
|
+
await notify_progress(
|
|
474
|
+
float(total_lines) if total_lines > 0 else 1,
|
|
475
|
+
float(total_lines) if total_lines > 0 else 1,
|
|
476
|
+
f"{completed_label} completed. Cached {len(cached_graphs)} graph(s): {', '.join(cached_graphs)}",
|
|
477
|
+
)
|
|
478
|
+
except Exception as e:
|
|
479
|
+
logger.error(f"Post-execution graph detection failed: {e}")
|
|
480
|
+
|
|
481
|
+
def _emit_graph_ready_task(
|
|
482
|
+
self,
|
|
483
|
+
*,
|
|
484
|
+
emit_graph_ready: bool,
|
|
485
|
+
graph_ready_initial: Optional[dict[str, str]],
|
|
486
|
+
notify_log: Callable[[str], Awaitable[None]],
|
|
487
|
+
graph_ready_task_id: Optional[str],
|
|
488
|
+
graph_ready_format: str,
|
|
489
|
+
) -> None:
|
|
490
|
+
if emit_graph_ready and graph_ready_initial is not None:
|
|
491
|
+
try:
|
|
492
|
+
asyncio.create_task(
|
|
493
|
+
self._emit_graph_ready_events(
|
|
494
|
+
graph_ready_initial,
|
|
495
|
+
notify_log,
|
|
496
|
+
graph_ready_task_id,
|
|
497
|
+
graph_ready_format,
|
|
498
|
+
)
|
|
499
|
+
)
|
|
500
|
+
except Exception as e:
|
|
501
|
+
logger.warning("graph_ready emission failed to start: %s", e)
|
|
502
|
+
|
|
503
|
+
async def _stream_smcl_log(
|
|
504
|
+
self,
|
|
505
|
+
*,
|
|
506
|
+
smcl_path: str,
|
|
507
|
+
notify_log: Callable[[str], Awaitable[None]],
|
|
508
|
+
done: anyio.Event,
|
|
509
|
+
on_chunk: Optional[Callable[[str], Awaitable[None]]] = None,
|
|
510
|
+
start_offset: int = 0,
|
|
511
|
+
tee: Optional[FileTeeIO] = None,
|
|
512
|
+
) -> None:
|
|
513
|
+
last_pos = start_offset
|
|
514
|
+
emitted_debug_chunks = 0
|
|
515
|
+
# Wait for Stata to create the SMCL file
|
|
516
|
+
while not done.is_set() and not os.path.exists(smcl_path):
|
|
517
|
+
await anyio.sleep(0.05)
|
|
518
|
+
|
|
519
|
+
try:
|
|
520
|
+
def _read_content() -> str:
|
|
521
|
+
try:
|
|
522
|
+
with open(smcl_path, "r", encoding="utf-8", errors="replace") as f:
|
|
523
|
+
f.seek(last_pos)
|
|
524
|
+
return f.read()
|
|
525
|
+
except PermissionError:
|
|
526
|
+
if is_windows():
|
|
527
|
+
try:
|
|
528
|
+
# Use 'type' on Windows to bypass exclusive lock
|
|
529
|
+
res = subprocess.run(f'type "{smcl_path}"', shell=True, capture_output=True)
|
|
530
|
+
full_content = res.stdout.decode("utf-8", errors="replace")
|
|
531
|
+
if len(full_content) > last_pos:
|
|
532
|
+
return full_content[last_pos:]
|
|
533
|
+
return ""
|
|
534
|
+
except Exception:
|
|
535
|
+
return ""
|
|
536
|
+
return ""
|
|
537
|
+
except FileNotFoundError:
|
|
538
|
+
return ""
|
|
539
|
+
|
|
540
|
+
while not done.is_set():
|
|
541
|
+
chunk = await anyio.to_thread.run_sync(_read_content)
|
|
542
|
+
if chunk:
|
|
543
|
+
is_first_chunk = last_pos == start_offset
|
|
544
|
+
last_pos += len(chunk)
|
|
545
|
+
# Clean chunk before sending to log channel to suppress maintenance leakage
|
|
546
|
+
cleaned_chunk = self._clean_internal_smcl(
|
|
547
|
+
chunk,
|
|
548
|
+
strip_output=False,
|
|
549
|
+
strip_leading_boilerplate=is_first_chunk,
|
|
550
|
+
)
|
|
551
|
+
if cleaned_chunk:
|
|
552
|
+
try:
|
|
553
|
+
await notify_log(cleaned_chunk)
|
|
554
|
+
except Exception as exc:
|
|
555
|
+
logger.debug("notify_log failed: %s", exc)
|
|
556
|
+
|
|
557
|
+
if tee:
|
|
558
|
+
try:
|
|
559
|
+
# Write cleaned SMCL to tee to satisfy requirements
|
|
560
|
+
# for clean logs with preserved markup.
|
|
561
|
+
tee.write(cleaned_chunk)
|
|
562
|
+
except Exception:
|
|
563
|
+
pass
|
|
564
|
+
|
|
565
|
+
if on_chunk is not None:
|
|
566
|
+
try:
|
|
567
|
+
await on_chunk(chunk)
|
|
568
|
+
except Exception as exc:
|
|
569
|
+
logger.debug("on_chunk callback failed: %s", exc)
|
|
570
|
+
await anyio.sleep(0.05)
|
|
571
|
+
|
|
572
|
+
# Final check for any remaining content
|
|
573
|
+
chunk = await anyio.to_thread.run_sync(_read_content)
|
|
574
|
+
if chunk:
|
|
575
|
+
last_pos += len(chunk)
|
|
576
|
+
cleaned_chunk = self._clean_internal_smcl(
|
|
577
|
+
chunk,
|
|
578
|
+
strip_output=False,
|
|
579
|
+
strip_leading_boilerplate=False,
|
|
580
|
+
)
|
|
581
|
+
if cleaned_chunk:
|
|
582
|
+
try:
|
|
583
|
+
await notify_log(cleaned_chunk)
|
|
584
|
+
except Exception as exc:
|
|
585
|
+
logger.debug("final notify_log failed: %s", exc)
|
|
586
|
+
|
|
587
|
+
if tee:
|
|
588
|
+
try:
|
|
589
|
+
# Write cleaned SMCL to tee
|
|
590
|
+
tee.write(cleaned_chunk)
|
|
591
|
+
except Exception:
|
|
592
|
+
pass
|
|
593
|
+
|
|
594
|
+
if on_chunk is not None:
|
|
595
|
+
# Final check even if last chunk is empty, to ensure
|
|
596
|
+
# graphs created at the very end are detected.
|
|
597
|
+
try:
|
|
598
|
+
await on_chunk(chunk or "")
|
|
599
|
+
except Exception as exc:
|
|
600
|
+
logger.debug("final on_chunk check failed: %s", exc)
|
|
601
|
+
|
|
602
|
+
except Exception as e:
|
|
603
|
+
logger.warning(f"Log streaming failed: {e}")
|
|
604
|
+
|
|
605
|
+
def _run_streaming_blocking(
|
|
606
|
+
self,
|
|
607
|
+
*,
|
|
608
|
+
command: str,
|
|
609
|
+
tee: FileTeeIO,
|
|
610
|
+
cwd: Optional[str],
|
|
611
|
+
trace: bool,
|
|
612
|
+
echo: bool,
|
|
613
|
+
smcl_path: str,
|
|
614
|
+
smcl_log_name: str,
|
|
615
|
+
hold_attr: str,
|
|
616
|
+
require_smcl_log: bool = False,
|
|
617
|
+
) -> tuple[int, Optional[Exception]]:
|
|
618
|
+
rc = -1
|
|
619
|
+
exc: Optional[Exception] = None
|
|
620
|
+
with self._exec_lock:
|
|
621
|
+
self._is_executing = True
|
|
622
|
+
self._last_results = None # Invalidate results cache
|
|
623
|
+
try:
|
|
624
|
+
from sfi import Scalar, SFIToolkit # Import SFI tools
|
|
625
|
+
with self._temp_cwd(cwd):
|
|
626
|
+
logger.debug(
|
|
627
|
+
"opening SMCL log name=%s path=%s cwd=%s",
|
|
628
|
+
smcl_log_name,
|
|
629
|
+
smcl_path,
|
|
630
|
+
os.getcwd(),
|
|
631
|
+
)
|
|
632
|
+
try:
|
|
633
|
+
if self._persistent_log_path and smcl_path == self._persistent_log_path:
|
|
634
|
+
# Re-open or resume global session log in append mode to ensure it's active
|
|
635
|
+
log_opened = self._open_smcl_log(smcl_path, smcl_log_name, quiet=True, append=True)
|
|
636
|
+
else:
|
|
637
|
+
log_opened = self._open_smcl_log(smcl_path, smcl_log_name, quiet=True)
|
|
638
|
+
except Exception as e:
|
|
639
|
+
log_opened = False
|
|
640
|
+
logger.warning("_open_smcl_log raised: %r", e)
|
|
641
|
+
logger.info("SMCL log_opened=%s path=%s", log_opened, smcl_path)
|
|
642
|
+
if require_smcl_log and not log_opened:
|
|
643
|
+
exc = RuntimeError("Failed to open SMCL log")
|
|
644
|
+
logger.error("SMCL log open failed for %s", smcl_path)
|
|
645
|
+
rc = 1
|
|
646
|
+
if exc is None:
|
|
647
|
+
try:
|
|
648
|
+
# Use an internal buffer to capture the direct output of pystata
|
|
649
|
+
# rather than writing it raw to the 'tee' (and log_path).
|
|
650
|
+
# We rely on _stream_smcl_log to populate the 'tee' with
|
|
651
|
+
# cleaned content from the SMCL log.
|
|
652
|
+
direct_buf = io.StringIO()
|
|
653
|
+
with self._redirect_io_streaming(direct_buf, direct_buf):
|
|
654
|
+
try:
|
|
655
|
+
if trace:
|
|
656
|
+
self.stata.run("set trace on")
|
|
657
|
+
|
|
658
|
+
# Hybrid execution: Single-line commands run natively for perfect echoing.
|
|
659
|
+
# Multi-line commands use the bundle for error handling and stability.
|
|
660
|
+
is_multi_line = "\n" in command.strip()
|
|
661
|
+
|
|
662
|
+
if not is_multi_line:
|
|
663
|
+
logger.debug("running Stata natively echo=%s", echo)
|
|
664
|
+
self._hold_name_stream = f"mcp_hold_{uuid.uuid4().hex[:8]}"
|
|
665
|
+
# Reset RC to 0 before running
|
|
666
|
+
self._run_internal("scalar _mcp_rc = 0", echo=False)
|
|
667
|
+
ret = self.stata.run(command, echo=echo)
|
|
668
|
+
# Use _rc if we were in a capture, but here we are native.
|
|
669
|
+
# Stata sets c(rc) to the return code of the last command.
|
|
670
|
+
self._run_internal(f"scalar _mcp_rc = c(rc)", echo=False)
|
|
671
|
+
self._run_internal(f"capture _return hold {self._hold_name_stream}", echo=False)
|
|
672
|
+
self._run_internal(f"capture quietly log flush {smcl_log_name}", echo=False)
|
|
673
|
+
|
|
674
|
+
# Retrieve RC via SFI
|
|
675
|
+
try:
|
|
676
|
+
rc_val = Scalar.getValue("_mcp_rc")
|
|
677
|
+
rc = int(float(rc_val)) if rc_val is not None else 0
|
|
678
|
+
except:
|
|
679
|
+
rc = 0
|
|
680
|
+
else:
|
|
681
|
+
# Optimization: Combined bundle for streaming too.
|
|
682
|
+
# Consolidates hold and potentially flush into one call.
|
|
683
|
+
self._hold_name_stream = f"mcp_hold_{uuid.uuid4().hex[:8]}"
|
|
684
|
+
|
|
685
|
+
# Initialization logic for locals can be sensitive.
|
|
686
|
+
# Since each run() in pystata starts a new context for locals unless it's a file,
|
|
687
|
+
# we use a global scalar for the return code.
|
|
688
|
+
# We use noisily inside the capture block to force echo of commands if requested.
|
|
689
|
+
bundle = (
|
|
690
|
+
f"capture noisily {{\n"
|
|
691
|
+
f"{'noisily {' if echo else ''}\n"
|
|
692
|
+
f"{command}\n"
|
|
693
|
+
f"{'}' if echo else ''}\n"
|
|
694
|
+
f"}}\n"
|
|
695
|
+
f"scalar _mcp_rc = _rc\n"
|
|
696
|
+
f"capture _return hold {self._hold_name_stream}\n"
|
|
697
|
+
f"capture quietly log flush {smcl_log_name}"
|
|
698
|
+
)
|
|
699
|
+
|
|
700
|
+
logger.debug("running Stata bundle echo=%s", echo)
|
|
701
|
+
# Using direct stata.run because tee redirection is already active
|
|
702
|
+
ret = self.stata.run(bundle, echo=echo)
|
|
703
|
+
|
|
704
|
+
# Retrieve RC via SFI for accuracy
|
|
705
|
+
try:
|
|
706
|
+
rc_val = Scalar.getValue("_mcp_rc")
|
|
707
|
+
rc = int(float(rc_val)) if rc_val is not None else 0
|
|
708
|
+
except:
|
|
709
|
+
rc = 0
|
|
710
|
+
|
|
711
|
+
if isinstance(ret, str) and ret:
|
|
712
|
+
# If for some reason SMCL log wasn't working, we can
|
|
713
|
+
# fall back to the raw output, but otherwise we
|
|
714
|
+
# avoid writing raw data to the tee.
|
|
715
|
+
pass
|
|
716
|
+
except Exception as e:
|
|
717
|
+
exc = e
|
|
718
|
+
logger.error("stata.run bundle failed: %r", e)
|
|
719
|
+
if rc in (-1, 0):
|
|
720
|
+
parsed_rc = self._parse_rc_from_text(str(e))
|
|
721
|
+
if parsed_rc is None:
|
|
722
|
+
try:
|
|
723
|
+
parsed_rc = self._parse_rc_from_text(direct_buf.getvalue())
|
|
724
|
+
except Exception:
|
|
725
|
+
parsed_rc = None
|
|
726
|
+
rc = parsed_rc if parsed_rc is not None else 1
|
|
727
|
+
finally:
|
|
728
|
+
if trace:
|
|
729
|
+
try:
|
|
730
|
+
self._run_internal("set trace off")
|
|
731
|
+
except Exception:
|
|
732
|
+
pass
|
|
733
|
+
finally:
|
|
734
|
+
# Only close if it's NOT the persistent session log
|
|
735
|
+
if not self._persistent_log_name or smcl_log_name != self._persistent_log_name:
|
|
736
|
+
self._close_smcl_log(smcl_log_name)
|
|
737
|
+
|
|
738
|
+
self._restore_results_from_hold(hold_attr)
|
|
739
|
+
|
|
740
|
+
# Final state restoration (invisibility)
|
|
741
|
+
try:
|
|
742
|
+
# Set c(rc) for the environment
|
|
743
|
+
self._run_internal(f"capture error {rc}" if rc > 0 else "capture", echo=False)
|
|
744
|
+
except Exception:
|
|
745
|
+
pass
|
|
746
|
+
return rc, exc
|
|
747
|
+
# If we get here, SMCL log failed and we're required to stop.
|
|
748
|
+
return rc, exc
|
|
749
|
+
finally:
|
|
750
|
+
self._is_executing = False
|
|
751
|
+
return rc, exc
|
|
752
|
+
|
|
753
|
+
def _resolve_do_file_path(
|
|
754
|
+
self,
|
|
755
|
+
path: str,
|
|
756
|
+
cwd: Optional[str],
|
|
757
|
+
) -> tuple[Optional[str], Optional[str], Optional[CommandResponse]]:
|
|
758
|
+
if cwd is not None and not os.path.isdir(cwd):
|
|
759
|
+
return None, None, CommandResponse(
|
|
760
|
+
command=f'do "{path}"',
|
|
761
|
+
rc=601,
|
|
762
|
+
stdout="",
|
|
763
|
+
stderr=None,
|
|
764
|
+
success=False,
|
|
765
|
+
error=ErrorEnvelope(
|
|
766
|
+
message=f"cwd not found: {cwd}",
|
|
767
|
+
rc=601,
|
|
768
|
+
command=path,
|
|
769
|
+
),
|
|
770
|
+
)
|
|
771
|
+
|
|
772
|
+
effective_path = path
|
|
773
|
+
if not os.path.isabs(path):
|
|
774
|
+
effective_path = os.path.abspath(os.path.join(cwd or os.getcwd(), path))
|
|
775
|
+
|
|
776
|
+
if not os.path.exists(effective_path):
|
|
777
|
+
return None, None, CommandResponse(
|
|
778
|
+
command=f'do "{effective_path}"',
|
|
779
|
+
rc=601,
|
|
780
|
+
stdout="",
|
|
781
|
+
stderr=None,
|
|
782
|
+
success=False,
|
|
783
|
+
error=ErrorEnvelope(
|
|
784
|
+
message=f"Do-file not found: {effective_path}",
|
|
785
|
+
rc=601,
|
|
786
|
+
command=effective_path,
|
|
787
|
+
),
|
|
788
|
+
)
|
|
789
|
+
|
|
790
|
+
path_for_stata = effective_path.replace("\\", "/")
|
|
791
|
+
command = f'do "{path_for_stata}"'
|
|
792
|
+
return effective_path, command, None
|
|
793
|
+
|
|
794
|
+
@contextmanager
|
|
795
|
+
def _smcl_log_capture(self) -> "Generator[Tuple[str, str], None, None]":
|
|
796
|
+
"""
|
|
797
|
+
Context manager that wraps command execution in a named SMCL log.
|
|
798
|
+
|
|
799
|
+
This runs alongside any user logs (named logs can coexist).
|
|
800
|
+
Yields (log_name, log_path) tuple for use within the context.
|
|
801
|
+
The SMCL file is NOT deleted automatically - caller should clean up.
|
|
802
|
+
|
|
803
|
+
Usage:
|
|
804
|
+
with self._smcl_log_capture() as (log_name, smcl_path):
|
|
805
|
+
self.stata.run(cmd)
|
|
806
|
+
# After context, read smcl_path for raw SMCL output
|
|
807
|
+
"""
|
|
808
|
+
# Use a unique name but DO NOT join start with mkstemp to avoid existing file locks.
|
|
809
|
+
# Stata will create the file.
|
|
810
|
+
smcl_path = self._create_smcl_log_path()
|
|
811
|
+
# Unique log name to avoid collisions with user logs
|
|
812
|
+
log_name = self._make_smcl_log_name()
|
|
813
|
+
|
|
814
|
+
try:
|
|
815
|
+
# Open named SMCL log (quietly to avoid polluting output)
|
|
816
|
+
log_opened = self._open_smcl_log(smcl_path, log_name, quiet=True)
|
|
817
|
+
if not log_opened:
|
|
818
|
+
# Still yield, consumer might see empty file or handle error,
|
|
819
|
+
# but we can't do much if Stata refuses to log.
|
|
820
|
+
pass
|
|
821
|
+
|
|
822
|
+
yield log_name, smcl_path
|
|
823
|
+
finally:
|
|
824
|
+
# Always close our named log
|
|
825
|
+
self._close_smcl_log(log_name)
|
|
826
|
+
# Ensure the persistent session log is still active after our capture.
|
|
827
|
+
if self._persistent_log_path and self._persistent_log_name:
|
|
828
|
+
try:
|
|
829
|
+
path_for_stata = self._persistent_log_path.replace("\\", "/")
|
|
830
|
+
mode = "append" if os.path.exists(self._persistent_log_path) else "replace"
|
|
831
|
+
reopen_cmd = (
|
|
832
|
+
f"capture quietly log using \"{path_for_stata}\", {mode} smcl name({self._persistent_log_name})"
|
|
833
|
+
)
|
|
834
|
+
self._run_internal(reopen_cmd, echo=False)
|
|
835
|
+
except Exception:
|
|
836
|
+
pass
|
|
837
|
+
|
|
838
|
+
def _read_smcl_file(self, path: str, start_offset: int = 0) -> str:
|
|
839
|
+
"""Read SMCL file contents, handling encoding issues, offsets and Windows file locks."""
|
|
840
|
+
try:
|
|
841
|
+
with open(path, 'r', encoding='utf-8', errors='replace') as f:
|
|
842
|
+
if start_offset > 0:
|
|
843
|
+
f.seek(start_offset)
|
|
844
|
+
return f.read()
|
|
845
|
+
except PermissionError:
|
|
846
|
+
if is_windows():
|
|
847
|
+
# Windows Fallback: Try to use 'type' command to bypass exclusive lock
|
|
848
|
+
try:
|
|
849
|
+
res = subprocess.run(f'type "{path}"', shell=True, capture_output=True)
|
|
850
|
+
if res.returncode == 0:
|
|
851
|
+
content = res.stdout.decode('utf-8', errors='replace')
|
|
852
|
+
if start_offset > 0 and len(content) > start_offset:
|
|
853
|
+
return content[start_offset:]
|
|
854
|
+
return content
|
|
855
|
+
except Exception as e:
|
|
856
|
+
logger.debug(f"Combined fallback read failed: {e}")
|
|
857
|
+
logger.warning(f"Failed to read SMCL file {path} due to lock")
|
|
858
|
+
return ""
|
|
859
|
+
except Exception as e:
|
|
860
|
+
logger.warning(f"Failed to read SMCL file {path}: {e}")
|
|
861
|
+
return ""
|
|
862
|
+
|
|
863
|
+
def _read_persistent_log_chunk(self, start_offset: int) -> str:
|
|
864
|
+
"""Read fresh chunk from persistent SMCL log starting at offset."""
|
|
865
|
+
if not self._persistent_log_path:
|
|
866
|
+
return ""
|
|
867
|
+
try:
|
|
868
|
+
with open(self._persistent_log_path, 'r', encoding='utf-8', errors='replace') as f:
|
|
869
|
+
f.seek(start_offset)
|
|
870
|
+
content = f.read()
|
|
871
|
+
|
|
872
|
+
if not content:
|
|
873
|
+
return ""
|
|
874
|
+
|
|
875
|
+
# Use refined cleaning logic to strip internal headers and maintenance
|
|
876
|
+
return self._clean_internal_smcl(content)
|
|
877
|
+
except PermissionError:
|
|
878
|
+
if is_windows():
|
|
879
|
+
try:
|
|
880
|
+
# Windows fallback for locked persistent log
|
|
881
|
+
res = subprocess.run(f'type "{self._persistent_log_path}"', shell=True, capture_output=True)
|
|
882
|
+
if res.returncode == 0:
|
|
883
|
+
full_content = res.stdout.decode('utf-8', errors='replace')
|
|
884
|
+
if len(full_content) > start_offset:
|
|
885
|
+
return full_content[start_offset:]
|
|
886
|
+
return ""
|
|
887
|
+
except Exception:
|
|
888
|
+
pass
|
|
889
|
+
return ""
|
|
890
|
+
except Exception:
|
|
891
|
+
return ""
|
|
892
|
+
|
|
893
|
+
def _extract_error_from_smcl(self, smcl_content: str, rc: int) -> Tuple[str, str]:
|
|
894
|
+
"""
|
|
895
|
+
Extract error message and context from raw SMCL output.
|
|
896
|
+
|
|
897
|
+
Uses {err} tags as the authoritative source for error detection.
|
|
898
|
+
|
|
899
|
+
Returns:
|
|
900
|
+
Tuple of (error_message, context_string)
|
|
901
|
+
"""
|
|
902
|
+
if not smcl_content:
|
|
903
|
+
return f"Stata error r({rc})", ""
|
|
904
|
+
|
|
905
|
+
# Try Rust optimization
|
|
906
|
+
native_res = fast_scan_log(smcl_content, rc)
|
|
907
|
+
if native_res:
|
|
908
|
+
error_msg, context, _ = native_res
|
|
909
|
+
# If native result is specific, return it. Otherwise fall through to recover
|
|
910
|
+
# a more descriptive error message from SMCL/text.
|
|
911
|
+
if error_msg and error_msg != f"Stata error r({rc})":
|
|
912
|
+
return error_msg, context
|
|
913
|
+
|
|
914
|
+
lines = smcl_content.splitlines()
|
|
915
|
+
|
|
916
|
+
# Search backwards for {err} tags - they indicate error lines
|
|
917
|
+
error_lines = []
|
|
918
|
+
error_start_idx = -1
|
|
919
|
+
|
|
920
|
+
# Skip the very last few lines if they contain our cleanup noise
|
|
921
|
+
# like "capture error 111" or "log flush invalid"
|
|
922
|
+
internal_noise_patterns = [
|
|
923
|
+
"flush invalid",
|
|
924
|
+
"capture error",
|
|
925
|
+
"search r(",
|
|
926
|
+
"r(198);",
|
|
927
|
+
"r(111);"
|
|
928
|
+
]
|
|
929
|
+
|
|
930
|
+
for i in range(len(lines) - 1, -1, -1):
|
|
931
|
+
line = lines[i]
|
|
932
|
+
if '{err}' in line:
|
|
933
|
+
# Is this internal noise?
|
|
934
|
+
is_noise = any(p in line.lower() for p in internal_noise_patterns)
|
|
935
|
+
if is_noise and error_start_idx == -1:
|
|
936
|
+
# If we only have noise at the very end, we should keep looking back
|
|
937
|
+
continue
|
|
938
|
+
|
|
939
|
+
if error_start_idx == -1:
|
|
940
|
+
error_start_idx = i
|
|
941
|
+
# Walk backwards to find consecutive {err} lines
|
|
942
|
+
j = i
|
|
943
|
+
while j >= 0 and '{err}' in lines[j]:
|
|
944
|
+
error_lines.insert(0, lines[j])
|
|
945
|
+
j -= 1
|
|
946
|
+
break
|
|
947
|
+
|
|
948
|
+
if error_lines:
|
|
949
|
+
# Clean SMCL tags from error message
|
|
950
|
+
clean_lines = []
|
|
951
|
+
for line in error_lines:
|
|
952
|
+
# Remove SMCL tags but keep the text content
|
|
953
|
+
cleaned = re.sub(r'\{[^}]*\}', '', line).strip()
|
|
954
|
+
if cleaned:
|
|
955
|
+
clean_lines.append(cleaned)
|
|
956
|
+
|
|
957
|
+
error_msg = " ".join(clean_lines) or f"Stata error r({rc})"
|
|
958
|
+
|
|
959
|
+
# Context is everything from error start to end
|
|
960
|
+
context_start = max(0, error_start_idx - 5) # Include 5 lines before error
|
|
961
|
+
context = "\n".join(lines[context_start:])
|
|
962
|
+
|
|
963
|
+
return error_msg, context
|
|
964
|
+
|
|
965
|
+
# Fallback: no {err} found, try to extract a meaningful message from text
|
|
966
|
+
# (some Stata errors do not emit {err} tags in SMCL).
|
|
967
|
+
try:
|
|
968
|
+
text_lines = self._smcl_to_text(smcl_content).splitlines()
|
|
969
|
+
except Exception:
|
|
970
|
+
text_lines = []
|
|
971
|
+
|
|
972
|
+
def _find_error_line() -> Optional[str]:
|
|
973
|
+
patterns = [
|
|
974
|
+
r"no variables defined",
|
|
975
|
+
r"not found",
|
|
976
|
+
r"variable .* not found",
|
|
977
|
+
r"no observations",
|
|
978
|
+
]
|
|
979
|
+
for line in reversed(text_lines):
|
|
980
|
+
lowered = line.lower()
|
|
981
|
+
for pat in patterns:
|
|
982
|
+
if re.search(pat, lowered):
|
|
983
|
+
return line.strip()
|
|
984
|
+
return None
|
|
985
|
+
|
|
986
|
+
extracted = _find_error_line()
|
|
987
|
+
if extracted:
|
|
988
|
+
error_msg = extracted
|
|
989
|
+
else:
|
|
990
|
+
error_msg = f"Stata error r({rc})"
|
|
991
|
+
|
|
992
|
+
# Context: last 30 lines of SMCL
|
|
993
|
+
context_start = max(0, len(lines) - 30)
|
|
994
|
+
context = "\n".join(lines[context_start:])
|
|
995
|
+
|
|
996
|
+
return error_msg, context
|
|
997
|
+
|
|
998
|
+
def _parse_rc_from_smcl(self, smcl_content: str) -> Optional[int]:
|
|
999
|
+
"""Parse return code from SMCL content using specific structural patterns."""
|
|
1000
|
+
if not smcl_content:
|
|
1001
|
+
return None
|
|
1002
|
+
|
|
1003
|
+
# Try Rust optimization
|
|
1004
|
+
native_res = fast_scan_log(smcl_content, 0)
|
|
1005
|
+
if native_res:
|
|
1006
|
+
_, _, rc = native_res
|
|
1007
|
+
if rc is not None:
|
|
1008
|
+
return rc
|
|
1009
|
+
|
|
1010
|
+
# 1. Primary check: SMCL search tag {search r(N), ...}
|
|
1011
|
+
# This is the most authoritative interactive indicator
|
|
1012
|
+
matches = list(re.finditer(r'\{search r\((\d+)\)', smcl_content))
|
|
1013
|
+
if matches:
|
|
1014
|
+
try:
|
|
1015
|
+
return int(matches[-1].group(1))
|
|
1016
|
+
except Exception:
|
|
1017
|
+
pass
|
|
1018
|
+
|
|
1019
|
+
# 2. Secondary check: Standalone r(N); pattern
|
|
1020
|
+
# This appears at the end of command blocks
|
|
1021
|
+
matches = list(re.finditer(r'(?<!\w)r\((\d+)\);?', smcl_content))
|
|
1022
|
+
if matches:
|
|
1023
|
+
try:
|
|
1024
|
+
return int(matches[-1].group(1))
|
|
1025
|
+
except Exception:
|
|
1026
|
+
pass
|
|
1027
|
+
|
|
1028
|
+
return None
|
|
1029
|
+
|
|
1030
|
+
@staticmethod
|
|
1031
|
+
def _create_graph_cache_callback(on_graph_cached, notify_log):
|
|
1032
|
+
"""Create a standardized graph cache callback with proper error handling."""
|
|
1033
|
+
async def graph_cache_callback(graph_name: str, success: bool) -> None:
|
|
1034
|
+
try:
|
|
1035
|
+
if on_graph_cached:
|
|
1036
|
+
await on_graph_cached(graph_name, success)
|
|
1037
|
+
except Exception as e:
|
|
1038
|
+
logger.error(f"Graph cache callback failed: {e}")
|
|
1039
|
+
|
|
1040
|
+
try:
|
|
1041
|
+
# Also notify via log channel
|
|
1042
|
+
await notify_log(json.dumps({
|
|
1043
|
+
"event": "graph_cached",
|
|
1044
|
+
"graph": graph_name,
|
|
1045
|
+
"success": success
|
|
1046
|
+
}))
|
|
1047
|
+
except Exception as e:
|
|
1048
|
+
logger.error(f"Failed to notify about graph cache: {e}")
|
|
1049
|
+
|
|
1050
|
+
return graph_cache_callback
|
|
1051
|
+
|
|
1052
|
+
def _get_cached_graph_path(self, graph_name: str) -> Optional[str]:
|
|
1053
|
+
if not hasattr(self, "_cache_lock") or not hasattr(self, "_preemptive_cache"):
|
|
1054
|
+
return None
|
|
1055
|
+
try:
|
|
1056
|
+
with self._cache_lock:
|
|
1057
|
+
cache_path = self._preemptive_cache.get(graph_name)
|
|
1058
|
+
if not cache_path:
|
|
1059
|
+
return None
|
|
1060
|
+
|
|
1061
|
+
# Double-check validity (e.g. signature match for current command)
|
|
1062
|
+
if not self._is_cache_valid(graph_name, cache_path):
|
|
1063
|
+
return None
|
|
1064
|
+
|
|
1065
|
+
return cache_path
|
|
1066
|
+
except Exception:
|
|
1067
|
+
return None
|
|
1068
|
+
|
|
1069
|
+
async def _emit_graph_ready_for_graphs(
|
|
1070
|
+
self,
|
|
1071
|
+
graph_names: List[str],
|
|
1072
|
+
*,
|
|
1073
|
+
notify_log: Callable[[str], Awaitable[None]],
|
|
1074
|
+
task_id: Optional[str],
|
|
1075
|
+
export_format: str,
|
|
1076
|
+
graph_ready_initial: Optional[dict[str, str]],
|
|
1077
|
+
) -> int:
|
|
1078
|
+
if not graph_names:
|
|
1079
|
+
return 0
|
|
1080
|
+
# Deduplicate requested names while preserving order
|
|
1081
|
+
graph_names = list(dict.fromkeys(graph_names))
|
|
1082
|
+
fmt = (export_format or "svg").strip().lower()
|
|
1083
|
+
emitted = 0
|
|
1084
|
+
|
|
1085
|
+
# Heuristic: Find active graph to help decide which existing graphs were touched.
|
|
1086
|
+
active_graph = None
|
|
1087
|
+
try:
|
|
1088
|
+
from sfi import Scalar
|
|
1089
|
+
active_graph = Scalar.getValue("c(curgraph)")
|
|
1090
|
+
except Exception:
|
|
1091
|
+
pass
|
|
1092
|
+
code = getattr(self, "_current_command_code", "")
|
|
1093
|
+
named_graphs = set(self._extract_named_graphs(code))
|
|
1094
|
+
|
|
1095
|
+
for graph_name in graph_names:
|
|
1096
|
+
# Try to determine a stable signature before exporting; prefer cached path if present
|
|
1097
|
+
cached_path = self._get_cached_graph_path(graph_name) if fmt == "svg" else None
|
|
1098
|
+
pre_signature = self._get_graph_signature(graph_name)
|
|
1099
|
+
emit_key = f"{graph_name}:{self._command_idx}:{fmt}"
|
|
1100
|
+
|
|
1101
|
+
# If we already emitted this EXACT signature in THIS command, skip.
|
|
1102
|
+
if self._last_emitted_graph_signatures.get(graph_name) == emit_key:
|
|
1103
|
+
continue
|
|
1104
|
+
|
|
1105
|
+
# Emit only when the command matches the graph command or explicitly names it.
|
|
1106
|
+
if graph_ready_initial is not None:
|
|
1107
|
+
graph_cmd = self._get_graph_command_line(graph_name)
|
|
1108
|
+
if not self._command_contains_graph_command(code, graph_cmd or ""):
|
|
1109
|
+
if graph_name not in named_graphs:
|
|
1110
|
+
continue
|
|
1111
|
+
|
|
1112
|
+
try:
|
|
1113
|
+
export_path = cached_path
|
|
1114
|
+
if not export_path:
|
|
1115
|
+
last_exc = None
|
|
1116
|
+
for attempt in range(6):
|
|
1117
|
+
try:
|
|
1118
|
+
export_path = await anyio.to_thread.run_sync(
|
|
1119
|
+
lambda: self.export_graph(graph_name, format=fmt)
|
|
1120
|
+
)
|
|
1121
|
+
break
|
|
1122
|
+
except Exception as exc:
|
|
1123
|
+
last_exc = exc
|
|
1124
|
+
if attempt < 5:
|
|
1125
|
+
await anyio.sleep(0.05)
|
|
1126
|
+
continue
|
|
1127
|
+
raise last_exc
|
|
1128
|
+
if self._last_emitted_graph_signatures.get(graph_name) == emit_key:
|
|
1129
|
+
continue
|
|
1130
|
+
payload = {
|
|
1131
|
+
"event": "graph_ready",
|
|
1132
|
+
"task_id": task_id,
|
|
1133
|
+
"graph": {
|
|
1134
|
+
"name": graph_name,
|
|
1135
|
+
"path": export_path,
|
|
1136
|
+
"label": graph_name,
|
|
1137
|
+
},
|
|
1138
|
+
}
|
|
1139
|
+
await notify_log(json.dumps(payload))
|
|
1140
|
+
emitted += 1
|
|
1141
|
+
self._last_emitted_graph_signatures[graph_name] = emit_key
|
|
1142
|
+
if graph_ready_initial is not None:
|
|
1143
|
+
graph_ready_initial[graph_name] = pre_signature
|
|
1144
|
+
except Exception as e:
|
|
1145
|
+
logger.warning("graph_ready export failed for %s: %s", graph_name, e)
|
|
1146
|
+
return emitted
|
|
1147
|
+
|
|
1148
|
+
@staticmethod
|
|
1149
|
+
def _extract_named_graphs(text: str) -> List[str]:
|
|
1150
|
+
if not text:
|
|
1151
|
+
return []
|
|
1152
|
+
matches = _GRAPH_NAME_PATTERN.findall(text)
|
|
1153
|
+
if not matches:
|
|
1154
|
+
return []
|
|
1155
|
+
out = []
|
|
1156
|
+
for raw in matches:
|
|
1157
|
+
name = raw.strip().strip("\"").strip("'").strip()
|
|
1158
|
+
if name:
|
|
1159
|
+
out.append(name)
|
|
1160
|
+
return out
|
|
1161
|
+
|
|
1162
|
+
async def _maybe_cache_graphs_on_chunk(
|
|
1163
|
+
self,
|
|
1164
|
+
*,
|
|
1165
|
+
graph_cache: Optional[StreamingGraphCache],
|
|
1166
|
+
emit_graph_ready: bool,
|
|
1167
|
+
notify_log: Callable[[str], Awaitable[None]],
|
|
1168
|
+
graph_ready_task_id: Optional[str],
|
|
1169
|
+
graph_ready_format: str,
|
|
1170
|
+
graph_ready_initial: Optional[dict[str, str]],
|
|
1171
|
+
last_check: List[float],
|
|
1172
|
+
force: bool = False,
|
|
1173
|
+
) -> int:
|
|
1174
|
+
if not graph_cache or not graph_cache.auto_cache:
|
|
1175
|
+
return 0
|
|
1176
|
+
if self._is_executing and not force:
|
|
1177
|
+
# Skip polling if Stata is busy; it will block on _exec_lock anyway.
|
|
1178
|
+
# During final check (force=True), we know it's safe because _run_streaming_blocking has finished.
|
|
1179
|
+
return 0
|
|
1180
|
+
now = time.monotonic()
|
|
1181
|
+
if not force and last_check and now - last_check[0] < 0.75:
|
|
1182
|
+
return 0
|
|
1183
|
+
if last_check:
|
|
1184
|
+
last_check[0] = now
|
|
1185
|
+
try:
|
|
1186
|
+
cached_names = await graph_cache.cache_detected_graphs_with_pystata()
|
|
1187
|
+
except Exception as e:
|
|
1188
|
+
logger.debug("graph_ready polling failed: %s", e)
|
|
1189
|
+
return 0
|
|
1190
|
+
if emit_graph_ready and cached_names:
|
|
1191
|
+
async with self._ensure_graph_ready_lock():
|
|
1192
|
+
return await self._emit_graph_ready_for_graphs(
|
|
1193
|
+
cached_names,
|
|
1194
|
+
notify_log=notify_log,
|
|
1195
|
+
task_id=graph_ready_task_id,
|
|
1196
|
+
export_format=graph_ready_format,
|
|
1197
|
+
graph_ready_initial=graph_ready_initial,
|
|
1198
|
+
)
|
|
1199
|
+
return 0
|
|
1200
|
+
|
|
1201
|
+
def _ensure_graph_ready_lock(self) -> asyncio.Lock:
|
|
1202
|
+
lock = getattr(self, "_graph_ready_lock", None)
|
|
1203
|
+
if lock is None:
|
|
1204
|
+
lock = asyncio.Lock()
|
|
1205
|
+
self._graph_ready_lock = lock
|
|
1206
|
+
return lock
|
|
1207
|
+
|
|
1208
|
+
async def _emit_graph_ready_events(
|
|
1209
|
+
self,
|
|
1210
|
+
initial_graphs: dict[str, str],
|
|
1211
|
+
notify_log: Callable[[str], Awaitable[None]],
|
|
1212
|
+
task_id: Optional[str],
|
|
1213
|
+
export_format: str,
|
|
1214
|
+
) -> int:
|
|
1215
|
+
if initial_graphs is None:
|
|
1216
|
+
return 0
|
|
1217
|
+
lock = self._ensure_graph_ready_lock()
|
|
1218
|
+
|
|
1219
|
+
fmt = (export_format or "svg").strip().lower()
|
|
1220
|
+
emitted = 0
|
|
1221
|
+
|
|
1222
|
+
# Poll briefly for new graphs after command completion; emit once per batch.
|
|
1223
|
+
for _ in range(5):
|
|
1224
|
+
try:
|
|
1225
|
+
current_graphs = list(self.list_graphs(force_refresh=True))
|
|
1226
|
+
except Exception as exc:
|
|
1227
|
+
logger.debug("graph_ready list_graphs failed: %s", exc)
|
|
1228
|
+
current_graphs = []
|
|
1229
|
+
|
|
1230
|
+
if current_graphs:
|
|
1231
|
+
async with lock:
|
|
1232
|
+
emitted += await self._emit_graph_ready_for_graphs(
|
|
1233
|
+
current_graphs,
|
|
1234
|
+
notify_log=notify_log,
|
|
1235
|
+
task_id=task_id,
|
|
1236
|
+
export_format=fmt,
|
|
1237
|
+
graph_ready_initial=initial_graphs,
|
|
1238
|
+
)
|
|
1239
|
+
break
|
|
1240
|
+
|
|
1241
|
+
await anyio.sleep(0.05)
|
|
1242
|
+
|
|
1243
|
+
return emitted
|
|
1244
|
+
|
|
1245
|
+
def _get_graph_signature(self, graph_name: str) -> str:
|
|
1246
|
+
"""Return a stable signature for a graph name based on graph metadata."""
|
|
1247
|
+
if self._graph_signature_cache_cmd_idx != self._command_idx:
|
|
1248
|
+
self._graph_signature_cache = {}
|
|
1249
|
+
self._graph_signature_cache_cmd_idx = self._command_idx
|
|
1250
|
+
|
|
1251
|
+
cached = self._graph_signature_cache.get(graph_name)
|
|
1252
|
+
if cached:
|
|
1253
|
+
return cached
|
|
1254
|
+
|
|
1255
|
+
signature = graph_name
|
|
1256
|
+
|
|
1257
|
+
# Refresh graph metadata if we don't have created timestamps yet.
|
|
1258
|
+
try:
|
|
1259
|
+
self.list_graphs(force_refresh=True)
|
|
1260
|
+
except Exception:
|
|
1261
|
+
pass
|
|
1262
|
+
|
|
1263
|
+
try:
|
|
1264
|
+
# Use cached graph metadata when available (created timestamp is stable).
|
|
1265
|
+
with self._list_graphs_cache_lock:
|
|
1266
|
+
cached_graphs = list(self._list_graphs_cache or [])
|
|
1267
|
+
for g in cached_graphs:
|
|
1268
|
+
if hasattr(g, "name") and g.name == graph_name and getattr(g, "created", None):
|
|
1269
|
+
signature = f"{graph_name}_{g.created}"
|
|
1270
|
+
break
|
|
1271
|
+
except Exception:
|
|
1272
|
+
pass
|
|
1273
|
+
|
|
1274
|
+
# If still missing, attempt a targeted timestamp lookup via the graph detector.
|
|
1275
|
+
if signature == graph_name:
|
|
1276
|
+
try:
|
|
1277
|
+
detector = getattr(self, "_graph_detector", None)
|
|
1278
|
+
if detector is not None:
|
|
1279
|
+
timestamps = detector._get_graph_timestamps([graph_name])
|
|
1280
|
+
ts = timestamps.get(graph_name)
|
|
1281
|
+
if ts:
|
|
1282
|
+
signature = f"{graph_name}_{ts}"
|
|
1283
|
+
except Exception:
|
|
1284
|
+
pass
|
|
1285
|
+
|
|
1286
|
+
self._graph_signature_cache[graph_name] = signature
|
|
1287
|
+
return signature
|
|
1288
|
+
|
|
1289
|
+
@staticmethod
|
|
1290
|
+
def _normalize_command_text(text: str) -> str:
|
|
1291
|
+
return " ".join((text or "").strip().split()).lower()
|
|
1292
|
+
|
|
1293
|
+
def _command_contains_graph_command(self, code: str, graph_cmd: str) -> bool:
|
|
1294
|
+
if not code or not graph_cmd:
|
|
1295
|
+
return False
|
|
1296
|
+
graph_norm = self._normalize_command_text(graph_cmd)
|
|
1297
|
+
if not graph_norm:
|
|
1298
|
+
return False
|
|
1299
|
+
graph_prefixed = f"graph {graph_norm}" if not graph_norm.startswith("graph ") else graph_norm
|
|
1300
|
+
def matches(candidate: str) -> bool:
|
|
1301
|
+
cand_norm = self._normalize_command_text(candidate)
|
|
1302
|
+
if not cand_norm:
|
|
1303
|
+
return False
|
|
1304
|
+
return (
|
|
1305
|
+
cand_norm == graph_norm
|
|
1306
|
+
or graph_norm.startswith(cand_norm)
|
|
1307
|
+
or cand_norm.startswith(graph_norm)
|
|
1308
|
+
or cand_norm == graph_prefixed
|
|
1309
|
+
or graph_prefixed.startswith(cand_norm)
|
|
1310
|
+
or cand_norm.startswith(graph_prefixed)
|
|
1311
|
+
)
|
|
1312
|
+
|
|
1313
|
+
if "\n" in code:
|
|
1314
|
+
for line in code.splitlines():
|
|
1315
|
+
if matches(line):
|
|
1316
|
+
return True
|
|
1317
|
+
return False
|
|
1318
|
+
return matches(code)
|
|
1319
|
+
|
|
1320
|
+
def _get_graph_command_line(self, graph_name: str) -> Optional[str]:
|
|
1321
|
+
"""Fetch the Stata command line used to create the graph, if available."""
|
|
1322
|
+
try:
|
|
1323
|
+
from sfi import Macro
|
|
1324
|
+
except Exception:
|
|
1325
|
+
return None
|
|
1326
|
+
|
|
1327
|
+
resolved = self._resolve_graph_name_for_stata(graph_name)
|
|
1328
|
+
hold_name = f"_mcp_gcmd_hold_{uuid.uuid4().hex[:8]}"
|
|
1329
|
+
cmd = None
|
|
1330
|
+
cur_graph = None
|
|
1331
|
+
|
|
1332
|
+
with self._exec_lock:
|
|
1333
|
+
try:
|
|
1334
|
+
bundle = (
|
|
1335
|
+
f"capture _return hold {hold_name}\n"
|
|
1336
|
+
f"capture quietly graph describe {resolved}\n"
|
|
1337
|
+
"macro define mcp_gcmd \"`r(command)'\"\n"
|
|
1338
|
+
"macro define mcp_curgraph \"`c(curgraph)'\"\n"
|
|
1339
|
+
f"capture _return restore {hold_name}"
|
|
1340
|
+
)
|
|
1341
|
+
self.stata.run(bundle, echo=False)
|
|
1342
|
+
cmd = Macro.getGlobal("mcp_gcmd")
|
|
1343
|
+
cur_graph = Macro.getGlobal("mcp_curgraph")
|
|
1344
|
+
self.stata.run("macro drop mcp_gcmd", echo=False)
|
|
1345
|
+
self.stata.run("macro drop mcp_curgraph", echo=False)
|
|
1346
|
+
except Exception:
|
|
1347
|
+
try:
|
|
1348
|
+
self.stata.run(f"capture _return restore {hold_name}", echo=False)
|
|
1349
|
+
except Exception:
|
|
1350
|
+
pass
|
|
1351
|
+
cmd = None
|
|
1352
|
+
|
|
1353
|
+
if cmd:
|
|
1354
|
+
return cmd
|
|
1355
|
+
|
|
1356
|
+
# Fallback: describe current graph without a name and validate against c(curgraph).
|
|
1357
|
+
with self._exec_lock:
|
|
1358
|
+
try:
|
|
1359
|
+
bundle = (
|
|
1360
|
+
f"capture _return hold {hold_name}\n"
|
|
1361
|
+
"capture quietly graph describe\n"
|
|
1362
|
+
"macro define mcp_gcmd \"`r(command)'\"\n"
|
|
1363
|
+
"macro define mcp_curgraph \"`c(curgraph)'\"\n"
|
|
1364
|
+
f"capture _return restore {hold_name}"
|
|
1365
|
+
)
|
|
1366
|
+
self.stata.run(bundle, echo=False)
|
|
1367
|
+
cmd = Macro.getGlobal("mcp_gcmd")
|
|
1368
|
+
cur_graph = Macro.getGlobal("mcp_curgraph")
|
|
1369
|
+
self.stata.run("macro drop mcp_gcmd", echo=False)
|
|
1370
|
+
self.stata.run("macro drop mcp_curgraph", echo=False)
|
|
1371
|
+
except Exception:
|
|
1372
|
+
try:
|
|
1373
|
+
self.stata.run(f"capture _return restore {hold_name}", echo=False)
|
|
1374
|
+
except Exception:
|
|
1375
|
+
pass
|
|
1376
|
+
cmd = None
|
|
1377
|
+
|
|
1378
|
+
if cmd and cur_graph:
|
|
1379
|
+
if cur_graph == resolved or cur_graph == graph_name:
|
|
1380
|
+
return cmd
|
|
1381
|
+
|
|
1382
|
+
return cmd or None
|
|
1383
|
+
|
|
1384
|
+
def _request_break_in(self) -> None:
|
|
1385
|
+
"""
|
|
1386
|
+
Attempt to interrupt a running Stata command when cancellation is requested.
|
|
1387
|
+
|
|
1388
|
+
Uses the Stata sfi.breakIn hook when available; errors are swallowed because
|
|
1389
|
+
cancellation should never crash the host process.
|
|
1390
|
+
"""
|
|
1391
|
+
try:
|
|
1392
|
+
import sfi # type: ignore[import-not-found]
|
|
1393
|
+
|
|
1394
|
+
break_fn = getattr(sfi, "breakIn", None) or getattr(sfi, "break_in", None)
|
|
1395
|
+
if callable(break_fn):
|
|
1396
|
+
try:
|
|
1397
|
+
break_fn()
|
|
1398
|
+
logger.info("Sent breakIn() to Stata for cancellation")
|
|
1399
|
+
except Exception as e: # pragma: no cover - best-effort
|
|
1400
|
+
logger.warning(f"Failed to send breakIn() to Stata: {e}")
|
|
1401
|
+
else: # pragma: no cover - environment without Stata runtime
|
|
1402
|
+
logger.debug("sfi.breakIn not available; cannot interrupt Stata")
|
|
1403
|
+
except Exception as e: # pragma: no cover - import failure or other
|
|
1404
|
+
logger.debug(f"Unable to import sfi for cancellation: {e}")
|
|
1405
|
+
|
|
1406
|
+
async def _wait_for_stata_stop(self, timeout: float = 2.0) -> bool:
|
|
1407
|
+
"""
|
|
1408
|
+
After requesting a break, poll the Stata interface so it can surface BreakError
|
|
1409
|
+
and return control. This is best-effort and time-bounded.
|
|
1410
|
+
"""
|
|
1411
|
+
deadline = time.monotonic() + timeout
|
|
1412
|
+
try:
|
|
1413
|
+
import sfi # type: ignore[import-not-found]
|
|
1414
|
+
|
|
1415
|
+
toolkit = getattr(sfi, "SFIToolkit", None)
|
|
1416
|
+
poll = getattr(toolkit, "pollnow", None) or getattr(toolkit, "pollstd", None)
|
|
1417
|
+
BreakError = getattr(sfi, "BreakError", None)
|
|
1418
|
+
except Exception: # pragma: no cover
|
|
1419
|
+
return False
|
|
1420
|
+
|
|
1421
|
+
if not callable(poll):
|
|
1422
|
+
return False
|
|
1423
|
+
|
|
1424
|
+
last_exc: Optional[Exception] = None
|
|
1425
|
+
while time.monotonic() < deadline:
|
|
1426
|
+
try:
|
|
1427
|
+
poll()
|
|
1428
|
+
except Exception as e: # pragma: no cover - depends on Stata runtime
|
|
1429
|
+
last_exc = e
|
|
1430
|
+
if BreakError is not None and isinstance(e, BreakError):
|
|
1431
|
+
logger.info("Stata BreakError detected; cancellation acknowledged by Stata")
|
|
1432
|
+
return True
|
|
1433
|
+
# If Stata already stopped, break on any other exception.
|
|
1434
|
+
break
|
|
1435
|
+
await anyio.sleep(0.05)
|
|
1436
|
+
|
|
1437
|
+
if last_exc:
|
|
1438
|
+
logger.debug(f"Cancellation poll exited with {last_exc}")
|
|
1439
|
+
return False
|
|
1440
|
+
|
|
1441
|
+
@contextmanager
|
|
1442
|
+
def _temp_cwd(self, cwd: Optional[str]):
|
|
1443
|
+
if cwd is None:
|
|
1444
|
+
yield
|
|
1445
|
+
return
|
|
1446
|
+
prev = os.getcwd()
|
|
1447
|
+
os.chdir(cwd)
|
|
1448
|
+
try:
|
|
1449
|
+
yield
|
|
1450
|
+
finally:
|
|
1451
|
+
os.chdir(prev)
|
|
1452
|
+
|
|
1453
|
+
@contextmanager
|
|
1454
|
+
def _safe_redirect_fds(self):
|
|
1455
|
+
"""Redirects fd 1 (stdout) to fd 2 (stderr) at the OS level."""
|
|
1456
|
+
# Save original stdout fd
|
|
1457
|
+
try:
|
|
1458
|
+
stdout_fd = os.dup(1)
|
|
1459
|
+
except Exception:
|
|
1460
|
+
# Fallback if we can't dup (e.g. strange environment)
|
|
1461
|
+
yield
|
|
1462
|
+
return
|
|
1463
|
+
|
|
1464
|
+
try:
|
|
1465
|
+
# Redirect OS-level stdout to stderr
|
|
1466
|
+
os.dup2(2, 1)
|
|
1467
|
+
yield
|
|
1468
|
+
finally:
|
|
1469
|
+
# Restore stdout
|
|
1470
|
+
try:
|
|
1471
|
+
os.dup2(stdout_fd, 1)
|
|
1472
|
+
os.close(stdout_fd)
|
|
1473
|
+
except Exception:
|
|
1474
|
+
pass
|
|
1475
|
+
|
|
1476
|
+
def init(self):
|
|
1477
|
+
"""Initializes usage of pystata using cached discovery results."""
|
|
1478
|
+
if self._initialized:
|
|
1479
|
+
return
|
|
1480
|
+
|
|
1481
|
+
# Suppress any non-UTF8 banner output from PyStata on stdout, which breaks MCP stdio transport
|
|
1482
|
+
from contextlib import redirect_stdout, redirect_stderr
|
|
1483
|
+
|
|
1484
|
+
try:
|
|
1485
|
+
import stata_setup
|
|
1486
|
+
|
|
1487
|
+
# Get discovered Stata paths (cached from first call)
|
|
1488
|
+
discovery_candidates = _get_discovery_candidates()
|
|
1489
|
+
if not discovery_candidates:
|
|
1490
|
+
raise RuntimeError("No Stata candidates found during discovery")
|
|
1491
|
+
|
|
1492
|
+
logger.info("Initializing Stata engine (attempting up to %d candidate binaries)...", len(discovery_candidates))
|
|
1493
|
+
|
|
1494
|
+
# Diagnostic: force faulthandler to output to stderr for C crashes
|
|
1495
|
+
import faulthandler
|
|
1496
|
+
faulthandler.enable(file=sys.stderr)
|
|
1497
|
+
import subprocess
|
|
1498
|
+
|
|
1499
|
+
success = False
|
|
1500
|
+
last_error = None
|
|
1501
|
+
chosen_exec: Optional[Tuple[str, str]] = None
|
|
1502
|
+
|
|
1503
|
+
for stata_exec_path, edition in discovery_candidates:
|
|
1504
|
+
candidates = []
|
|
1505
|
+
# Prefer the binary directory first (documented input for stata_setup)
|
|
1506
|
+
bin_dir = os.path.dirname(stata_exec_path)
|
|
1507
|
+
|
|
1508
|
+
# 2. App Bundle: .../StataMP.app (macOS only)
|
|
1509
|
+
curr = bin_dir
|
|
1510
|
+
app_bundle = None
|
|
1511
|
+
while len(curr) > 1:
|
|
1512
|
+
if curr.endswith(".app"):
|
|
1513
|
+
app_bundle = curr
|
|
1514
|
+
break
|
|
1515
|
+
parent = os.path.dirname(curr)
|
|
1516
|
+
if parent == curr:
|
|
1517
|
+
break
|
|
1518
|
+
curr = parent
|
|
1519
|
+
|
|
1520
|
+
ordered_candidates = []
|
|
1521
|
+
if app_bundle:
|
|
1522
|
+
# On macOS, the parent of the .app is often the correct install path
|
|
1523
|
+
# (e.g., /Applications/StataNow containing StataMP.app)
|
|
1524
|
+
parent_dir = os.path.dirname(app_bundle)
|
|
1525
|
+
if parent_dir and parent_dir != "/":
|
|
1526
|
+
ordered_candidates.append(parent_dir)
|
|
1527
|
+
ordered_candidates.append(app_bundle)
|
|
1528
|
+
|
|
1529
|
+
if bin_dir:
|
|
1530
|
+
ordered_candidates.append(bin_dir)
|
|
1531
|
+
|
|
1532
|
+
# Deduplicate preserving order
|
|
1533
|
+
seen = set()
|
|
1534
|
+
candidates = []
|
|
1535
|
+
for c in ordered_candidates:
|
|
1536
|
+
if c not in seen:
|
|
1537
|
+
seen.add(c)
|
|
1538
|
+
candidates.append(c)
|
|
1539
|
+
|
|
1540
|
+
for path in candidates:
|
|
1541
|
+
try:
|
|
1542
|
+
# 1. Pre-flight check in a subprocess to capture hard exits/crashes
|
|
1543
|
+
skip_preflight = os.environ.get("MCP_STATA_SKIP_PREFLIGHT") == "1"
|
|
1544
|
+
if not skip_preflight:
|
|
1545
|
+
sys.stderr.write(f"[mcp_stata] DEBUG: Pre-flight check for path '{path}'\n")
|
|
1546
|
+
sys.stderr.flush()
|
|
1547
|
+
|
|
1548
|
+
preflight_code = f"""
|
|
1549
|
+
import sys
|
|
1550
|
+
import stata_setup
|
|
1551
|
+
from contextlib import redirect_stdout, redirect_stderr
|
|
1552
|
+
with redirect_stdout(sys.stderr), redirect_stderr(sys.stderr):
|
|
1553
|
+
try:
|
|
1554
|
+
stata_setup.config({repr(path)}, {repr(edition)})
|
|
1555
|
+
from pystata import stata
|
|
1556
|
+
# Minimal verification of engine health
|
|
1557
|
+
stata.run('display 1', echo=False)
|
|
1558
|
+
print('PREFLIGHT_OK')
|
|
1559
|
+
except Exception as e:
|
|
1560
|
+
print(f'PREFLIGHT_FAIL: {{e}}', file=sys.stderr)
|
|
1561
|
+
sys.exit(1)
|
|
1562
|
+
"""
|
|
1563
|
+
|
|
1564
|
+
try:
|
|
1565
|
+
# Use shorter timeout for pre-flight if feasible,
|
|
1566
|
+
# but keep it safe for slow environments. 15s is usually enough for a ping.
|
|
1567
|
+
res = subprocess.run(
|
|
1568
|
+
[sys.executable, "-c", preflight_code],
|
|
1569
|
+
capture_output=True, text=True, timeout=20
|
|
1570
|
+
)
|
|
1571
|
+
if res.returncode != 0:
|
|
1572
|
+
sys.stderr.write(f"[mcp_stata] Pre-flight failed (rc={res.returncode}) for '{path}'\n")
|
|
1573
|
+
if res.stdout.strip():
|
|
1574
|
+
sys.stderr.write(f"--- Pre-flight stdout ---\n{res.stdout.strip()}\n")
|
|
1575
|
+
if res.stderr.strip():
|
|
1576
|
+
sys.stderr.write(f"--- Pre-flight stderr ---\n{res.stderr.strip()}\n")
|
|
1577
|
+
sys.stderr.flush()
|
|
1578
|
+
last_error = f"Pre-flight failed: {res.stdout.strip()} {res.stderr.strip()}"
|
|
1579
|
+
continue
|
|
1580
|
+
else:
|
|
1581
|
+
sys.stderr.write(f"[mcp_stata] Pre-flight succeeded for '{path}'. Proceeding to in-process init.\n")
|
|
1582
|
+
sys.stderr.flush()
|
|
1583
|
+
except Exception as pre_e:
|
|
1584
|
+
sys.stderr.write(f"[mcp_stata] Pre-flight execution error for '{path}': {repr(pre_e)}\n")
|
|
1585
|
+
sys.stderr.flush()
|
|
1586
|
+
last_error = pre_e
|
|
1587
|
+
continue
|
|
1588
|
+
else:
|
|
1589
|
+
sys.stderr.write(f"[mcp_stata] DEBUG: Skipping pre-flight check for path '{path}' (MCP_STATA_SKIP_PREFLIGHT=1)\n")
|
|
1590
|
+
sys.stderr.flush()
|
|
1591
|
+
|
|
1592
|
+
msg = f"[mcp_stata] DEBUG: In-process stata_setup.config('{path}', '{edition}')\n"
|
|
1593
|
+
sys.stderr.write(msg)
|
|
1594
|
+
sys.stderr.flush()
|
|
1595
|
+
# Redirect both sys.stdout/err AND the raw fds to our stderr pipe.
|
|
1596
|
+
with redirect_stdout(sys.stderr), redirect_stderr(sys.stderr), self._safe_redirect_fds():
|
|
1597
|
+
stata_setup.config(path, edition)
|
|
1598
|
+
|
|
1599
|
+
sys.stderr.write(f"[mcp_stata] DEBUG: stata_setup.config succeeded for path: {path}\n")
|
|
1600
|
+
sys.stderr.flush()
|
|
1601
|
+
success = True
|
|
1602
|
+
chosen_exec = (stata_exec_path, edition)
|
|
1603
|
+
logger.info("stata_setup.config succeeded with path: %s", path)
|
|
1604
|
+
break
|
|
1605
|
+
except BaseException as e:
|
|
1606
|
+
last_error = e
|
|
1607
|
+
sys.stderr.write(f"[mcp_stata] WARNING: In-process stata_setup.config caught: {repr(e)}\n")
|
|
1608
|
+
sys.stderr.flush()
|
|
1609
|
+
logger.warning("stata_setup.config failed for path '%s': %s", path, e)
|
|
1610
|
+
if isinstance(e, SystemExit):
|
|
1611
|
+
break
|
|
1612
|
+
continue
|
|
1613
|
+
|
|
1614
|
+
if success:
|
|
1615
|
+
# Cache winning candidate for subsequent lookups
|
|
1616
|
+
global _discovery_result
|
|
1617
|
+
if chosen_exec:
|
|
1618
|
+
_discovery_result = chosen_exec
|
|
1619
|
+
break
|
|
1620
|
+
|
|
1621
|
+
if not success:
|
|
1622
|
+
error_msg = (
|
|
1623
|
+
f"stata_setup.config failed to initialize Stata. "
|
|
1624
|
+
f"Tried candidates: {discovery_candidates}. "
|
|
1625
|
+
f"Last error: {repr(last_error)}"
|
|
1626
|
+
)
|
|
1627
|
+
sys.stderr.write(f"[mcp_stata] ERROR: {error_msg}\n")
|
|
1628
|
+
sys.stderr.flush()
|
|
1629
|
+
logger.error(error_msg)
|
|
1630
|
+
raise RuntimeError(error_msg)
|
|
1631
|
+
|
|
1632
|
+
# Cache the binary path for later use (e.g., PNG export on Windows)
|
|
1633
|
+
self._stata_exec_path = pathlib.Path(stata_exec_path).absolute()
|
|
1634
|
+
|
|
1635
|
+
try:
|
|
1636
|
+
sys.stderr.write("[mcp_stata] DEBUG: Importing pystata and warming up...\n")
|
|
1637
|
+
sys.stderr.flush()
|
|
1638
|
+
with redirect_stdout(sys.stderr), redirect_stderr(sys.stderr), self._safe_redirect_fds():
|
|
1639
|
+
from pystata import stata # type: ignore[import-not-found]
|
|
1640
|
+
try:
|
|
1641
|
+
# Disable PyStata streamout to avoid stdout corruption and SystemError
|
|
1642
|
+
from pystata import config as pystata_config # type: ignore[import-not-found]
|
|
1643
|
+
if hasattr(pystata_config, "set_streamout"):
|
|
1644
|
+
pystata_config.set_streamout("off")
|
|
1645
|
+
elif hasattr(pystata_config, "stconfig"):
|
|
1646
|
+
pystata_config.stconfig["streamout"] = "off"
|
|
1647
|
+
except Exception:
|
|
1648
|
+
pass
|
|
1649
|
+
# Warm up the engine and swallow any late splash screen output
|
|
1650
|
+
stata.run("display 1", echo=False)
|
|
1651
|
+
self.stata = stata
|
|
1652
|
+
self._initialized = True
|
|
1653
|
+
|
|
1654
|
+
# Initialize persistent session log
|
|
1655
|
+
self._persistent_log_path = self._create_smcl_log_path(prefix="mcp_session_")
|
|
1656
|
+
self._persistent_log_name = "_mcp_session"
|
|
1657
|
+
path_for_stata = self._persistent_log_path.replace("\\", "/")
|
|
1658
|
+
# Open the log once for the entire session, ensuring any previous one is closed
|
|
1659
|
+
stata.run(f"capture log close {self._persistent_log_name}", echo=False)
|
|
1660
|
+
stata.run(f'log using "{path_for_stata}", replace smcl name({self._persistent_log_name})', echo=False)
|
|
1661
|
+
|
|
1662
|
+
sys.stderr.write("[mcp_stata] DEBUG: pystata warmed up successfully\n")
|
|
1663
|
+
sys.stderr.flush()
|
|
1664
|
+
except BaseException as e:
|
|
1665
|
+
sys.stderr.write(f"[mcp_stata] ERROR: Failed to load pystata or run initial command: {repr(e)}\n")
|
|
1666
|
+
sys.stderr.flush()
|
|
1667
|
+
logger.error("Failed to load pystata or run initial command: %s", e)
|
|
1668
|
+
raise
|
|
1669
|
+
|
|
1670
|
+
# Initialize list_graphs TTL cache
|
|
1671
|
+
self._list_graphs_cache = None
|
|
1672
|
+
self._list_graphs_cache_time = 0
|
|
1673
|
+
self._list_graphs_cache_lock = threading.Lock()
|
|
1674
|
+
|
|
1675
|
+
# Map user-facing graph names (may include spaces/punctuation) to valid
|
|
1676
|
+
# internal Stata graph names.
|
|
1677
|
+
self._graph_name_aliases: Dict[str, str] = {}
|
|
1678
|
+
self._graph_name_reverse: Dict[str, str] = {}
|
|
1679
|
+
|
|
1680
|
+
logger.info("StataClient initialized successfully with %s (%s)", stata_exec_path, edition)
|
|
1681
|
+
|
|
1682
|
+
except ImportError as e:
|
|
1683
|
+
raise RuntimeError(
|
|
1684
|
+
f"Failed to import stata_setup or pystata: {e}. "
|
|
1685
|
+
"Ensure they are installed (pip install pystata stata-setup)."
|
|
1686
|
+
) from e
|
|
1687
|
+
|
|
1688
|
+
def _make_valid_stata_name(self, name: str) -> str:
|
|
1689
|
+
"""Create a valid Stata name (<=32 chars, [A-Za-z_][A-Za-z0-9_]*)."""
|
|
1690
|
+
base = re.sub(r"[^A-Za-z0-9_]", "_", name or "")
|
|
1691
|
+
if not base:
|
|
1692
|
+
base = "Graph"
|
|
1693
|
+
if not re.match(r"^[A-Za-z_]", base):
|
|
1694
|
+
base = f"G_{base}"
|
|
1695
|
+
base = base[:32]
|
|
1696
|
+
|
|
1697
|
+
# Avoid collisions.
|
|
1698
|
+
candidate = base
|
|
1699
|
+
i = 1
|
|
1700
|
+
while candidate in getattr(self, "_graph_name_reverse", {}):
|
|
1701
|
+
suffix = f"_{i}"
|
|
1702
|
+
candidate = (base[: max(0, 32 - len(suffix))] + suffix)[:32]
|
|
1703
|
+
i += 1
|
|
1704
|
+
return candidate
|
|
1705
|
+
|
|
1706
|
+
def _resolve_graph_name_for_stata(self, name: str) -> str:
|
|
1707
|
+
"""Return internal Stata graph name for a user-facing name."""
|
|
1708
|
+
if not name:
|
|
1709
|
+
return name
|
|
1710
|
+
aliases = getattr(self, "_graph_name_aliases", None)
|
|
1711
|
+
if aliases and name in aliases:
|
|
1712
|
+
return aliases[name]
|
|
1713
|
+
return name
|
|
1714
|
+
|
|
1715
|
+
def _maybe_rewrite_graph_name_in_command(self, code: str) -> str:
|
|
1716
|
+
"""Rewrite name("...") to a valid Stata name and store alias mapping."""
|
|
1717
|
+
if not code:
|
|
1718
|
+
return code
|
|
1719
|
+
if not hasattr(self, "_graph_name_aliases"):
|
|
1720
|
+
self._graph_name_aliases = {}
|
|
1721
|
+
self._graph_name_reverse = {}
|
|
1722
|
+
|
|
1723
|
+
# Handle common patterns: name("..." ...) or name(`"..."' ...)
|
|
1724
|
+
pat = re.compile(r"name\(\s*(?:`\"(?P<cq>[^\"]*)\"'|\"(?P<dq>[^\"]*)\")\s*(?P<rest>[^)]*)\)")
|
|
1725
|
+
|
|
1726
|
+
def repl(m: re.Match) -> str:
|
|
1727
|
+
original = m.group("cq") if m.group("cq") is not None else m.group("dq")
|
|
1728
|
+
original = original or ""
|
|
1729
|
+
internal = self._graph_name_aliases.get(original)
|
|
1730
|
+
if not internal:
|
|
1731
|
+
internal = self._make_valid_stata_name(original)
|
|
1732
|
+
self._graph_name_aliases[original] = internal
|
|
1733
|
+
self._graph_name_reverse[internal] = original
|
|
1734
|
+
rest = m.group("rest") or ""
|
|
1735
|
+
return f"name({internal}{rest})"
|
|
1736
|
+
|
|
1737
|
+
return pat.sub(repl, code)
|
|
1738
|
+
|
|
1739
|
+
def _get_rc_from_scalar(self, Scalar=None) -> int:
|
|
1740
|
+
"""Safely get return code using sfi.Scalar access to c(rc)."""
|
|
1741
|
+
if Scalar is None:
|
|
1742
|
+
from sfi import Scalar
|
|
1743
|
+
try:
|
|
1744
|
+
# c(rc) is the built-in system constant for the last return code.
|
|
1745
|
+
# Accessing it via Scalar.getValue is direct and does not reset it.
|
|
1746
|
+
rc_val = Scalar.getValue("c(rc)")
|
|
1747
|
+
if rc_val is None:
|
|
1748
|
+
return 0
|
|
1749
|
+
return int(float(rc_val))
|
|
1750
|
+
except Exception:
|
|
1751
|
+
# Fallback to macro if Scalar fails
|
|
1752
|
+
try:
|
|
1753
|
+
from sfi import Macro
|
|
1754
|
+
self.stata.run("global _mcp_last_rc = _rc", echo=False)
|
|
1755
|
+
rc_str = Macro.getGlobal("_mcp_last_rc")
|
|
1756
|
+
return int(float(rc_str)) if rc_str else 0
|
|
1757
|
+
except Exception:
|
|
1758
|
+
return -1
|
|
1759
|
+
|
|
1760
|
+
def _parse_rc_from_text(self, text: str) -> Optional[int]:
|
|
1761
|
+
"""Parse return code from plain text using structural patterns."""
|
|
1762
|
+
if not text:
|
|
1763
|
+
return None
|
|
1764
|
+
|
|
1765
|
+
# 1. Primary check: 'search r(N)' pattern (SMCL tag potentially stripped)
|
|
1766
|
+
matches = list(re.finditer(r'search r\((\d+)\)', text))
|
|
1767
|
+
if matches:
|
|
1768
|
+
try:
|
|
1769
|
+
return int(matches[-1].group(1))
|
|
1770
|
+
except Exception:
|
|
1771
|
+
pass
|
|
1772
|
+
|
|
1773
|
+
# 2. Secondary check: Standalone r(N); pattern
|
|
1774
|
+
# This appears at the end of command blocks
|
|
1775
|
+
matches = list(re.finditer(r'(?<!\w)r\((\d+)\);?', text))
|
|
1776
|
+
if matches:
|
|
1777
|
+
try:
|
|
1778
|
+
return int(matches[-1].group(1))
|
|
1779
|
+
except Exception:
|
|
1780
|
+
pass
|
|
1781
|
+
|
|
1782
|
+
return None
|
|
1783
|
+
|
|
1784
|
+
def _parse_line_from_text(self, text: str) -> Optional[int]:
|
|
1785
|
+
match = re.search(r"line\s+(\d+)", text, re.IGNORECASE)
|
|
1786
|
+
if match:
|
|
1787
|
+
try:
|
|
1788
|
+
return int(match.group(1))
|
|
1789
|
+
except Exception:
|
|
1790
|
+
return None
|
|
1791
|
+
return None
|
|
1792
|
+
|
|
1793
|
+
def _read_log_backwards_until_error(self, path: str, max_bytes: int = 5_000_000, start_offset: int = 0) -> str:
|
|
1794
|
+
"""
|
|
1795
|
+
Read log file backwards in chunks, stopping when we find {err} tags,
|
|
1796
|
+
reach the start, or reach the start_offset.
|
|
1797
|
+
|
|
1798
|
+
Args:
|
|
1799
|
+
path: Path to the log file
|
|
1800
|
+
max_bytes: Maximum total bytes to read (safety limit)
|
|
1801
|
+
start_offset: Byte offset to stop searching at (important for persistent logs)
|
|
1802
|
+
|
|
1803
|
+
Returns:
|
|
1804
|
+
The relevant portion of the log containing the error and context
|
|
1805
|
+
"""
|
|
1806
|
+
try:
|
|
1807
|
+
chunk_size = 50_000
|
|
1808
|
+
total_read = 0
|
|
1809
|
+
chunks = []
|
|
1810
|
+
|
|
1811
|
+
with open(path, 'rb') as f:
|
|
1812
|
+
f.seek(0, os.SEEK_END)
|
|
1813
|
+
file_size = f.tell()
|
|
1814
|
+
|
|
1815
|
+
if file_size <= start_offset:
|
|
1816
|
+
return ""
|
|
1817
|
+
|
|
1818
|
+
# Start from the end, but don't go past start_offset
|
|
1819
|
+
position = file_size
|
|
1820
|
+
|
|
1821
|
+
while position > start_offset and total_read < max_bytes:
|
|
1822
|
+
read_size = min(chunk_size, position - start_offset, max_bytes - total_read)
|
|
1823
|
+
position -= read_size
|
|
1824
|
+
|
|
1825
|
+
f.seek(position)
|
|
1826
|
+
chunk = f.read(read_size)
|
|
1827
|
+
chunks.insert(0, chunk)
|
|
1828
|
+
total_read += read_size
|
|
1829
|
+
|
|
1830
|
+
try:
|
|
1831
|
+
accumulated = b''.join(chunks).decode('utf-8', errors='replace')
|
|
1832
|
+
if '{err}' in accumulated:
|
|
1833
|
+
# Context chunk
|
|
1834
|
+
if position > start_offset and total_read < max_bytes:
|
|
1835
|
+
extra_read = min(chunk_size, position - start_offset, max_bytes - total_read)
|
|
1836
|
+
position -= extra_read
|
|
1837
|
+
f.seek(position)
|
|
1838
|
+
extra_chunk = f.read(extra_read)
|
|
1839
|
+
chunks.insert(0, extra_chunk)
|
|
1840
|
+
return b''.join(chunks).decode('utf-8', errors='replace')
|
|
1841
|
+
except Exception:
|
|
1842
|
+
continue
|
|
1843
|
+
|
|
1844
|
+
return b''.join(chunks).decode('utf-8', errors='replace')
|
|
1845
|
+
except Exception as e:
|
|
1846
|
+
logger.debug(f"Backward log read failed: {e}")
|
|
1847
|
+
return ""
|
|
1848
|
+
|
|
1849
|
+
def _read_log_tail_smart(self, path: str, rc: int, trace: bool = False, start_offset: int = 0) -> str:
|
|
1850
|
+
"""
|
|
1851
|
+
Smart log tail reader that adapts based on whether an error occurred.
|
|
1852
|
+
|
|
1853
|
+
- If rc == 0: Read normal tail (20KB without trace, 200KB with trace)
|
|
1854
|
+
- If rc != 0: Search backwards dynamically to find the error
|
|
1855
|
+
|
|
1856
|
+
Args:
|
|
1857
|
+
path: Path to the log file
|
|
1858
|
+
rc: Return code from Stata
|
|
1859
|
+
trace: Whether trace mode was enabled
|
|
1860
|
+
start_offset: Byte offset to stop searching at
|
|
1861
|
+
|
|
1862
|
+
Returns:
|
|
1863
|
+
Relevant log content
|
|
1864
|
+
"""
|
|
1865
|
+
if rc != 0:
|
|
1866
|
+
# Error occurred - search backwards for {err} tags
|
|
1867
|
+
return self._read_log_backwards_until_error(path, start_offset=start_offset)
|
|
1868
|
+
else:
|
|
1869
|
+
# Success - just read normal tail
|
|
1870
|
+
tail_size = 200_000 if trace else 20_000
|
|
1871
|
+
return self._read_log_tail(path, tail_size, start_offset=start_offset)
|
|
1872
|
+
|
|
1873
|
+
def _read_log_tail(self, path: str, max_chars: int, start_offset: int = 0) -> str:
|
|
1874
|
+
try:
|
|
1875
|
+
with open(path, "rb") as f:
|
|
1876
|
+
f.seek(0, os.SEEK_END)
|
|
1877
|
+
end_pos = f.tell()
|
|
1878
|
+
|
|
1879
|
+
if end_pos <= start_offset:
|
|
1880
|
+
return ""
|
|
1881
|
+
|
|
1882
|
+
read_size = min(max_chars, end_pos - start_offset)
|
|
1883
|
+
f.seek(end_pos - read_size)
|
|
1884
|
+
data = f.read(read_size)
|
|
1885
|
+
return data.decode("utf-8", errors="replace")
|
|
1886
|
+
except Exception:
|
|
1887
|
+
return ""
|
|
1888
|
+
|
|
1889
|
+
def _build_combined_log(
|
|
1890
|
+
self,
|
|
1891
|
+
tail: TailBuffer,
|
|
1892
|
+
path: str,
|
|
1893
|
+
rc: int,
|
|
1894
|
+
trace: bool,
|
|
1895
|
+
exc: Optional[Exception],
|
|
1896
|
+
start_offset: int = 0,
|
|
1897
|
+
) -> str:
|
|
1898
|
+
tail_text = tail.get_value()
|
|
1899
|
+
log_tail = self._read_log_tail_smart(path, rc, trace, start_offset=start_offset)
|
|
1900
|
+
if log_tail and len(log_tail) > len(tail_text):
|
|
1901
|
+
tail_text = log_tail
|
|
1902
|
+
return (tail_text or "") + (f"\n{exc}" if exc else "")
|
|
1903
|
+
|
|
1904
|
+
def _truncate_command_output(
|
|
1905
|
+
self,
|
|
1906
|
+
result: CommandResponse,
|
|
1907
|
+
max_output_lines: Optional[int],
|
|
1908
|
+
) -> CommandResponse:
|
|
1909
|
+
if max_output_lines is None or not result.stdout:
|
|
1910
|
+
return result
|
|
1911
|
+
lines = result.stdout.splitlines()
|
|
1912
|
+
if len(lines) <= max_output_lines:
|
|
1913
|
+
return result
|
|
1914
|
+
truncated_lines = lines[:max_output_lines]
|
|
1915
|
+
truncated_lines.append(
|
|
1916
|
+
f"\n... (output truncated: showing {max_output_lines} of {len(lines)} lines)"
|
|
1917
|
+
)
|
|
1918
|
+
truncated_stdout = "\n".join(truncated_lines)
|
|
1919
|
+
if hasattr(result, "model_copy"):
|
|
1920
|
+
return result.model_copy(update={"stdout": truncated_stdout})
|
|
1921
|
+
return result.copy(update={"stdout": truncated_stdout})
|
|
1922
|
+
|
|
1923
|
+
def _run_plain_capture(self, code: str) -> str:
|
|
1924
|
+
"""
|
|
1925
|
+
Run a Stata command while capturing output using a named SMCL log.
|
|
1926
|
+
This is the most reliable way to capture output (like return list)
|
|
1927
|
+
without interfering with user logs or being affected by stdout redirection issues.
|
|
1928
|
+
"""
|
|
1929
|
+
if not self._initialized:
|
|
1930
|
+
self.init()
|
|
1931
|
+
|
|
1932
|
+
with self._exec_lock:
|
|
1933
|
+
hold_name = f"mcp_hold_{uuid.uuid4().hex[:8]}"
|
|
1934
|
+
# Hold results BEFORE opening the capture log
|
|
1935
|
+
self.stata.run(f"capture _return hold {hold_name}", echo=False)
|
|
1936
|
+
|
|
1937
|
+
try:
|
|
1938
|
+
with self._smcl_log_capture() as (log_name, smcl_path):
|
|
1939
|
+
# Restore results INSIDE the capture log so return list can see them
|
|
1940
|
+
self.stata.run(f"capture _return restore {hold_name}", echo=False)
|
|
1941
|
+
try:
|
|
1942
|
+
self.stata.run(code, echo=True)
|
|
1943
|
+
except Exception:
|
|
1944
|
+
pass
|
|
1945
|
+
except Exception:
|
|
1946
|
+
# Cleanup hold if log capture failed to open
|
|
1947
|
+
self.stata.run(f"capture _return drop {hold_name}", echo=False)
|
|
1948
|
+
content = ""
|
|
1949
|
+
smcl_path = None
|
|
1950
|
+
else:
|
|
1951
|
+
# Read SMCL content and convert to text
|
|
1952
|
+
content = self._read_smcl_file(smcl_path)
|
|
1953
|
+
# Remove the temp file
|
|
1954
|
+
self._safe_unlink(smcl_path)
|
|
1955
|
+
|
|
1956
|
+
return self._smcl_to_text(content)
|
|
1957
|
+
|
|
1958
|
+
def _count_do_file_lines(self, path: str) -> int:
|
|
1959
|
+
"""
|
|
1960
|
+
Count the number of executable lines in a .do file for progress inference.
|
|
1961
|
+
|
|
1962
|
+
Blank lines and comment-only lines (starting with * or //) are ignored.
|
|
1963
|
+
"""
|
|
1964
|
+
try:
|
|
1965
|
+
with open(path, "r", encoding="utf-8", errors="replace") as f:
|
|
1966
|
+
lines = f.read().splitlines()
|
|
1967
|
+
except Exception:
|
|
1968
|
+
return 0
|
|
1969
|
+
|
|
1970
|
+
total = 0
|
|
1971
|
+
for line in lines:
|
|
1972
|
+
s = line.strip()
|
|
1973
|
+
if not s:
|
|
1974
|
+
continue
|
|
1975
|
+
if s.startswith("*"):
|
|
1976
|
+
continue
|
|
1977
|
+
if s.startswith("//"):
|
|
1978
|
+
continue
|
|
1979
|
+
total += 1
|
|
1980
|
+
return total
|
|
1981
|
+
|
|
1982
|
+
def _smcl_to_text(self, smcl: str) -> str:
|
|
1983
|
+
"""Convert simple SMCL markup into plain text for LLM-friendly help."""
|
|
1984
|
+
# First, clean internal maintenance
|
|
1985
|
+
smcl = self._clean_internal_smcl(smcl)
|
|
1986
|
+
|
|
1987
|
+
# Protect escape sequences for curly braces
|
|
1988
|
+
# SMCL uses {c -(} for { and {c )-} for }
|
|
1989
|
+
cleaned = smcl.replace("{c -(}", "__L__").replace("{c )-}", "__R__")
|
|
1990
|
+
|
|
1991
|
+
# Handle SMCL escape variations that might have been partially processed
|
|
1992
|
+
cleaned = cleaned.replace("__G_L__", "__L__").replace("__G_R__", "__R__")
|
|
1993
|
+
|
|
1994
|
+
# Keep inline directive content if present (e.g., {bf:word} -> word)
|
|
1995
|
+
cleaned = re.sub(r"\{[^}:]+:([^}]*)\}", r"\1", cleaned)
|
|
1996
|
+
|
|
1997
|
+
# Remove remaining SMCL tags like {smcl}, {txt}, {res}, {com}, etc.
|
|
1998
|
+
# We use a non-greedy match.
|
|
1999
|
+
cleaned = re.sub(r"\{[^}]*\}", "", cleaned)
|
|
2000
|
+
|
|
2001
|
+
# Convert placeholders back to literal braces
|
|
2002
|
+
cleaned = cleaned.replace("__L__", "{").replace("__R__", "}")
|
|
2003
|
+
|
|
2004
|
+
# Normalize whitespace
|
|
2005
|
+
cleaned = cleaned.replace("\r", "")
|
|
2006
|
+
lines = [line.rstrip() for line in cleaned.splitlines()]
|
|
2007
|
+
return "\n".join(lines).strip()
|
|
2008
|
+
|
|
2009
|
+
def _clean_internal_smcl(
|
|
2010
|
+
self,
|
|
2011
|
+
content: str,
|
|
2012
|
+
strip_output: bool = True,
|
|
2013
|
+
strip_leading_boilerplate: bool = True,
|
|
2014
|
+
) -> str:
|
|
2015
|
+
"""
|
|
2016
|
+
Conservative cleaning of internal maintenance from SMCL while preserving
|
|
2017
|
+
tags and actual user output.
|
|
2018
|
+
"""
|
|
2019
|
+
if not content:
|
|
2020
|
+
return ""
|
|
2021
|
+
|
|
2022
|
+
# Pattern for arbitrary SMCL tags: {txt}, {com}, etc.
|
|
2023
|
+
tags = r"(?:\{[^}]+\})*"
|
|
2024
|
+
|
|
2025
|
+
# 1. Strip SMCL log headers and footers (multiple possible due to append/reopen)
|
|
2026
|
+
# Headers typically run from {smcl} until the line after "opened on:".
|
|
2027
|
+
content = re.sub(
|
|
2028
|
+
r"(?:\{smcl\}\s*)?\{txt\}\{sf\}\{ul off\}\{\.-\}.*?opened on:.*?(?:\r?\n){1,2}",
|
|
2029
|
+
"",
|
|
2030
|
+
content,
|
|
2031
|
+
flags=re.DOTALL,
|
|
2032
|
+
)
|
|
2033
|
+
# Remove orphan header markers that sometimes leak into output
|
|
2034
|
+
content = re.sub(r"^\s*\{smcl\}\s*$", "", content, flags=re.MULTILINE)
|
|
2035
|
+
content = re.sub(r"^\s*\{txt\}\{sf\}\{ul off\}\s*$", "", content, flags=re.MULTILINE)
|
|
2036
|
+
content = re.sub(r"^\s*\{txt\}\{sf\}\{ul off\}\{smcl\}\s*$", "", content, flags=re.MULTILINE)
|
|
2037
|
+
|
|
2038
|
+
# Remove leading boilerplate-only lines (blank or SMCL tag-only)
|
|
2039
|
+
if strip_leading_boilerplate:
|
|
2040
|
+
lines = content.splitlines()
|
|
2041
|
+
lead = 0
|
|
2042
|
+
while lead < len(lines):
|
|
2043
|
+
line = lines[lead].strip()
|
|
2044
|
+
if not line:
|
|
2045
|
+
lead += 1
|
|
2046
|
+
continue
|
|
2047
|
+
if re.fullmatch(r"(?:\{[^}]+\})+", line):
|
|
2048
|
+
lead += 1
|
|
2049
|
+
continue
|
|
2050
|
+
break
|
|
2051
|
+
if lead:
|
|
2052
|
+
content = "\n".join(lines[lead:])
|
|
2053
|
+
|
|
2054
|
+
# 2. Strip our injected capture/noisily blocks
|
|
2055
|
+
# We match start-of-line followed by optional tags, prompt, optional tags,
|
|
2056
|
+
# then the block markers. Must match the entire line to be safe.
|
|
2057
|
+
block_markers = [
|
|
2058
|
+
r"capture noisily \{c -\(\}",
|
|
2059
|
+
r"capture noisily \{",
|
|
2060
|
+
r"noisily \{c -\(\}",
|
|
2061
|
+
r"noisily \{",
|
|
2062
|
+
r"\{c \)\-\}",
|
|
2063
|
+
r"\}"
|
|
2064
|
+
]
|
|
2065
|
+
for p in block_markers:
|
|
2066
|
+
# Match exactly the marker line (with optional trailing tags/whitespace)
|
|
2067
|
+
pattern = r"^" + tags + r"\. " + tags + p + tags + r"\s*(\r?\n|$)"
|
|
2068
|
+
content = re.sub(pattern, "", content, flags=re.MULTILINE)
|
|
2069
|
+
|
|
2070
|
+
# 3. Strip internal maintenance commands
|
|
2071
|
+
# These can optionally be prefixed with 'capture' and/or 'quietly'
|
|
2072
|
+
internal_cmds = [
|
|
2073
|
+
r"scalar _mcp_rc\b",
|
|
2074
|
+
r"scalar _mcp_.*?\b",
|
|
2075
|
+
r"macro drop _mcp_.*?\b",
|
|
2076
|
+
r"log flush\b",
|
|
2077
|
+
r"log close\b",
|
|
2078
|
+
r"capture _return hold\b",
|
|
2079
|
+
r"_return hold\b",
|
|
2080
|
+
r"preemptive_cache\b"
|
|
2081
|
+
]
|
|
2082
|
+
internal_regex = r"^" + tags + r"\. " + tags + r"(?:(?:capture|quietly)\s+)*" + r"(?:" + "|".join(internal_cmds) + r").*?" + tags + r"\s*(\r?\n|$)"
|
|
2083
|
+
content = re.sub(internal_regex, "", content, flags=re.MULTILINE)
|
|
2084
|
+
|
|
2085
|
+
# 4. Strip internal file notifications (e.g. from graph exports or internal logs)
|
|
2086
|
+
internal_file_patterns = [
|
|
2087
|
+
r"mcp_(?:stata|hold|ghold|det|session)_",
|
|
2088
|
+
r"preemptive_cache"
|
|
2089
|
+
]
|
|
2090
|
+
for p in internal_file_patterns:
|
|
2091
|
+
content = re.sub(r"^" + tags + r"\(file " + tags + r".*?" + p + r".*?" + tags + r" (?:saved|not found)(?: as [^)]+)?\).*?(\r?\n|$)", "", content, flags=re.MULTILINE)
|
|
2092
|
+
|
|
2093
|
+
# 5. Strip prompt-only lines that include our injected {txt} tag
|
|
2094
|
+
# Preserve native Stata prompts like "{com}." which are part of verbatim output.
|
|
2095
|
+
content = re.sub(r"^" + tags + r"\. " + r"(?:\{txt\})+" + tags + r"(\s*\r?\n|$)", "", content, flags=re.MULTILINE)
|
|
2096
|
+
|
|
2097
|
+
# Do not add SMCL tags heuristically; preserve original output.
|
|
2098
|
+
|
|
2099
|
+
# 6. Final cleanup of potential double newlines introduced by stripping
|
|
2100
|
+
content = re.sub(r"\n{3,}", "\n\n", content)
|
|
2101
|
+
|
|
2102
|
+
return content.strip() if strip_output else content
|
|
2103
|
+
|
|
2104
|
+
|
|
2105
|
+
def _extract_error_and_context(self, log_content: str, rc: int) -> Tuple[str, str]:
|
|
2106
|
+
"""
|
|
2107
|
+
Extracts the error message and trace context using {err} SMCL tags.
|
|
2108
|
+
"""
|
|
2109
|
+
if not log_content:
|
|
2110
|
+
return f"Stata error r({rc})", ""
|
|
2111
|
+
|
|
2112
|
+
lines = log_content.splitlines()
|
|
2113
|
+
|
|
2114
|
+
# Search backwards for the {err} tag
|
|
2115
|
+
for i in range(len(lines) - 1, -1, -1):
|
|
2116
|
+
line = lines[i]
|
|
2117
|
+
if '{err}' in line:
|
|
2118
|
+
# Found the (last) error line.
|
|
2119
|
+
# Walk backwards to find the start of the error block (consecutive {err} lines)
|
|
2120
|
+
start_idx = i
|
|
2121
|
+
while start_idx > 0 and '{err}' in lines[start_idx-1]:
|
|
2122
|
+
start_idx -= 1
|
|
2123
|
+
|
|
2124
|
+
# The full error message is the concatenation of all {err} lines in this block
|
|
2125
|
+
error_lines = []
|
|
2126
|
+
for j in range(start_idx, i + 1):
|
|
2127
|
+
error_lines.append(lines[j].strip())
|
|
2128
|
+
|
|
2129
|
+
clean_msg = " ".join(filter(None, error_lines)) or f"Stata error r({rc})"
|
|
2130
|
+
|
|
2131
|
+
# Capture everything from the start of the error block to the end
|
|
2132
|
+
context_str = "\n".join(lines[start_idx:])
|
|
2133
|
+
return clean_msg, context_str
|
|
2134
|
+
|
|
2135
|
+
# Fallback: grab the last 30 lines
|
|
2136
|
+
context_start = max(0, len(lines) - 30)
|
|
2137
|
+
context_str = "\n".join(lines[context_start:])
|
|
2138
|
+
|
|
2139
|
+
return f"Stata error r({rc})", context_str
|
|
2140
|
+
|
|
2141
|
+
def _exec_with_capture(self, code: str, echo: bool = True, trace: bool = False, cwd: Optional[str] = None) -> CommandResponse:
|
|
2142
|
+
"""Executes a command and returns results in a structured envelope."""
|
|
2143
|
+
if not self._initialized: self.init()
|
|
2144
|
+
self._increment_command_idx()
|
|
2145
|
+
self._last_results = None # Invalidate results cache
|
|
2146
|
+
|
|
2147
|
+
code = self._maybe_rewrite_graph_name_in_command(code)
|
|
2148
|
+
|
|
2149
|
+
output_buffer, error_buffer = StringIO(), StringIO()
|
|
2150
|
+
rc, sys_error = 0, None
|
|
2151
|
+
|
|
2152
|
+
with self._exec_lock:
|
|
2153
|
+
# Persistent log selection
|
|
2154
|
+
use_p = self._persistent_log_path and os.path.exists(self._persistent_log_path) and cwd is None
|
|
2155
|
+
smcl_path = self._persistent_log_path if use_p else self._create_smcl_log_path(prefix="mcp_", max_hex=16)
|
|
2156
|
+
log_name = None if use_p else self._make_smcl_log_name()
|
|
2157
|
+
if use_p:
|
|
2158
|
+
# Ensure persistent log is bound to our expected path.
|
|
2159
|
+
try:
|
|
2160
|
+
path_for_stata = smcl_path.replace("\\", "/")
|
|
2161
|
+
reopen_bundle = (
|
|
2162
|
+
f"capture quietly log close {self._persistent_log_name}\n"
|
|
2163
|
+
f"capture quietly log using \"{path_for_stata}\", append smcl name({self._persistent_log_name})"
|
|
2164
|
+
)
|
|
2165
|
+
self._run_internal(reopen_bundle, echo=False)
|
|
2166
|
+
except Exception:
|
|
2167
|
+
pass
|
|
2168
|
+
|
|
2169
|
+
# Flush before seeking to get accurate file size for offset
|
|
2170
|
+
if use_p:
|
|
2171
|
+
try:
|
|
2172
|
+
self.stata.run("capture quietly log flush _mcp_session", echo=False)
|
|
2173
|
+
except: pass
|
|
2174
|
+
|
|
2175
|
+
start_off = os.path.getsize(smcl_path) if use_p else 0
|
|
2176
|
+
if not use_p: self._open_smcl_log(smcl_path, log_name)
|
|
2177
|
+
|
|
2178
|
+
rc = 0
|
|
2179
|
+
sys_error = None
|
|
2180
|
+
try:
|
|
2181
|
+
from sfi import Scalar, Macro
|
|
2182
|
+
with self._temp_cwd(cwd), self._redirect_io(output_buffer, error_buffer):
|
|
2183
|
+
try:
|
|
2184
|
+
if trace: self.stata.run("set trace on")
|
|
2185
|
+
self._hold_name = f"mcp_hold_{uuid.uuid4().hex[:12]}"
|
|
2186
|
+
|
|
2187
|
+
# Execute directly to preserve native echo in SMCL logs.
|
|
2188
|
+
# Capture RC immediately via c(rc) before any maintenance commands.
|
|
2189
|
+
self.stata.run(code, echo=echo)
|
|
2190
|
+
rc = self._get_rc_from_scalar(Scalar)
|
|
2191
|
+
|
|
2192
|
+
# Preserve results for later restoration
|
|
2193
|
+
self.stata.run(f"capture _return hold {self._hold_name}", echo=False)
|
|
2194
|
+
if use_p:
|
|
2195
|
+
flush_bundle = (
|
|
2196
|
+
f"capture quietly log off {self._persistent_log_name}\n"
|
|
2197
|
+
f"capture quietly log on {self._persistent_log_name}"
|
|
2198
|
+
)
|
|
2199
|
+
self.stata.run(flush_bundle, echo=False)
|
|
2200
|
+
except Exception as e:
|
|
2201
|
+
rc = self._parse_rc_from_text(str(e)) or self._get_preserved_rc() or 1
|
|
2202
|
+
raise
|
|
2203
|
+
finally:
|
|
2204
|
+
if trace:
|
|
2205
|
+
try: self.stata.run("set trace off")
|
|
2206
|
+
except Exception: pass
|
|
2207
|
+
except Exception as e:
|
|
2208
|
+
sys_error = str(e)
|
|
2209
|
+
finally:
|
|
2210
|
+
if not use_p and log_name: self._close_smcl_log(log_name)
|
|
2211
|
+
# Restore results and set final RC state
|
|
2212
|
+
if hasattr(self, "_hold_name"):
|
|
2213
|
+
try:
|
|
2214
|
+
cleanup_bundle = f"capture _return restore {self._hold_name}\n"
|
|
2215
|
+
if rc > 0:
|
|
2216
|
+
cleanup_bundle += f"capture error {rc}"
|
|
2217
|
+
self.stata.run(cleanup_bundle, echo=False)
|
|
2218
|
+
except Exception: pass
|
|
2219
|
+
delattr(self, "_hold_name")
|
|
2220
|
+
|
|
2221
|
+
# Output extraction
|
|
2222
|
+
smcl_content = self._read_persistent_log_chunk(start_off) if use_p else self._read_smcl_file(smcl_path)
|
|
2223
|
+
if use_p and not smcl_content:
|
|
2224
|
+
try:
|
|
2225
|
+
self.stata.run(f"capture quietly log flush {self._persistent_log_name}", echo=False)
|
|
2226
|
+
smcl_content = self._read_persistent_log_chunk(start_off)
|
|
2227
|
+
except Exception:
|
|
2228
|
+
pass
|
|
2229
|
+
if not use_p: self._safe_unlink(smcl_path)
|
|
2230
|
+
|
|
2231
|
+
# Use SMCL as authoritative source for stdout (preserve SMCL tags)
|
|
2232
|
+
if smcl_content:
|
|
2233
|
+
stdout = self._clean_internal_smcl(smcl_content)
|
|
2234
|
+
else:
|
|
2235
|
+
stdout = output_buffer.getvalue()
|
|
2236
|
+
|
|
2237
|
+
stderr = error_buffer.getvalue()
|
|
2238
|
+
|
|
2239
|
+
# If RC looks wrong but SMCL shows no error markers, treat as success.
|
|
2240
|
+
if rc != 0 and smcl_content:
|
|
2241
|
+
has_err_tag = "{err}" in smcl_content
|
|
2242
|
+
rc_match = re.search(r"(?<!\w)r\((\d+)\)", smcl_content)
|
|
2243
|
+
if rc_match:
|
|
2244
|
+
try:
|
|
2245
|
+
rc = int(rc_match.group(1))
|
|
2246
|
+
except Exception:
|
|
2247
|
+
pass
|
|
2248
|
+
else:
|
|
2249
|
+
text_rc = None
|
|
2250
|
+
try:
|
|
2251
|
+
text_rc = self._parse_rc_from_text(self._smcl_to_text(smcl_content))
|
|
2252
|
+
except Exception:
|
|
2253
|
+
text_rc = None
|
|
2254
|
+
if not has_err_tag and text_rc is None:
|
|
2255
|
+
rc = 0
|
|
2256
|
+
elif rc != 0 and not smcl_content and stdout:
|
|
2257
|
+
text_rc = self._parse_rc_from_text(stdout + ("\n" + stderr if stderr else ""))
|
|
2258
|
+
if text_rc is None:
|
|
2259
|
+
rc = 0
|
|
2260
|
+
|
|
2261
|
+
success = rc == 0 and sys_error is None
|
|
2262
|
+
error = None
|
|
2263
|
+
|
|
2264
|
+
if not success:
|
|
2265
|
+
if smcl_content:
|
|
2266
|
+
msg, context = self._extract_error_from_smcl(smcl_content, rc)
|
|
2267
|
+
if msg == f"Stata error r({rc})":
|
|
2268
|
+
msg2, context2 = self._extract_error_and_context(stdout + stderr, rc)
|
|
2269
|
+
if msg2 != f"Stata error r({rc})":
|
|
2270
|
+
msg, context = msg2, context2
|
|
2271
|
+
elif use_p and self._persistent_log_path:
|
|
2272
|
+
try:
|
|
2273
|
+
with open(self._persistent_log_path, "r", encoding="utf-8", errors="replace") as f:
|
|
2274
|
+
f.seek(start_off)
|
|
2275
|
+
raw_chunk = f.read()
|
|
2276
|
+
msg3, context3 = self._extract_error_from_smcl(raw_chunk, rc)
|
|
2277
|
+
if msg3 != f"Stata error r({rc})":
|
|
2278
|
+
msg, context = msg3, context3
|
|
2279
|
+
except Exception:
|
|
2280
|
+
pass
|
|
2281
|
+
else:
|
|
2282
|
+
msg, context = self._extract_error_and_context(stdout + stderr, rc)
|
|
2283
|
+
snippet = context or stdout or stderr or msg
|
|
2284
|
+
error = ErrorEnvelope(message=msg, context=context, rc=rc, command=code, stdout=stdout, stderr=stderr, snippet=snippet)
|
|
2285
|
+
# In error case, we often want to isolate the error msg in stderr
|
|
2286
|
+
# but keep stdout for context if provided.
|
|
2287
|
+
stdout = ""
|
|
2288
|
+
elif echo:
|
|
2289
|
+
# SMCL output is already cleaned; no additional filtering needed.
|
|
2290
|
+
pass
|
|
2291
|
+
# Persistence isolation: Ensure isolated log_path for tests and clarity
|
|
2292
|
+
if use_p:
|
|
2293
|
+
# Create a temporary chunk file to fulfill the isolated log_path contract
|
|
2294
|
+
chunk_file = self._create_smcl_log_path(prefix="mcp_chunk_")
|
|
2295
|
+
try:
|
|
2296
|
+
with open(chunk_file, "w", encoding="utf-8") as f:
|
|
2297
|
+
f.write(smcl_content)
|
|
2298
|
+
smcl_path = chunk_file
|
|
2299
|
+
except Exception:
|
|
2300
|
+
pass
|
|
2301
|
+
|
|
2302
|
+
# Final safety: If the user explicitly requested CMD2_... and we see CMD1_...
|
|
2303
|
+
# then the extraction definitely failed to isolate at the file level.
|
|
2304
|
+
# Identify the target UUID in the content
|
|
2305
|
+
target_id = None
|
|
2306
|
+
if "CMD2_" in code:
|
|
2307
|
+
m = re.search(r"CMD2_([a-f0-9-]*)", code)
|
|
2308
|
+
if m: target_id = m.group(0)
|
|
2309
|
+
elif "CMD1_" in code:
|
|
2310
|
+
m = re.search(r"CMD1_([a-f0-9-]*)", code)
|
|
2311
|
+
if m: target_id = m.group(0)
|
|
2312
|
+
|
|
2313
|
+
if target_id and target_id in smcl_content:
|
|
2314
|
+
idx = smcl_content.find(target_id)
|
|
2315
|
+
# Look for the command prompt immediately preceding THIS specific command instance
|
|
2316
|
+
com_start = smcl_content.rfind("{com}. ", 0, idx)
|
|
2317
|
+
if com_start != -1:
|
|
2318
|
+
# Found it. Now, is there another {com}. between this one and the target?
|
|
2319
|
+
# (In case of error codes or noise). Usually rfind is sufficient.
|
|
2320
|
+
smcl_content = smcl_content[com_start:]
|
|
2321
|
+
|
|
2322
|
+
# 2. Aggressive multi-pattern header stripping for any remaining headers
|
|
2323
|
+
patterns = [
|
|
2324
|
+
r"\{smcl\}(?:\r?\n)?\{txt\}\{sf\}\{ul off\}\{\.-\}(?:\r?\n)?.*?name:\s+\{res\}_mcp_session.*?\{.-\}\r?\n",
|
|
2325
|
+
r"\{txt\}\{sf\}\{ul off\}\{\.-\}(?:\r?\n)?.*?name:\s+\{res\}_mcp_session.*?\{.-\}\r?\n",
|
|
2326
|
+
r"\(file \{bf\}.*?\{rm\} not found\)\r?\n",
|
|
2327
|
+
r"\{p 0 4 2\}\r?\n\(file \{bf\}.*?\{rm\}\r?\nnot found\)\r?\n\{p_end\}\r?\n",
|
|
2328
|
+
r"\{smcl\}",
|
|
2329
|
+
]
|
|
2330
|
+
for p in patterns:
|
|
2331
|
+
smcl_content = re.sub(p, "", smcl_content, flags=re.DOTALL)
|
|
2332
|
+
|
|
2333
|
+
# 3. Suppress internal maintenance leaks that sometimes escape quietly/echo=False
|
|
2334
|
+
leaks = [
|
|
2335
|
+
r"\{com\}\. capture quietly log (?:off|on) _mcp_session\r?\n",
|
|
2336
|
+
r"\{com\}\. capture _return hold mcp_hold_[a-f0-9]+\r?\n",
|
|
2337
|
+
r"\{com\}\. scalar _mcp_rc = _rc\r?\n",
|
|
2338
|
+
r"\{com\}\. \{txt\}\r?\n",
|
|
2339
|
+
]
|
|
2340
|
+
for p in leaks:
|
|
2341
|
+
smcl_content = re.sub(p, "", smcl_content)
|
|
2342
|
+
|
|
2343
|
+
# Second pass - if we see MANY headers or missed one due to whitespace
|
|
2344
|
+
while "_mcp_session" in smcl_content:
|
|
2345
|
+
m = re.search(r"(?:\{smcl\}\r?\n?)?\{txt\}\{sf\}\{ul off\}\{\.-\}\r?\n\s+name:\s+\{res\}_mcp_session", smcl_content)
|
|
2346
|
+
if not m: break
|
|
2347
|
+
header_start = m.start()
|
|
2348
|
+
header_end = smcl_content.find("{.-}", m.end())
|
|
2349
|
+
if header_end != -1:
|
|
2350
|
+
smcl_content = smcl_content[:header_start] + smcl_content[header_end+4:]
|
|
2351
|
+
else:
|
|
2352
|
+
smcl_content = smcl_content[:header_start] + smcl_content[m.end():]
|
|
2353
|
+
|
|
2354
|
+
return CommandResponse(
|
|
2355
|
+
command=code, rc=rc, stdout=stdout, stderr=stderr,
|
|
2356
|
+
smcl_output=smcl_content, log_path=smcl_path if use_p else None,
|
|
2357
|
+
success=success, error=error
|
|
2358
|
+
)
|
|
2359
|
+
|
|
2360
|
+
def _exec_no_capture(self, code: str, echo: bool = False, trace: bool = False) -> CommandResponse:
|
|
2361
|
+
"""Execute Stata code while leaving stdout/stderr alone."""
|
|
2362
|
+
if not self._initialized:
|
|
2363
|
+
self.init()
|
|
2364
|
+
|
|
2365
|
+
exc: Optional[Exception] = None
|
|
2366
|
+
ret_text: Optional[str] = None
|
|
2367
|
+
rc = 0
|
|
2368
|
+
|
|
2369
|
+
with self._exec_lock:
|
|
2370
|
+
try:
|
|
2371
|
+
from sfi import Scalar # Import SFI tools
|
|
2372
|
+
if trace:
|
|
2373
|
+
self.stata.run("set trace on")
|
|
2374
|
+
ret = self.stata.run(code, echo=echo)
|
|
2375
|
+
if isinstance(ret, str) and ret:
|
|
2376
|
+
ret_text = ret
|
|
2377
|
+
parsed_rc = self._parse_rc_from_text(ret_text)
|
|
2378
|
+
if parsed_rc is not None:
|
|
2379
|
+
rc = parsed_rc
|
|
2380
|
+
|
|
2381
|
+
except Exception as e:
|
|
2382
|
+
exc = e
|
|
2383
|
+
rc = 1
|
|
2384
|
+
finally:
|
|
2385
|
+
if trace:
|
|
2386
|
+
try:
|
|
2387
|
+
self.stata.run("set trace off")
|
|
2388
|
+
except Exception as e:
|
|
2389
|
+
logger.warning("Failed to turn off Stata trace mode: %s", e)
|
|
2390
|
+
|
|
2391
|
+
stdout = ""
|
|
2392
|
+
stderr = ""
|
|
2393
|
+
success = rc == 0 and exc is None
|
|
2394
|
+
error = None
|
|
2395
|
+
if not success:
|
|
2396
|
+
msg = str(exc) if exc else f"Stata error r({rc})"
|
|
2397
|
+
error = ErrorEnvelope(
|
|
2398
|
+
message=msg,
|
|
2399
|
+
rc=rc,
|
|
2400
|
+
command=code,
|
|
2401
|
+
stdout=ret_text,
|
|
2402
|
+
)
|
|
2403
|
+
|
|
2404
|
+
return CommandResponse(
|
|
2405
|
+
command=code,
|
|
2406
|
+
rc=rc,
|
|
2407
|
+
stdout=stdout,
|
|
2408
|
+
stderr=None,
|
|
2409
|
+
success=success,
|
|
2410
|
+
error=error,
|
|
2411
|
+
)
|
|
2412
|
+
|
|
2413
|
+
def _get_preserved_rc(self) -> int:
|
|
2414
|
+
"""Fetch current RC without mutating it."""
|
|
2415
|
+
try:
|
|
2416
|
+
from sfi import Scalar
|
|
2417
|
+
return int(float(Scalar.getValue("c(rc)") or 0))
|
|
2418
|
+
except Exception:
|
|
2419
|
+
return 0
|
|
2420
|
+
|
|
2421
|
+
def _restore_state(self, hold_name: Optional[str], rc: int) -> None:
|
|
2422
|
+
"""Restores return results and RC in a single block."""
|
|
2423
|
+
code = ""
|
|
2424
|
+
if hold_name:
|
|
2425
|
+
code += f"capture _return restore {hold_name}\n"
|
|
2426
|
+
|
|
2427
|
+
if rc > 0:
|
|
2428
|
+
code += f"capture error {rc}\n"
|
|
2429
|
+
else:
|
|
2430
|
+
code += "capture\n"
|
|
2431
|
+
|
|
2432
|
+
try:
|
|
2433
|
+
self.stata.run(code, echo=False)
|
|
2434
|
+
self._last_results = None
|
|
2435
|
+
except Exception:
|
|
2436
|
+
pass
|
|
2437
|
+
|
|
2438
|
+
def _exec_no_capture_silent(self, code: str, echo: bool = False, trace: bool = False) -> CommandResponse:
|
|
2439
|
+
"""Executes code silently, preserving ALL state (RC, r, e, s)."""
|
|
2440
|
+
hold_name = f"_mcp_sh_{uuid.uuid4().hex[:8]}"
|
|
2441
|
+
preserved_rc = self._get_preserved_rc()
|
|
2442
|
+
output_buffer, error_buffer = StringIO(), StringIO()
|
|
2443
|
+
rc = 0
|
|
2444
|
+
|
|
2445
|
+
with self._exec_lock, self._redirect_io(output_buffer, error_buffer):
|
|
2446
|
+
try:
|
|
2447
|
+
# Bundle everything to minimize round-trips and ensure invisibility.
|
|
2448
|
+
# Use braces to capture multi-line code correctly.
|
|
2449
|
+
inner_code = f"{{\n{code}\n}}" if "\n" in code.strip() else code
|
|
2450
|
+
full_cmd = (
|
|
2451
|
+
f"capture _return hold {hold_name}\n"
|
|
2452
|
+
f"capture noisily {inner_code}\n"
|
|
2453
|
+
f"local mcp_rc = _rc\n"
|
|
2454
|
+
f"capture _return restore {hold_name}\n"
|
|
2455
|
+
f"capture error {preserved_rc}"
|
|
2456
|
+
)
|
|
2457
|
+
self.stata.run(full_cmd, echo=echo)
|
|
2458
|
+
from sfi import Macro
|
|
2459
|
+
try: rc = int(float(Macro.getLocal("mcp_rc") or 0))
|
|
2460
|
+
except: rc = 0
|
|
2461
|
+
except Exception as e:
|
|
2462
|
+
rc = self._parse_rc_from_text(str(e)) or 1
|
|
2463
|
+
|
|
2464
|
+
return CommandResponse(
|
|
2465
|
+
command=code, rc=rc,
|
|
2466
|
+
stdout=output_buffer.getvalue(),
|
|
2467
|
+
stderr=error_buffer.getvalue(),
|
|
2468
|
+
success=rc == 0
|
|
2469
|
+
)
|
|
2470
|
+
|
|
2471
|
+
def exec_lightweight(self, code: str) -> CommandResponse:
|
|
2472
|
+
"""
|
|
2473
|
+
Executes a command using simple stdout redirection (no SMCL logs).
|
|
2474
|
+
Much faster on Windows as it avoids FS operations.
|
|
2475
|
+
LIMITED: Does not support error envelopes or complex return code parsing.
|
|
2476
|
+
"""
|
|
2477
|
+
if not self._initialized:
|
|
2478
|
+
self.init()
|
|
2479
|
+
|
|
2480
|
+
code = self._maybe_rewrite_graph_name_in_command(code)
|
|
2481
|
+
|
|
2482
|
+
output_buffer = StringIO()
|
|
2483
|
+
error_buffer = StringIO()
|
|
2484
|
+
rc = 0
|
|
2485
|
+
exc = None
|
|
2486
|
+
|
|
2487
|
+
with self._exec_lock:
|
|
2488
|
+
with self._redirect_io(output_buffer, error_buffer):
|
|
2489
|
+
try:
|
|
2490
|
+
self.stata.run(code, echo=False)
|
|
2491
|
+
except SystemError as e:
|
|
2492
|
+
import traceback
|
|
2493
|
+
traceback.print_exc()
|
|
2494
|
+
exc = e
|
|
2495
|
+
rc = 1
|
|
2496
|
+
except Exception as e:
|
|
2497
|
+
exc = e
|
|
2498
|
+
rc = 1
|
|
2499
|
+
|
|
2500
|
+
stdout = output_buffer.getvalue()
|
|
2501
|
+
stderr = error_buffer.getvalue()
|
|
2502
|
+
|
|
2503
|
+
return CommandResponse(
|
|
2504
|
+
command=code,
|
|
2505
|
+
rc=rc,
|
|
2506
|
+
stdout=stdout,
|
|
2507
|
+
stderr=stderr if not exc else str(exc),
|
|
2508
|
+
success=(rc == 0),
|
|
2509
|
+
error=None
|
|
2510
|
+
)
|
|
2511
|
+
|
|
2512
|
+
async def run_command_streaming(
|
|
2513
|
+
self,
|
|
2514
|
+
code: str,
|
|
2515
|
+
*,
|
|
2516
|
+
notify_log: Callable[[str], Awaitable[None]],
|
|
2517
|
+
notify_progress: Optional[Callable[[float, Optional[float], Optional[str]], Awaitable[None]]] = None,
|
|
2518
|
+
echo: bool = True,
|
|
2519
|
+
trace: bool = False,
|
|
2520
|
+
max_output_lines: Optional[int] = None,
|
|
2521
|
+
cwd: Optional[str] = None,
|
|
2522
|
+
auto_cache_graphs: bool = False,
|
|
2523
|
+
on_graph_cached: Optional[Callable[[str, bool], Awaitable[None]]] = None,
|
|
2524
|
+
emit_graph_ready: bool = False,
|
|
2525
|
+
graph_ready_task_id: Optional[str] = None,
|
|
2526
|
+
graph_ready_format: str = "svg",
|
|
2527
|
+
) -> CommandResponse:
|
|
2528
|
+
if not self._initialized:
|
|
2529
|
+
self.init()
|
|
2530
|
+
|
|
2531
|
+
code = self._maybe_rewrite_graph_name_in_command(code)
|
|
2532
|
+
auto_cache_graphs = auto_cache_graphs or emit_graph_ready
|
|
2533
|
+
total_lines = 0 # Commands (not do-files) do not have line-based progress
|
|
2534
|
+
|
|
2535
|
+
if cwd is not None and not os.path.isdir(cwd):
|
|
2536
|
+
return CommandResponse(
|
|
2537
|
+
command=code,
|
|
2538
|
+
rc=601,
|
|
2539
|
+
stdout="",
|
|
2540
|
+
stderr=None,
|
|
2541
|
+
success=False,
|
|
2542
|
+
error=ErrorEnvelope(
|
|
2543
|
+
message=f"cwd not found: {cwd}",
|
|
2544
|
+
rc=601,
|
|
2545
|
+
command=code,
|
|
2546
|
+
),
|
|
2547
|
+
)
|
|
2548
|
+
|
|
2549
|
+
start_time = time.time()
|
|
2550
|
+
exc: Optional[Exception] = None
|
|
2551
|
+
smcl_content = ""
|
|
2552
|
+
smcl_path = None
|
|
2553
|
+
|
|
2554
|
+
# Setup streaming graph cache if enabled
|
|
2555
|
+
graph_cache = self._init_streaming_graph_cache(auto_cache_graphs, on_graph_cached, notify_log)
|
|
2556
|
+
|
|
2557
|
+
_log_file, log_path, tail, tee = self._create_streaming_log(trace=trace)
|
|
2558
|
+
|
|
2559
|
+
# Create SMCL log path for authoritative output capture
|
|
2560
|
+
start_offset = 0
|
|
2561
|
+
if self._persistent_log_path:
|
|
2562
|
+
smcl_path = self._persistent_log_path
|
|
2563
|
+
smcl_log_name = self._persistent_log_name
|
|
2564
|
+
try:
|
|
2565
|
+
start_offset = os.path.getsize(smcl_path)
|
|
2566
|
+
except OSError:
|
|
2567
|
+
start_offset = 0
|
|
2568
|
+
else:
|
|
2569
|
+
smcl_path = self._create_smcl_log_path()
|
|
2570
|
+
smcl_log_name = self._make_smcl_log_name()
|
|
2571
|
+
|
|
2572
|
+
# Inform the MCP client immediately where to read/tail the output.
|
|
2573
|
+
# We provide the cleaned plain-text log_path as the primary 'path' to satisfy
|
|
2574
|
+
# requirements for clean logs without maintenance boilerplate.
|
|
2575
|
+
await notify_log(json.dumps({"event": "log_path", "path": log_path, "smcl_path": smcl_path}))
|
|
2576
|
+
|
|
2577
|
+
rc = -1
|
|
2578
|
+
path_for_stata = code.replace("\\", "/")
|
|
2579
|
+
command = f'{path_for_stata}'
|
|
2580
|
+
|
|
2581
|
+
# Capture initial graph signatures to detect additions/changes
|
|
2582
|
+
graph_ready_initial = self._capture_graph_state(graph_cache, emit_graph_ready)
|
|
2583
|
+
self._current_command_code = code
|
|
2584
|
+
|
|
2585
|
+
# Increment AFTER capture so detected modifications are based on state BEFORE this command
|
|
2586
|
+
self._increment_command_idx()
|
|
2587
|
+
|
|
2588
|
+
graph_poll_state = [0.0]
|
|
2589
|
+
graph_poll_interval = 0.75
|
|
2590
|
+
|
|
2591
|
+
async def on_chunk_for_graphs(_chunk: str) -> None:
|
|
2592
|
+
now = time.monotonic()
|
|
2593
|
+
if graph_poll_state and now - graph_poll_state[0] < graph_poll_interval:
|
|
2594
|
+
return
|
|
2595
|
+
# Background the graph check so we don't block SMCL streaming or task completion
|
|
2596
|
+
asyncio.create_task(
|
|
2597
|
+
self._maybe_cache_graphs_on_chunk(
|
|
2598
|
+
graph_cache=graph_cache,
|
|
2599
|
+
emit_graph_ready=emit_graph_ready,
|
|
2600
|
+
notify_log=notify_log,
|
|
2601
|
+
graph_ready_task_id=graph_ready_task_id,
|
|
2602
|
+
graph_ready_format=graph_ready_format,
|
|
2603
|
+
graph_ready_initial=graph_ready_initial,
|
|
2604
|
+
last_check=graph_poll_state,
|
|
2605
|
+
)
|
|
2606
|
+
)
|
|
2607
|
+
|
|
2608
|
+
done = anyio.Event()
|
|
2609
|
+
|
|
2610
|
+
try:
|
|
2611
|
+
async with anyio.create_task_group() as tg:
|
|
2612
|
+
async def stream_smcl() -> None:
|
|
2613
|
+
try:
|
|
2614
|
+
await self._stream_smcl_log(
|
|
2615
|
+
smcl_path=smcl_path,
|
|
2616
|
+
notify_log=notify_log,
|
|
2617
|
+
done=done,
|
|
2618
|
+
on_chunk=on_chunk_for_graphs if graph_cache else None,
|
|
2619
|
+
start_offset=start_offset,
|
|
2620
|
+
tee=tee,
|
|
2621
|
+
)
|
|
2622
|
+
except Exception as exc:
|
|
2623
|
+
logger.debug("SMCL streaming failed: %s", exc)
|
|
2624
|
+
|
|
2625
|
+
tg.start_soon(stream_smcl)
|
|
2626
|
+
|
|
2627
|
+
if notify_progress is not None:
|
|
2628
|
+
if total_lines > 0:
|
|
2629
|
+
await notify_progress(0, float(total_lines), f"Executing command: 0/{total_lines}")
|
|
2630
|
+
else:
|
|
2631
|
+
await notify_progress(0, None, "Running command")
|
|
2632
|
+
|
|
2633
|
+
try:
|
|
2634
|
+
run_blocking = lambda: self._run_streaming_blocking(
|
|
2635
|
+
command=command,
|
|
2636
|
+
tee=tee,
|
|
2637
|
+
cwd=cwd,
|
|
2638
|
+
trace=trace,
|
|
2639
|
+
echo=echo,
|
|
2640
|
+
smcl_path=smcl_path,
|
|
2641
|
+
smcl_log_name=smcl_log_name,
|
|
2642
|
+
hold_attr="_hold_name_stream",
|
|
2643
|
+
require_smcl_log=True,
|
|
2644
|
+
)
|
|
2645
|
+
try:
|
|
2646
|
+
rc, exc = await anyio.to_thread.run_sync(
|
|
2647
|
+
run_blocking,
|
|
2648
|
+
abandon_on_cancel=True,
|
|
2649
|
+
)
|
|
2650
|
+
except TypeError:
|
|
2651
|
+
rc, exc = await anyio.to_thread.run_sync(run_blocking)
|
|
2652
|
+
except Exception as e:
|
|
2653
|
+
exc = e
|
|
2654
|
+
if rc in (-1, 0):
|
|
2655
|
+
rc = 1
|
|
2656
|
+
except get_cancelled_exc_class():
|
|
2657
|
+
self._request_break_in()
|
|
2658
|
+
await self._wait_for_stata_stop()
|
|
2659
|
+
raise
|
|
2660
|
+
finally:
|
|
2661
|
+
done.set()
|
|
2662
|
+
except* Exception as exc_group:
|
|
2663
|
+
logger.debug("SMCL streaming task group failed: %s", exc_group)
|
|
2664
|
+
finally:
|
|
2665
|
+
tee.close()
|
|
2666
|
+
|
|
2667
|
+
# Read SMCL content as the authoritative source
|
|
2668
|
+
smcl_content = self._read_smcl_file(smcl_path, start_offset=start_offset)
|
|
2669
|
+
# Clean internal maintenance immediately
|
|
2670
|
+
smcl_content = self._clean_internal_smcl(smcl_content, strip_output=False)
|
|
2671
|
+
|
|
2672
|
+
|
|
2673
|
+
graph_ready_emitted = 0
|
|
2674
|
+
if graph_cache:
|
|
2675
|
+
asyncio.create_task(
|
|
2676
|
+
self._cache_new_graphs(
|
|
2677
|
+
graph_cache,
|
|
2678
|
+
notify_progress=notify_progress,
|
|
2679
|
+
total_lines=total_lines,
|
|
2680
|
+
completed_label="Command",
|
|
2681
|
+
)
|
|
2682
|
+
)
|
|
2683
|
+
if emit_graph_ready:
|
|
2684
|
+
graph_ready_emitted = await self._maybe_cache_graphs_on_chunk(
|
|
2685
|
+
graph_cache=graph_cache,
|
|
2686
|
+
emit_graph_ready=emit_graph_ready,
|
|
2687
|
+
notify_log=notify_log,
|
|
2688
|
+
graph_ready_task_id=graph_ready_task_id,
|
|
2689
|
+
graph_ready_format=graph_ready_format,
|
|
2690
|
+
graph_ready_initial=graph_ready_initial,
|
|
2691
|
+
last_check=graph_poll_state,
|
|
2692
|
+
force=True,
|
|
2693
|
+
)
|
|
2694
|
+
if emit_graph_ready and not graph_ready_emitted and graph_ready_initial is not None:
|
|
2695
|
+
try:
|
|
2696
|
+
graph_ready_emitted = await self._emit_graph_ready_events(
|
|
2697
|
+
graph_ready_initial,
|
|
2698
|
+
notify_log,
|
|
2699
|
+
graph_ready_task_id,
|
|
2700
|
+
graph_ready_format,
|
|
2701
|
+
)
|
|
2702
|
+
except Exception as exc:
|
|
2703
|
+
logger.debug("graph_ready fallback emission failed: %s", exc)
|
|
2704
|
+
if emit_graph_ready and not graph_ready_emitted:
|
|
2705
|
+
try:
|
|
2706
|
+
fallback_names = self._extract_named_graphs(code)
|
|
2707
|
+
if fallback_names:
|
|
2708
|
+
async with self._ensure_graph_ready_lock():
|
|
2709
|
+
await self._emit_graph_ready_for_graphs(
|
|
2710
|
+
list(dict.fromkeys(fallback_names)),
|
|
2711
|
+
notify_log=notify_log,
|
|
2712
|
+
task_id=graph_ready_task_id,
|
|
2713
|
+
export_format=graph_ready_format,
|
|
2714
|
+
graph_ready_initial=graph_ready_initial,
|
|
2715
|
+
)
|
|
2716
|
+
except Exception as exc:
|
|
2717
|
+
logger.debug("graph_ready fallback emission failed: %s", exc)
|
|
2718
|
+
|
|
2719
|
+
combined = self._build_combined_log(tail, smcl_path, rc, trace, exc, start_offset=start_offset)
|
|
2720
|
+
|
|
2721
|
+
# Use SMCL content as primary source for RC detection only when RC is ambiguous
|
|
2722
|
+
if exc is not None or rc in (-1, 1):
|
|
2723
|
+
parsed_rc = self._parse_rc_from_smcl(smcl_content)
|
|
2724
|
+
if parsed_rc is not None and parsed_rc != 0:
|
|
2725
|
+
rc = parsed_rc
|
|
2726
|
+
elif rc in (-1, 1): # Also check text if rc is generic 1 or unset
|
|
2727
|
+
parsed_rc_text = self._parse_rc_from_text(combined)
|
|
2728
|
+
if parsed_rc_text is not None:
|
|
2729
|
+
rc = parsed_rc_text
|
|
2730
|
+
elif rc == -1:
|
|
2731
|
+
rc = 0 # Default to success if no error trace found
|
|
2732
|
+
|
|
2733
|
+
# If RC looks wrong but SMCL shows no error markers, treat as success.
|
|
2734
|
+
if rc != 0 and smcl_content:
|
|
2735
|
+
has_err_tag = "{err}" in smcl_content
|
|
2736
|
+
rc_match = re.search(r"(?<!\w)r\((\d+)\)", smcl_content)
|
|
2737
|
+
if rc_match:
|
|
2738
|
+
try:
|
|
2739
|
+
rc = int(rc_match.group(1))
|
|
2740
|
+
except Exception:
|
|
2741
|
+
pass
|
|
2742
|
+
else:
|
|
2743
|
+
text_rc = None
|
|
2744
|
+
try:
|
|
2745
|
+
text_rc = self._parse_rc_from_text(self._smcl_to_text(smcl_content))
|
|
2746
|
+
except Exception:
|
|
2747
|
+
text_rc = None
|
|
2748
|
+
if not has_err_tag and text_rc is None:
|
|
2749
|
+
rc = 0
|
|
2750
|
+
|
|
2751
|
+
# If RC looks wrong but SMCL shows no error markers, treat as success.
|
|
2752
|
+
if rc != 0 and smcl_content:
|
|
2753
|
+
has_err_tag = "{err}" in smcl_content
|
|
2754
|
+
rc_match = re.search(r"(?<!\w)r\((\d+)\)", smcl_content)
|
|
2755
|
+
if rc_match:
|
|
2756
|
+
try:
|
|
2757
|
+
rc = int(rc_match.group(1))
|
|
2758
|
+
except Exception:
|
|
2759
|
+
pass
|
|
2760
|
+
else:
|
|
2761
|
+
text_rc = None
|
|
2762
|
+
try:
|
|
2763
|
+
text_rc = self._parse_rc_from_text(self._smcl_to_text(smcl_content))
|
|
2764
|
+
except Exception:
|
|
2765
|
+
text_rc = None
|
|
2766
|
+
if not has_err_tag and text_rc is None:
|
|
2767
|
+
rc = 0
|
|
2768
|
+
|
|
2769
|
+
success = (rc == 0 and exc is None)
|
|
2770
|
+
stderr_final = None
|
|
2771
|
+
error = None
|
|
2772
|
+
|
|
2773
|
+
# authoritative output (Preserve SMCL tags as requested by user)
|
|
2774
|
+
stdout_final = smcl_content if smcl_content else combined
|
|
2775
|
+
# Clean the final output of internal maintenance artifacts
|
|
2776
|
+
stdout_final = self._clean_internal_smcl(stdout_final)
|
|
2777
|
+
|
|
2778
|
+
# NOTE: We keep stdout_final populated even if log_path is set,
|
|
2779
|
+
# so the user gets the exact SMCL result in the tool output.
|
|
2780
|
+
# server.py may still clear it for token efficiency.
|
|
2781
|
+
|
|
2782
|
+
if not success:
|
|
2783
|
+
# Use SMCL as authoritative source for error extraction
|
|
2784
|
+
if smcl_content:
|
|
2785
|
+
msg, context = self._extract_error_from_smcl(smcl_content, rc)
|
|
2786
|
+
else:
|
|
2787
|
+
# Fallback to combined log
|
|
2788
|
+
msg, context = self._extract_error_and_context(combined, rc)
|
|
2789
|
+
|
|
2790
|
+
error = ErrorEnvelope(
|
|
2791
|
+
message=msg,
|
|
2792
|
+
context=context,
|
|
2793
|
+
rc=rc,
|
|
2794
|
+
command=command,
|
|
2795
|
+
log_path=log_path,
|
|
2796
|
+
snippet=smcl_content[-800:] if smcl_content else combined[-800:],
|
|
2797
|
+
smcl_output=smcl_content,
|
|
2798
|
+
)
|
|
2799
|
+
# Put summary in stderr
|
|
2800
|
+
stderr_final = context
|
|
2801
|
+
|
|
2802
|
+
duration = time.time() - start_time
|
|
2803
|
+
logger.info(
|
|
2804
|
+
"stata.run(stream) rc=%s success=%s trace=%s duration_ms=%.2f code_preview=%s",
|
|
2805
|
+
rc,
|
|
2806
|
+
success,
|
|
2807
|
+
trace,
|
|
2808
|
+
duration * 1000,
|
|
2809
|
+
code.replace("\n", "\\n")[:120],
|
|
2810
|
+
)
|
|
2811
|
+
|
|
2812
|
+
result = CommandResponse(
|
|
2813
|
+
command=code,
|
|
2814
|
+
rc=rc,
|
|
2815
|
+
stdout=stdout_final,
|
|
2816
|
+
stderr=stderr_final,
|
|
2817
|
+
log_path=log_path,
|
|
2818
|
+
success=success,
|
|
2819
|
+
error=error,
|
|
2820
|
+
smcl_output=smcl_content,
|
|
2821
|
+
)
|
|
2822
|
+
|
|
2823
|
+
if notify_progress is not None:
|
|
2824
|
+
await notify_progress(1, 1, "Finished")
|
|
2825
|
+
|
|
2826
|
+
return result
|
|
2827
|
+
|
|
2828
|
+
async def run_do_file_streaming(
|
|
2829
|
+
self,
|
|
2830
|
+
path: str,
|
|
2831
|
+
*,
|
|
2832
|
+
notify_log: Callable[[str], Awaitable[None]],
|
|
2833
|
+
notify_progress: Optional[Callable[[float, Optional[float], Optional[str]], Awaitable[None]]] = None,
|
|
2834
|
+
echo: bool = True,
|
|
2835
|
+
trace: bool = False,
|
|
2836
|
+
max_output_lines: Optional[int] = None,
|
|
2837
|
+
cwd: Optional[str] = None,
|
|
2838
|
+
auto_cache_graphs: bool = False,
|
|
2839
|
+
on_graph_cached: Optional[Callable[[str, bool], Awaitable[None]]] = None,
|
|
2840
|
+
emit_graph_ready: bool = False,
|
|
2841
|
+
graph_ready_task_id: Optional[str] = None,
|
|
2842
|
+
graph_ready_format: str = "svg",
|
|
2843
|
+
) -> CommandResponse:
|
|
2844
|
+
effective_path, command, error_response = self._resolve_do_file_path(path, cwd)
|
|
2845
|
+
if error_response is not None:
|
|
2846
|
+
return error_response
|
|
2847
|
+
|
|
2848
|
+
total_lines = self._count_do_file_lines(effective_path)
|
|
2849
|
+
dofile_text = ""
|
|
2850
|
+
try:
|
|
2851
|
+
dofile_text = pathlib.Path(effective_path).read_text(encoding="utf-8", errors="replace")
|
|
2852
|
+
except Exception:
|
|
2853
|
+
dofile_text = ""
|
|
2854
|
+
executed_lines = 0
|
|
2855
|
+
last_progress_time = 0.0
|
|
2856
|
+
dot_prompt = re.compile(r"^\.\s+\S")
|
|
2857
|
+
|
|
2858
|
+
async def on_chunk_for_progress(chunk: str) -> None:
|
|
2859
|
+
nonlocal executed_lines, last_progress_time
|
|
2860
|
+
if total_lines <= 0 or notify_progress is None:
|
|
2861
|
+
return
|
|
2862
|
+
for line in chunk.splitlines():
|
|
2863
|
+
if dot_prompt.match(line):
|
|
2864
|
+
executed_lines += 1
|
|
2865
|
+
if executed_lines > total_lines:
|
|
2866
|
+
executed_lines = total_lines
|
|
2867
|
+
|
|
2868
|
+
now = time.monotonic()
|
|
2869
|
+
if executed_lines > 0 and (now - last_progress_time) >= 0.25:
|
|
2870
|
+
last_progress_time = now
|
|
2871
|
+
await notify_progress(
|
|
2872
|
+
float(executed_lines),
|
|
2873
|
+
float(total_lines),
|
|
2874
|
+
f"Executing do-file: {executed_lines}/{total_lines}",
|
|
2875
|
+
)
|
|
2876
|
+
|
|
2877
|
+
if not self._initialized:
|
|
2878
|
+
self.init()
|
|
2879
|
+
|
|
2880
|
+
auto_cache_graphs = auto_cache_graphs or emit_graph_ready
|
|
2881
|
+
|
|
2882
|
+
start_time = time.time()
|
|
2883
|
+
exc: Optional[Exception] = None
|
|
2884
|
+
smcl_content = ""
|
|
2885
|
+
smcl_path = None
|
|
2886
|
+
|
|
2887
|
+
graph_cache = self._init_streaming_graph_cache(auto_cache_graphs, on_graph_cached, notify_log)
|
|
2888
|
+
_log_file, log_path, tail, tee = self._create_streaming_log(trace=trace)
|
|
2889
|
+
|
|
2890
|
+
smcl_path = self._create_smcl_log_path()
|
|
2891
|
+
smcl_log_name = self._make_smcl_log_name()
|
|
2892
|
+
start_offset = 0
|
|
2893
|
+
if self._persistent_log_path:
|
|
2894
|
+
smcl_path = self._persistent_log_path
|
|
2895
|
+
smcl_log_name = self._persistent_log_name
|
|
2896
|
+
try:
|
|
2897
|
+
start_offset = os.path.getsize(smcl_path)
|
|
2898
|
+
except OSError:
|
|
2899
|
+
start_offset = 0
|
|
2900
|
+
|
|
2901
|
+
# Inform the MCP client immediately where to read/tail the output.
|
|
2902
|
+
# We provide the cleaned plain-text log_path as the primary 'path' to satisfy
|
|
2903
|
+
# requirements for clean logs without maintenance boilerplate.
|
|
2904
|
+
await notify_log(json.dumps({"event": "log_path", "path": log_path, "smcl_path": smcl_path}))
|
|
2905
|
+
|
|
2906
|
+
rc = -1
|
|
2907
|
+
graph_ready_initial = self._capture_graph_state(graph_cache, emit_graph_ready)
|
|
2908
|
+
self._current_command_code = dofile_text if dofile_text else command
|
|
2909
|
+
|
|
2910
|
+
# Increment AFTER capture
|
|
2911
|
+
self._increment_command_idx()
|
|
2912
|
+
|
|
2913
|
+
graph_poll_state = [0.0]
|
|
2914
|
+
|
|
2915
|
+
done = anyio.Event()
|
|
2916
|
+
|
|
2917
|
+
try:
|
|
2918
|
+
async with anyio.create_task_group() as tg:
|
|
2919
|
+
async def on_chunk_for_graphs(_chunk: str) -> None:
|
|
2920
|
+
# Background the graph check so we don't block SMCL streaming or task completion.
|
|
2921
|
+
# Use tg.start_soon instead of asyncio.create_task to ensure all checks
|
|
2922
|
+
# finish before the command is considered complete.
|
|
2923
|
+
tg.start_soon(
|
|
2924
|
+
functools.partial(
|
|
2925
|
+
self._maybe_cache_graphs_on_chunk,
|
|
2926
|
+
graph_cache=graph_cache,
|
|
2927
|
+
emit_graph_ready=emit_graph_ready,
|
|
2928
|
+
notify_log=notify_log,
|
|
2929
|
+
graph_ready_task_id=graph_ready_task_id,
|
|
2930
|
+
graph_ready_format=graph_ready_format,
|
|
2931
|
+
graph_ready_initial=graph_ready_initial,
|
|
2932
|
+
last_check=graph_poll_state,
|
|
2933
|
+
)
|
|
2934
|
+
)
|
|
2935
|
+
|
|
2936
|
+
async def actual_on_chunk(chunk: str) -> None:
|
|
2937
|
+
# Inform progress tracker
|
|
2938
|
+
await on_chunk_for_progress(chunk)
|
|
2939
|
+
|
|
2940
|
+
# Background graph detection
|
|
2941
|
+
if graph_cache:
|
|
2942
|
+
await on_chunk_for_graphs(chunk)
|
|
2943
|
+
|
|
2944
|
+
async def stream_smcl() -> None:
|
|
2945
|
+
try:
|
|
2946
|
+
await self._stream_smcl_log(
|
|
2947
|
+
smcl_path=smcl_path,
|
|
2948
|
+
notify_log=notify_log,
|
|
2949
|
+
done=done,
|
|
2950
|
+
on_chunk=actual_on_chunk,
|
|
2951
|
+
start_offset=start_offset,
|
|
2952
|
+
tee=tee,
|
|
2953
|
+
)
|
|
2954
|
+
except Exception as exc:
|
|
2955
|
+
logger.debug("SMCL streaming failed: %s", exc)
|
|
2956
|
+
|
|
2957
|
+
tg.start_soon(stream_smcl)
|
|
2958
|
+
|
|
2959
|
+
if notify_progress is not None:
|
|
2960
|
+
if total_lines > 0:
|
|
2961
|
+
await notify_progress(0, float(total_lines), f"Executing do-file: 0/{total_lines}")
|
|
2962
|
+
else:
|
|
2963
|
+
await notify_progress(0, None, "Running do-file")
|
|
2964
|
+
|
|
2965
|
+
try:
|
|
2966
|
+
run_blocking = lambda: self._run_streaming_blocking(
|
|
2967
|
+
command=command,
|
|
2968
|
+
tee=tee,
|
|
2969
|
+
cwd=cwd,
|
|
2970
|
+
trace=trace,
|
|
2971
|
+
echo=echo,
|
|
2972
|
+
smcl_path=smcl_path,
|
|
2973
|
+
smcl_log_name=smcl_log_name,
|
|
2974
|
+
hold_attr="_hold_name_do",
|
|
2975
|
+
require_smcl_log=True,
|
|
2976
|
+
)
|
|
2977
|
+
try:
|
|
2978
|
+
rc, exc = await anyio.to_thread.run_sync(
|
|
2979
|
+
run_blocking,
|
|
2980
|
+
abandon_on_cancel=True,
|
|
2981
|
+
)
|
|
2982
|
+
except TypeError:
|
|
2983
|
+
rc, exc = await anyio.to_thread.run_sync(run_blocking)
|
|
2984
|
+
except Exception as e:
|
|
2985
|
+
exc = e
|
|
2986
|
+
if rc in (-1, 0):
|
|
2987
|
+
rc = 1
|
|
2988
|
+
except get_cancelled_exc_class():
|
|
2989
|
+
self._request_break_in()
|
|
2990
|
+
await self._wait_for_stata_stop()
|
|
2991
|
+
raise
|
|
2992
|
+
finally:
|
|
2993
|
+
done.set()
|
|
2994
|
+
except* Exception as exc_group:
|
|
2995
|
+
logger.debug("SMCL streaming task group failed: %s", exc_group)
|
|
2996
|
+
finally:
|
|
2997
|
+
tee.close()
|
|
2998
|
+
|
|
2999
|
+
# Read SMCL content as the authoritative source
|
|
3000
|
+
smcl_content = self._read_smcl_file(smcl_path, start_offset=start_offset)
|
|
3001
|
+
# Clean internal maintenance immediately
|
|
3002
|
+
smcl_content = self._clean_internal_smcl(smcl_content, strip_output=False)
|
|
3003
|
+
|
|
3004
|
+
|
|
3005
|
+
graph_ready_emitted = 0
|
|
3006
|
+
if graph_cache:
|
|
3007
|
+
asyncio.create_task(
|
|
3008
|
+
self._cache_new_graphs(
|
|
3009
|
+
graph_cache,
|
|
3010
|
+
notify_progress=notify_progress,
|
|
3011
|
+
total_lines=total_lines,
|
|
3012
|
+
completed_label="Do-file",
|
|
3013
|
+
)
|
|
3014
|
+
)
|
|
3015
|
+
if emit_graph_ready:
|
|
3016
|
+
graph_ready_emitted = await self._maybe_cache_graphs_on_chunk(
|
|
3017
|
+
graph_cache=graph_cache,
|
|
3018
|
+
emit_graph_ready=emit_graph_ready,
|
|
3019
|
+
notify_log=notify_log,
|
|
3020
|
+
graph_ready_task_id=graph_ready_task_id,
|
|
3021
|
+
graph_ready_format=graph_ready_format,
|
|
3022
|
+
graph_ready_initial=graph_ready_initial,
|
|
3023
|
+
last_check=graph_poll_state,
|
|
3024
|
+
force=True,
|
|
3025
|
+
)
|
|
3026
|
+
if emit_graph_ready and not graph_ready_emitted and graph_ready_initial is not None:
|
|
3027
|
+
try:
|
|
3028
|
+
graph_ready_emitted = await self._emit_graph_ready_events(
|
|
3029
|
+
graph_ready_initial,
|
|
3030
|
+
notify_log,
|
|
3031
|
+
graph_ready_task_id,
|
|
3032
|
+
graph_ready_format,
|
|
3033
|
+
)
|
|
3034
|
+
except Exception as exc:
|
|
3035
|
+
logger.debug("graph_ready fallback emission failed: %s", exc)
|
|
3036
|
+
if emit_graph_ready and not graph_ready_emitted:
|
|
3037
|
+
try:
|
|
3038
|
+
fallback_names = self._extract_named_graphs(dofile_text)
|
|
3039
|
+
if fallback_names:
|
|
3040
|
+
async with self._ensure_graph_ready_lock():
|
|
3041
|
+
await self._emit_graph_ready_for_graphs(
|
|
3042
|
+
list(dict.fromkeys(fallback_names)),
|
|
3043
|
+
notify_log=notify_log,
|
|
3044
|
+
task_id=graph_ready_task_id,
|
|
3045
|
+
export_format=graph_ready_format,
|
|
3046
|
+
graph_ready_initial=graph_ready_initial,
|
|
3047
|
+
)
|
|
3048
|
+
except Exception as exc:
|
|
3049
|
+
logger.debug("graph_ready fallback emission failed: %s", exc)
|
|
3050
|
+
|
|
3051
|
+
combined = self._build_combined_log(tail, smcl_path, rc, trace, exc, start_offset=start_offset)
|
|
3052
|
+
|
|
3053
|
+
# Use SMCL content as primary source for RC detection only when RC is ambiguous
|
|
3054
|
+
if exc is not None or rc in (-1, 1):
|
|
3055
|
+
parsed_rc = self._parse_rc_from_smcl(smcl_content)
|
|
3056
|
+
if parsed_rc is not None and parsed_rc != 0:
|
|
3057
|
+
rc = parsed_rc
|
|
3058
|
+
elif rc in (-1, 1):
|
|
3059
|
+
parsed_rc_text = self._parse_rc_from_text(combined)
|
|
3060
|
+
if parsed_rc_text is not None:
|
|
3061
|
+
rc = parsed_rc_text
|
|
3062
|
+
elif rc == -1:
|
|
3063
|
+
rc = 0 # Default to success if no error found
|
|
3064
|
+
|
|
3065
|
+
# If RC looks wrong but SMCL shows no error markers, treat as success.
|
|
3066
|
+
if rc != 0 and smcl_content:
|
|
3067
|
+
has_err_tag = "{err}" in smcl_content
|
|
3068
|
+
rc_match = re.search(r"(?<!\w)r\((\d+)\)", smcl_content)
|
|
3069
|
+
if rc_match:
|
|
3070
|
+
try:
|
|
3071
|
+
rc = int(rc_match.group(1))
|
|
3072
|
+
except Exception:
|
|
3073
|
+
pass
|
|
3074
|
+
else:
|
|
3075
|
+
text_rc = None
|
|
3076
|
+
try:
|
|
3077
|
+
text_rc = self._parse_rc_from_text(self._smcl_to_text(smcl_content))
|
|
3078
|
+
except Exception:
|
|
3079
|
+
text_rc = None
|
|
3080
|
+
if not has_err_tag and text_rc is None:
|
|
3081
|
+
rc = 0
|
|
3082
|
+
|
|
3083
|
+
success = (rc == 0 and exc is None)
|
|
3084
|
+
stderr_final = None
|
|
3085
|
+
error = None
|
|
3086
|
+
|
|
3087
|
+
# authoritative output (Preserve SMCL tags as requested by user)
|
|
3088
|
+
stdout_final = smcl_content if smcl_content else combined
|
|
3089
|
+
# Clean the final output of internal maintenance artifacts
|
|
3090
|
+
stdout_final = self._clean_internal_smcl(stdout_final)
|
|
3091
|
+
|
|
3092
|
+
# NOTE: We keep stdout_final populated even if log_path is set,
|
|
3093
|
+
# so the user gets the exact SMCL result in the tool output.
|
|
3094
|
+
# server.py may still clear it for token efficiency.
|
|
3095
|
+
|
|
3096
|
+
if not success:
|
|
3097
|
+
# Use SMCL as authoritative source for error extraction
|
|
3098
|
+
if smcl_content:
|
|
3099
|
+
msg, context = self._extract_error_from_smcl(smcl_content, rc)
|
|
3100
|
+
else:
|
|
3101
|
+
# Fallback to combined log
|
|
3102
|
+
msg, context = self._extract_error_and_context(combined, rc)
|
|
3103
|
+
|
|
3104
|
+
error = ErrorEnvelope(
|
|
3105
|
+
message=msg,
|
|
3106
|
+
context=context,
|
|
3107
|
+
rc=rc,
|
|
3108
|
+
command=command,
|
|
3109
|
+
log_path=log_path,
|
|
3110
|
+
snippet=smcl_content[-800:] if smcl_content else combined[-800:],
|
|
3111
|
+
smcl_output=smcl_content,
|
|
3112
|
+
)
|
|
3113
|
+
# Put summary in stderr
|
|
3114
|
+
stderr_final = context
|
|
3115
|
+
# Token Efficiency optimization: we keep stdout for local users/tests
|
|
3116
|
+
# but if it's very large, we might truncate it later
|
|
3117
|
+
|
|
3118
|
+
duration = time.time() - start_time
|
|
3119
|
+
logger.info(
|
|
3120
|
+
"stata.run(do stream) rc=%s success=%s trace=%s duration_ms=%.2f path=%s",
|
|
3121
|
+
rc,
|
|
3122
|
+
success,
|
|
3123
|
+
trace,
|
|
3124
|
+
duration * 1000,
|
|
3125
|
+
effective_path,
|
|
3126
|
+
)
|
|
3127
|
+
|
|
3128
|
+
result = CommandResponse(
|
|
3129
|
+
command=command,
|
|
3130
|
+
rc=rc,
|
|
3131
|
+
stdout=stdout_final,
|
|
3132
|
+
stderr=stderr_final,
|
|
3133
|
+
log_path=log_path,
|
|
3134
|
+
success=success,
|
|
3135
|
+
error=error,
|
|
3136
|
+
smcl_output=smcl_content,
|
|
3137
|
+
)
|
|
3138
|
+
|
|
3139
|
+
if notify_progress is not None:
|
|
3140
|
+
if total_lines > 0:
|
|
3141
|
+
await notify_progress(float(total_lines), float(total_lines), f"Executing do-file: {total_lines}/{total_lines}")
|
|
3142
|
+
else:
|
|
3143
|
+
await notify_progress(1, 1, "Finished")
|
|
3144
|
+
|
|
3145
|
+
return result
|
|
3146
|
+
|
|
3147
|
+
def run_command_structured(self, code: str, echo: bool = True, trace: bool = False, max_output_lines: Optional[int] = None, cwd: Optional[str] = None) -> CommandResponse:
|
|
3148
|
+
"""Runs a Stata command and returns a structured envelope.
|
|
3149
|
+
|
|
3150
|
+
Args:
|
|
3151
|
+
code: The Stata command to execute.
|
|
3152
|
+
echo: If True, the command itself is included in the output.
|
|
3153
|
+
trace: If True, enables trace mode for debugging.
|
|
3154
|
+
max_output_lines: If set, truncates stdout to this many lines (token efficiency).
|
|
3155
|
+
"""
|
|
3156
|
+
result = self._exec_with_capture(code, echo=echo, trace=trace, cwd=cwd)
|
|
3157
|
+
|
|
3158
|
+
return self._truncate_command_output(result, max_output_lines)
|
|
3159
|
+
|
|
3160
|
+
def get_data(self, start: int = 0, count: int = 50) -> List[Dict[str, Any]]:
|
|
3161
|
+
"""Returns valid JSON-serializable data."""
|
|
3162
|
+
if not self._initialized:
|
|
3163
|
+
self.init()
|
|
3164
|
+
|
|
3165
|
+
if count > self.MAX_DATA_ROWS:
|
|
3166
|
+
count = self.MAX_DATA_ROWS
|
|
3167
|
+
|
|
3168
|
+
with self._exec_lock:
|
|
3169
|
+
try:
|
|
3170
|
+
# Use pystata integration to retrieve data
|
|
3171
|
+
df = self.stata.pdataframe_from_data()
|
|
3172
|
+
|
|
3173
|
+
# Slice
|
|
3174
|
+
sliced = df.iloc[start : start + count]
|
|
3175
|
+
|
|
3176
|
+
# Convert to dict
|
|
3177
|
+
return sliced.to_dict(orient="records")
|
|
3178
|
+
except Exception as e:
|
|
3179
|
+
return [{"error": f"Failed to retrieve data: {e}"}]
|
|
3180
|
+
|
|
3181
|
+
def list_variables(self) -> List[Dict[str, str]]:
|
|
3182
|
+
"""Returns list of variables with labels."""
|
|
3183
|
+
if not self._initialized:
|
|
3184
|
+
self.init()
|
|
3185
|
+
|
|
3186
|
+
# We can use sfi to be efficient
|
|
3187
|
+
from sfi import Data # type: ignore[import-not-found]
|
|
3188
|
+
vars_info = []
|
|
3189
|
+
with self._exec_lock:
|
|
3190
|
+
for i in range(Data.getVarCount()):
|
|
3191
|
+
var_index = i # 0-based
|
|
3192
|
+
name = Data.getVarName(var_index)
|
|
3193
|
+
label = Data.getVarLabel(var_index)
|
|
3194
|
+
type_str = Data.getVarType(var_index) # Returns int
|
|
3195
|
+
|
|
3196
|
+
vars_info.append({
|
|
3197
|
+
"name": name,
|
|
3198
|
+
"label": label,
|
|
3199
|
+
"type": str(type_str),
|
|
3200
|
+
})
|
|
3201
|
+
return vars_info
|
|
3202
|
+
|
|
3203
|
+
def get_dataset_state(self) -> Dict[str, Any]:
|
|
3204
|
+
"""Return basic dataset state without mutating the dataset."""
|
|
3205
|
+
if not self._initialized:
|
|
3206
|
+
self.init()
|
|
3207
|
+
|
|
3208
|
+
from sfi import Data, Macro # type: ignore[import-not-found]
|
|
3209
|
+
|
|
3210
|
+
with self._exec_lock:
|
|
3211
|
+
n = int(Data.getObsTotal())
|
|
3212
|
+
k = int(Data.getVarCount())
|
|
3213
|
+
|
|
3214
|
+
frame = "default"
|
|
3215
|
+
sortlist = ""
|
|
3216
|
+
changed = False
|
|
3217
|
+
# Use a combined fetch for dataset state to minimize roundtrips
|
|
3218
|
+
try:
|
|
3219
|
+
state_bundle = (
|
|
3220
|
+
"macro define mcp_frame \"`c(frame)'\"\n"
|
|
3221
|
+
"macro define mcp_sortlist \"`c(sortlist)'\"\n"
|
|
3222
|
+
"macro define mcp_changed \"`c(changed)'\""
|
|
3223
|
+
)
|
|
3224
|
+
self.stata.run(state_bundle, echo=False)
|
|
3225
|
+
frame = str(Macro.getGlobal("mcp_frame") or "default")
|
|
3226
|
+
sortlist = str(Macro.getGlobal("mcp_sortlist") or "")
|
|
3227
|
+
changed = bool(int(float(Macro.getGlobal("mcp_changed") or "0")))
|
|
3228
|
+
self.stata.run("macro drop mcp_frame mcp_sortlist mcp_changed", echo=False)
|
|
3229
|
+
except Exception:
|
|
3230
|
+
logger.debug("Failed to get dataset state macros", exc_info=True)
|
|
3231
|
+
|
|
3232
|
+
return {"frame": frame, "n": n, "k": k, "sortlist": sortlist, "changed": changed}
|
|
3233
|
+
|
|
3234
|
+
def _require_data_in_memory(self) -> None:
|
|
3235
|
+
state = self.get_dataset_state()
|
|
3236
|
+
if int(state.get("k", 0) or 0) == 0 and int(state.get("n", 0) or 0) == 0:
|
|
3237
|
+
# Stata empty dataset could still have k>0 n==0; treat that as ok.
|
|
3238
|
+
raise RuntimeError("No data in memory")
|
|
3239
|
+
|
|
3240
|
+
def _get_var_index_map(self) -> Dict[str, int]:
|
|
3241
|
+
from sfi import Data # type: ignore[import-not-found]
|
|
3242
|
+
|
|
3243
|
+
out: Dict[str, int] = {}
|
|
3244
|
+
with self._exec_lock:
|
|
3245
|
+
for i in range(int(Data.getVarCount())):
|
|
3246
|
+
try:
|
|
3247
|
+
out[str(Data.getVarName(i))] = i
|
|
3248
|
+
except Exception:
|
|
3249
|
+
continue
|
|
3250
|
+
return out
|
|
3251
|
+
|
|
3252
|
+
def list_variables_rich(self) -> List[Dict[str, Any]]:
|
|
3253
|
+
"""Return variable metadata (name/type/label/format/valueLabel) without modifying the dataset."""
|
|
3254
|
+
if not self._initialized:
|
|
3255
|
+
self.init()
|
|
3256
|
+
|
|
3257
|
+
from sfi import Data # type: ignore[import-not-found]
|
|
3258
|
+
|
|
3259
|
+
vars_info: List[Dict[str, Any]] = []
|
|
3260
|
+
for i in range(int(Data.getVarCount())):
|
|
3261
|
+
name = str(Data.getVarName(i))
|
|
3262
|
+
label = None
|
|
3263
|
+
fmt = None
|
|
3264
|
+
vtype = None
|
|
3265
|
+
value_label = None
|
|
3266
|
+
try:
|
|
3267
|
+
label = Data.getVarLabel(i)
|
|
3268
|
+
except Exception:
|
|
3269
|
+
label = None
|
|
3270
|
+
try:
|
|
3271
|
+
fmt = Data.getVarFormat(i)
|
|
3272
|
+
except Exception:
|
|
3273
|
+
fmt = None
|
|
3274
|
+
try:
|
|
3275
|
+
vtype = Data.getVarType(i)
|
|
3276
|
+
except Exception:
|
|
3277
|
+
vtype = None
|
|
3278
|
+
|
|
3279
|
+
vars_info.append(
|
|
3280
|
+
{
|
|
3281
|
+
"name": name,
|
|
3282
|
+
"type": str(vtype) if vtype is not None else None,
|
|
3283
|
+
"label": label if label else None,
|
|
3284
|
+
"format": fmt if fmt else None,
|
|
3285
|
+
"valueLabel": value_label,
|
|
3286
|
+
}
|
|
3287
|
+
)
|
|
3288
|
+
return vars_info
|
|
3289
|
+
|
|
3290
|
+
@staticmethod
|
|
3291
|
+
def _is_stata_missing(value: Any) -> bool:
|
|
3292
|
+
if value is None:
|
|
3293
|
+
return True
|
|
3294
|
+
if isinstance(value, float):
|
|
3295
|
+
# Stata missing values typically show up as very large floats via sfi.Data.get
|
|
3296
|
+
return value > 8.0e307
|
|
3297
|
+
return False
|
|
3298
|
+
|
|
3299
|
+
def _normalize_cell(self, value: Any, *, max_chars: int) -> tuple[Any, bool]:
|
|
3300
|
+
if self._is_stata_missing(value):
|
|
3301
|
+
return ".", False
|
|
3302
|
+
if isinstance(value, str):
|
|
3303
|
+
if len(value) > max_chars:
|
|
3304
|
+
return value[:max_chars], True
|
|
3305
|
+
return value, False
|
|
3306
|
+
return value, False
|
|
3307
|
+
|
|
3308
|
+
def get_page(
|
|
3309
|
+
self,
|
|
3310
|
+
*,
|
|
3311
|
+
offset: int,
|
|
3312
|
+
limit: int,
|
|
3313
|
+
vars: List[str],
|
|
3314
|
+
include_obs_no: bool,
|
|
3315
|
+
max_chars: int,
|
|
3316
|
+
obs_indices: Optional[List[int]] = None,
|
|
3317
|
+
) -> Dict[str, Any]:
|
|
3318
|
+
if not self._initialized:
|
|
3319
|
+
self.init()
|
|
3320
|
+
|
|
3321
|
+
from sfi import Data # type: ignore[import-not-found]
|
|
3322
|
+
|
|
3323
|
+
state = self.get_dataset_state()
|
|
3324
|
+
n = int(state.get("n", 0) or 0)
|
|
3325
|
+
k = int(state.get("k", 0) or 0)
|
|
3326
|
+
if k == 0 and n == 0:
|
|
3327
|
+
raise RuntimeError("No data in memory")
|
|
3328
|
+
|
|
3329
|
+
var_map = self._get_var_index_map()
|
|
3330
|
+
for v in vars:
|
|
3331
|
+
if v not in var_map:
|
|
3332
|
+
raise ValueError(f"Invalid variable: {v}")
|
|
3333
|
+
|
|
3334
|
+
if obs_indices is None:
|
|
3335
|
+
start = offset
|
|
3336
|
+
end = min(offset + limit, n)
|
|
3337
|
+
if start >= n:
|
|
3338
|
+
rows: list[list[Any]] = []
|
|
3339
|
+
returned = 0
|
|
3340
|
+
obs_list: list[int] = []
|
|
3341
|
+
else:
|
|
3342
|
+
obs_list = list(range(start, end))
|
|
3343
|
+
raw_rows = Data.get(var=vars, obs=obs_list)
|
|
3344
|
+
rows = raw_rows
|
|
3345
|
+
returned = len(rows)
|
|
3346
|
+
else:
|
|
3347
|
+
start = offset
|
|
3348
|
+
end = min(offset + limit, len(obs_indices))
|
|
3349
|
+
obs_list = obs_indices[start:end]
|
|
3350
|
+
raw_rows = Data.get(var=vars, obs=obs_list) if obs_list else []
|
|
3351
|
+
rows = raw_rows
|
|
3352
|
+
returned = len(rows)
|
|
3353
|
+
|
|
3354
|
+
out_vars = list(vars)
|
|
3355
|
+
out_rows: list[list[Any]] = []
|
|
3356
|
+
truncated_cells = 0
|
|
3357
|
+
|
|
3358
|
+
if include_obs_no:
|
|
3359
|
+
out_vars = ["_n"] + out_vars
|
|
3360
|
+
|
|
3361
|
+
for idx, raw in enumerate(rows):
|
|
3362
|
+
norm_row: list[Any] = []
|
|
3363
|
+
if include_obs_no:
|
|
3364
|
+
norm_row.append(int(obs_list[idx]) + 1)
|
|
3365
|
+
for cell in raw:
|
|
3366
|
+
norm, truncated = self._normalize_cell(cell, max_chars=max_chars)
|
|
3367
|
+
if truncated:
|
|
3368
|
+
truncated_cells += 1
|
|
3369
|
+
norm_row.append(norm)
|
|
3370
|
+
out_rows.append(norm_row)
|
|
3371
|
+
|
|
3372
|
+
return {
|
|
3373
|
+
"vars": out_vars,
|
|
3374
|
+
"rows": out_rows,
|
|
3375
|
+
"returned": returned,
|
|
3376
|
+
"truncated_cells": truncated_cells,
|
|
3377
|
+
}
|
|
3378
|
+
|
|
3379
|
+
def get_arrow_stream(
|
|
3380
|
+
self,
|
|
3381
|
+
*,
|
|
3382
|
+
offset: int,
|
|
3383
|
+
limit: int,
|
|
3384
|
+
vars: List[str],
|
|
3385
|
+
include_obs_no: bool,
|
|
3386
|
+
obs_indices: Optional[List[int]] = None,
|
|
3387
|
+
) -> bytes:
|
|
3388
|
+
"""
|
|
3389
|
+
Returns an Apache Arrow IPC stream (as bytes) for the requested data page.
|
|
3390
|
+
Uses Polars if available (faster), falls back to Pandas.
|
|
3391
|
+
"""
|
|
3392
|
+
if not self._initialized:
|
|
3393
|
+
self.init()
|
|
3394
|
+
|
|
3395
|
+
import pyarrow as pa
|
|
3396
|
+
from sfi import Data # type: ignore[import-not-found]
|
|
3397
|
+
|
|
3398
|
+
use_polars = _get_polars_available()
|
|
3399
|
+
if use_polars:
|
|
3400
|
+
import polars as pl
|
|
3401
|
+
else:
|
|
3402
|
+
import pandas as pd
|
|
3403
|
+
|
|
3404
|
+
state = self.get_dataset_state()
|
|
3405
|
+
n = int(state.get("n", 0) or 0)
|
|
3406
|
+
k = int(state.get("k", 0) or 0)
|
|
3407
|
+
if k == 0 and n == 0:
|
|
3408
|
+
raise RuntimeError("No data in memory")
|
|
3409
|
+
|
|
3410
|
+
var_map = self._get_var_index_map()
|
|
3411
|
+
for v in vars:
|
|
3412
|
+
if v not in var_map:
|
|
3413
|
+
raise ValueError(f"Invalid variable: {v}")
|
|
3414
|
+
|
|
3415
|
+
# Determine observations to fetch
|
|
3416
|
+
if obs_indices is None:
|
|
3417
|
+
start = offset
|
|
3418
|
+
end = min(offset + limit, n)
|
|
3419
|
+
obs_list = list(range(start, end)) if start < n else []
|
|
3420
|
+
else:
|
|
3421
|
+
start = offset
|
|
3422
|
+
end = min(offset + limit, len(obs_indices))
|
|
3423
|
+
obs_list = obs_indices[start:end]
|
|
3424
|
+
|
|
3425
|
+
try:
|
|
3426
|
+
if not obs_list:
|
|
3427
|
+
# Empty schema-only table
|
|
3428
|
+
if use_polars:
|
|
3429
|
+
schema_cols = {}
|
|
3430
|
+
if include_obs_no:
|
|
3431
|
+
schema_cols["_n"] = pl.Int64
|
|
3432
|
+
for v in vars:
|
|
3433
|
+
schema_cols[v] = pl.Utf8
|
|
3434
|
+
table = pl.DataFrame(schema=schema_cols).to_arrow()
|
|
3435
|
+
else:
|
|
3436
|
+
columns = {}
|
|
3437
|
+
if include_obs_no:
|
|
3438
|
+
columns["_n"] = pa.array([], type=pa.int64())
|
|
3439
|
+
for v in vars:
|
|
3440
|
+
columns[v] = pa.array([], type=pa.string())
|
|
3441
|
+
table = pa.table(columns)
|
|
3442
|
+
else:
|
|
3443
|
+
# Fetch all data in one C-call
|
|
3444
|
+
raw_data = Data.get(var=vars, obs=obs_list, valuelabel=False)
|
|
3445
|
+
|
|
3446
|
+
if use_polars:
|
|
3447
|
+
df = pl.DataFrame(raw_data, schema=vars, orient="row")
|
|
3448
|
+
if include_obs_no:
|
|
3449
|
+
obs_nums = [i + 1 for i in obs_list]
|
|
3450
|
+
df = df.with_columns(pl.Series("_n", obs_nums, dtype=pl.Int64))
|
|
3451
|
+
df = df.select(["_n"] + vars)
|
|
3452
|
+
table = df.to_arrow()
|
|
3453
|
+
else:
|
|
3454
|
+
df = pd.DataFrame(raw_data, columns=vars)
|
|
3455
|
+
if include_obs_no:
|
|
3456
|
+
df.insert(0, "_n", [i + 1 for i in obs_list])
|
|
3457
|
+
table = pa.Table.from_pandas(df, preserve_index=False)
|
|
3458
|
+
|
|
3459
|
+
# Serialize to IPC Stream
|
|
3460
|
+
sink = pa.BufferOutputStream()
|
|
3461
|
+
with pa.RecordBatchStreamWriter(sink, table.schema) as writer:
|
|
3462
|
+
writer.write_table(table)
|
|
3463
|
+
|
|
3464
|
+
return sink.getvalue().to_pybytes()
|
|
3465
|
+
|
|
3466
|
+
except Exception as e:
|
|
3467
|
+
raise RuntimeError(f"Failed to generate Arrow stream: {e}")
|
|
3468
|
+
|
|
3469
|
+
_FILTER_IDENT = re.compile(r"\b[A-Za-z_][A-Za-z0-9_]*\b")
|
|
3470
|
+
|
|
3471
|
+
def _extract_filter_vars(self, filter_expr: str) -> List[str]:
|
|
3472
|
+
tokens = set(self._FILTER_IDENT.findall(filter_expr or ""))
|
|
3473
|
+
# Exclude python keywords we might inject.
|
|
3474
|
+
exclude = {"and", "or", "not", "True", "False", "None"}
|
|
3475
|
+
var_map = self._get_var_index_map()
|
|
3476
|
+
vars_used = [t for t in tokens if t not in exclude and t in var_map]
|
|
3477
|
+
return sorted(vars_used)
|
|
3478
|
+
|
|
3479
|
+
def _compile_filter_expr(self, filter_expr: str) -> Any:
|
|
3480
|
+
expr = (filter_expr or "").strip()
|
|
3481
|
+
if not expr:
|
|
3482
|
+
raise ValueError("Empty filter")
|
|
3483
|
+
|
|
3484
|
+
# Stata boolean operators.
|
|
3485
|
+
expr = expr.replace("&", " and ").replace("|", " or ")
|
|
3486
|
+
|
|
3487
|
+
# Replace missing literal '.' (but not numeric decimals like 0.5).
|
|
3488
|
+
expr = re.sub(r"(?<![0-9])\.(?![0-9A-Za-z_])", "None", expr)
|
|
3489
|
+
|
|
3490
|
+
try:
|
|
3491
|
+
return compile(expr, "<filterExpr>", "eval")
|
|
3492
|
+
except Exception as e:
|
|
3493
|
+
raise ValueError(f"Invalid filter expression: {e}")
|
|
3494
|
+
|
|
3495
|
+
def validate_filter_expr(self, filter_expr: str) -> None:
|
|
3496
|
+
if not self._initialized:
|
|
3497
|
+
self.init()
|
|
3498
|
+
state = self.get_dataset_state()
|
|
3499
|
+
if int(state.get("k", 0) or 0) == 0 and int(state.get("n", 0) or 0) == 0:
|
|
3500
|
+
raise RuntimeError("No data in memory")
|
|
3501
|
+
|
|
3502
|
+
vars_used = self._extract_filter_vars(filter_expr)
|
|
3503
|
+
if not vars_used:
|
|
3504
|
+
# still allow constant expressions like "1" or "True"
|
|
3505
|
+
self._compile_filter_expr(filter_expr)
|
|
3506
|
+
return
|
|
3507
|
+
self._compile_filter_expr(filter_expr)
|
|
3508
|
+
|
|
3509
|
+
def compute_view_indices(self, filter_expr: str, *, chunk_size: int = 5000) -> List[int]:
|
|
3510
|
+
if not self._initialized:
|
|
3511
|
+
self.init()
|
|
3512
|
+
|
|
3513
|
+
from sfi import Data # type: ignore[import-not-found]
|
|
3514
|
+
|
|
3515
|
+
state = self.get_dataset_state()
|
|
3516
|
+
n = int(state.get("n", 0) or 0)
|
|
3517
|
+
k = int(state.get("k", 0) or 0)
|
|
3518
|
+
if k == 0 and n == 0:
|
|
3519
|
+
raise RuntimeError("No data in memory")
|
|
3520
|
+
|
|
3521
|
+
vars_used = self._extract_filter_vars(filter_expr)
|
|
3522
|
+
code = self._compile_filter_expr(filter_expr)
|
|
3523
|
+
_ = self._get_var_index_map()
|
|
3524
|
+
|
|
3525
|
+
is_string_vars = []
|
|
3526
|
+
if vars_used:
|
|
3527
|
+
try:
|
|
3528
|
+
from sfi import Variable # type: ignore
|
|
3529
|
+
is_string_vars = [Variable.isString(v) for v in vars_used]
|
|
3530
|
+
except (ImportError, AttributeError):
|
|
3531
|
+
# Stata 19+ compatibility
|
|
3532
|
+
is_string_vars = [Data.isVarTypeString(v) for v in vars_used]
|
|
3533
|
+
|
|
3534
|
+
indices: List[int] = []
|
|
3535
|
+
for start in range(0, n, chunk_size):
|
|
3536
|
+
end = min(start + chunk_size, n)
|
|
3537
|
+
obs_list = list(range(start, end))
|
|
3538
|
+
raw_rows = Data.get(var=vars_used, obs=obs_list) if vars_used else [[None] for _ in obs_list]
|
|
3539
|
+
|
|
3540
|
+
# Try Rust optimization for the chunk
|
|
3541
|
+
if vars_used and raw_rows:
|
|
3542
|
+
# Transpose rows to columns for Rust
|
|
3543
|
+
cols = []
|
|
3544
|
+
# Extract columns
|
|
3545
|
+
for j in range(len(vars_used)):
|
|
3546
|
+
col_data_list = [row[j] for row in raw_rows]
|
|
3547
|
+
if not is_string_vars[j]:
|
|
3548
|
+
import numpy as np
|
|
3549
|
+
col_data = np.array(col_data_list, dtype=np.float64)
|
|
3550
|
+
else:
|
|
3551
|
+
col_data = col_data_list
|
|
3552
|
+
cols.append(col_data)
|
|
3553
|
+
|
|
3554
|
+
rust_indices = compute_filter_indices(filter_expr, vars_used, cols, is_string_vars)
|
|
3555
|
+
if rust_indices is not None:
|
|
3556
|
+
indices.extend([int(obs_list[i]) for i in rust_indices])
|
|
3557
|
+
continue
|
|
3558
|
+
|
|
3559
|
+
for row_i, obs in enumerate(obs_list):
|
|
3560
|
+
env: Dict[str, Any] = {}
|
|
3561
|
+
if vars_used:
|
|
3562
|
+
for j, v in enumerate(vars_used):
|
|
3563
|
+
val = raw_rows[row_i][j]
|
|
3564
|
+
env[v] = None if self._is_stata_missing(val) else val
|
|
3565
|
+
|
|
3566
|
+
ok = False
|
|
3567
|
+
try:
|
|
3568
|
+
ok = bool(eval(code, {"__builtins__": {}}, env))
|
|
3569
|
+
except NameError as e:
|
|
3570
|
+
raise ValueError(f"Invalid filter: {e}")
|
|
3571
|
+
except Exception as e:
|
|
3572
|
+
raise ValueError(f"Invalid filter: {e}")
|
|
3573
|
+
|
|
3574
|
+
if ok:
|
|
3575
|
+
indices.append(int(obs))
|
|
3576
|
+
|
|
3577
|
+
return indices
|
|
3578
|
+
|
|
3579
|
+
def apply_sort(self, sort_spec: List[str]) -> None:
|
|
3580
|
+
"""
|
|
3581
|
+
Apply sorting to the dataset using gsort.
|
|
3582
|
+
|
|
3583
|
+
Args:
|
|
3584
|
+
sort_spec: List of variables to sort by, with optional +/- prefix.
|
|
3585
|
+
e.g., ["-price", "+mpg"] sorts by price descending, then mpg ascending.
|
|
3586
|
+
No prefix is treated as ascending (+).
|
|
3587
|
+
|
|
3588
|
+
Raises:
|
|
3589
|
+
ValueError: If sort_spec is invalid or contains invalid variables
|
|
3590
|
+
RuntimeError: If no data in memory or sort command fails
|
|
3591
|
+
"""
|
|
3592
|
+
if not self._initialized:
|
|
3593
|
+
self.init()
|
|
3594
|
+
|
|
3595
|
+
state = self.get_dataset_state()
|
|
3596
|
+
if int(state.get("k", 0) or 0) == 0 and int(state.get("n", 0) or 0) == 0:
|
|
3597
|
+
raise RuntimeError("No data in memory")
|
|
3598
|
+
|
|
3599
|
+
if not sort_spec or not isinstance(sort_spec, list):
|
|
3600
|
+
raise ValueError("sort_spec must be a non-empty list")
|
|
3601
|
+
|
|
3602
|
+
# Validate all variables exist
|
|
3603
|
+
var_map = self._get_var_index_map()
|
|
3604
|
+
for spec in sort_spec:
|
|
3605
|
+
if not isinstance(spec, str) or not spec:
|
|
3606
|
+
raise ValueError(f"Invalid sort specification: {spec!r}")
|
|
3607
|
+
# Extract variable name (remove +/- prefix if present)
|
|
3608
|
+
varname = spec.lstrip("+-")
|
|
3609
|
+
if not varname:
|
|
3610
|
+
raise ValueError(f"Invalid sort specification: {spec!r}")
|
|
3611
|
+
|
|
3612
|
+
if varname not in var_map:
|
|
3613
|
+
raise ValueError(f"Variable not found: {varname}")
|
|
3614
|
+
|
|
3615
|
+
# Build gsort command
|
|
3616
|
+
# gsort uses - for descending, + or nothing for ascending
|
|
3617
|
+
gsort_args = []
|
|
3618
|
+
for spec in sort_spec:
|
|
3619
|
+
if spec.startswith("-") or spec.startswith("+"):
|
|
3620
|
+
gsort_args.append(spec)
|
|
3621
|
+
else:
|
|
3622
|
+
# No prefix means ascending, add + explicitly for clarity
|
|
3623
|
+
gsort_args.append(f"+{spec}")
|
|
3624
|
+
|
|
3625
|
+
cmd = f"gsort {' '.join(gsort_args)}"
|
|
3626
|
+
|
|
3627
|
+
try:
|
|
3628
|
+
# Sorting is hot-path for UI paging; use lightweight execution.
|
|
3629
|
+
result = self.exec_lightweight(cmd)
|
|
3630
|
+
if not result.success:
|
|
3631
|
+
error_msg = result.stderr or "Sort failed"
|
|
3632
|
+
raise RuntimeError(f"Failed to sort dataset: {error_msg}")
|
|
3633
|
+
except Exception as e:
|
|
3634
|
+
if isinstance(e, RuntimeError):
|
|
3635
|
+
raise
|
|
3636
|
+
raise RuntimeError(f"Failed to sort dataset: {e}")
|
|
3637
|
+
|
|
3638
|
+
def get_variable_details(self, varname: str) -> str:
|
|
3639
|
+
"""Returns codebook/summary for a specific variable while preserving state."""
|
|
3640
|
+
# Use _exec_no_capture_silent to preserve r()/e() results
|
|
3641
|
+
resp = self._exec_no_capture_silent(f"codebook {varname}", echo=False)
|
|
3642
|
+
if resp.success:
|
|
3643
|
+
# _exec_no_capture_silent captures output in resp.error.stdout if it fails,
|
|
3644
|
+
# but wait, it doesn't return stdout in CommandResponse for success?
|
|
3645
|
+
# Let me check CommandResponse creation in _exec_no_capture_silent.
|
|
3646
|
+
pass
|
|
3647
|
+
return resp.stdout or ""
|
|
3648
|
+
|
|
3649
|
+
def list_variables_structured(self) -> VariablesResponse:
|
|
3650
|
+
vars_info: List[VariableInfo] = []
|
|
3651
|
+
for item in self.list_variables():
|
|
3652
|
+
vars_info.append(
|
|
3653
|
+
VariableInfo(
|
|
3654
|
+
name=item.get("name", ""),
|
|
3655
|
+
label=item.get("label"),
|
|
3656
|
+
type=item.get("type"),
|
|
3657
|
+
)
|
|
3658
|
+
)
|
|
3659
|
+
return VariablesResponse(variables=vars_info)
|
|
3660
|
+
|
|
3661
|
+
def list_graphs(self, *, force_refresh: bool = False) -> List[str]:
|
|
3662
|
+
"""Returns list of graphs in memory with TTL caching."""
|
|
3663
|
+
if not self._initialized:
|
|
3664
|
+
self.init()
|
|
3665
|
+
|
|
3666
|
+
import time
|
|
3667
|
+
|
|
3668
|
+
# Prevent recursive Stata calls - if we're already executing, return cached or empty
|
|
3669
|
+
if self._is_executing:
|
|
3670
|
+
with self._list_graphs_cache_lock:
|
|
3671
|
+
if self._list_graphs_cache is not None:
|
|
3672
|
+
logger.debug("Recursive list_graphs call prevented, returning cached value")
|
|
3673
|
+
if self._list_graphs_cache and hasattr(self._list_graphs_cache[0], "name"):
|
|
3674
|
+
return [g.name for g in self._list_graphs_cache]
|
|
3675
|
+
return self._list_graphs_cache
|
|
3676
|
+
else:
|
|
3677
|
+
logger.debug("Recursive list_graphs call prevented, returning empty list")
|
|
3678
|
+
return []
|
|
3679
|
+
|
|
3680
|
+
# Check if cache is valid
|
|
3681
|
+
current_time = time.time()
|
|
3682
|
+
with self._list_graphs_cache_lock:
|
|
3683
|
+
if (not force_refresh and self._list_graphs_cache is not None and
|
|
3684
|
+
current_time - self._list_graphs_cache_time < self.LIST_GRAPHS_TTL):
|
|
3685
|
+
if self._list_graphs_cache and hasattr(self._list_graphs_cache[0], "name"):
|
|
3686
|
+
return [g.name for g in self._list_graphs_cache]
|
|
3687
|
+
return self._list_graphs_cache
|
|
3688
|
+
|
|
3689
|
+
# Cache miss or expired, fetch fresh data
|
|
3690
|
+
with self._exec_lock:
|
|
3691
|
+
try:
|
|
3692
|
+
# Preservation of r() results is critical because this can be called
|
|
3693
|
+
# automatically after every user command (e.g., during streaming).
|
|
3694
|
+
import time
|
|
3695
|
+
hold_name = f"_mcp_ghold_{int(time.time() * 1000 % 1000000)}"
|
|
3696
|
+
try:
|
|
3697
|
+
self.stata.run(f"capture _return hold {hold_name}", echo=False)
|
|
3698
|
+
except SystemError:
|
|
3699
|
+
import traceback
|
|
3700
|
+
sys.stderr.write(traceback.format_exc())
|
|
3701
|
+
sys.stderr.flush()
|
|
3702
|
+
raise
|
|
3703
|
+
|
|
3704
|
+
try:
|
|
3705
|
+
# Bundle name listing and metadata retrieval into one Stata call for efficiency
|
|
3706
|
+
bundle = (
|
|
3707
|
+
"macro define mcp_graph_list \"\"\n"
|
|
3708
|
+
"global mcp_graph_details \"\"\n"
|
|
3709
|
+
"quietly graph dir, memory\n"
|
|
3710
|
+
"macro define mcp_graph_list \"`r(list)'\"\n"
|
|
3711
|
+
"if \"`r(list)'\" != \"\" {\n"
|
|
3712
|
+
" foreach g in `r(list)' {\n"
|
|
3713
|
+
" quietly graph describe `g'\n"
|
|
3714
|
+
" global mcp_graph_details \"$mcp_graph_details `g'|`r(command_date)' `r(command_time)';\"\n"
|
|
3715
|
+
" }\n"
|
|
3716
|
+
"}"
|
|
3717
|
+
)
|
|
3718
|
+
self.stata.run(bundle, echo=False)
|
|
3719
|
+
from sfi import Macro # type: ignore[import-not-found]
|
|
3720
|
+
graph_list_str = Macro.getGlobal("mcp_graph_list")
|
|
3721
|
+
details_str = Macro.getGlobal("mcp_graph_details")
|
|
3722
|
+
# Cleanup global to keep Stata environment tidy
|
|
3723
|
+
self.stata.run("macro drop mcp_graph_details", echo=False)
|
|
3724
|
+
finally:
|
|
3725
|
+
try:
|
|
3726
|
+
self.stata.run(f"capture _return restore {hold_name}", echo=False)
|
|
3727
|
+
except SystemError:
|
|
3728
|
+
import traceback
|
|
3729
|
+
sys.stderr.write(traceback.format_exc())
|
|
3730
|
+
sys.stderr.flush()
|
|
3731
|
+
raise
|
|
3732
|
+
|
|
3733
|
+
raw_list = graph_list_str.split() if graph_list_str else []
|
|
3734
|
+
|
|
3735
|
+
# Parse details: "name1|date time; name2|date time;"
|
|
3736
|
+
details_map = {}
|
|
3737
|
+
if details_str:
|
|
3738
|
+
for item in details_str.split(';'):
|
|
3739
|
+
if '|' in item:
|
|
3740
|
+
parts = item.strip().split('|', 1)
|
|
3741
|
+
if len(parts) == 2:
|
|
3742
|
+
gname, ts = parts
|
|
3743
|
+
details_map[gname] = ts
|
|
3744
|
+
|
|
3745
|
+
# Map internal Stata names back to user-facing names when we have an alias.
|
|
3746
|
+
reverse = getattr(self, "_graph_name_reverse", {})
|
|
3747
|
+
|
|
3748
|
+
graph_infos = []
|
|
3749
|
+
for n in raw_list:
|
|
3750
|
+
graph_infos.append(GraphInfo(
|
|
3751
|
+
name=reverse.get(n, n),
|
|
3752
|
+
active=False,
|
|
3753
|
+
created=details_map.get(n)
|
|
3754
|
+
))
|
|
3755
|
+
|
|
3756
|
+
# Update cache
|
|
3757
|
+
with self._list_graphs_cache_lock:
|
|
3758
|
+
self._list_graphs_cache = graph_infos
|
|
3759
|
+
self._list_graphs_cache_time = time.time()
|
|
3760
|
+
|
|
3761
|
+
return [g.name for g in graph_infos]
|
|
3762
|
+
|
|
3763
|
+
except Exception as e:
|
|
3764
|
+
# On error, return cached result if available, otherwise empty list
|
|
3765
|
+
with self._list_graphs_cache_lock:
|
|
3766
|
+
if self._list_graphs_cache is not None:
|
|
3767
|
+
logger.warning(f"list_graphs failed, returning cached result: {e}")
|
|
3768
|
+
if self._list_graphs_cache and hasattr(self._list_graphs_cache[0], "name"):
|
|
3769
|
+
return [g.name for g in self._list_graphs_cache]
|
|
3770
|
+
return self._list_graphs_cache
|
|
3771
|
+
logger.warning(f"list_graphs failed, no cache available: {e}")
|
|
3772
|
+
return []
|
|
3773
|
+
|
|
3774
|
+
def list_graphs_structured(self) -> GraphListResponse:
|
|
3775
|
+
self.list_graphs()
|
|
3776
|
+
|
|
3777
|
+
with self._list_graphs_cache_lock:
|
|
3778
|
+
if not self._list_graphs_cache:
|
|
3779
|
+
return GraphListResponse(graphs=[])
|
|
3780
|
+
|
|
3781
|
+
# The cache now contains GraphInfo objects
|
|
3782
|
+
graphs = [g.model_copy() for g in self._list_graphs_cache]
|
|
3783
|
+
|
|
3784
|
+
if graphs:
|
|
3785
|
+
# Most recently created/displayed graph is active in Stata
|
|
3786
|
+
graphs[-1].active = True
|
|
3787
|
+
|
|
3788
|
+
return GraphListResponse(graphs=graphs)
|
|
3789
|
+
|
|
3790
|
+
def invalidate_list_graphs_cache(self) -> None:
|
|
3791
|
+
"""Invalidate the list_graphs cache to force fresh data on next call."""
|
|
3792
|
+
with self._list_graphs_cache_lock:
|
|
3793
|
+
self._list_graphs_cache = None
|
|
3794
|
+
self._list_graphs_cache_time = 0
|
|
3795
|
+
|
|
3796
|
+
def export_graph(self, graph_name: str = None, filename: str = None, format: str = "pdf") -> str:
|
|
3797
|
+
"""Exports graph to a temp file (pdf or png) and returns the path.
|
|
3798
|
+
|
|
3799
|
+
On Windows, PyStata can crash when exporting PNGs directly. For PNG on
|
|
3800
|
+
Windows, we save the graph to .gph and invoke the Stata executable in
|
|
3801
|
+
batch mode to export the PNG out-of-process.
|
|
3802
|
+
"""
|
|
3803
|
+
import tempfile
|
|
3804
|
+
|
|
3805
|
+
fmt = (format or "pdf").strip().lower()
|
|
3806
|
+
if fmt not in {"pdf", "png", "svg"}:
|
|
3807
|
+
raise ValueError(f"Unsupported graph export format: {format}. Allowed: pdf, png, svg.")
|
|
3808
|
+
|
|
3809
|
+
|
|
3810
|
+
if not filename:
|
|
3811
|
+
suffix = f".{fmt}"
|
|
3812
|
+
# Use validated temp dir to avoid Windows write permission errors
|
|
3813
|
+
with tempfile.NamedTemporaryFile(prefix="mcp_stata_", suffix=suffix, dir=get_writable_temp_dir(), delete=False) as tmp:
|
|
3814
|
+
filename = tmp.name
|
|
3815
|
+
register_temp_file(filename)
|
|
3816
|
+
else:
|
|
3817
|
+
# Ensure fresh start
|
|
3818
|
+
p_filename = pathlib.Path(filename)
|
|
3819
|
+
if p_filename.exists():
|
|
3820
|
+
try:
|
|
3821
|
+
p_filename.unlink()
|
|
3822
|
+
except Exception:
|
|
3823
|
+
pass
|
|
3824
|
+
|
|
3825
|
+
# Keep the user-facing path as a normal absolute path
|
|
3826
|
+
user_filename = pathlib.Path(filename).absolute()
|
|
3827
|
+
|
|
3828
|
+
if fmt == "png" and is_windows():
|
|
3829
|
+
# 1) Save graph to a .gph file from the embedded session
|
|
3830
|
+
with tempfile.NamedTemporaryFile(prefix="mcp_stata_graph_", suffix=".gph", dir=get_writable_temp_dir(), delete=False) as gph_tmp:
|
|
3831
|
+
gph_path = pathlib.Path(gph_tmp.name)
|
|
3832
|
+
register_temp_file(gph_path)
|
|
3833
|
+
gph_path_for_stata = gph_path.as_posix()
|
|
3834
|
+
# Make the target graph current, then save without name() (which isn't accepted there)
|
|
3835
|
+
if graph_name:
|
|
3836
|
+
self._exec_no_capture_silent(f'quietly graph display {graph_name}', echo=False)
|
|
3837
|
+
save_cmd = f'quietly graph save "{gph_path_for_stata}", replace'
|
|
3838
|
+
save_resp = self._exec_no_capture_silent(save_cmd, echo=False)
|
|
3839
|
+
if not save_resp.success:
|
|
3840
|
+
msg = save_resp.error.message if save_resp.error else f"graph save failed (rc={save_resp.rc})"
|
|
3841
|
+
raise RuntimeError(msg)
|
|
3842
|
+
|
|
3843
|
+
# 2) Prepare a do-file to export PNG externally
|
|
3844
|
+
user_filename_fwd = user_filename.as_posix()
|
|
3845
|
+
do_lines = [
|
|
3846
|
+
f'quietly graph use "{gph_path_for_stata}"',
|
|
3847
|
+
f'quietly graph export "{user_filename_fwd}", replace as(png)',
|
|
3848
|
+
"exit",
|
|
3849
|
+
]
|
|
3850
|
+
with tempfile.NamedTemporaryFile(prefix="mcp_stata_export_", suffix=".do", dir=get_writable_temp_dir(), delete=False, mode="w", encoding="ascii") as do_tmp:
|
|
3851
|
+
do_tmp.write("\n".join(do_lines))
|
|
3852
|
+
do_path = pathlib.Path(do_tmp.name)
|
|
3853
|
+
register_temp_file(do_path)
|
|
3854
|
+
|
|
3855
|
+
stata_exe = getattr(self, "_stata_exec_path", None)
|
|
3856
|
+
if not stata_exe or not pathlib.Path(stata_exe).exists():
|
|
3857
|
+
raise RuntimeError("Stata executable path unavailable for PNG export")
|
|
3858
|
+
|
|
3859
|
+
workdir = do_path.parent
|
|
3860
|
+
log_path = do_path.with_suffix(".log")
|
|
3861
|
+
register_temp_file(log_path)
|
|
3862
|
+
|
|
3863
|
+
cmd = [str(stata_exe), "/e", "do", str(do_path)]
|
|
3864
|
+
try:
|
|
3865
|
+
completed = subprocess.run(
|
|
3866
|
+
cmd,
|
|
3867
|
+
capture_output=True,
|
|
3868
|
+
text=True,
|
|
3869
|
+
timeout=30,
|
|
3870
|
+
cwd=workdir,
|
|
3871
|
+
)
|
|
3872
|
+
except subprocess.TimeoutExpired:
|
|
3873
|
+
raise RuntimeError("External Stata export timed out")
|
|
3874
|
+
finally:
|
|
3875
|
+
try:
|
|
3876
|
+
do_path.unlink()
|
|
3877
|
+
except Exception:
|
|
3878
|
+
# Ignore errors during temporary do-file cleanup (file may not exist or be locked)
|
|
3879
|
+
logger.warning("Failed to remove temporary do-file: %s", do_path, exc_info=True)
|
|
3880
|
+
|
|
3881
|
+
try:
|
|
3882
|
+
gph_path.unlink()
|
|
3883
|
+
except Exception:
|
|
3884
|
+
logger.warning("Failed to remove temporary graph file: %s", gph_path, exc_info=True)
|
|
3885
|
+
|
|
3886
|
+
try:
|
|
3887
|
+
if log_path.exists():
|
|
3888
|
+
log_path.unlink()
|
|
3889
|
+
except Exception:
|
|
3890
|
+
logger.warning("Failed to remove temporary log file: %s", log_path, exc_info=True)
|
|
3891
|
+
|
|
3892
|
+
if completed.returncode != 0:
|
|
3893
|
+
err = completed.stderr.strip() or completed.stdout.strip() or str(completed.returncode)
|
|
3894
|
+
raise RuntimeError(f"External Stata export failed: {err}")
|
|
3895
|
+
|
|
3896
|
+
else:
|
|
3897
|
+
# Stata prefers forward slashes in its command parser on Windows
|
|
3898
|
+
filename_for_stata = user_filename.as_posix()
|
|
3899
|
+
|
|
3900
|
+
if graph_name:
|
|
3901
|
+
resolved = self._resolve_graph_name_for_stata(graph_name)
|
|
3902
|
+
# Use display + export without name() for maximum compatibility.
|
|
3903
|
+
# name(NAME) often fails in PyStata for non-active graphs (r(693)).
|
|
3904
|
+
# Graph identifiers must NOT be quoted in 'graph display'.
|
|
3905
|
+
disp_resp = self._exec_no_capture_silent(f'quietly graph display {resolved}', echo=False)
|
|
3906
|
+
if not disp_resp.success:
|
|
3907
|
+
# graph display failed, likely rc=111 or 693
|
|
3908
|
+
msg = disp_resp.error.message if disp_resp.error else f"Graph display failed (rc={disp_resp.rc})"
|
|
3909
|
+
# Normalize for test expectations
|
|
3910
|
+
if disp_resp.rc == 111:
|
|
3911
|
+
msg = f"graph {resolved} not found r(111);"
|
|
3912
|
+
raise RuntimeError(msg)
|
|
3913
|
+
|
|
3914
|
+
cmd = f'quietly graph export "{filename_for_stata}", replace as({fmt})'
|
|
3915
|
+
|
|
3916
|
+
# Avoid stdout/stderr redirection for graph export because PyStata's
|
|
3917
|
+
# output thread can crash on Windows when we swap stdio handles.
|
|
3918
|
+
resp = self._exec_no_capture_silent(cmd, echo=False)
|
|
3919
|
+
if not resp.success:
|
|
3920
|
+
# Retry once after a short pause in case Stata had a transient file handle issue
|
|
3921
|
+
time.sleep(0.2)
|
|
3922
|
+
resp_retry = self._exec_no_capture_silent(cmd, echo=False)
|
|
3923
|
+
if not resp_retry.success:
|
|
3924
|
+
msg = resp_retry.error.message if resp_retry.error else f"graph export failed (rc={resp_retry.rc})"
|
|
3925
|
+
raise RuntimeError(msg)
|
|
3926
|
+
resp = resp_retry
|
|
3927
|
+
|
|
3928
|
+
if user_filename.exists():
|
|
3929
|
+
try:
|
|
3930
|
+
size = user_filename.stat().st_size
|
|
3931
|
+
if size == 0:
|
|
3932
|
+
raise RuntimeError(f"Graph export failed: produced empty file {user_filename}")
|
|
3933
|
+
if size > self.MAX_GRAPH_BYTES:
|
|
3934
|
+
raise RuntimeError(
|
|
3935
|
+
f"Graph export failed: file too large (> {self.MAX_GRAPH_BYTES} bytes): {user_filename}"
|
|
3936
|
+
)
|
|
3937
|
+
except Exception as size_err:
|
|
3938
|
+
# Clean up oversized or unreadable files
|
|
3939
|
+
try:
|
|
3940
|
+
user_filename.unlink()
|
|
3941
|
+
except Exception:
|
|
3942
|
+
pass
|
|
3943
|
+
raise size_err
|
|
3944
|
+
return str(user_filename)
|
|
3945
|
+
|
|
3946
|
+
# If file missing, it failed. Check output for details.
|
|
3947
|
+
msg = resp.error.message if resp.error else "graph export failed: file missing"
|
|
3948
|
+
raise RuntimeError(msg)
|
|
3949
|
+
|
|
3950
|
+
def get_help(self, topic: str, plain_text: bool = False) -> str:
|
|
3951
|
+
"""Returns help text as Markdown (default) or plain text."""
|
|
3952
|
+
if not self._initialized:
|
|
3953
|
+
self.init()
|
|
3954
|
+
|
|
3955
|
+
with self._exec_lock:
|
|
3956
|
+
# Try to locate the .sthlp help file
|
|
3957
|
+
# We use 'capture' to avoid crashing if not found.
|
|
3958
|
+
# Combined into a single bundle to prevent r(fn) from being cleared.
|
|
3959
|
+
from sfi import Macro # type: ignore[import-not-found]
|
|
3960
|
+
bundle = (
|
|
3961
|
+
f"capture findfile {topic}.sthlp\n"
|
|
3962
|
+
"macro define mcp_help_file \"`r(fn)'\""
|
|
3963
|
+
)
|
|
3964
|
+
self.stata.run(bundle, echo=False)
|
|
3965
|
+
fn = Macro.getGlobal("mcp_help_file")
|
|
3966
|
+
|
|
3967
|
+
if fn and os.path.exists(fn):
|
|
3968
|
+
try:
|
|
3969
|
+
with open(fn, 'r', encoding='utf-8', errors='replace') as f:
|
|
3970
|
+
smcl = f.read()
|
|
3971
|
+
if plain_text:
|
|
3972
|
+
return self._smcl_to_text(smcl)
|
|
3973
|
+
try:
|
|
3974
|
+
return smcl_to_markdown(smcl, adopath=os.path.dirname(fn), current_file=os.path.splitext(os.path.basename(fn))[0])
|
|
3975
|
+
except Exception as parse_err:
|
|
3976
|
+
logger.warning("SMCL to Markdown failed, falling back to plain text: %s", parse_err)
|
|
3977
|
+
return self._smcl_to_text(smcl)
|
|
3978
|
+
except Exception as e:
|
|
3979
|
+
logger.warning("Help file read failed for %s: %s", topic, e)
|
|
3980
|
+
|
|
3981
|
+
# If no help file found, return a fallback message
|
|
3982
|
+
return f"Help file for '{topic}' not found."
|
|
3983
|
+
|
|
3984
|
+
def get_stored_results(self, force_fresh: bool = False) -> Dict[str, Any]:
|
|
3985
|
+
"""Returns e() and r() results using SFI for maximum reliability."""
|
|
3986
|
+
if not force_fresh and self._last_results is not None:
|
|
3987
|
+
return self._last_results
|
|
3988
|
+
|
|
3989
|
+
if not self._initialized:
|
|
3990
|
+
self.init()
|
|
3991
|
+
|
|
3992
|
+
with self._exec_lock:
|
|
3993
|
+
# Capture the current RC first using SFI (non-mutating)
|
|
3994
|
+
try:
|
|
3995
|
+
from sfi import Scalar, Macro
|
|
3996
|
+
preserved_rc = int(float(Scalar.getValue("c(rc)") or 0))
|
|
3997
|
+
except Exception:
|
|
3998
|
+
preserved_rc = 0
|
|
3999
|
+
|
|
4000
|
+
results = {"r": {}, "e": {}, "s": {}}
|
|
4001
|
+
|
|
4002
|
+
try:
|
|
4003
|
+
# Fetch lists of names. macro define `: ...' is non-mutating for results.
|
|
4004
|
+
fetch_names_block = (
|
|
4005
|
+
"macro define mcp_r_sc \"`: r(scalars)'\"\n"
|
|
4006
|
+
"macro define mcp_r_ma \"`: r(macros)'\"\n"
|
|
4007
|
+
"macro define mcp_e_sc \"`: e(scalars)'\"\n"
|
|
4008
|
+
"macro define mcp_e_ma \"`: e(macros)'\"\n"
|
|
4009
|
+
"macro define mcp_s_sc \"`: s(scalars)'\"\n"
|
|
4010
|
+
"macro define mcp_s_ma \"`: s(macros)'\"\n"
|
|
4011
|
+
)
|
|
4012
|
+
self.stata.run(fetch_names_block, echo=False)
|
|
4013
|
+
|
|
4014
|
+
for rclass in ["r", "e", "s"]:
|
|
4015
|
+
sc_names = (Macro.getGlobal(f"mcp_{rclass}_sc") or "").split()
|
|
4016
|
+
ma_names = (Macro.getGlobal(f"mcp_{rclass}_ma") or "").split()
|
|
4017
|
+
|
|
4018
|
+
# Fetch Scalars via SFI (fast, non-mutating)
|
|
4019
|
+
for name in sc_names:
|
|
4020
|
+
try:
|
|
4021
|
+
val = Scalar.getValue(f"{rclass}({name})")
|
|
4022
|
+
results[rclass][name] = val
|
|
4023
|
+
except Exception:
|
|
4024
|
+
pass
|
|
4025
|
+
|
|
4026
|
+
# Fetch Macros via global expansion
|
|
4027
|
+
if ma_names:
|
|
4028
|
+
# Bundle macro copying to minimize roundtrips
|
|
4029
|
+
# We use global macros as a transfer area
|
|
4030
|
+
copy_block = ""
|
|
4031
|
+
for name in ma_names:
|
|
4032
|
+
copy_block += f"macro define mcp_m_{rclass}_{name} \"`{rclass}({name})'\"\n"
|
|
4033
|
+
|
|
4034
|
+
if copy_block:
|
|
4035
|
+
self.stata.run(copy_block, echo=False)
|
|
4036
|
+
for name in ma_names:
|
|
4037
|
+
results[rclass][name] = Macro.getGlobal(f"mcp_m_{rclass}_{name}")
|
|
4038
|
+
|
|
4039
|
+
# Cleanup and Restore state
|
|
4040
|
+
self.stata.run("macro drop mcp_*", echo=False)
|
|
4041
|
+
|
|
4042
|
+
if preserved_rc > 0:
|
|
4043
|
+
self.stata.run(f"capture error {preserved_rc}", echo=False)
|
|
4044
|
+
else:
|
|
4045
|
+
self.stata.run("capture", echo=False)
|
|
4046
|
+
|
|
4047
|
+
self._last_results = results
|
|
4048
|
+
return results
|
|
4049
|
+
except Exception as e:
|
|
4050
|
+
logger.error(f"SFI-based get_stored_results failed: {e}")
|
|
4051
|
+
return {"r": {}, "e": {}}
|
|
4052
|
+
|
|
4053
|
+
def invalidate_graph_cache(self, graph_name: str = None) -> None:
|
|
4054
|
+
"""Invalidate cache for specific graph or all graphs.
|
|
4055
|
+
|
|
4056
|
+
Args:
|
|
4057
|
+
graph_name: Specific graph name to invalidate. If None, clears all cache.
|
|
4058
|
+
"""
|
|
4059
|
+
self._initialize_cache()
|
|
4060
|
+
|
|
4061
|
+
with self._cache_lock:
|
|
4062
|
+
if graph_name is None:
|
|
4063
|
+
# Clear all cache
|
|
4064
|
+
self._preemptive_cache.clear()
|
|
4065
|
+
else:
|
|
4066
|
+
# Clear specific graph cache
|
|
4067
|
+
if graph_name in self._preemptive_cache:
|
|
4068
|
+
del self._preemptive_cache[graph_name]
|
|
4069
|
+
# Also clear hash if present
|
|
4070
|
+
hash_key = f"{graph_name}_hash"
|
|
4071
|
+
if hash_key in self._preemptive_cache:
|
|
4072
|
+
del self._preemptive_cache[hash_key]
|
|
4073
|
+
|
|
4074
|
+
def _initialize_cache(self) -> None:
|
|
4075
|
+
"""Initialize cache in a thread-safe manner."""
|
|
4076
|
+
import tempfile
|
|
4077
|
+
import threading
|
|
4078
|
+
import os
|
|
4079
|
+
import uuid
|
|
4080
|
+
|
|
4081
|
+
with StataClient._cache_init_lock: # Use class-level lock
|
|
4082
|
+
if not hasattr(self, '_cache_initialized'):
|
|
4083
|
+
self._preemptive_cache = {}
|
|
4084
|
+
self._cache_access_times = {} # Track access times for LRU
|
|
4085
|
+
self._cache_sizes = {} # Track individual cache item sizes
|
|
4086
|
+
self._total_cache_size = 0 # Track total cache size in bytes
|
|
4087
|
+
# Use unique identifier to avoid conflicts
|
|
4088
|
+
unique_id = f"preemptive_cache_{uuid.uuid4().hex[:8]}_{os.getpid()}"
|
|
4089
|
+
self._preemptive_cache_dir = tempfile.mkdtemp(prefix=unique_id, dir=get_writable_temp_dir())
|
|
4090
|
+
register_temp_dir(self._preemptive_cache_dir)
|
|
4091
|
+
self._cache_lock = threading.Lock()
|
|
4092
|
+
self._cache_initialized = True
|
|
4093
|
+
|
|
4094
|
+
# Register cleanup function
|
|
4095
|
+
import atexit
|
|
4096
|
+
atexit.register(self._cleanup_cache)
|
|
4097
|
+
else:
|
|
4098
|
+
# Cache already initialized, but directory might have been removed.
|
|
4099
|
+
if (not hasattr(self, '_preemptive_cache_dir') or
|
|
4100
|
+
not self._preemptive_cache_dir or
|
|
4101
|
+
not os.path.isdir(self._preemptive_cache_dir)):
|
|
4102
|
+
unique_id = f"preemptive_cache_{uuid.uuid4().hex[:8]}_{os.getpid()}"
|
|
4103
|
+
self._preemptive_cache_dir = tempfile.mkdtemp(prefix=unique_id, dir=get_writable_temp_dir())
|
|
4104
|
+
register_temp_dir(self._preemptive_cache_dir)
|
|
4105
|
+
|
|
4106
|
+
def _cleanup_cache(self) -> None:
|
|
4107
|
+
"""Clean up cache directory and files."""
|
|
4108
|
+
import os
|
|
4109
|
+
import shutil
|
|
4110
|
+
|
|
4111
|
+
if hasattr(self, '_preemptive_cache_dir') and self._preemptive_cache_dir:
|
|
4112
|
+
try:
|
|
4113
|
+
shutil.rmtree(self._preemptive_cache_dir, ignore_errors=True)
|
|
4114
|
+
except Exception:
|
|
4115
|
+
pass # Best effort cleanup
|
|
4116
|
+
|
|
4117
|
+
if hasattr(self, '_preemptive_cache'):
|
|
4118
|
+
self._preemptive_cache.clear()
|
|
4119
|
+
|
|
4120
|
+
def _evict_cache_if_needed(self, new_item_size: int = 0) -> None:
|
|
4121
|
+
"""
|
|
4122
|
+
Evict least recently used cache items if cache size limits are exceeded.
|
|
4123
|
+
|
|
4124
|
+
NOTE: The caller is responsible for holding ``self._cache_lock`` while
|
|
4125
|
+
invoking this method, so that eviction and subsequent cache insertion
|
|
4126
|
+
(if any) occur within a single critical section.
|
|
4127
|
+
"""
|
|
4128
|
+
import time
|
|
4129
|
+
|
|
4130
|
+
# Check if we need to evict based on count or size
|
|
4131
|
+
needs_eviction = (
|
|
4132
|
+
len(self._preemptive_cache) > StataClient.MAX_CACHE_SIZE or
|
|
4133
|
+
self._total_cache_size + new_item_size > StataClient.MAX_CACHE_BYTES
|
|
4134
|
+
)
|
|
4135
|
+
|
|
4136
|
+
if not needs_eviction:
|
|
4137
|
+
return
|
|
4138
|
+
|
|
4139
|
+
# Sort by access time (oldest first)
|
|
4140
|
+
items_by_access = sorted(
|
|
4141
|
+
self._cache_access_times.items(),
|
|
4142
|
+
key=lambda x: x[1]
|
|
4143
|
+
)
|
|
4144
|
+
|
|
4145
|
+
evicted_count = 0
|
|
4146
|
+
for graph_name, access_time in items_by_access:
|
|
4147
|
+
if (len(self._preemptive_cache) < StataClient.MAX_CACHE_SIZE and
|
|
4148
|
+
self._total_cache_size + new_item_size <= StataClient.MAX_CACHE_BYTES):
|
|
4149
|
+
break
|
|
4150
|
+
|
|
4151
|
+
# Remove from cache
|
|
4152
|
+
if graph_name in self._preemptive_cache:
|
|
4153
|
+
cache_path = self._preemptive_cache[graph_name]
|
|
4154
|
+
|
|
4155
|
+
# Remove file
|
|
4156
|
+
try:
|
|
4157
|
+
if os.path.exists(cache_path):
|
|
4158
|
+
os.remove(cache_path)
|
|
4159
|
+
except Exception:
|
|
4160
|
+
pass
|
|
4161
|
+
|
|
4162
|
+
# Update tracking
|
|
4163
|
+
item_size = self._cache_sizes.get(graph_name, 0)
|
|
4164
|
+
del self._preemptive_cache[graph_name]
|
|
4165
|
+
del self._cache_access_times[graph_name]
|
|
4166
|
+
if graph_name in self._cache_sizes:
|
|
4167
|
+
del self._cache_sizes[graph_name]
|
|
4168
|
+
self._total_cache_size -= item_size
|
|
4169
|
+
evicted_count += 1
|
|
4170
|
+
|
|
4171
|
+
# Remove hash entry if exists
|
|
4172
|
+
hash_key = f"{graph_name}_hash"
|
|
4173
|
+
if hash_key in self._preemptive_cache:
|
|
4174
|
+
del self._preemptive_cache[hash_key]
|
|
4175
|
+
|
|
4176
|
+
if evicted_count > 0:
|
|
4177
|
+
logger.debug(f"Evicted {evicted_count} items from graph cache due to size limits")
|
|
4178
|
+
|
|
4179
|
+
def _get_content_hash(self, data: bytes) -> str:
|
|
4180
|
+
"""Generate content hash for cache validation."""
|
|
4181
|
+
import hashlib
|
|
4182
|
+
return hashlib.md5(data).hexdigest()
|
|
4183
|
+
|
|
4184
|
+
def _sanitize_filename(self, name: str) -> str:
|
|
4185
|
+
"""Sanitize graph name for safe file system usage."""
|
|
4186
|
+
import re
|
|
4187
|
+
# Remove or replace problematic characters
|
|
4188
|
+
safe_name = re.sub(r'[<>:"/\\|?*]', '_', name)
|
|
4189
|
+
safe_name = re.sub(r'[^\w\-_.]', '_', safe_name)
|
|
4190
|
+
# Limit length
|
|
4191
|
+
return safe_name[:100] if len(safe_name) > 100 else safe_name
|
|
4192
|
+
|
|
4193
|
+
def _validate_graph_exists(self, graph_name: str) -> bool:
|
|
4194
|
+
"""Validate that graph still exists in Stata."""
|
|
4195
|
+
try:
|
|
4196
|
+
# First try to get graph list to verify existence
|
|
4197
|
+
graph_list = self.list_graphs(force_refresh=True)
|
|
4198
|
+
if graph_name not in graph_list:
|
|
4199
|
+
return False
|
|
4200
|
+
|
|
4201
|
+
# Additional validation by attempting to display the graph
|
|
4202
|
+
resolved = self._resolve_graph_name_for_stata(graph_name)
|
|
4203
|
+
cmd = f'quietly graph display {resolved}'
|
|
4204
|
+
resp = self._exec_no_capture_silent(cmd, echo=False)
|
|
4205
|
+
return resp.success
|
|
4206
|
+
except Exception:
|
|
4207
|
+
return False
|
|
4208
|
+
|
|
4209
|
+
def _is_cache_valid(self, graph_name: str, cache_path: str) -> bool:
|
|
4210
|
+
"""Check if cached content is still valid using internal signatures."""
|
|
4211
|
+
try:
|
|
4212
|
+
if not os.path.exists(cache_path) or os.path.getsize(cache_path) == 0:
|
|
4213
|
+
return False
|
|
4214
|
+
|
|
4215
|
+
current_sig = self._get_graph_signature(graph_name)
|
|
4216
|
+
cached_sig = self._preemptive_cache.get(f"{graph_name}_sig")
|
|
4217
|
+
|
|
4218
|
+
# If we have a signature match, it's valid for the current command session
|
|
4219
|
+
if cached_sig and cached_sig == current_sig:
|
|
4220
|
+
return True
|
|
4221
|
+
|
|
4222
|
+
# Otherwise it's invalid (needs refresh for new command)
|
|
4223
|
+
return False
|
|
4224
|
+
except Exception:
|
|
4225
|
+
return False
|
|
4226
|
+
|
|
4227
|
+
def export_graphs_all(self) -> GraphExportResponse:
|
|
4228
|
+
"""Exports all graphs to file paths."""
|
|
4229
|
+
exports: List[GraphExport] = []
|
|
4230
|
+
graph_names = self.list_graphs(force_refresh=True)
|
|
4231
|
+
|
|
4232
|
+
if not graph_names:
|
|
4233
|
+
return GraphExportResponse(graphs=exports)
|
|
4234
|
+
|
|
4235
|
+
import tempfile
|
|
4236
|
+
import os
|
|
4237
|
+
import threading
|
|
4238
|
+
import uuid
|
|
4239
|
+
import time
|
|
4240
|
+
import logging
|
|
4241
|
+
|
|
4242
|
+
# Initialize cache in thread-safe manner
|
|
4243
|
+
self._initialize_cache()
|
|
4244
|
+
|
|
4245
|
+
def _cache_keyed_svg_path(name: str) -> str:
|
|
4246
|
+
import hashlib
|
|
4247
|
+
safe_name = self._sanitize_filename(name)
|
|
4248
|
+
suffix = hashlib.md5((name or "").encode("utf-8")).hexdigest()[:8]
|
|
4249
|
+
return os.path.join(self._preemptive_cache_dir, f"{safe_name}_{suffix}.svg")
|
|
4250
|
+
|
|
4251
|
+
def _export_svg_bytes(name: str) -> bytes:
|
|
4252
|
+
resolved = self._resolve_graph_name_for_stata(name)
|
|
4253
|
+
|
|
4254
|
+
temp_dir = get_writable_temp_dir()
|
|
4255
|
+
safe_temp_name = self._sanitize_filename(name)
|
|
4256
|
+
unique_filename = f"{safe_temp_name}_{uuid.uuid4().hex[:8]}_{os.getpid()}_{int(time.time())}.svg"
|
|
4257
|
+
svg_path = os.path.join(temp_dir, unique_filename)
|
|
4258
|
+
svg_path_for_stata = svg_path.replace("\\", "/")
|
|
4259
|
+
|
|
4260
|
+
try:
|
|
4261
|
+
# We use name identifier WITHOUT quotes for Stata 19 compatibility
|
|
4262
|
+
# but we use quotes for the file path.
|
|
4263
|
+
export_cmd = f'quietly graph export "{svg_path_for_stata}", name({resolved}) replace as(svg)'
|
|
4264
|
+
export_resp = self._exec_no_capture_silent(export_cmd, echo=False)
|
|
4265
|
+
|
|
4266
|
+
if not export_resp.success:
|
|
4267
|
+
# Fallback for complex names if the unquoted version failed
|
|
4268
|
+
# but only if it's not a generic r(1)
|
|
4269
|
+
if export_resp.rc != 1:
|
|
4270
|
+
export_cmd_quoted = f'quietly graph export "{svg_path_for_stata}", name("{resolved}") replace as(svg)'
|
|
4271
|
+
export_resp = self._exec_no_capture_silent(export_cmd_quoted, echo=False)
|
|
4272
|
+
|
|
4273
|
+
if not export_resp.success:
|
|
4274
|
+
# Final resort: display and then export active
|
|
4275
|
+
display_cmd = f'quietly graph display {resolved}'
|
|
4276
|
+
display_resp = self._exec_no_capture_silent(display_cmd, echo=False)
|
|
4277
|
+
if display_resp.success:
|
|
4278
|
+
export_cmd2 = f'quietly graph export "{svg_path_for_stata}", replace as(svg)'
|
|
4279
|
+
export_resp = self._exec_no_capture_silent(export_cmd2, echo=False)
|
|
4280
|
+
else:
|
|
4281
|
+
export_resp = display_resp
|
|
4282
|
+
|
|
4283
|
+
if export_resp.success and os.path.exists(svg_path) and os.path.getsize(svg_path) > 0:
|
|
4284
|
+
with open(svg_path, "rb") as f:
|
|
4285
|
+
return f.read()
|
|
4286
|
+
error_msg = getattr(export_resp, 'error', 'Unknown error')
|
|
4287
|
+
raise RuntimeError(f"Failed to export graph {name}: {error_msg}")
|
|
4288
|
+
finally:
|
|
4289
|
+
if os.path.exists(svg_path):
|
|
4290
|
+
try:
|
|
4291
|
+
os.remove(svg_path)
|
|
4292
|
+
except OSError as e:
|
|
4293
|
+
logger.warning(f"Failed to cleanup temp file {svg_path}: {e}")
|
|
4294
|
+
|
|
4295
|
+
cached_graphs = {}
|
|
4296
|
+
uncached_graphs = []
|
|
4297
|
+
cache_errors = []
|
|
4298
|
+
|
|
4299
|
+
with self._cache_lock:
|
|
4300
|
+
for name in graph_names:
|
|
4301
|
+
if name in self._preemptive_cache:
|
|
4302
|
+
cached_path = self._preemptive_cache[name]
|
|
4303
|
+
if os.path.exists(cached_path) and os.path.getsize(cached_path) > 0:
|
|
4304
|
+
# Additional validation: check if graph content has changed
|
|
4305
|
+
if self._is_cache_valid(name, cached_path):
|
|
4306
|
+
cached_graphs[name] = cached_path
|
|
4307
|
+
else:
|
|
4308
|
+
uncached_graphs.append(name)
|
|
4309
|
+
# Remove stale cache entry
|
|
4310
|
+
del self._preemptive_cache[name]
|
|
4311
|
+
else:
|
|
4312
|
+
uncached_graphs.append(name)
|
|
4313
|
+
# Remove invalid cache entry
|
|
4314
|
+
if name in self._preemptive_cache:
|
|
4315
|
+
del self._preemptive_cache[name]
|
|
4316
|
+
else:
|
|
4317
|
+
uncached_graphs.append(name)
|
|
4318
|
+
|
|
4319
|
+
for name, cached_path in cached_graphs.items():
|
|
4320
|
+
try:
|
|
4321
|
+
exports.append(GraphExport(name=name, file_path=cached_path))
|
|
4322
|
+
except Exception as e:
|
|
4323
|
+
cache_errors.append(f"Failed to read cached graph {name}: {e}")
|
|
4324
|
+
# Fall back to uncached processing
|
|
4325
|
+
uncached_graphs.append(name)
|
|
4326
|
+
|
|
4327
|
+
if uncached_graphs:
|
|
4328
|
+
successful_graphs = []
|
|
4329
|
+
failed_graphs = []
|
|
4330
|
+
memory_results = {}
|
|
4331
|
+
|
|
4332
|
+
for name in uncached_graphs:
|
|
4333
|
+
try:
|
|
4334
|
+
svg_data = _export_svg_bytes(name)
|
|
4335
|
+
memory_results[name] = svg_data
|
|
4336
|
+
successful_graphs.append(name)
|
|
4337
|
+
except Exception as e:
|
|
4338
|
+
failed_graphs.append(name)
|
|
4339
|
+
cache_errors.append(f"Failed to cache graph {name}: {e}")
|
|
4340
|
+
|
|
4341
|
+
for name in successful_graphs:
|
|
4342
|
+
result = memory_results[name]
|
|
4343
|
+
|
|
4344
|
+
cache_path = _cache_keyed_svg_path(name)
|
|
4345
|
+
|
|
4346
|
+
try:
|
|
4347
|
+
with open(cache_path, 'wb') as f:
|
|
4348
|
+
f.write(result)
|
|
4349
|
+
|
|
4350
|
+
# Update cache with size tracking and eviction
|
|
4351
|
+
import time
|
|
4352
|
+
item_size = len(result)
|
|
4353
|
+
self._evict_cache_if_needed(item_size)
|
|
4354
|
+
|
|
4355
|
+
with self._cache_lock:
|
|
4356
|
+
self._preemptive_cache[name] = cache_path
|
|
4357
|
+
# Store content hash for validation
|
|
4358
|
+
self._preemptive_cache[f"{name}_hash"] = self._get_content_hash(result)
|
|
4359
|
+
# Update tracking
|
|
4360
|
+
self._cache_access_times[name] = time.time()
|
|
4361
|
+
self._cache_sizes[name] = item_size
|
|
4362
|
+
self._total_cache_size += item_size
|
|
4363
|
+
|
|
4364
|
+
exports.append(GraphExport(name=name, file_path=cache_path))
|
|
4365
|
+
except Exception as e:
|
|
4366
|
+
cache_errors.append(f"Failed to cache graph {name}: {e}")
|
|
4367
|
+
# Still return the result even if caching fails
|
|
4368
|
+
# Create temp file for immediate use
|
|
4369
|
+
safe_name = self._sanitize_filename(name)
|
|
4370
|
+
temp_path = os.path.join(get_writable_temp_dir(), f"{safe_name}_{uuid.uuid4().hex[:8]}.svg")
|
|
4371
|
+
with open(temp_path, 'wb') as f:
|
|
4372
|
+
f.write(result)
|
|
4373
|
+
register_temp_file(temp_path)
|
|
4374
|
+
exports.append(GraphExport(name=name, file_path=temp_path))
|
|
4375
|
+
|
|
4376
|
+
# Log errors if any occurred
|
|
4377
|
+
if cache_errors:
|
|
4378
|
+
logger = logging.getLogger(__name__)
|
|
4379
|
+
for error in cache_errors:
|
|
4380
|
+
logger.warning(error)
|
|
4381
|
+
|
|
4382
|
+
return GraphExportResponse(graphs=exports)
|
|
4383
|
+
|
|
4384
|
+
def cache_graph_on_creation(self, graph_name: str) -> bool:
|
|
4385
|
+
"""Revolutionary method to cache a graph immediately after creation.
|
|
4386
|
+
|
|
4387
|
+
Call this method right after creating a graph to pre-emptively cache it.
|
|
4388
|
+
This eliminates all export wait time for future access.
|
|
4389
|
+
|
|
4390
|
+
Args:
|
|
4391
|
+
graph_name: Name of the graph to cache
|
|
4392
|
+
|
|
4393
|
+
Returns:
|
|
4394
|
+
True if caching succeeded, False otherwise
|
|
4395
|
+
"""
|
|
4396
|
+
import os
|
|
4397
|
+
import logging
|
|
4398
|
+
logger = logging.getLogger("mcp_stata.stata_client")
|
|
4399
|
+
|
|
4400
|
+
# Initialize cache in thread-safe manner
|
|
4401
|
+
self._initialize_cache()
|
|
4402
|
+
|
|
4403
|
+
# Invalidate list_graphs cache since a new graph was created
|
|
4404
|
+
self.invalidate_list_graphs_cache()
|
|
4405
|
+
|
|
4406
|
+
# Check if already cached and valid
|
|
4407
|
+
with self._cache_lock:
|
|
4408
|
+
if graph_name in self._preemptive_cache:
|
|
4409
|
+
cache_path = self._preemptive_cache[graph_name]
|
|
4410
|
+
if os.path.exists(cache_path) and os.path.getsize(cache_path) > 0:
|
|
4411
|
+
if self._is_cache_valid(graph_name, cache_path):
|
|
4412
|
+
# Update access time for LRU
|
|
4413
|
+
import time
|
|
4414
|
+
self._cache_access_times[graph_name] = time.time()
|
|
4415
|
+
return True
|
|
4416
|
+
else:
|
|
4417
|
+
# Remove stale cache entry
|
|
4418
|
+
del self._preemptive_cache[graph_name]
|
|
4419
|
+
if graph_name in self._cache_access_times:
|
|
4420
|
+
del self._cache_access_times[graph_name]
|
|
4421
|
+
if graph_name in self._cache_sizes:
|
|
4422
|
+
self._total_cache_size -= self._cache_sizes[graph_name]
|
|
4423
|
+
del self._cache_sizes[graph_name]
|
|
4424
|
+
# Remove hash entry if exists
|
|
4425
|
+
hash_key = f"{graph_name}_hash"
|
|
4426
|
+
if hash_key in self._preemptive_cache:
|
|
4427
|
+
del self._preemptive_cache[hash_key]
|
|
4428
|
+
|
|
4429
|
+
try:
|
|
4430
|
+
# Include signature in filename to force client-side refresh
|
|
4431
|
+
import hashlib
|
|
4432
|
+
sig = self._get_graph_signature(graph_name)
|
|
4433
|
+
safe_name = self._sanitize_filename(sig)
|
|
4434
|
+
suffix = hashlib.md5((sig or "").encode("utf-8")).hexdigest()[:8]
|
|
4435
|
+
cache_path = os.path.join(self._preemptive_cache_dir, f"{safe_name}_{suffix}.svg")
|
|
4436
|
+
cache_path_for_stata = cache_path.replace("\\", "/")
|
|
4437
|
+
|
|
4438
|
+
resolved_graph_name = self._resolve_graph_name_for_stata(graph_name)
|
|
4439
|
+
safe_name = resolved_graph_name.strip()
|
|
4440
|
+
|
|
4441
|
+
# The most reliable and efficient strategy for capturing distinct graphs in
|
|
4442
|
+
# PyStata background tasks:
|
|
4443
|
+
# 1. Ensure the specific graph is active in the Stata engine via 'graph display'.
|
|
4444
|
+
# 2. Export with the explicit name() option to ensure isolation.
|
|
4445
|
+
# Graph names in Stata should NOT be quoted.
|
|
4446
|
+
|
|
4447
|
+
maintenance = [
|
|
4448
|
+
f"quietly graph display {safe_name}",
|
|
4449
|
+
f"quietly graph export \"{cache_path_for_stata}\", name({safe_name}) replace as(svg)"
|
|
4450
|
+
]
|
|
4451
|
+
|
|
4452
|
+
resp = self._exec_no_capture_silent("\n".join(maintenance), echo=False)
|
|
4453
|
+
|
|
4454
|
+
if resp.success and os.path.exists(cache_path) and os.path.getsize(cache_path) > 0:
|
|
4455
|
+
# Read the data to compute hash
|
|
4456
|
+
with open(cache_path, 'rb') as f:
|
|
4457
|
+
data = f.read()
|
|
4458
|
+
|
|
4459
|
+
# Update cache with size tracking and eviction
|
|
4460
|
+
import time
|
|
4461
|
+
item_size = len(data)
|
|
4462
|
+
self._evict_cache_if_needed(item_size)
|
|
4463
|
+
|
|
4464
|
+
with self._cache_lock:
|
|
4465
|
+
# Clear any old versions of this graph from the path cache
|
|
4466
|
+
# (Optional but keeps it clean)
|
|
4467
|
+
old_path = self._preemptive_cache.get(graph_name)
|
|
4468
|
+
if old_path and old_path != cache_path:
|
|
4469
|
+
try:
|
|
4470
|
+
os.remove(old_path)
|
|
4471
|
+
except Exception:
|
|
4472
|
+
pass
|
|
4473
|
+
|
|
4474
|
+
self._preemptive_cache[graph_name] = cache_path
|
|
4475
|
+
# Store content hash for validation
|
|
4476
|
+
self._preemptive_cache[f"{graph_name}_hash"] = self._get_content_hash(data)
|
|
4477
|
+
# Store signature for fast validation
|
|
4478
|
+
self._preemptive_cache[f"{graph_name}_sig"] = self._get_graph_signature(graph_name)
|
|
4479
|
+
# Update tracking
|
|
4480
|
+
self._cache_access_times[graph_name] = time.time()
|
|
4481
|
+
self._cache_sizes[graph_name] = item_size
|
|
4482
|
+
self._total_cache_size += item_size
|
|
4483
|
+
|
|
4484
|
+
return True
|
|
4485
|
+
else:
|
|
4486
|
+
error_msg = getattr(resp, 'error', 'Unknown error')
|
|
4487
|
+
logger = logging.getLogger(__name__)
|
|
4488
|
+
logger.warning(f"Failed to cache graph {graph_name}: {error_msg}")
|
|
4489
|
+
|
|
4490
|
+
except Exception as e:
|
|
4491
|
+
logger = logging.getLogger(__name__)
|
|
4492
|
+
logger.warning(f"Exception caching graph {graph_name}: {e}")
|
|
4493
|
+
|
|
4494
|
+
return False
|
|
4495
|
+
|
|
4496
|
+
def run_do_file(self, path: str, echo: bool = True, trace: bool = False, max_output_lines: Optional[int] = None, cwd: Optional[str] = None) -> CommandResponse:
|
|
4497
|
+
effective_path, command, error_response = self._resolve_do_file_path(path, cwd)
|
|
4498
|
+
if error_response is not None:
|
|
4499
|
+
return error_response
|
|
4500
|
+
|
|
4501
|
+
if not self._initialized:
|
|
4502
|
+
self.init()
|
|
4503
|
+
|
|
4504
|
+
start_time = time.time()
|
|
4505
|
+
exc: Optional[Exception] = None
|
|
4506
|
+
smcl_content = ""
|
|
4507
|
+
smcl_path = None
|
|
4508
|
+
|
|
4509
|
+
_log_file, log_path, tail, tee = self._create_streaming_log(trace=trace)
|
|
4510
|
+
smcl_path = self._create_smcl_log_path()
|
|
4511
|
+
smcl_log_name = self._make_smcl_log_name()
|
|
4512
|
+
|
|
4513
|
+
rc = -1
|
|
4514
|
+
try:
|
|
4515
|
+
rc, exc = self._run_streaming_blocking(
|
|
4516
|
+
command=command,
|
|
4517
|
+
tee=tee,
|
|
4518
|
+
cwd=cwd,
|
|
4519
|
+
trace=trace,
|
|
4520
|
+
echo=echo,
|
|
4521
|
+
smcl_path=smcl_path,
|
|
4522
|
+
smcl_log_name=smcl_log_name,
|
|
4523
|
+
hold_attr="_hold_name_do_sync",
|
|
4524
|
+
require_smcl_log=True,
|
|
4525
|
+
)
|
|
4526
|
+
except Exception as e:
|
|
4527
|
+
exc = e
|
|
4528
|
+
rc = 1
|
|
4529
|
+
finally:
|
|
4530
|
+
tee.close()
|
|
4531
|
+
|
|
4532
|
+
# Read SMCL content as the authoritative source
|
|
4533
|
+
smcl_content = self._read_smcl_file(smcl_path)
|
|
4534
|
+
smcl_content = self._clean_internal_smcl(smcl_content, strip_output=False)
|
|
4535
|
+
|
|
4536
|
+
combined = self._build_combined_log(tail, log_path, rc, trace, exc)
|
|
4537
|
+
|
|
4538
|
+
# Use SMCL content as primary source for RC detection if not already captured
|
|
4539
|
+
if rc == -1 and not exc:
|
|
4540
|
+
parsed_rc = self._parse_rc_from_smcl(smcl_content)
|
|
4541
|
+
if parsed_rc is not None:
|
|
4542
|
+
rc = parsed_rc
|
|
4543
|
+
else:
|
|
4544
|
+
# Fallback to text parsing
|
|
4545
|
+
parsed_rc = self._parse_rc_from_text(combined)
|
|
4546
|
+
rc = parsed_rc if parsed_rc is not None else 0
|
|
4547
|
+
elif exc and rc == 1:
|
|
4548
|
+
# Try to parse more specific RC from exception message
|
|
4549
|
+
parsed_rc = self._parse_rc_from_text(str(exc))
|
|
4550
|
+
if parsed_rc is not None:
|
|
4551
|
+
rc = parsed_rc
|
|
4552
|
+
|
|
4553
|
+
# If RC looks wrong but SMCL shows no error markers, treat as success.
|
|
4554
|
+
if rc != 0 and smcl_content:
|
|
4555
|
+
has_err_tag = "{err}" in smcl_content
|
|
4556
|
+
rc_match = re.search(r"(?<!\w)r\((\d+)\)", smcl_content)
|
|
4557
|
+
if rc_match:
|
|
4558
|
+
try:
|
|
4559
|
+
rc = int(rc_match.group(1))
|
|
4560
|
+
except Exception:
|
|
4561
|
+
pass
|
|
4562
|
+
else:
|
|
4563
|
+
text_rc = None
|
|
4564
|
+
try:
|
|
4565
|
+
text_rc = self._parse_rc_from_text(self._smcl_to_text(smcl_content))
|
|
4566
|
+
except Exception:
|
|
4567
|
+
text_rc = None
|
|
4568
|
+
if not has_err_tag and text_rc is None:
|
|
4569
|
+
rc = 0
|
|
4570
|
+
|
|
4571
|
+
success = (rc == 0 and exc is None)
|
|
4572
|
+
error = None
|
|
4573
|
+
|
|
4574
|
+
if not success:
|
|
4575
|
+
# Use SMCL as authoritative source for error extraction
|
|
4576
|
+
if smcl_content:
|
|
4577
|
+
msg, context = self._extract_error_from_smcl(smcl_content, rc)
|
|
4578
|
+
else:
|
|
4579
|
+
# Fallback to combined log
|
|
4580
|
+
msg, context = self._extract_error_and_context(combined, rc)
|
|
4581
|
+
|
|
4582
|
+
error = ErrorEnvelope(
|
|
4583
|
+
message=msg,
|
|
4584
|
+
rc=rc,
|
|
4585
|
+
snippet=context,
|
|
4586
|
+
command=command,
|
|
4587
|
+
log_path=log_path,
|
|
4588
|
+
smcl_output=smcl_content,
|
|
4589
|
+
)
|
|
4590
|
+
|
|
4591
|
+
duration = time.time() - start_time
|
|
4592
|
+
logger.info(
|
|
4593
|
+
"stata.run(do) rc=%s success=%s trace=%s duration_ms=%.2f path=%s",
|
|
4594
|
+
rc,
|
|
4595
|
+
success,
|
|
4596
|
+
trace,
|
|
4597
|
+
duration * 1000,
|
|
4598
|
+
effective_path,
|
|
4599
|
+
)
|
|
4600
|
+
|
|
4601
|
+
try:
|
|
4602
|
+
with open(log_path, "w", encoding="utf-8", errors="replace") as handle:
|
|
4603
|
+
handle.write(smcl_content)
|
|
4604
|
+
except Exception:
|
|
4605
|
+
pass
|
|
4606
|
+
|
|
4607
|
+
return CommandResponse(
|
|
4608
|
+
command=command,
|
|
4609
|
+
rc=rc,
|
|
4610
|
+
stdout="",
|
|
4611
|
+
stderr=None,
|
|
4612
|
+
log_path=log_path,
|
|
4613
|
+
success=success,
|
|
4614
|
+
error=error,
|
|
4615
|
+
smcl_output=smcl_content,
|
|
4616
|
+
)
|
|
4617
|
+
|
|
4618
|
+
def load_data(self, source: str, clear: bool = True, max_output_lines: Optional[int] = None) -> CommandResponse:
|
|
4619
|
+
src = source.strip()
|
|
4620
|
+
clear_suffix = ", clear" if clear else ""
|
|
4621
|
+
|
|
4622
|
+
if src.startswith("sysuse "):
|
|
4623
|
+
cmd = f"{src}{clear_suffix}"
|
|
4624
|
+
elif src.startswith("webuse "):
|
|
4625
|
+
cmd = f"{src}{clear_suffix}"
|
|
4626
|
+
elif src.startswith("use "):
|
|
4627
|
+
cmd = f"{src}{clear_suffix}"
|
|
4628
|
+
elif "://" in src or src.endswith(".dta") or os.path.sep in src:
|
|
4629
|
+
cmd = f'use "{src}"{clear_suffix}'
|
|
4630
|
+
else:
|
|
4631
|
+
cmd = f"sysuse {src}{clear_suffix}"
|
|
4632
|
+
|
|
4633
|
+
result = self._exec_with_capture(cmd, echo=True, trace=False)
|
|
4634
|
+
return self._truncate_command_output(result, max_output_lines)
|
|
4635
|
+
|
|
4636
|
+
def codebook(self, varname: str, trace: bool = False, max_output_lines: Optional[int] = None) -> CommandResponse:
|
|
4637
|
+
result = self._exec_with_capture(f"codebook {varname}", trace=trace)
|
|
4638
|
+
return self._truncate_command_output(result, max_output_lines)
|