execsql2 2.5.0__py3-none-any.whl → 2.7.1__py3-none-any.whl

execsql/metacommands/__init__.py

@@ -10,207 +10,208 @@ Handler functions live in the sibling modules:
 
 from __future__ import annotations
 
-import execsql.state as _state  # noqa: F401
+import execsql.state as _state
 
 # Handler imports — grouped by module for readability.
 from execsql.metacommands.connect import (
-    x_connect_pg,  # noqa: F401
-    x_connect_user_pg,  # noqa: F401
-    x_connect_ssvr,  # noqa: F401
-    x_connect_user_ssvr,  # noqa: F401
-    x_connect_mysql,  # noqa: F401
-    x_connect_user_mysql,  # noqa: F401
-    x_connect_access,  # noqa: F401
-    x_connect_fb,  # noqa: F401
-    x_connect_user_fb,  # noqa: F401
-    x_connect_ora,  # noqa: F401
-    x_connect_user_ora,  # noqa: F401
-    x_connect_duckdb,  # noqa: F401
-    x_connect_sqlite,  # noqa: F401
-    x_connect_dsn,  # noqa: F401
-    x_use,  # noqa: F401
-    x_disconnect,  # noqa: F401
-    x_autocommit_on,  # noqa: F401
-    x_autocommit_off,  # noqa: F401
-    x_pg_vacuum,  # noqa: F401
-    x_daoflushdelay,  # noqa: F401
+    x_connect_pg,
+    x_connect_user_pg,
+    x_connect_ssvr,
+    x_connect_user_ssvr,
+    x_connect_mysql,
+    x_connect_user_mysql,
+    x_connect_access,
+    x_connect_fb,
+    x_connect_user_fb,
+    x_connect_ora,
+    x_connect_user_ora,
+    x_connect_duckdb,
+    x_connect_sqlite,
+    x_connect_dsn,
+    x_use,
+    x_disconnect,
+    x_autocommit_on,
+    x_autocommit_off,
+    x_pg_vacuum,
+    x_daoflushdelay,
 )
 from execsql.metacommands.control import (
-    x_if,  # noqa: F401
-    x_if_orif,  # noqa: F401
-    x_if_andif,  # noqa: F401
-    x_if_elseif,  # noqa: F401
-    x_if_else,  # noqa: F401
-    x_if_block,  # noqa: F401
-    x_if_end,  # noqa: F401
-    x_loop,  # noqa: F401
-    x_halt,  # noqa: F401
-    x_halt_msg,  # noqa: F401
-    x_error_halt,  # noqa: F401
-    x_metacommand_error_halt,  # noqa: F401
-    x_begin_batch,  # noqa: F401
-    x_end_batch,  # noqa: F401
-    x_rollback,  # noqa: F401
-    x_break,  # noqa: F401
-    x_wait_until,  # noqa: F401
+    x_if,
+    x_if_orif,
+    x_if_andif,
+    x_if_elseif,
+    x_if_else,
+    x_if_block,
+    x_if_end,
+    x_loop,
+    x_halt,
+    x_halt_msg,
+    x_error_halt,
+    x_metacommand_error_halt,
+    x_begin_batch,
+    x_end_batch,
+    x_rollback,
+    x_break,
+    x_wait_until,
 )
 from execsql.metacommands.data import (
-    x_sub,  # noqa: F401
-    x_sub_add,  # noqa: F401
-    x_sub_append,  # noqa: F401
-    x_sub_empty,  # noqa: F401
-    x_rm_sub,  # noqa: F401
-    x_sub_local,  # noqa: F401
-    x_sub_tempfile,  # noqa: F401
-    x_sub_ini,  # noqa: F401
-    x_sub_querystring,  # noqa: F401
-    x_sub_encrypt,  # noqa: F401
-    x_sub_decrypt,  # noqa: F401
-    x_subdata,  # noqa: F401
-    x_selectsub,  # noqa: F401
-    x_prompt_selectsub,  # noqa: F401
-    x_empty_strings,  # noqa: F401
-    x_trim_strings,  # noqa: F401
-    x_replace_newlines,  # noqa: F401
-    x_empty_rows,  # noqa: F401
-    x_only_strings,  # noqa: F401
-    x_boolean_int,  # noqa: F401
-    x_boolean_words,  # noqa: F401
-    x_fold_col_hdrs,  # noqa: F401
-    x_trim_col_hdrs,  # noqa: F401
-    x_clean_col_hdrs,  # noqa: F401
-    x_del_empty_cols,  # noqa: F401
-    x_create_col_hdrs,  # noqa: F401
-    x_dedup_col_hdrs,  # noqa: F401
-    x_import_common_cols_only,  # noqa: F401
-    x_quote_all_text,  # noqa: F401
-    x_reset_counter,  # noqa: F401
-    x_reset_counters,  # noqa: F401
-    x_set_counter,  # noqa: F401
-    x_max_int,  # noqa: F401
+    x_sub,
+    x_sub_add,
+    x_sub_append,
+    x_sub_empty,
+    x_rm_sub,
+    x_sub_local,
+    x_sub_tempfile,
+    x_sub_ini,
+    x_sub_querystring,
+    x_sub_encrypt,
+    x_sub_decrypt,
+    x_subdata,
+    x_selectsub,
+    x_prompt_selectsub,
+    x_empty_strings,
+    x_trim_strings,
+    x_replace_newlines,
+    x_empty_rows,
+    x_only_strings,
+    x_boolean_int,
+    x_boolean_words,
+    x_fold_col_hdrs,
+    x_trim_col_hdrs,
+    x_clean_col_hdrs,
+    x_del_empty_cols,
+    x_create_col_hdrs,
+    x_dedup_col_hdrs,
+    x_import_common_cols_only,
+    x_quote_all_text,
+    x_reset_counter,
+    x_reset_counters,
+    x_set_counter,
+    x_max_int,
 )
 from execsql.metacommands.debug import (
-    x_debug_write_metacommands,  # noqa: F401
-    x_debug_commandliststack,  # noqa: F401
-    x_debug_iflevels,  # noqa: F401
-    x_debug_write_odbc_drivers,  # noqa: F401
-    x_debug_log_subvars,  # noqa: F401
-    x_debug_log_config,  # noqa: F401
-    x_debug_write_subvars,  # noqa: F401
-    x_debug_write_config,  # noqa: F401
+    x_debug_write_metacommands,
+    x_debug_commandliststack,
+    x_debug_iflevels,
+    x_debug_write_odbc_drivers,
+    x_debug_log_subvars,
+    x_debug_log_config,
+    x_debug_write_subvars,
+    x_debug_write_config,
 )
 from execsql.metacommands.io import (
-    x_export,  # noqa: F401
-    x_export_query,  # noqa: F401
-    x_export_query_with_template,  # noqa: F401
-    x_export_with_template,  # noqa: F401
-    x_export_ods_multiple,  # noqa: F401
-    x_export_metadata,  # noqa: F401
-    x_export_metadata_table,  # noqa: F401
-    x_import,  # noqa: F401
-    x_import_file,  # noqa: F401
-    x_import_ods,  # noqa: F401
-    x_import_ods_pattern,  # noqa: F401
-    x_import_xls,  # noqa: F401
-    x_import_xls_pattern,  # noqa: F401
-    x_import_parquet,  # noqa: F401
-    x_import_feather,  # noqa: F401
-    x_import_row_buffer,  # noqa: F401
-    x_show_progress,  # noqa: F401
-    x_export_row_buffer,  # noqa: F401
-    x_write,  # noqa: F401
-    x_write_create_table,  # noqa: F401
-    x_write_create_table_ods,  # noqa: F401
-    x_write_create_table_xls,  # noqa: F401
-    x_write_create_table_alias,  # noqa: F401
-    x_write_prefix,  # noqa: F401
-    x_write_suffix,  # noqa: F401
-    x_writescript,  # noqa: F401
-    x_include,  # noqa: F401
-    x_copy,  # noqa: F401
-    x_copy_query,  # noqa: F401
-    x_zip,  # noqa: F401
-    x_zip_buffer_mb,  # noqa: F401
-    x_rm_file,  # noqa: F401
-    x_make_export_dirs,  # noqa: F401
-    x_cd,  # noqa: F401
-    x_scan_lines,  # noqa: F401
-    x_hdf5_text_len,  # noqa: F401
-    x_serve,  # noqa: F401
+    x_export,
+    x_export_query,
+    x_export_query_with_template,
+    x_export_with_template,
+    x_export_ods_multiple,
+    x_export_xlsx_multiple,
+    x_export_metadata,
+    x_export_metadata_table,
+    x_import,
+    x_import_file,
+    x_import_ods,
+    x_import_ods_pattern,
+    x_import_xls,
+    x_import_xls_pattern,
+    x_import_parquet,
+    x_import_feather,
+    x_import_row_buffer,
+    x_show_progress,
+    x_export_row_buffer,
+    x_write,
+    x_write_create_table,
+    x_write_create_table_ods,
+    x_write_create_table_xls,
+    x_write_create_table_alias,
+    x_write_prefix,
+    x_write_suffix,
+    x_writescript,
+    x_include,
+    x_copy,
+    x_copy_query,
+    x_zip,
+    x_zip_buffer_mb,
+    x_rm_file,
+    x_make_export_dirs,
+    x_cd,
+    x_scan_lines,
+    x_hdf5_text_len,
+    x_serve,
 )
 from execsql.metacommands.prompt import (
-    x_prompt,  # noqa: F401
-    x_prompt_enter,  # noqa: F401
-    x_prompt_entryform,  # noqa: F401
-    x_prompt_pause,  # noqa: F401
-    x_prompt_compare,  # noqa: F401
-    x_prompt_ask_compare,  # noqa: F401
-    x_prompt_ask,  # noqa: F401
-    x_prompt_map,  # noqa: F401
-    x_prompt_action,  # noqa: F401
-    x_prompt_savefile,  # noqa: F401
-    x_prompt_openfile,  # noqa: F401
-    x_prompt_directory,  # noqa: F401
-    x_prompt_select_rows,  # noqa: F401
-    x_prompt_credentials,  # noqa: F401
-    x_prompt_connect,  # noqa: F401
-    x_ask,  # noqa: F401
-    x_pause,  # noqa: F401
-    x_msg,  # noqa: F401
-    x_reset_dialog_canceled,  # noqa: F401
+    x_prompt,
+    x_prompt_enter,
+    x_prompt_entryform,
+    x_prompt_pause,
+    x_prompt_compare,
+    x_prompt_ask_compare,
+    x_prompt_ask,
+    x_prompt_map,
+    x_prompt_action,
+    x_prompt_savefile,
+    x_prompt_openfile,
+    x_prompt_directory,
+    x_prompt_select_rows,
+    x_prompt_credentials,
+    x_prompt_connect,
+    x_ask,
+    x_pause,
+    x_msg,
+    x_reset_dialog_canceled,
 )
 from execsql.metacommands.script_ext import (
-    x_extendscript,  # noqa: F401
-    x_extendscript_metacommand,  # noqa: F401
-    x_extendscript_sql,  # noqa: F401
-    x_executescript,  # noqa: F401
+    x_extendscript,
+    x_extendscript_metacommand,
+    x_extendscript_sql,
+    x_executescript,
 )
 from execsql.metacommands.system import (
-    x_system_cmd,  # noqa: F401
-    x_email,  # noqa: F401
-    x_timer,  # noqa: F401
-    x_log,  # noqa: F401
-    x_logwritemessages,  # noqa: F401
-    x_log_datavars,  # noqa: F401
-    x_log_sql,  # noqa: F401
-    x_console,  # noqa: F401
-    x_consoleprogress,  # noqa: F401
-    x_consolewait,  # noqa: F401
-    x_consolewait_onerror,  # noqa: F401
-    x_consolewait_whendone,  # noqa: F401
-    x_console_hideshow,  # noqa: F401
-    x_consolewidth,  # noqa: F401
-    x_consoleheight,  # noqa: F401
-    x_consolestatus,  # noqa: F401
-    x_consolesave,  # noqa: F401
-    x_cancel_halt,  # noqa: F401
-    x_cancel_halt_write_clear,  # noqa: F401
-    x_cancel_halt_write,  # noqa: F401
-    x_cancel_halt_email_clear,  # noqa: F401
-    x_cancel_halt_email,  # noqa: F401
-    x_cancel_halt_exec,  # noqa: F401
-    x_cancel_halt_exec_clear,  # noqa: F401
-    x_error_halt_write_clear,  # noqa: F401
-    x_error_halt_write,  # noqa: F401
-    x_error_halt_email_clear,  # noqa: F401
-    x_error_halt_email,  # noqa: F401
-    x_error_halt_exec,  # noqa: F401
-    x_error_halt_exec_clear,  # noqa: F401
-    x_write_warnings,  # noqa: F401
-    x_gui_level,  # noqa: F401
-    x_execute,  # noqa: F401
+    x_system_cmd,
+    x_email,
+    x_timer,
+    x_log,
+    x_logwritemessages,
+    x_log_datavars,
+    x_log_sql,
+    x_console,
+    x_consoleprogress,
+    x_consolewait,
+    x_consolewait_onerror,
+    x_consolewait_whendone,
+    x_console_hideshow,
+    x_consolewidth,
+    x_consoleheight,
+    x_consolestatus,
+    x_consolesave,
+    x_cancel_halt,
+    x_cancel_halt_write_clear,
+    x_cancel_halt_write,
+    x_cancel_halt_email_clear,
+    x_cancel_halt_email,
+    x_cancel_halt_exec,
+    x_cancel_halt_exec_clear,
+    x_error_halt_write_clear,
+    x_error_halt_write,
+    x_error_halt_email_clear,
+    x_error_halt_email,
+    x_error_halt_exec,
+    x_error_halt_exec_clear,
+    x_write_warnings,
+    x_gui_level,
+    x_execute,
 )
 
 # Regex helper functions (from utils/regex.py)
 from execsql.utils.regex import (
-    ins_rxs,  # noqa: F401
-    ins_quoted_rx,  # noqa: F401
-    ins_schema_rxs,  # noqa: F401
-    ins_table_rxs,  # noqa: F401
-    ins_table_list_rxs,  # noqa: F401
-    ins_fn_rxs,  # noqa: F401
+    ins_rxs,
+    ins_quoted_rx,
+    ins_schema_rxs,
+    ins_table_rxs,
+    ins_table_list_rxs,
+    ins_fn_rxs,
 )
