execsql2 2.1.2__py3-none-any.whl → 2.2.1__py3-none-any.whl

execsql/metacommands/io_write.py

@@ -0,0 +1,248 @@
+"""WRITE metacommand handlers.
+
+Implements ``x_write``, ``x_write_create_table`` (CSV, ODS, XLS, alias),
+``x_write_prefix``, ``x_write_suffix``, and ``x_writescript``.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Any
+
+import execsql.state as _state
+from execsql.exceptions import ErrInfo
+from execsql.exporters.delimited import CsvFile
+from execsql.importers.ods import ods_data
+from execsql.importers.xls import xls_data
+from execsql.models import DataTable
+from execsql.script import substitute_vars
+from execsql.utils.errors import exception_desc
+from execsql.utils.fileio import check_dir, filewriter_close, filewriter_open_as_new, filewriter_write
+from execsql.utils.gui import ConsoleUIError
+
+
+def x_write(**kwargs: Any) -> None:
+    msg = f"{kwargs['text']}\n"
+    tee = kwargs["tee"]
+    tee = bool(tee)
+    outf = kwargs["filename"]
+    if _state.conf.write_prefix is not None:
+        msg = substitute_vars(_state.conf.write_prefix) + " " + msg
+    if _state.conf.write_suffix is not None:
+        msg = msg[:-1] + " " + substitute_vars(_state.conf.write_suffix) + "\n"
+    if outf:
+        check_dir(outf)
+        filewriter_write(outf, msg)
+    if (not outf) or tee:
+        try:
+            _state.output.write(msg)
+        except TypeError as e:
+            raise ErrInfo(
+                type="other",
+                command_text=kwargs["metacommandline"],
+                other_msg="TypeError in 'write' metacommand.",
+            ) from e
+        except ConsoleUIError as e:
+            _state.output.reset()
+            _state.exec_log.log_status_info(f"Console UI write failed (message {{{e.value}}}); output reset to stdout.")
+            _state.output.write(msg.encode(_state.conf.output_encoding))
+    if _state.conf.tee_write_log:
+        _state.exec_log.log_user_msg(msg)
+    return None
+
+
+def x_write_create_table(**kwargs: Any) -> None:
+    filename = kwargs["filename"]
+    if not Path(filename).exists():
+        raise ErrInfo(
+            type="cmd",
+            command_text=kwargs["metacommandline"],
+            other_msg="Input file does not exist",
+        )
+    quotechar = kwargs["quotechar"]
+    delimchar = kwargs["delimchar"]
+    encoding = kwargs["encoding"]
+    if delimchar:
+        if delimchar.lower() == "tab":
+            delimchar = chr(9)
+        elif delimchar.lower() in ("unitsep", "us"):
+            delimchar = chr(31)
+    junk_hdrs = kwargs["skip"]
+    if not junk_hdrs:
+        junk_hdrs = 0
+    else:
+        junk_hdrs = int(junk_hdrs)
+    enc = encoding if encoding else _state.conf.import_encoding
+    inf = CsvFile(filename, enc, junk_header_lines=junk_hdrs)
+    if quotechar and delimchar:
+        inf.lineformat(delimchar, quotechar, None)
+    inf.evaluate_column_types()
+    sql = inf.create_table(_state.dbs.current().type, kwargs["schema"], kwargs["table"], pretty=True)
+    inf.close()
+    comment = kwargs["comment"]
+    outfile = kwargs["outfile"]
+
+    def write(txt: str) -> None:
+        if outfile is None or outfile == "stdout":
+            _state.output.write(txt)
+        else:
+            filewriter_write(outfile, txt)
+
+    if outfile:
+        check_dir(outfile)
+    if comment:
+        write(f"-- {comment}\n")
+    write(f"{sql}\n")
+
+
+def x_write_create_table_ods(**kwargs: Any) -> None:
+    schemaname = kwargs["schema"]
+    tablename = kwargs["table"]
+    filename = kwargs["filename"]
+    sheetname = kwargs["sheet"]
+    hdr_rows = kwargs["skip"]
+    if not hdr_rows:
+        hdr_rows = 0
+    else:
+        hdr_rows = int(hdr_rows)
+    comment = kwargs["comment"]
+    outfile = kwargs["outfile"]
+    if not Path(filename).exists():
+        raise ErrInfo(
+            type="cmd",
+            command_text=kwargs["metacommandline"],
+            other_msg="Input file does not exist",
+        )
+    hdrs, data = ods_data(filename, sheetname, hdr_rows)
+    tablespec = DataTable(hdrs, data)
+    sql = tablespec.create_table(_state.dbs.current().type, schemaname, tablename, pretty=True)
+    if outfile:
+        if comment:
+            filewriter_write(outfile, f"-- {comment}\n")
+        filewriter_write(outfile, sql)
+        filewriter_close(outfile)
+    else:
+        if comment:
+            _state.output.write(f"-- {comment}\n")
+        _state.output.write(f"{sql}\n")
+
+
+def x_write_create_table_xls(**kwargs: Any) -> None:
+    schemaname = kwargs["schema"]
+    tablename = kwargs["table"]
+    filename = kwargs["filename"]
+    sheetname = kwargs["sheet"]
+    junk_hdrs = kwargs["skip"]
+    encoding = kwargs["encoding"]
+    enc = encoding if encoding else _state.conf.import_encoding
+    if not junk_hdrs:
+        junk_hdrs = 0
+    else:
+        junk_hdrs = int(junk_hdrs)
+    comment = kwargs["comment"]
+    outfile = kwargs["outfile"]
+    if not Path(filename).exists():
+        raise ErrInfo(
+            type="cmd",
+            command_text=kwargs["metacommandline"],
+            other_msg="Input file does not exist",
+        )
+    hdrs, data = xls_data(filename, sheetname, junk_hdrs, enc)
+    tablespec = DataTable(hdrs, data)
+    sql = tablespec.create_table(_state.dbs.current().type, schemaname, tablename, pretty=True)
+    if outfile:
+        if comment:
+            filewriter_write(outfile, f"-- {comment}\n")
+        filewriter_write(outfile, sql)
+        filewriter_close(outfile)
+    else:
+        if comment:
+            _state.output.write(f"-- {comment}\n")
+        _state.output.write(f"{sql}\n")
+
+
+def x_write_create_table_alias(**kwargs: Any) -> None:
+    alias = kwargs["alias"].lower()
+    schema = kwargs["schema"]
+    table = kwargs["table"]
+    comment = kwargs["comment"]
+    outfile = kwargs["filename"]
+    if alias not in _state.dbs.aliases():
+        raise ErrInfo(
+            type="cmd",
+            command_text=kwargs["metacommandline"],
+            other_msg=f"Unrecognized database alias: {alias}.",
+        )
+    db = _state.dbs.aliased_as(alias)
+    tbl = db.schema_qualified_table_name(schema, table)
+    try:
+        if not db.table_exists(table, schema):
+            raise ErrInfo(
+                type="cmd",
+                command_text=kwargs["metacommandline"],
+                other_msg=f"Table {tbl} does not exist",
+            )
+    except Exception:
+        pass  # Best-effort check; some adapters lack information_schema.
+    select_stmt = f"select * from {tbl};"
+    try:
+        hdrs, rows = db.select_rowsource(select_stmt)
+    except ErrInfo:
+        raise
+    except Exception as e:
+        raise ErrInfo("db", select_stmt, exception_msg=exception_desc()) from e
+    tablespec = DataTable(hdrs, rows)
+    sql = tablespec.create_table(_state.dbs.current().type, kwargs["schema1"], kwargs["table1"], pretty=True)
+    if outfile:
+        if comment:
+            filewriter_write(outfile, f"-- {comment}\n")
+        filewriter_write(outfile, sql)
+        filewriter_close(outfile)
+    else:
+        if comment:
+            _state.output.write(f"-- {comment}\n")
+        _state.output.write(f"{sql}\n")
+
+
+def x_write_prefix(**kwargs: Any) -> None:
+    pf = kwargs["prefix"]
+    if pf.lower() == "clear":
+        _state.conf.write_prefix = None
+    else:
+        _state.conf.write_prefix = pf
+    return None
+
+
+def x_write_suffix(**kwargs: Any) -> None:
+    sf = kwargs["suffix"]
+    if sf.lower() == "clear":
+        _state.conf.write_suffix = None
+    else:
+        _state.conf.write_suffix = sf
+    return None
+
+
+def x_writescript(**kwargs: Any) -> None:
+    script_id = kwargs["script_id"]
+    output_dest = kwargs["filename"]
+    append = kwargs["append"]
+
+    def write(txt: str) -> None:
+        if output_dest is None or output_dest == "stdout":
+            _state.output.write(txt)
+        else:
+            filewriter_write(output_dest, txt)
+
+    if output_dest is not None and output_dest != "stdout":
+        check_dir(output_dest)
+        if not append:
+            filewriter_open_as_new(output_dest)
+    script = _state.savedscripts[script_id]
+    if script.paramnames is not None and len(script.paramnames) > 0:
+        write(f"BEGIN SCRIPT {script_id} ({', '.join(script.paramnames)})\n")
+    else:
+        write(f"BEGIN SCRIPT {script_id}\n")
+    lines = [c.commandline() for c in script.cmdlist]
+    for line in lines:
+        write(f"{line}\n")
+    write(f"END SCRIPT {script_id}\n")

execsql/metacommands/prompt.py

@@ -29,7 +29,6 @@ from typing import Any
 import execsql.state as _state
 from execsql.script import current_script_line
 from execsql.utils.errors import exception_desc, exit_now
-from execsql.utils.fileio import EncodedFile, check_dir
 from execsql.utils.gui import (
     ActionSpec,
     EntrySpec,
@@ -38,7 +37,6 @@ from execsql.utils.gui import (
     GUI_DIRECTORY,
     GUI_DISPLAY,
     GUI_ENTRY,
-    GUI_HALT,
     GUI_MAP,
     GUI_MSG,
     GUI_OPENFILE,
@@ -210,12 +208,12 @@ def x_prompt_entryform(**kwargs: Any) -> None:
                     initial_value = str(str(v["initial_value"]).lower() in ("yes", "true", "on", "1"))
                 else:
                     initial_value = str(v["initial_value"])
-            except Exception:
+            except Exception as e:
                 raise ErrInfo(
                     type="cmd",
                     command_text=kwargs["metacommandline"],
                     other_msg=f"The initial value of {v['initial_value']} can't be used.",
-                )
+                ) from e
         if "lookup_table" in colhdrs:
             lt = v["lookup_table"]
             if lt:
@@ -226,23 +224,23 @@ def x_prompt_entryform(**kwargs: Any) -> None:
             if entry_width:
                 try:
                     entry_width = int(entry_width)
-                except Exception:
+                except Exception as e:
                     raise ErrInfo(
                         type="cmd",
                         command_text=kwargs["metacommandline"],
                         other_msg=f"Entry width {entry_width} is not an integer",
-                    )
+                    ) from e
         if "height" in colhdrs:
             entry_height = v.get("height")
             if entry_height:
                 try:
                     entry_height = int(entry_height)
-                except Exception:
+                except Exception as e:
                     raise ErrInfo(
                         type="cmd",
                         command_text=kwargs["metacommandline"],
                         other_msg=f"Entry height {entry_height} is not an integer",
-                    )
+                    ) from e
                 if entry_height < 1:
                     entry_height = 1
         if "form_column" in colhdrs:
@@ -250,12 +248,12 @@ def x_prompt_entryform(**kwargs: Any) -> None:
             if entry_col:
                 try:
                     entry_col = int(entry_col)
-                except Exception:
+                except Exception as e:
                     raise ErrInfo(
                         type="cmd",
                         command_text=kwargs["metacommandline"],
                         other_msg=f"Entry column {entry_col} is not an integer",
-                    )
+                    ) from e
                 if entry_col < 1:
                     entry_col = 1
         subvarset = _state.subvars if subvar[0] != "~" else _state.commandliststack[-1].localvars
@@ -363,15 +361,15 @@ def prompt_compare(button_list: list, **kwargs: Any) -> Any:
     if alias1 is not None:
         try:
             db1 = _state.dbs.aliased_as(alias1)
-        except Exception:
-            raise ErrInfo(type="error", other_msg=badaliasmsg % alias1)
+        except Exception as e:
+            raise ErrInfo(type="error", other_msg=badaliasmsg % alias1) from e
     else:
         db1 = _state.dbs.current()
     if alias2 is not None:
         try:
             db2 = _state.dbs.aliased_as(alias2)
-        except Exception:
-            raise ErrInfo(type="error", other_msg=badaliasmsg % alias2)
+        except Exception as e:
+            raise ErrInfo(type="error", other_msg=badaliasmsg % alias2) from e
     else:
         db2 = _state.dbs.current()
     sq_name1 = db1.schema_qualified_table_name(schema1, table1)
@@ -666,8 +664,8 @@ def x_prompt_savefile(**kwargs: Any) -> None:
                 subvarset5.add_substitution(sub_name5, Path(fn).stem)
     except (ErrInfo, SystemExit):
         raise
-    except Exception:
-        raise ErrInfo(type="exception", exception_msg=exception_desc())
+    except Exception as e:
+        raise ErrInfo(type="exception", exception_msg=exception_desc()) from e
     return None
 
 
@@ -733,8 +731,8 @@ def x_prompt_openfile(**kwargs: Any) -> None:
                 subvarset5.add_substitution(sub_name5, Path(fn).stem)
     except (ErrInfo, SystemExit):
         raise
-    except Exception:
-        raise ErrInfo(type="exception", exception_msg=exception_desc())
+    except Exception as e:
+        raise ErrInfo(type="exception", exception_msg=exception_desc()) from e
     return None
 
 
@@ -769,8 +767,8 @@ def x_prompt_directory(**kwargs: Any) -> None:
             )
     except (ErrInfo, SystemExit):
         raise
-    except Exception:
-        raise ErrInfo(type="exception", exception_msg=exception_desc())
+    except Exception as e:
+        raise ErrInfo(type="exception", exception_msg=exception_desc()) from e
     return None
 
 
@@ -787,15 +785,15 @@ def prompt_select_rows(button_list: list, **kwargs: Any) -> Any:
     if alias1 is not None:
         try:
             db1 = _state.dbs.aliased_as(alias1)
-        except Exception:
-            raise ErrInfo(type="error", other_msg=badaliasmsg % alias1)
+        except Exception as e:
+            raise ErrInfo(type="error", other_msg=badaliasmsg % alias1) from e
     else:
         db1 = _state.dbs.current()
     if alias2 is not None:
         try:
             db2 = _state.dbs.aliased_as(alias2)
-        except Exception:
-            raise ErrInfo(type="error", other_msg=badaliasmsg % alias2)
+        except Exception as e:
+            raise ErrInfo(type="error", other_msg=badaliasmsg % alias2) from e
     else:
         db2 = _state.dbs.current()
     sq_name1 = db1.schema_qualified_table_name(schema1, table1)
@@ -942,48 +940,6 @@ def x_pause(**kwargs: Any) -> None:
     return None
 
 
-def x_halt_msg(**kwargs: Any) -> None:
-    errmsg = kwargs["errmsg"]
-    tee = kwargs["tee"]
-    tee = bool(tee)
-    outf = kwargs["filename"]
-    errlevel = kwargs["errorlevel"]
-    if errlevel:
-        errlevel = int(errlevel)
-    else:
-        errlevel = 3
-    conf = _state.conf
-    if outf:
-        check_dir(outf)
-        of = EncodedFile(outf, conf.output_encoding).open("a")
-        of.write(f"{errmsg}\n")
-        of.close()
-    schema = kwargs.get("schema")
-    table = kwargs.get("table")
-    if table:
-        db = _state.dbs.current()
-        db_obj = db.schema_qualified_table_name(schema, table)
-        sql = f"select * from {db_obj};"
-        headers, rows = db.select_data(sql)
-    else:
-        headers, rows = None, None
-    enable_gui()
-    return_queue = _queue.Queue()
-    gui_args = {
-        "title": "HALT",
-        "message": errmsg,
-        "button_list": [("OK", 1, "<Return>")],
-        "no_cancel": True,
-        "column_headers": headers,
-        "rowset": rows,
-        "help_url": None,
-    }
-    _state.gui_manager_queue.put(GuiSpec(GUI_HALT, gui_args, return_queue))
-    return_queue.get(block=True)
-    _state.exec_log.log_exit_halt(*current_script_line(), msg=errmsg)
-    exit_now(errlevel, None)
-
-
 def x_msg(**kwargs: Any) -> None:
     message = kwargs["message"]
     current_script_line()

execsql/metacommands/system.py

@@ -89,6 +89,11 @@ def x_log_datavars(**kwargs: Any) -> None:
     _state.conf.log_datavars = setting in ("yes", "on", "true", "1")
 
 
+def x_log_sql(**kwargs: Any) -> None:
+    setting = kwargs["setting"].lower()
+    _state.conf.log_sql = setting in ("yes", "on", "true", "1")
+
+
 def x_console(**kwargs: Any) -> None:
     onoff = kwargs["onoff"].lower()
     if onoff == "on":
@@ -251,6 +256,6 @@ def x_execute(**kwargs: Any) -> None:
         db.commit()
     except ErrInfo:
         raise
-    except Exception:
-        raise ErrInfo("db", command_text=sql, exception_msg=exception_desc())
+    except Exception as e:
+        raise ErrInfo("db", command_text=sql, exception_msg=exception_desc()) from e
     return None

execsql/script.py

@@ -419,6 +419,7 @@ class MetaCommand:
         run_in_batch: bool = False,
         run_when_false: bool = False,
         set_error_flag: bool = True,
+        category: str | None = None,
     ) -> None:
         self.rx = rx
         self.exec_fn = exec_func
@@ -426,6 +427,7 @@ class MetaCommand:
         self.run_in_batch = run_in_batch
         self.run_when_false = run_when_false
         self.set_error_flag = set_error_flag
+        self.category = category
         self.hitcount = 0
 
     def __repr__(self) -> str:
@@ -488,6 +490,7 @@ class MetaCommandList:
         run_in_batch: bool = False,
         run_when_false: bool = False,
         set_error_flag: bool = True,
+        category: str | None = None,
     ) -> None:
         if type(matching_regexes) in (tuple, list):
             regexes = [re.compile(rx, re.I) for rx in tuple(matching_regexes)]
@@ -497,9 +500,30 @@ class MetaCommandList:
             # Prepend to preserve "last registered, first checked" ordering.
             self._commands.insert(
                 0,
-                MetaCommand(rx, exec_func, description, run_in_batch, run_when_false, set_error_flag),
+                MetaCommand(
+                    rx,
+                    exec_func,
+                    description,
+                    run_in_batch,
+                    run_when_false,
+                    set_error_flag,
+                    category,
+                ),
             )
 
+    def keywords_by_category(self) -> dict[str, list[str]]:
+        """Return ``{category: [keyword, ...]}`` from entries that have both.
+
+        Used by ``--dump-keywords`` to introspect the dispatch table.
+        """
+        result: dict[str, list[str]] = {}
+        for mc in self._commands:
+            if mc.category and mc.description:
+                kw_list = result.setdefault(mc.category, [])
+                if mc.description not in kw_list:
+                    kw_list.append(mc.description)
+        return result
+
     def eval(self, cmd_str: str) -> tuple:
         """Evaluate *cmd_str* against the registered metacommands.
 
