pyOpenVBA 1.0.0__py3-none-any.whl

pyopenvba/__init__.py

@@ -0,0 +1,80 @@
+"""
+pyOpenVBA
+=========
+Read and write VBA sections of xlsm / xlsb / xls Excel files
+using pure Python — no external dependencies.
+
+Public API
+----------
+    from pyopenvba import ExcelFile, pull, push
+
+    # In-process module edit
+    with ExcelFile("workbook.xlsm") as wb:
+        modules = wb.vba_modules()          # dict[name -> source]
+        wb.set_module("Module1", new_src)
+        wb.save("workbook_modified.xlsm")
+
+    # Disk-based workflow (.bas / .cls files)
+    pull("workbook.xlsm", "./vba_src")      # extract modules
+    push("./vba_src", "workbook.xlsm")      # write edits back in place
+"""
+
+from pathlib import Path
+from typing import Union
+
+from pyopenvba.excel import ExcelFile
+from pyopenvba.exceptions import (
+    PyOpenVBAError,
+    CFBError,
+    VBAProjectError,
+    UnsupportedFormatError,
+)
+from pyopenvba.vba import VBAModuleKind
+
+
+def pull(
+    workbook: Union[str, Path],
+    dest_dir: Union[str, Path],
+    *,
+    encoding: str = "utf-8",
+    overwrite: bool = True,
+) -> list[Path]:
+    """
+    Export every VBA module from ``workbook`` into ``dest_dir`` as
+    ``.bas`` / ``.cls`` files. Returns the paths written.
+    """
+    with ExcelFile(workbook) as wb:
+        return wb.pull_modules(dest_dir, encoding=encoding, overwrite=overwrite)
+
+
+def push(
+    src_dir: Union[str, Path],
+    workbook: Union[str, Path],
+    *,
+    out: Union[str, Path, None] = None,
+    encoding: str = "utf-8",
+    strict: bool = False,
+) -> list[str]:
+    """
+    Update VBA modules in ``workbook`` from ``.bas`` / ``.cls`` files
+    in ``src_dir`` and save. Saves in place unless ``out`` is given.
+    Returns the list of updated module names.
+    """
+    with ExcelFile(workbook) as wb:
+        updated = wb.push_modules(src_dir, encoding=encoding, strict=strict)
+        wb.save(out)
+    return updated
+
+
+__all__ = [
+    "ExcelFile",
+    "VBAModuleKind",
+    "PyOpenVBAError",
+    "CFBError",
+    "VBAProjectError",
+    "UnsupportedFormatError",
+    "pull",
+    "push",
+]
+
+__version__ = "1.0.0"

pyopenvba/__main__.py

@@ -0,0 +1,68 @@
+"""
+Command-line entry point.
+
+Usage::
+
+    python -m pyopenvba pull <workbook> <dest_dir>
+    python -m pyopenvba push <src_dir> <workbook> [--out <new_path>] [--strict]
+    python -m pyopenvba ls   <workbook>
+"""
+
+from __future__ import annotations
+
+import argparse
+import sys
+from pathlib import Path
+
+from pyopenvba import ExcelFile, pull, push
+
+
+def _cmd_pull(args: argparse.Namespace) -> int:
+    written = pull(args.workbook, args.dest, overwrite=not args.no_overwrite)
+    for p in written:
+        print(p)
+    return 0
+
+
+def _cmd_push(args: argparse.Namespace) -> int:
+    updated = push(args.src, args.workbook, out=args.out, strict=args.strict)
+    for name in updated:
+        print(name)
+    return 0
+
+
+def _cmd_ls(args: argparse.Namespace) -> int:
+    with ExcelFile(args.workbook) as wb:
+        for m in wb.vba_project().modules:
+            print(f"{m.kind.name:8s}  {m.name}")
+    return 0
+
+
+def main(argv: list[str] | None = None) -> int:
+    parser = argparse.ArgumentParser(prog="pyopenvba")
+    sub = parser.add_subparsers(dest="cmd", required=True)
+
+    p_pull = sub.add_parser("pull", help="Export VBA modules to a directory.")
+    p_pull.add_argument("workbook", type=Path)
+    p_pull.add_argument("dest", type=Path)
+    p_pull.add_argument("--no-overwrite", action="store_true")
+    p_pull.set_defaults(func=_cmd_pull)
+
+    p_push = sub.add_parser("push", help="Import VBA modules from a directory and save.")
+    p_push.add_argument("src", type=Path)
+    p_push.add_argument("workbook", type=Path)
+    p_push.add_argument("--out", type=Path, default=None)
+    p_push.add_argument("--strict", action="store_true",
+                        help="Fail if any source file has no matching module.")
+    p_push.set_defaults(func=_cmd_push)
+
+    p_ls = sub.add_parser("ls", help="List VBA modules in a workbook.")
+    p_ls.add_argument("workbook", type=Path)
+    p_ls.set_defaults(func=_cmd_ls)
+
+    args = parser.parse_args(argv)
+    return int(args.func(args))
+
+
+if __name__ == "__main__":   # pragma: no cover
+    sys.exit(main())