-from execsql.script import MetaCommandList  # noqa: F401
+from execsql.script import MetaCommandList
 
 __all__ = [
     # execsql.state
@@ -303,6 +304,7 @@ __all__ = [
     "x_export_query_with_template",
     "x_export_with_template",
     "x_export_ods_multiple",
+    "x_export_xlsx_multiple",
     "x_export_metadata",
     "x_export_metadata_table",
     "x_import",
@@ -427,12 +429,31 @@ TEXT_FORMATS = ["TXT", "TXT-AND", "PLAIN"]
 JSON_VARIANT_FORMATS = ["JSON_TS", "JSON_TABLESCHEMA"]
 
 QUERY_EXPORT_FORMATS = (
-    DELIMITED_FORMATS + TEXT_FORMATS + ["ODS", "JSON", "HTML", "CGI-HTML", "VALUES", "LATEX", "RAW", "B64", "FEATHER"]
+    DELIMITED_FORMATS
+    + TEXT_FORMATS
+    + ["ODS", "XLSX", "JSON", "HTML", "CGI-HTML", "VALUES", "LATEX", "RAW", "B64", "FEATHER", "YAML", "MARKDOWN", "MD"]
 )
 TABLE_EXPORT_FORMATS = (
     DELIMITED_FORMATS
     + TEXT_FORMATS
-    + ["JSON", "XML", "VALUES", "HTML", "CGI-HTML", "SQLITE", "DUCKDB", "LATEX", "RAW", "B64", "FEATHER", "HDF5"]
+    + [
+        "JSON",
+        "XML",
+        "VALUES",
+        "HTML",
+        "CGI-HTML",
+        "SQLITE",
+        "DUCKDB",
+        "LATEX",
+        "RAW",
+        "B64",
+        "FEATHER",
+        "HDF5",
+        "XLSX",
+        "YAML",
+        "MARKDOWN",
+        "MD",
+    ]
 )
 SERVE_FORMATS = ["BINARY", "CSV", "TXT", "TEXT", "ODS", "JSON", "HTML", "PDF", "ZIP"]
 METADATA_FORMATS = ["CSV", "TAB", "TSV", "TABQ", "TSVQ", "TXT", "TEXT"]
@@ -457,6 +478,6 @@ DATABASE_TYPES = [
 # ---------------------------------------------------------------------------
 # Module-level DISPATCH_TABLE — built once at import time.
 # ---------------------------------------------------------------------------
-from execsql.metacommands.dispatch import build_dispatch_table  # noqa: E402
+from execsql.metacommands.dispatch import build_dispatch_table
 
 DISPATCH_TABLE = build_dispatch_table()

execsql/metacommands/dispatch.py

@@ -107,6 +107,7 @@ from execsql.metacommands.io import (
     x_export_metadata,
     x_export_metadata_table,
     x_export_ods_multiple,
+    x_export_xlsx_multiple,
     x_export_query,
     x_export_query_with_template,
     x_export_row_buffer,
@@ -395,6 +396,16 @@ def build_dispatch_table() -> MetaCommandList:
         ),
         x_export_ods_multiple,
     )
+    mcl.add(
+        ins_table_list_rxs(
+            r"^\s*EXPORT\s+",
+            ins_fn_rxs(
+                r"\s+(?P<tee>TEE\s+)?(?P<append>APPEND\s+)?TO\s+",
+                r'\s+AS\s+XLSX(?:\s+DESCRIP(?:TION)?\s+"(?P<description>[^"]*)")?\s*$',
+            ),
+        ),
+        x_export_xlsx_multiple,
+    )
 
     # ------------------------------------------------------------------
     # IMPORT_FILE

execsql/metacommands/io.py

@@ -22,6 +22,7 @@ from execsql.metacommands.io_export import (  # noqa: F401
     x_export_metadata,
     x_export_metadata_table,
     x_export_ods_multiple,
+    x_export_xlsx_multiple,
     x_export_query,
     x_export_query_with_template,
     x_export_row_buffer,
@@ -78,6 +79,7 @@ __all__ = [
     "x_export_metadata",
     "x_export_metadata_table",
     "x_export_ods_multiple",
+    "x_export_xlsx_multiple",
     "x_export_query",
     "x_export_query_with_template",
     "x_export_row_buffer",

execsql/metacommands/io_export.py

@@ -19,6 +19,7 @@ from execsql.exporters.html import write_query_to_cgi_html, write_query_to_html
 from execsql.exporters.json import write_query_to_json, write_query_to_json_ts
 from execsql.exporters.latex import write_query_to_latex
 from execsql.exporters.ods import write_queries_to_ods, write_query_to_ods
+from execsql.exporters.xlsx import write_queries_to_xlsx, write_query_to_xlsx
 from execsql.exporters.parquet import write_query_to_parquet
 from execsql.exporters.pretty import prettyprint_query, prettyprint_rowset
 from execsql.exporters.raw import write_query_b64, write_query_raw
@@ -26,6 +27,8 @@ from execsql.exporters.sqlite import write_query_to_sqlite
 from execsql.exporters.templates import report_query
 from execsql.exporters.values import write_query_to_values
 from execsql.exporters.xml import write_query_to_xml
+from execsql.exporters.markdown import write_query_to_markdown
+from execsql.exporters.yaml import write_query_to_yaml
 from execsql.importers.base import import_data_table
 from execsql.script import current_script_line
 from execsql.utils.errors import exception_desc
@@ -85,6 +88,8 @@ def x_export(**kwargs: Any) -> None:
             raise ErrInfo("error", other_msg="Cannot export to the HDF5 format within a zipfile.")
         if filefmt == "ods":
             raise ErrInfo("error", other_msg="Cannot export to an ODS workbook within a zipfile.")
+        if filefmt == "xlsx":
+            raise ErrInfo("error", other_msg="Cannot export to an XLSX workbook within a zipfile.")
     notype = bool(kwargs.get("notype"))
     if zipfilename is not None:
         check_dir(zipfilename)
@@ -120,6 +125,15 @@ def x_export(**kwargs: Any) -> None:
             sheetname=queryname,
             desc=description,
         )
+    elif filefmt == "xlsx":
+        write_query_to_xlsx(
+            select_stmt,
+            _state.dbs.current(),
+            outfile,
+            append,
+            sheetname=queryname,
+            desc=description,
+        )
     elif filefmt == "duckdb":
         write_query_to_duckdb(select_stmt, _state.dbs.current(), outfile, append, tablename=queryname)
     elif filefmt == "sqlite":
@@ -191,6 +205,24 @@ def x_export(**kwargs: Any) -> None:
         )
     elif filefmt == "hdf5":
         write_query_to_hdf5(table, select_stmt, _state.dbs.current(), outfile, append, desc=description)
+    elif filefmt == "yaml":
+        write_query_to_yaml(
+            select_stmt,
+            _state.dbs.current(),
+            outfile,
+            append,
+            desc=description,
+            zipfile=zipfilename,
+        )
+    elif filefmt in ("markdown", "md"):
+        write_query_to_markdown(
+            select_stmt,
+            _state.dbs.current(),
+            outfile,
+            append,
+            desc=description,
+            zipfile=zipfilename,
+        )
     else:
         try:
             hdrs, rows = _state.dbs.current().select_rowsource(select_stmt)
@@ -237,6 +269,8 @@ def x_export_query(**kwargs: Any) -> None:
             raise ErrInfo("error", other_msg="Cannot export to the HDF5 format within a zipfile.")
         if filefmt == "ods":
             raise ErrInfo("error", other_msg="Cannot export to an ODS workbook within a zipfile.")
+        if filefmt == "xlsx":
+            raise ErrInfo("error", other_msg="Cannot export to an XLSX workbook within a zipfile.")
     notype = bool(kwargs.get("notype"))
     check_dir(outfile)
     if tee and outfile.lower() != "stdout":
@@ -270,6 +304,16 @@ def x_export_query(**kwargs: Any) -> None:
             sheetname=f"Query_{lno}",
             desc=description,
         )
+    elif filefmt == "xlsx":
+        script_name, lno = current_script_line()
+        write_query_to_xlsx(
+            select_stmt,
+            _state.dbs.current(),
+            outfile,
+            append,
+            sheetname=f"Query_{lno}",
+            desc=description,
+        )
     elif filefmt == "json":
         write_query_to_json(
             select_stmt,
@@ -325,6 +369,24 @@ def x_export_query(**kwargs: Any) -> None:
             desc=description,
             zipfile=zipfilename,
         )
+    elif filefmt == "yaml":
+        write_query_to_yaml(
+            select_stmt,
+            _state.dbs.current(),
+            outfile,
+            append,
+            desc=description,
+            zipfile=zipfilename,
+        )
+    elif filefmt in ("markdown", "md"):
+        write_query_to_markdown(
+            select_stmt,
+            _state.dbs.current(),
+            outfile,
+            append,
+            desc=description,
+            zipfile=zipfilename,
+        )
     else:
         try:
             hdrs, rows = _state.dbs.current().select_rowsource(select_stmt)
@@ -403,6 +465,19 @@ def x_export_ods_multiple(**kwargs: Any) -> None:
     write_queries_to_ods(table_list, _state.dbs.current(), outfile, append, tee, desc=description)
 
 
+def x_export_xlsx_multiple(**kwargs: Any) -> None:
+    """Export multiple tables to separate worksheets in a single XLSX workbook."""
+    table_list = kwargs["tables"]
+    outfile = kwargs["filename"]
+    description = kwargs["description"]
+    tee = kwargs["tee"]
+    tee = bool(tee)
+    append = kwargs["append"]
+    append = append is not None
+    check_dir(outfile)
+    write_queries_to_xlsx(table_list, _state.dbs.current(), outfile, append, tee, desc=description)
+
+
 def x_export_metadata(**kwargs: Any) -> None:
     outfile = kwargs["filename"]
     append = kwargs["append"] is not None