@@ -549,6 +573,10 @@ class SqlStmt:
                 )
             try:
                 db = _state.dbs.current()
+                if _state.conf.log_sql and _state.exec_log:
+                    lno = getattr(_state, "last_command", None)
+                    lno = lno.line_no if lno and hasattr(lno, "line_no") else None
+                    _state.exec_log.log_sql_query(cmd, db.name(), lno)
                 db.execute(cmd)
                 if commit:
                     db.commit()
@@ -915,6 +943,9 @@ def set_system_vars() -> None:
     _state.subvars.add_substitution("$VERSION3", str(_state.tertiary_vno))
 
 
+_MAX_SUBSTITUTION_DEPTH = 100
+
+
 def substitute_vars(command_str: str, localvars: SubVarSet | None = None) -> str:
     # Substitutes global variables, global counters, and local variables.
     if localvars is not None:
@@ -923,11 +954,21 @@ def substitute_vars(command_str: str, localvars: SubVarSet | None = None) -> str
         subs = _state.subvars
     cmdstr = copy.copy(command_str)
     subs_made = True
+    iterations = 0
     while subs_made:
         subs_made = False
         cmdstr, subs_made = subs.substitute_all(cmdstr)
         cmdstr, any_subbed = _state.counters.substitute_all(cmdstr)
         subs_made = subs_made or any_subbed
