""" Excel Formula Recalculation Script Recalculates all formulas in an Excel file using LibreOffice """ import json import os import platform import subprocess import sys from pathlib import Path from office.soffice import get_soffice_cmd, get_soffice_env from openpyxl import load_workbook MACRO_DIR_MACOS = "~/Library/Application Support/LibreOffice/4/user/basic/Standard" MACRO_DIR_LINUX = "~/.config/libreoffice/4/user/basic/Standard" MACRO_DIR_WINDOWS = "~/AppData/Roaming/LibreOffice/4/user/basic/Standard" MACRO_FILENAME = "Module1.xba" RECALCULATE_MACRO = """ Sub RecalculateAndSave() ThisComponent.calculateAll() ThisComponent.store() ThisComponent.close(True) End Sub """ def has_gtimeout(): try: subprocess.run( ["gtimeout", "--version"], capture_output=True, timeout=1, check=False ) return True except (FileNotFoundError, subprocess.TimeoutExpired): return False def _get_macro_dir() -> str: """Return the LibreOffice macro directory for the current platform.""" system = platform.system() if system == "Darwin": return MACRO_DIR_MACOS elif system == "Windows": return MACRO_DIR_WINDOWS else: return MACRO_DIR_LINUX def setup_libreoffice_macro(): macro_dir = os.path.expanduser(_get_macro_dir()) macro_file = os.path.join(macro_dir, MACRO_FILENAME) if ( os.path.exists(macro_file) and "RecalculateAndSave" in Path(macro_file).read_text() ): return True if not os.path.exists(macro_dir): subprocess.run( [get_soffice_cmd(), "--headless", "--terminate_after_init"], capture_output=True, timeout=10, env=get_soffice_env(), ) os.makedirs(macro_dir, exist_ok=True) try: Path(macro_file).write_text(RECALCULATE_MACRO) return True except Exception: return False def recalc(filename, timeout=30): if not Path(filename).exists(): return {"error": f"File {filename} does not exist"} abs_path = str(Path(filename).absolute()) if not setup_libreoffice_macro(): return {"error": "Failed to setup LibreOffice macro"} cmd = [ get_soffice_cmd(), "--headless", "--norestore", "vnd.sun.star.script:Standard.Module1.RecalculateAndSave?language=Basic&location=application", abs_path, ] system = platform.system() if system == "Linux": cmd = ["timeout", str(timeout)] + cmd elif system == "Darwin" and has_gtimeout(): cmd = ["gtimeout", str(timeout)] + cmd # On Windows, rely on subprocess timeout parameter instead of external tool try: result = subprocess.run( cmd, capture_output=True, text=True, env=get_soffice_env(), timeout=timeout if system == "Windows" else None, ) except subprocess.TimeoutExpired: return { "error": ( f"LibreOffice recalculation timed out after {timeout} seconds" ), } if result.returncode != 0 and result.returncode != 124: error_msg = result.stderr or "Unknown error during recalculation" if "Module1" in error_msg or "RecalculateAndSave" not in error_msg: return {"error": "LibreOffice macro not configured properly"} return {"error": error_msg} try: wb = load_workbook(filename, data_only=True) excel_errors = [ "#VALUE!", "#DIV/0!", "#REF!", "#NAME?", "#NULL!", "#NUM!", "#N/A", ] error_details = {err: [] for err in excel_errors} total_errors = 0 for sheet_name in wb.sheetnames: ws = wb[sheet_name] for row in ws.iter_rows(): for cell in row: if cell.value is not None and isinstance(cell.value, str): for err in excel_errors: if err in cell.value: location = f"{sheet_name}!{cell.coordinate}" error_details[err].append(location) total_errors += 1 break wb.close() result = { "status": "success" if total_errors == 0 else "errors_found", "total_errors": total_errors, "error_summary": {}, } for err_type, locations in error_details.items(): if locations: result["error_summary"][err_type] = { "count": len(locations), "locations": locations[:20], } wb_formulas = load_workbook(filename, data_only=False) formula_count = 0 for sheet_name in wb_formulas.sheetnames: ws = wb_formulas[sheet_name] for row in ws.iter_rows(): for cell in row: if ( cell.value and isinstance(cell.value, str) and cell.value.startswith("=") ): formula_count += 1 wb_formulas.close() result["total_formulas"] = formula_count return result except Exception as e: return {"error": str(e)} def main(): if len(sys.argv) < 2: print("Usage: python recalc.py [timeout_seconds]") print("\nRecalculates all formulas in an Excel file using LibreOffice") print("\nReturns JSON with error details:") print(" - status: 'success' or 'errors_found'") print(" - total_errors: Total number of Excel errors found") print(" - total_formulas: Number of formulas in the file") print(" - error_summary: Breakdown by error type with locations") print(" - #VALUE!, #DIV/0!, #REF!, #NAME?, #NULL!, #NUM!, #N/A") sys.exit(1) filename = sys.argv[1] timeout = int(sys.argv[2]) if len(sys.argv) > 2 else 30 result = recalc(filename, timeout) print(json.dumps(result, indent=2)) if __name__ == "__main__": main()