forked from balisujohn/localwriter
-
Notifications
You must be signed in to change notification settings - Fork 14
Expand file tree
/
Copy pathfunction.py
More file actions
778 lines (670 loc) · 32.3 KB
/
Copy pathfunction.py
File metadata and controls
778 lines (670 loc) · 32.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
# WriterAgent - AI Writing Assistant for LibreOffice
# Copyright (c) 2024 John Balis
# Copyright (c) 2026 KeithCu (modifications and relicensing)
#
# SPDX-License-Identifier: GPL-3.0-or-later
"""=PY() execution and return helpers (venv worker); no LLM imports."""
from __future__ import annotations
import logging
import math
import threading
from typing import Any, cast
from plugin.calc.calc_addin_data import (
calc_addin_args_from_split,
check_python_data_size,
check_python_multi_data_size,
count_cells,
pack_calc_data_for_wire,
pack_calc_multi_data_for_wire,
split_python_addin_data_args,
)
from plugin.calc.python.image_egress import insert_image_result_on_sheet
from plugin.framework.errors import format_error_payload
from plugin.framework.i18n import _
from plugin.scripting.config_limits import configured_python_max_data_cells
from plugin.scripting.payload_codec import is_dataframe_payload, is_split_grid, find_image_payloads
from plugin.scripting.calc_range import dataframe_to_labeled_grid
# Optional: reset worker init/cell sessions on workbook close (see python_workbook_lifecycle.py).
# from plugin.calc.python.workbook_lifecycle import ensure_calc_workbook_unload_resets_python
from plugin.scripting.document_scripts import build_python_eval_init_kwargs, get_calc_document_from_ctx
from plugin.scripting.session_manager import workbook_session_id
from plugin.scripting.venv_worker import run_code_in_user_venv
log = logging.getLogger(__name__)
# Calc legacy add-in bridge accepts scalar double/string returns only. List results are
# emitted one scalar per formula evaluation (matrix block or repeated recalc).
MATRIX_SCALAR_SESSIONS = threading.local()
def flatten_result_values(result: Any) -> list:
"""Row-major flattening for list / nested list worker results."""
if not isinstance(result, (list, tuple)):
return [result]
if not result:
return []
if isinstance(result[0], (list, tuple)):
flat: list = []
for row in result:
flat.extend(row)
return flat
return list(result)
def is_scalar_index_arg(py_data: list | list[list] | None) -> bool:
"""True when arg 1 is one number (matrix index), not a data range."""
if py_data is None:
return False
return count_cells(py_data) == 1
def _unwrap_single_cell(py_data: Any) -> Any:
"""Unwrap ``[[v]]`` / ``[v]`` / scalar to the inner value."""
val = py_data
while isinstance(val, list) and len(val) == 1:
val = val[0]
return val
# Tests and legacy imports
_is_scalar_index_arg = is_scalar_index_arg
def result_to_calc_grid(result: Any, *, include_dataframe_header: bool = True) -> Any:
"""Normalize worker results for Calc consumers.
DataFrame envelopes become a labeled 2D grid (header row + body) by default.
Lists/ndarrays (already unpacked on host) pass through unchanged.
"""
if is_dataframe_payload(result):
cols = list(result.get("columns") or [])
data = result.get("data")
return dataframe_to_labeled_grid(cols, data if isinstance(data, list) else [], include_header=include_dataframe_header)
return result
def coerce_index(value: Any) -> int:
if value is None:
return 0
if isinstance(value, bool):
return int(value)
if isinstance(value, int):
return value
if isinstance(value, float):
return int(value)
if isinstance(value, str) and value.strip():
return int(float(value))
raise ValueError(f"index must be numeric, got {value!r}")
def to_calc_compatible(val: Any) -> float | str | bool | tuple:
"""Recursively convert Python values into LibreOffice Calc supported types.
Calc cells only support float (UNO double), str (UNO string), and bool (UNO boolean).
Crucially, Calc matrix formulas do NOT support integer (UNO long) types and will
throw #VALUE! if a sequence contains integers/longs.
"""
if val is None:
return ""
if isinstance(val, bool):
return val
if isinstance(val, int):
return float(val)
if isinstance(val, float):
# Computed NaN (or NaN from a numeric grid that contained blanks) is returned as-is.
# The Calc add-in bridge renders a raw NaN double as a cascading error (#NUM! or #VALUE!).
# Python None is mapped to "" (empty cell). We intentionally do NOT collapse NaN here.
if math.isnan(val):
return val
return val
if isinstance(val, str):
return val
if isinstance(val, (list, tuple)):
inner = val[0] if val else None
if isinstance(inner, (list, tuple)):
return tuple(tuple(to_calc_compatible(cell) for cell in row) for row in val)
return tuple(to_calc_compatible(item) for item in val)
return str(val)
def _get_calc_doc(ctx: Any) -> Any | None:
try:
from plugin.framework.uno_context import get_desktop
desktop = get_desktop(ctx)
doc = desktop.getCurrentComponent()
if doc is not None and hasattr(doc, "getSheets"):
return doc
comps = desktop.getComponents()
if comps:
enum = comps.createEnumeration()
while enum and enum.hasMoreElements():
elem = enum.nextElement()
model = None
if hasattr(elem, "getURL") and callable(getattr(elem, "getURL")):
model = elem
elif hasattr(elem, "getController") and elem.getController():
model = elem.getController().getModel()
if model and hasattr(model, "getSheets"):
return model
except Exception:
pass
return None
def session_key(ctx: Any, code: str) -> tuple:
from plugin.framework.thread_guard import on_main_thread
from plugin.framework.queue_executor import execute_on_main_thread
def _session_key_impl() -> tuple:
doc_url = ""
sheet_name = ""
try:
if not (hasattr(ctx, "ServiceManager") or hasattr(ctx, "getServiceManager")):
return (doc_url, sheet_name, code)
doc = _get_calc_doc(ctx)
if doc is not None:
doc_url = getattr(doc, "getURL", lambda: "")() or ""
ctrl = getattr(doc, "getCurrentController", lambda: None)()
if ctrl is not None:
sheet = ctrl.getActiveSheet()
if sheet is not None:
sheet_name = sheet.getName()
except Exception:
pass
return (doc_url, sheet_name, code)
if not on_main_thread():
return execute_on_main_thread(_session_key_impl)
return _session_key_impl()
class WorkerResultSession:
"""Caches one worker list result across multiple =PY() calls in a recalc pass."""
__slots__ = ("raw", "flat", "next_index")
def __init__(self, raw: Any, flat: list) -> None:
self.raw = raw
self.flat = tuple(flat)
self.next_index = 0
# Legacy alias for tests
_WorkerResultSession = WorkerResultSession
def scalar_for_list_result(ctx: Any, code: str, result: Any, *, worker_data: Any = None) -> float | str | bool:
"""Return one Calc scalar per invocation when the worker produced a list."""
flat: list = [to_calc_compatible(v) for v in flatten_result_values(result)]
if not flat:
return ""
key = (session_key(ctx, code), repr(worker_data))
sessions = getattr(MATRIX_SCALAR_SESSIONS, "sessions", None)
if sessions is None:
sessions = {}
MATRIX_SCALAR_SESSIONS.sessions = sessions
state = sessions.get(key)
if not isinstance(state, WorkerResultSession) or state.flat != tuple(flat):
state = WorkerResultSession(result, flat)
sessions[key] = state
idx = state.next_index
state.next_index = idx + 1
if state.next_index >= len(state.flat):
sessions.pop(key, None)
if 0 <= idx < len(state.flat):
return state.flat[idx]
return state.flat[-1] if state.flat else ""
# The spill registry tracks coordinates that were spilled by each formula cell.
# Key: (doc_url, sheet_name, formula_row, formula_col)
# Value: list of (spilled_row, spilled_col) coordinates
SPILL_REGISTRY: dict[tuple[str, str, int, int], list[tuple[int, int]]] = {}
LOADED_DOCUMENTS: set[str] = set()
import unohelper
from com.sun.star.util import XModifyListener
SHEET_MODIFY_LISTENERS: dict[tuple[str, str], CalcSpillModifyListener] = {}
class CalcSpillModifyListener(unohelper.Base, XModifyListener):
"""Listens to sheet changes to automatically clean up orphaned spilled cells."""
def __init__(self, ctx: Any, doc_url: str, sheet_name: str) -> None:
self.ctx = ctx
self.doc_url = doc_url
self.sheet_name = sheet_name
def modified(self, aEvent: Any) -> None:
try:
sheet = aEvent.Source
if sheet is None:
return
to_remove = []
for key, value in list(SPILL_REGISTRY.items()):
doc_url, sheet_name, frow, fcol = key
if doc_url == self.doc_url and sheet_name == self.sheet_name:
try:
cell = sheet.getCellByPosition(fcol, frow)
formula = cell.getFormula()
if not formula or not (("PYTHON" in formula or "PY" in formula)):
# Clear previously spilled cells
for r, c in value:
if (r, c) != (frow, fcol):
try:
spill_cell = sheet.getCellByPosition(c, r)
spill_cell.clearContents(23)
except Exception:
pass
to_remove.append(key)
except Exception:
log.debug("Failed to inspect formula cell %r", key, exc_info=True)
if to_remove:
for key in to_remove:
SPILL_REGISTRY.pop(key, None)
doc = _get_calc_doc(self.ctx)
if doc is not None:
save_spill_registry_for_doc(doc)
except Exception:
log.exception("Error in CalcSpillModifyListener.modified")
def disposing(self, Source: Any) -> None: # noqa: N802, N803 -- UNO signature
SHEET_MODIFY_LISTENERS.pop((self.doc_url, self.sheet_name), None)
def load_spill_registry_for_doc(doc: Any) -> None:
"""Load the document's spill registry from its UserDefinedProperties."""
try:
from plugin.doc.document_helpers import get_document_property
import json
raw = get_document_property(doc, "WriterAgentSpillRegistry", None)
if not isinstance(raw, str) or not raw.strip():
return
data = json.loads(raw)
doc_url = getattr(doc, "getURL", lambda: "")() or ""
for key, value in data.items():
parts = key.split(":")
if len(parts) == 2:
sheet_name, coords = parts
row_col = coords.split(",")
if len(row_col) == 2:
frow, fcol = int(row_col[0]), int(row_col[1])
spill_coords = [(int(r), int(c)) for r, c in value]
SPILL_REGISTRY[(doc_url, sheet_name, frow, fcol)] = spill_coords
except Exception:
log.exception("Failed to load spill registry from document property")
def save_spill_registry_for_doc(doc: Any) -> None:
"""Save the document's spill registry to its UserDefinedProperties."""
try:
from plugin.doc.document_helpers import set_document_property
import json
doc_url = getattr(doc, "getURL", lambda: "")() or ""
doc_spills = {}
for key, value in SPILL_REGISTRY.items():
k_url, sheet_name, frow, fcol = key
if k_url == doc_url:
doc_spills[f"{sheet_name}:{frow},{fcol}"] = value
set_document_property(doc, "WriterAgentSpillRegistry", json.dumps(doc_spills))
except Exception:
log.exception("Failed to save spill registry to document property")
def locate_formula_cell(ctx: Any, sheet: Any, code_str: str) -> tuple[int, int] | None:
"""Find the row and column coordinates of the cell containing the Python formula."""
# 1. Fast-path: check active selection and adjacent cells (above, left)
try:
if not (hasattr(ctx, "ServiceManager") or hasattr(ctx, "getServiceManager")):
return None
doc = _get_calc_doc(ctx)
if doc is not None:
ctrl = doc.getCurrentController()
if ctrl is not None:
selection = ctrl.getSelection()
if selection is not None and hasattr(selection, "getRangeAddress"):
addr = selection.getRangeAddress()
candidates = [
(addr.StartRow, addr.StartColumn),
(addr.StartRow - 1, addr.StartColumn),
(addr.StartRow, addr.StartColumn - 1),
]
for r, c in candidates:
if r >= 0 and c >= 0:
cell = sheet.getCellByPosition(c, r)
formula = cell.getFormula()
if ("PYTHON" in formula or "PY" in formula) and code_str in formula:
return (r, c)
except Exception:
pass
# 2. Fallback: query the sheet for formula cells
try:
# com.sun.star.sheet.CellFlags.FORMULA = 16
formula_cells = sheet.queryContentCells(16)
if formula_cells is not None:
for i in range(formula_cells.getCount()):
cell_range = formula_cells.getByIndex(i)
addr = cell_range.getRangeAddress()
for r in range(addr.StartRow, addr.EndRow + 1):
for c in range(addr.StartColumn, addr.EndColumn + 1):
cell = sheet.getCellByPosition(c, r)
formula = cell.getFormula()
if ("PYTHON" in formula or "PY" in formula) and code_str in formula:
return (r, c)
except Exception:
pass
return None
def perform_deferred_spill(
ctx: Any,
doc_url: str,
sheet_name: str,
formula_row: int,
formula_col: int,
grid: list[list[Any]]
) -> None:
"""Clear old spilled cells and write new values deferred (collision check is done synchronously)."""
try:
if not (hasattr(ctx, "ServiceManager") or hasattr(ctx, "getServiceManager")):
return
doc = _get_calc_doc(ctx)
if doc is None:
return
current_url = getattr(doc, "getURL", lambda: "")() or ""
if current_url != doc_url:
return
sheet = doc.getSheets().getByName(sheet_name)
if sheet is None:
return
reg_key = (doc_url, sheet_name, formula_row, formula_col)
# 1. Clear previously spilled cells
previous_spills = SPILL_REGISTRY.get(reg_key, [])
for r, c in previous_spills:
if (r, c) != (formula_row, formula_col):
try:
cell = sheet.getCellByPosition(c, r)
# Clear contents: VALUE, DATETIME, STRING, FORMULA (23)
cell.clearContents(23)
except Exception:
pass
# 2. Determine bounds
num_rows = len(grid)
num_cols = max(len(row) for row in grid) if num_rows > 0 else 0
if num_rows == 0 or num_cols == 0:
SPILL_REGISTRY[reg_key] = []
save_spill_registry_for_doc(doc)
return
# 3. Coerce and pad grid values for rectangular setDataArray block write
coerced_grid = []
for row in grid:
coerced_row = []
for col_idx in range(num_cols):
val = row[col_idx] if col_idx < len(row) else None
calc_val = to_calc_compatible(val)
if isinstance(calc_val, bool):
calc_val = 1.0 if calc_val else 0.0
elif calc_val is None:
calc_val = ""
coerced_row.append(calc_val)
coerced_grid.append(coerced_row)
# 4. Spill new values using setDataArray to avoid O(N) individual cell writes
if num_cols > 1:
first_row_range = sheet.getCellRangeByPosition(
formula_col + 1, formula_row, formula_col + num_cols - 1, formula_row
)
first_row_range.setDataArray((tuple(coerced_grid[0][1:]),))
if num_rows > 1:
remaining_range = sheet.getCellRangeByPosition(
formula_col, formula_row + 1, formula_col + num_cols - 1, formula_row + num_rows - 1
)
remaining_range.setDataArray(tuple(tuple(row) for row in coerced_grid[1:]))
new_spills = []
for r_offset in range(num_rows):
for c_offset in range(num_cols):
if (r_offset, c_offset) == (0, 0):
continue
new_spills.append((formula_row + r_offset, formula_col + c_offset))
SPILL_REGISTRY[reg_key] = new_spills
save_spill_registry_for_doc(doc)
except Exception:
log.exception("Error in perform_deferred_spill")
def finalize_python_return(
ctx: Any,
code: str,
result: Any,
*,
index_arg: Any = None,
worker_data: Any = None,
) -> float | str | bool | tuple:
"""Map worker result to a single value Calc's add-in bridge accepts."""
# Worker egress (payload_codec.child_pack_result + host_unpack_data) always yields plain
# lists/scalars on the host — NumPy lives only in the venv subprocess, not in LO's Python.
# DataFrame envelopes become labeled grids (header row + body) so columns survive spill.
result = result_to_calc_grid(result)
# Auto-spill check: If it's a list/tuple, index_arg is not provided, and it's not a matrix selection
is_matrix = False
if isinstance(result, (list, tuple)) and index_arg is None and len(result) > 0:
from plugin.framework.config import get_config_bool
if get_config_bool("scripting.python_auto_spill"):
try:
doc = None
if not (hasattr(ctx, "ServiceManager") or hasattr(ctx, "getServiceManager")):
is_matrix = True
else:
doc = _get_calc_doc(ctx)
if doc is not None:
ctrl = doc.getCurrentController()
if ctrl is not None:
selection = ctrl.getSelection()
if selection is not None and hasattr(selection, "getRangeAddress"):
addr = selection.getRangeAddress()
is_matrix = (addr.EndColumn - addr.StartColumn > 0) or (addr.EndRow - addr.StartRow > 0)
except Exception:
pass
else:
is_matrix = True
if not is_matrix:
grid_to_spill = []
first_elem = result[0]
if isinstance(first_elem, (list, tuple)):
grid_to_spill = [list(row) for row in result]
else:
grid_to_spill = [[x] for x in result]
# Get document and sheet to locate formula cell
try:
if not (hasattr(ctx, "ServiceManager") or hasattr(ctx, "getServiceManager")):
return to_calc_compatible(grid_to_spill[0][0])
doc = _get_calc_doc(ctx)
if doc is not None:
doc_url = getattr(doc, "getURL", lambda: "")() or ""
ctrl = doc.getCurrentController()
if ctrl is not None:
sheet = ctrl.getActiveSheet()
if sheet is not None:
sheet_name = sheet.getName()
formula_coord = locate_formula_cell(ctx, sheet, code)
log.debug("Spill: located formula cell at %r for code %r", formula_coord, code)
if formula_coord is not None:
formula_row, formula_col = formula_coord
# Check for collisions synchronously
if doc_url not in LOADED_DOCUMENTS:
load_spill_registry_for_doc(doc)
LOADED_DOCUMENTS.add(doc_url)
# Register sheet modify listener for auto-cleanup of spills
sheet_key = (doc_url, sheet_name)
if sheet_key not in SHEET_MODIFY_LISTENERS:
try:
listener = CalcSpillModifyListener(ctx, doc_url, sheet_name)
sheet.addModifyListener(listener)
SHEET_MODIFY_LISTENERS[sheet_key] = listener
except Exception:
log.exception("Failed to register modify listener on sheet")
num_rows = len(grid_to_spill)
num_cols = max(len(row) for row in grid_to_spill) if num_rows > 0 else 0
reg_key = (doc_url, sheet_name, formula_row, formula_col)
previous_spills = SPILL_REGISTRY.get(reg_key, [])
prev_spill_set = set(previous_spills)
log.debug("Spill: previous spills for cell %r: %r", reg_key, previous_spills)
try:
from com.sun.star.table.CellContentType import EMPTY
except ImportError:
EMPTY = cast("Any", 0)
collides = False
for r_offset in range(num_rows):
for c_offset in range(num_cols):
target_r = formula_row + r_offset
target_c = formula_col + c_offset
if target_r >= 1048576 or target_c >= 16384:
log.debug("Spill: collision: target coordinate %r is out of bounds", (target_r, target_c))
collides = True
break
if (target_r, target_c) == (formula_row, formula_col):
continue
if (target_r, target_c) in prev_spill_set:
continue
cell = sheet.getCellByPosition(target_c, target_r)
cell_type = cell.getType()
if cell_type != EMPTY:
log.debug("Spill: collision: cell at %r (type=%s, val=%r, formula=%r) is not empty",
(target_r, target_c), cell_type, cell.getValue() or cell.getString(), cell.getFormula())
collides = True
break
if collides:
break
if collides:
return "#SPILL!"
from plugin.framework.queue_executor import post_to_main_thread
def _deferred_spill_on_main() -> None:
post_to_main_thread(
lambda: perform_deferred_spill(
ctx, doc_url, sheet_name, formula_row, formula_col, grid_to_spill
)
)
t = threading.Timer(0.1, _deferred_spill_on_main)
t.start()
return to_calc_compatible(grid_to_spill[0][0])
except Exception:
log.exception("Error checking spill collision or locating formula cell")
if isinstance(result, (list, tuple)):
if index_arg is not None:
flat = flatten_result_values(result)
idx = coerce_index(index_arg)
if idx < 0 or idx >= len(flat):
return f"Error: index {idx} out of range (result length {len(flat)})"
return to_calc_compatible(flat[idx])
return scalar_for_list_result(ctx, code, result, worker_data=worker_data)
return to_calc_compatible(result)
# Backward-compatible alias for tests and callers.
_insert_image_result_on_sheet = insert_image_result_on_sheet
def _format_error_for_display(exc: BaseException) -> str:
"""Cell-safe error text without importing ``plugin.framework.client`` (loads LLM stack)."""
err: Exception = exc if isinstance(exc, Exception) else RuntimeError(str(exc))
payload = format_error_payload(err)
return _("Error: {0}").format(payload.get("message", str(exc)))
def _code_uses_indexed_multi_data(code: str) -> bool:
"""True when inline code references ``data[n]`` or ``inputs[n]`` (all PY args are data ranges)."""
src = code or ""
return "data[" in src or "inputs[" in src
def get_python_init_kwargs(ctx: Any) -> dict[str, Any]:
from plugin.framework.thread_guard import on_main_thread
from plugin.framework.queue_executor import execute_on_main_thread
def _get_python_init_kwargs_impl() -> dict[str, Any]:
doc = get_calc_document_from_ctx(ctx)
if doc is not None:
return build_python_eval_init_kwargs(doc)
return {}
if not on_main_thread():
return execute_on_main_thread(_get_python_init_kwargs_impl)
return _get_python_init_kwargs_impl()
def execute_python_addin(
ctx: Any,
code: str,
data: Any = None,
true_strings: set[str] | None = None,
false_strings: set[str] | None = None,
) -> Any:
"""Run *code* in the user venv and return a Calc-compatible scalar (or error string)."""
log.debug("=== PYTHON(%r, data=%r) ===", code, data)
try:
args = split_python_addin_data_args(data)
py_data = calc_addin_args_from_split(args, true_strings, false_strings)
log.debug("PYTHON parsed py_data: %r", py_data)
is_multi = len(args) > 1
index_arg = None
if py_data is not None:
if is_multi and not _code_uses_indexed_multi_data(code):
last_arg = args[-1]
if not isinstance(last_arg, (list, tuple)) or count_cells(py_data[-1]) == 1:
idx_val = py_data[-1]
while isinstance(idx_val, list) and idx_val:
idx_val = idx_val[0]
index_arg = idx_val
py_data = py_data[:-1]
args = args[:-1]
is_multi = len(args) > 1
if py_data:
if not is_multi:
py_data = py_data[0]
else:
py_data = None
elif is_scalar_index_arg(py_data) and not is_split_grid(py_data):
# Single cell may be a matrix index and/or the data value itself.
index_arg = _unwrap_single_cell(py_data)
max_cells = configured_python_max_data_cells(ctx)
if py_data is not None:
if is_multi:
size_err = check_python_multi_data_size(py_data, max_cells=max_cells)
else:
size_err = check_python_data_size(py_data, max_cells=max_cells)
if size_err:
ret = f"Error: {size_err}"
log.debug("PYTHON returning size error: %r", ret)
_record_py_diagnostic(ctx, code, None, status="error", message=ret)
return ret
worker_data = pack_calc_multi_data_for_wire(py_data) if is_multi else pack_calc_data_for_wire(py_data)
else:
worker_data = None
# Synchronous: =PY() runs during Calc recalc; UI event pumping from
# run_blocking_in_thread can re-enter the formula engine and yield #VALUE!.
sessions = getattr(MATRIX_SCALAR_SESSIONS, "sessions", None)
if sessions is None:
sessions = {}
MATRIX_SCALAR_SESSIONS.sessions = sessions
cache_key = (session_key(ctx, code), repr(worker_data))
cached = sessions.get(cache_key)
if isinstance(cached, WorkerResultSession) and cached.next_index < len(cached.flat):
res = {"status": "ok", "result": cached.raw}
else:
session_id = workbook_session_id(ctx)
init_kwargs = get_python_init_kwargs(ctx)
res = run_code_in_user_venv(
ctx,
code,
data=worker_data,
session_id=session_id,
**init_kwargs,
)
log.debug("PYTHON res from worker: %r", res)
if res.get("status") == "ok":
_record_py_diagnostic(ctx, code, res, status="ok")
result = res.get("result")
log.debug("PYTHON raw result: %r (type: %s)", result, type(result).__name__)
images = find_image_payloads(result)
if images:
for img in images:
insert_image_result_on_sheet(ctx, img)
return _("Image inserted") if len(images) == 1 else _("Images inserted")
final_ret = finalize_python_return(ctx, code, result, index_arg=index_arg, worker_data=worker_data)
log.debug("PYTHON returning scalar: %r (type: %s)", final_ret, type(final_ret).__name__)
return final_ret
err_msg = f"Error: {res.get('message') or res.get('error')}"
_record_py_diagnostic(ctx, code, res, status="error", message=err_msg)
log.debug("PYTHON returning worker error: %r", err_msg)
return err_msg
except Exception as e:
log.exception("PYTHON unexpected error during execution")
err_msg = _format_error_for_display(e)
_record_py_diagnostic(ctx, code, None, status="error", message=err_msg, traceback=str(e))
log.debug("PYTHON returning exception wrapper: %r", err_msg)
return err_msg
def _diagnostics_workbook_key(ctx: Any) -> str:
"""Stable workbook key for the diagnostics store (UNO-light best effort)."""
try:
from plugin.scripting.document_scripts import get_calc_document_from_ctx
from plugin.scripting.session_manager import calc_workbook_base_session_id
doc = get_calc_document_from_ctx(ctx)
if doc is not None:
return calc_workbook_base_session_id(doc)
except Exception:
log.debug("diagnostics workbook key failed", exc_info=True)
return "unknown"
def _record_py_diagnostic(
ctx: Any,
code: str,
res: dict[str, Any] | None,
*,
status: str,
message: str = "",
traceback: str = "",
) -> None:
"""Record stdout/errors for the LibrePy sidebar without extra UNO work.
Skips successful evaluations with empty stdout so the log stays actionable.
"""
try:
from plugin.calc.python.diagnostics import record_python_eval
stdout = ""
tb = traceback
msg = message
if isinstance(res, dict):
stdout = str(res.get("stdout") or "")
if not msg:
msg = str(res.get("message") or res.get("error") or "")
if not tb:
raw_tb = res.get("traceback")
tb = str(raw_tb) if raw_tb else ""
if status == "ok" and not (stdout or "").strip():
return
record_python_eval(
workbook_key=_diagnostics_workbook_key(ctx),
code=code or "",
status=status,
message=msg,
stdout=stdout,
traceback=tb,
)
except Exception:
# Never break formula evaluation for diagnostics UI.
log.debug("record_python_eval failed", exc_info=True)