+        iterations += 1
+        if iterations >= _MAX_SUBSTITUTION_DEPTH:
+            raise ErrInfo(
+                type="error",
+                other_msg=(
+                    f"Substitution variable cycle detected: exceeded {_MAX_SUBSTITUTION_DEPTH} "
+                    f"iterations while expanding variables in: {command_str[:200]}"
+                ),
+            )
     m = _state.defer_rx.findall(cmdstr)
     # Substitute any deferred substitution variables with regular substitution var flags.
     if m is not None:
@@ -952,8 +993,8 @@ def runscripts() -> None:
             raise
         except ErrInfo:
             raise
-        except Exception:
-            raise ErrInfo(type="exception", exception_msg=exception_desc())
+        except Exception as e:
+            raise ErrInfo(type="exception", exception_msg=exception_desc()) from e
         _state.cmds_run += 1
 
 
@@ -1126,8 +1167,11 @@ def read_sqlfile(sql_file_name: str) -> None:
 
     sz, dt = file_size_date(sql_file_name)
     _state.exec_log.log_status_info(f"Reading script file {sql_file_name} (size: {sz}; date: {dt})")
-    scriptfile_obj = ScriptFile(sql_file_name, _state.conf.script_encoding).open("r")
-    sqllist = _parse_script_lines(scriptfile_obj, sql_file_name)
+    scriptfile_obj = ScriptFile(sql_file_name, _state.conf.script_encoding)
+    try:
+        sqllist = _parse_script_lines(scriptfile_obj, sql_file_name)
+    finally:
+        scriptfile_obj.close()
     if sqllist:
         _state.commandliststack.append(CommandList(sqllist, Path(sql_file_name).name))