【Python】Python で Excel の VBA コードを抽出し VSCode でコーディングする方法（XVBA がうまく動作しない場合の代替手段）

作成日: 2025/06/02, 更新日: 2025/06/02

XVBA は Visual Studio Code の拡張機能で、Excel の VBA コードを抽出してファイル化することができます。
VBA コードをファイル化することで、コードの変更管理が容易になったり、Git Hub Copilot を利用してコードの補完を行うことができます。
しかし、自分の環境で XVBA を利用しようとしたところ、VBA コードをエクセルファイルへ書き込んだ後にエクセルファイルが開けなくなってしまうという問題が発生しました。
本記事では、XVBA がうまく動作しない場合の代替手段として、Python を利用して Excel の VBA コードを抽出する方法を紹介いたします。

コーディングルール・前提条件
（先に結論）Excel の VBA コードを抽出/書き込みする Python スクリプト
Python スクリプトの解説
1. sync_vba.py の構成
定数の説明
関数の説明
(番外編) VBA コードを保存した時に自動でエクセルファイルに書き戻す方法
1. .vscode/extensions.json
2. .vscode/settings.json

コーディングルール・前提条件

本記事に記載の Python スクリプトでは、PEP8 に準拠しています。
- flake 8 による構文チェックと、 black による自動フォーマットを実施しています。
- 処理の都合上チェックを無視する必要があるコードには、 # noqa を記載しています。
- 1行当たりの最大文字数（ max-line-length ）は 200 に設定しています。
Python のランタイムバージョンは 3.13.3 を利用して動作確認を行っています。
MacOS での動作確認を行っておりません。Mac 版の Office を導入している環境でも動作する可能性はありますが、 Windows 環境での動作を前提にしています。
VBA を Visual Studio Code で編集するための拡張機能は、以下のものを利用しています。
- VBA - Visual Basic for Applications
以下の定義を .vscode\extensions.json に追記することで、Visual Studio Code で VBA ファイルを開いた際に、VBA の拡張機能を自動的に有効化できます。

{
    "recommendations": [
        "serkonda7.vscode-vba"
    ]
}

Visual Studio Code の設定ファイル（ settings.json ）に以下の内容を追加することで、VBA ファイルを Shift-JIS で開くように設定してください。
- Python ファイルと JSON ファイルは UTF-8 で開くように設定しています。

{
    "files.encoding": "shiftjis",
    "[python]": {
        "files.encoding": "utf8"
    },
    "[json]": {
        "files.encoding": "utf8"
    }
}

（先に結論）Excel の VBA コードを抽出/書き込みする Python スクリプト

以下の Python スクリプトが、Excel の VBA コードを抽出/書き込みします。適当 Python ファイルの名前（例： sync_vba.py ）で保存してください。

import argparse
import difflib
import json
import os
import shutil
import sys
import zipfile
from datetime import datetime

import openpyxl
import xlwings as xw
from oletools.olevba import VBA_Parser

CONFIG_FILE = "config.json"
CACHE_DIR = ".cache"
BACKUP_KEEP_COUNT = 3 


def create_config():
    config = {"xlsm_file_path": "your_xlsm_file_path_here.xlsm"}
    with open(CONFIG_FILE, "w", encoding="utf-8") as f:
        json.dump(config, f, indent=4, ensure_ascii=False)
    print(f"{CONFIG_FILE} has been created. Please edit xlsm_file_path.")


def load_config():
    if not os.path.exists(CONFIG_FILE):
        print(
            f"{CONFIG_FILE} not found. Please initialize with the --init option."
        )
        sys.exit(1)
    with open(CONFIG_FILE, "r", encoding="utf-8") as f:
        return json.load(f)


def extract_vba(xlsm_file_path, output_dir="vba", force_master=False):
    if not os.path.exists(xlsm_file_path):
        sys.exit(1)
    if not os.path.exists(output_dir):
        os.makedirs(output_dir)
    if not os.path.exists(CACHE_DIR):
        os.makedirs(CACHE_DIR)
    with zipfile.ZipFile(xlsm_file_path, "r") as z:
        vba_bin_path = None
        for f in z.namelist():
            if f == "xl/vbaProject.bin":
                vba_bin_path = f
                break
        if not vba_bin_path:
            sys.exit(1)
        tmp_bin = os.path.join(CACHE_DIR, "vbaProject.bin")
        with z.open(vba_bin_path) as src, open(tmp_bin, "wb") as dst:
            dst.write(src.read())
    vba_parser = VBA_Parser(tmp_bin)
    if not vba_parser.detect_vba_macros():
        return
    for (filename, stream_path, vba_filename, vba_code) in vba_parser.extract_macros():
        if vba_code:
            filtered_code = "\n".join(
                line for line in vba_code.splitlines() if not line.strip().startswith("Attribute VB_")
            )
            cache_path = os.path.join(CACHE_DIR, vba_filename)
            with open(cache_path, "w", encoding="shift-jis") as f:
                f.write(filtered_code)
            vba_path = os.path.join(output_dir, vba_filename)
            if os.path.exists(vba_path):
                try:
                    with open(vba_path, "r", encoding="shift-jis") as f1:
                        old = f1.readlines()
                except UnicodeDecodeError:
                    with open(vba_path, "r", encoding="utf-8") as f1:
                        content = f1.read()
                    with open(vba_path, "w", encoding="shift-jis") as f1:
                        f1.write(content)
                    old = content.splitlines(keepends=True)
                with open(cache_path, "r", encoding="shift-jis") as f2:
                    new = f2.readlines()
                diff = list(difflib.unified_diff(old, new, fromfile=vba_path, tofile=cache_path))
                if diff:
                    print(f"\nDiff for {vba_filename}:")
                    print("")
                    print("".join(diff))
                    print("")
                    print("* + : New content extracted from xlsm file, - : Content in current file)")
                    if force_master:
                        print(f"--force option: {vba_filename} will keep the current file as master.")
                        continue
                    while True:
                        sel = input(f"Difference found in {vba_filename}. Which do you want to keep as master? [k] Keep current file/[n] Overwrite with new extracted content > ").strip().lower()
                        if sel == "k":
                            break
                        elif sel == "n":
                            with open(vba_path, "w", encoding="shift-jis") as f:
                                f.write(filtered_code)
                            break
            else:
                with open(vba_path, "w", encoding="shift-jis") as f:
                    f.write(filtered_code)


def write_vba_to_xlsm(xlsm_file_path, vba_dir="vba"):
    abs_path = os.path.abspath(xlsm_file_path)
    if not os.path.exists(abs_path):
        print("The specified xlsm file does not exist. Please check the path.")
        sys.exit(1)
    app = xw.App(visible=False)
    try:
        wb = xw.Book(abs_path)
        vba_modules = {mod.Name: mod for mod in wb.api.VBProject.VBComponents}
        for fname in os.listdir(vba_dir):
            if fname.startswith("."):
                continue
            fpath = os.path.join(vba_dir, fname)
            if not os.path.isfile(fpath):
                continue
            mod_name, ext = os.path.splitext(fname)
            import re
            if not re.match(r"^[A-Za-z_][A-Za-z0-9_]*$", mod_name):
                print(f"Invalid module name: {mod_name} (Must start with a letter or _, and only contain alphanumeric and _)")
                sys.exit(1) 
            if mod_name in vba_modules:
                with open(fpath, "r", encoding="shift-jis") as f:
                    code = f.read()
                code_module = vba_modules[mod_name].CodeModule
                code_module.DeleteLines(1, code_module.CountOfLines)
                code_module.AddFromString(code)
            else:
                if ext.lower() == ".bas":
                    kind = 1
                elif ext.lower() == ".cls":
                    kind = 2
                elif ext.lower() == ".frm":
                    kind = 3
                else:
                    continue
                with open(fpath, "r", encoding="shift-jis") as f:
                    code = f.read()
                mod = wb.api.VBProject.VBComponents.Add(kind)
                mod.Name = mod_name
                mod.CodeModule.AddFromString(code)
        wb.save()
        wb.close()
    except Exception as e:
        print("Error opening workbook:", e)
        raise
    finally:
        app.quit()


def backup_xlsm(xlsm_file_path):
    if not os.path.exists(CACHE_DIR):
        os.makedirs(CACHE_DIR)
    base = os.path.basename(xlsm_file_path)
    dt = datetime.now().strftime("%Y%m%d_%H%M%S")
    backup_name = f"{base}.{dt}.bak"
    backup_path = os.path.join(CACHE_DIR, backup_name)
    shutil.copy2(xlsm_file_path, backup_path)
    backups = sorted(
        [f for f in os.listdir(CACHE_DIR) if f.startswith(base) and f.endswith(".bak")],
        reverse=True
    )
    for old in backups[BACKUP_KEEP_COUNT:]:
        try:
            os.remove(os.path.join(CACHE_DIR, old))
        except Exception:
            pass


def main(force_master=False):
    config = load_config()
    xlsm_file_path = config.get("xlsm_file_path")
    if not xlsm_file_path:
        print("xlsm_file_path is not set in config.json.")
        sys.exit(1)
    backup_xlsm(xlsm_file_path)
    extract_vba(xlsm_file_path, force_master=force_master)
    write_vba_to_xlsm(xlsm_file_path)
    print("Completed successfully.")


if __name__ == "__main__":
    parser = argparse.ArgumentParser(
        description="VBA module sync tool"
    )
    parser.add_argument("--init", action="store_true", help="Initialize config.json.")
    parser.add_argument("--force", action="store_true", help="Keep existing vba files as master even if there are differences.")
    args = parser.parse_args()

    if args.init:
        create_config()
        sys.exit(0)
    main(force_master=args.force)

Python スクリプトでは以下のモジュールを利用しています。
- 標準ライブラリ
  - argparse : コマンドライン引数の解析
  - difflib : 差分の表示
  - json : 設定ファイルの読み書き
  - os , shutil , sys , zipfile : ファイル操作
  - datetime : 日時の操作
- 外部ライブラリ
  - openpyxl : Excel ファイルの読み書き
  - xlwings : Excel VBA の操作
  - oletools : VBA コードの抽出
モジュールをインストールするには、以下のコマンドを実行してください。

pip install openpyxl xlwings oletools

初回実行時は、以下のコマンドで config.json を生成します。

python sync_vba.py --init

生成された config.json をエディタで開き、 xlsm_file_path の値を、VBA コードを抽出したい Excel ファイルのパスに変更してください。

{
    "xlsm_file_path": "your_xlsm_file_path_here.xlsm"
}

その後、以下のコマンドで VBA コードの抽出と書き込みを行います。

python sync_vba.py

以下は実行例となります。エクセルファイル内との VBA コードに差分がない場合は、特に出力はありません。

> python .\sync_vba.py
Completed successfully.

VBA コードに差分がある場合は、差分が表示されます。どちらをマスターにするかを選択するプロンプトが表示されます。
- n を入力すると、現在のファイルを上書きします。

> python .\sync_vba.py

Diff for Sheet1.cls:

--- vba\Sheet1.cls
+++ .cache\Sheet1.cls
@@ -6,6 +6,7 @@
         ActiveWindow.ScrollRow = 1
         ActiveWindow.ScrollColumn = 1
     Next ws
+    Debug.Print ("TEST")
     ThisWorkbook.Worksheets(1).Activate
     ThisWorkbook.Worksheets(1).Range("A1").Select
 End Sub

* + : New content extracted from xlsm file, - : Content in current file)
Difference found in Sheet1.cls. Which do you want to keep as master? [k] Keep current file/[n] Overwrite with new extracted content >

--force オプションを指定すると、VBA コードの差分がある場合でも、現在の VBA ファイルをマスターとして保持します。

python sync_vba.py --force

コマンドを実行後、以下のフォルダ/ファイルが生成されます。
- vba ディレクトリ内の VBA ファイルは、Visual Studio Code で編集できます。VBA コードを変更した後、再度 sync_vba.py を実行すると、変更が Excel ファイルに反映されます。

# コーディングルール・前提条件で作成したファイル
.vscode
├── extensions.json
├── settings.json
# 抽出された VBA コードを保存するディレクトリ
vba
├── Sheet1.cls
├── ThisWorkbook.cls
├── Module1.bas
# 一時ファイルを保存するディレクトリ（エクセルファイルから抽出した VBA コードや、バックアップファイルを保存）
.cache
├── Sheet1.cls
├── ThisWorkbook.cls
├── Module1.bas
├── your_xlsm_file_path_here.xlsm.${datetime}.bak
# --init オプションで生成される設定ファイル
config.json
# VBA コードを抽出/書き込みする Python スクリプト本体
sync_vba.py

Python スクリプトの解説

sync_vba.py の構成

sync_vba.py は、Excel ファイルから VBA コードを抽出し、指定されたディレクトリに保存するスクリプトです。
スクリプトは以下の機能を持っています。
- --init オプションで初期設定ファイル config.json を生成
- --force オプションで差分がある場合でも現在のファイルをマスターとして保持
- Excel ファイルから VBA コードを抽出し、指定ディレクトリに保存
- 抽出した VBA コードを Excel ファイルに書き戻す
- 差分がある場合は、ユーザーにどちらをマスターにするかを選択させる
スクリプトは、以下の順番で処理を行います。
1. config.json ファイルを読み込み、Excel ファイルのパスを取得
2. Excel ファイルのバックアップを作成
3. Excel ファイルから VBA コードを抽出し、指定ディレクトリに保存
4. 抽出した VBA コードを Excel ファイルに書き戻す

定数の説明

Python スクリプト内で使用される定数は以下の通りです。必要に変更してご利用ください。
- CONFIG_FILE : 設定ファイルの名前。 config.json として保存されます。
- CACHE_DIR : 一時ファイルを保存するディレクトリ。 .cache として保存されます。
- BACKUP_KEEP_COUNT : バックアップファイルの保持数。最新のバックアップを含めて、最大でこの数だけバックアップを保持します。

関数の説明

create_config()

設定ファイル config.json を生成します。
初回実行時に --init オプションを指定すると、この関数が呼び出されます。

def create_config():
    config = {"xlsm_file_path": "your_xlsm_file_path_here.xlsm"}
    with open(CONFIG_FILE, "w", encoding="utf-8") as f:
        json.dump(config, f, indent=4, ensure_ascii=False)
    print(f"{CONFIG_FILE} has been created. Please edit xlsm_file_path.")

load_config()

設定ファイル config.json を読み込み、辞書形式で返します。
設定ファイルが存在しない場合は、エラーメッセージを表示して終了します。

def load_config():
    if not os.path.exists(CONFIG_FILE):
        print(
            f"{CONFIG_FILE} not found. Please initialize with the --init option."
        )
        sys.exit(1)
    with open(CONFIG_FILE, "r", encoding="utf-8") as f:
        return json.load(f)

extract_vba(xlsm_file_path, output_dir=“vba”, force_master=False)

指定された Excel ファイルから VBA コードを抽出し、指定されたディレクトリに保存します。
- xlsm_file_path : 対象の Excel ファイルのパス
- output_dir : 抽出した VBA コードを保存するディレクトリ（デフォルトは vba ）
- force_master : 差分がある場合に現在のファイルをマスターとして保持するかどうか（デフォルトは False ）
Excel ファイルが存在しない場合は、エラーメッセージを表示して終了します。
抽出した VBA コードは、 output_dir ディレクトリに保存されます。
差分がある場合は、ユーザーにどちらをマスターにするかを選択させます。

def extract_vba(xlsm_file_path, output_dir="vba", force_master=False):
    if not os.path.exists(xlsm_file_path):
        sys.exit(1)
    if not os.path.exists(output_dir):
        os.makedirs(output_dir)
    if not os.path.exists(CACHE_DIR):
        os.makedirs(CACHE_DIR)
    with zipfile.ZipFile(xlsm_file_path, "r") as z:
        vba_bin_path = None
        for f in z.namelist():
            if f == "xl/vbaProject.bin":
                vba_bin_path = f
                break
        if not vba_bin_path:
            sys.exit(1)
        tmp_bin = os.path.join(CACHE_DIR, "vbaProject.bin")
        with z.open(vba_bin_path) as src, open(tmp_bin, "wb") as dst:
            dst.write(src.read())
    vba_parser = VBA_Parser(tmp_bin)
    if not vba_parser.detect_vba_macros():
        return
    for (filename, stream_path, vba_filename, vba_code) in vba_parser.extract_macros():
        if vba_code:
            filtered_code = "\n".join(
                line for line in vba_code.splitlines() if not line.strip().startswith("Attribute VB_")
            )
            cache_path = os.path.join(CACHE_DIR, vba_filename)
            with open(cache_path, "w", encoding="shift-jis") as f:
                f.write(filtered_code)
            vba_path = os.path.join(output_dir, vba_filename)
            if os.path.exists(vba_path):
                try:
                    with open(vba_path, "r", encoding="shift-jis") as f1:
                        old = f1.readlines()
                except UnicodeDecodeError:
                    with open(vba_path, "r", encoding="utf-8") as f1:
                        content = f1.read()
                    with open(vba_path, "w", encoding="shift-jis") as f1:
                        f1.write(content)
                    old = content.splitlines(keepends=True)
                with open(cache_path, "r", encoding="shift-jis") as f2:
                    new = f2.readlines()
                diff = list(difflib.unified_diff(old, new, fromfile=vba_path, tofile=cache_path))
                if diff:
                    print(f"\nDiff for {vba_filename}:")
                    print("")
                    print("".join(diff))
                    print("")
                    print("* + : New content extracted from xlsm file, - : Content in current file)")
                    if force_master:
                        print(f"--force option: {vba_filename} will keep the current file as master.")
                        continue
                    while True:
                        sel = input(f"Difference found in {vba_filename}. Which do you want to keep as master? [k] Keep current file/[n] Overwrite with new extracted content > ").strip().lower()
                        if sel == "k":
                            break
                        elif sel == "n":
                            with open(vba_path, "w", encoding="shift-jis") as f:
                                f.write(filtered_code)
                            break
            else:
                with open(vba_path, "w", encoding="shift-jis") as f:
                    f.write(filtered_code)

write_vba_to_xlsm(xlsm_file_path, vba_dir=“vba”)

指定された Excel ファイルに、指定されたディレクトリから VBA コードを読み込み、書き戻します。
- xlsm_file_path : 対象の Excel ファイルのパス
- vba_dir : VBA コードが保存されているディレクトリ（デフォルトは vba ）
Excel ファイルが存在しない場合は、エラーメッセージを表示して終了します。
VBA コードは、 vba_dir ディレクトリから読み込み、Excel ファイルに書き戻されます。

def write_vba_to_xlsm(xlsm_file_path, vba_dir="vba"):
    abs_path = os.path.abspath(xlsm_file_path)
    if not os.path.exists(abs_path):
        print("The specified xlsm file does not exist. Please check the path.")
        sys.exit(1)
    app = xw.App(visible=False)
    try:
        wb = xw.Book(abs_path)
        vba_modules = {mod.Name: mod for mod in wb.api.VBProject.VBComponents}
        for fname in os.listdir(vba_dir):
            if fname.startswith("."):
                continue
            fpath = os.path.join(vba_dir, fname)
            if not os.path.isfile(fpath):
                continue
            mod_name, ext = os.path.splitext(fname)
            import re
            if not re.match(r"^[A-Za-z_][A-Za-z0-9_]*$", mod_name):
                print(f"Invalid module name: {mod_name} (Must start with a letter or _, and only contain alphanumeric and _)")
                sys.exit(1) 
            if mod_name in vba_modules:
                with open(fpath, "r", encoding="shift-jis") as f:
                    code = f.read()
                code_module = vba_modules[mod_name].CodeModule
                code_module.DeleteLines(1, code_module.CountOfLines)
                code_module.AddFromString(code)
            else:
                if ext.lower() == ".bas":
                    kind = 1
                elif ext.lower() == ".cls":
                    kind = 2
                elif ext.lower() == ".frm":
                    kind = 3
                else:
                    continue
                with open(fpath, "r", encoding="shift-jis") as f:
                    code = f.read()
                mod = wb.api.VBProject.VBComponents.Add(kind)
                mod.Name = mod_name
                mod.CodeModule.AddFromString(code)
        wb.save()
        wb.close()
    except Exception as e:
        print("Error opening workbook:", e)
        raise
    finally:
        app.quit()

backup_xlsm(xlsm_file_path)

指定された Excel ファイルのバックアップを作成します。
バックアップファイルは、 .cache ディレクトリに保存され、最新のバックアップを含めて最大 BACKUP_KEEP_COUNT 個のバックアップを保持します。
バックアップファイルの名前は、元のファイル名に日時を付加した形式になります。

def backup_xlsm(xlsm_file_path):
    if not os.path.exists(CACHE_DIR):
        os.makedirs(CACHE_DIR)
    base = os.path.basename(xlsm_file_path)
    dt = datetime.now().strftime("%Y%m%d_%H%M%S")
    backup_name = f"{base}.{dt}.bak"
    backup_path = os.path.join(CACHE_DIR, backup_name)
    shutil.copy2(xlsm_file_path, backup_path)
    backups = sorted(
        [f for f in os.listdir(CACHE_DIR) if f.startswith(base) and f.endswith(".bak")],
        reverse=True
    )
    for old in backups[BACKUP_KEEP_COUNT:]:
        try:
            os.remove(os.path.join(CACHE_DIR, old))
        except Exception:
            pass

main(force_master=False)

スクリプトのメイン処理を実行します。
- force_master : 差分がある場合に現在のファイルをマスターとして保持するかどうか（デフォルトは False ）
設定ファイルを読み込み、Excel ファイルのパスを取得します。
Excel ファイルのバックアップを作成し、VBA コードの抽出と書き戻しを行います。
処理が成功した場合は、完了メッセージを表示します。

def main(force_master=False):
    config = load_config()
    xlsm_file_path = config.get("xlsm_file_path")
    if not xlsm_file_path:
        print("xlsm_file_path is not set in config.json.")
        sys.exit(1)
    backup_xlsm(xlsm_file_path)
    extract_vba(xlsm_file_path, force_master=force_master)
    write_vba_to_xlsm(xlsm_file_path)
    print("Completed successfully.")

エントリーポイント

スクリプトが直接実行された場合のエントリーポイントは if __name__ == "__main__": ブロックです。
argparse モジュールを使用してコマンドライン引数を解析します。
- --init : 設定ファイルを生成するオプション
- --force : 差分がある場合に現在のファイルをマスターとして保持するオプション
コマンドライン引数を解析し、 --init オプションが指定された場合は設定ファイルを生成します。
それ以外の場合は、 main() 関数を呼び出して処理を実行します。

if __name__ == "__main__":
    parser = argparse.ArgumentParser(
        description="VBA module sync tool"
    )
    parser.add_argument("--init", action="store_true", help="Initialize config.json.")
    parser.add_argument("--force", action="store_true", help="Keep existing vba files as master even if there are differences.")
    args = parser.parse_args()

    if args.init:
        create_config()
        sys.exit(0)
    main(force_master=args.force)

(番外編) VBA コードを保存した時に自動でエクセルファイルに書き戻す方法

Visual Studio Code で VBA コードを保存した際に、Python スクリプトを自動で実行してエクセルファイルに書き戻すための設定を行います。
Visual Studio Code の拡張機能 Run On Save を利用することで、ファイルを保存した際に Visual Studio Code からコマンドを実行できます。
この拡張機能を利用するために、ワークスペース（エクセルを開いているディレクトリ）に以下の 2 つのファイルを作成します。

.vscode/extensions.json

Visual Studio Code の拡張機能を推奨する設定ファイルです。以下の内容を .vscode/extensions.json に保存してください。
- VBA ファイルを開いた際に、VBA の拡張機能を自動的に Run On Save 拡張機能を有効化します。

{
    "recommendations": [
        "emeraldwalk.RunOnSave"
    ]
}

.vscode/settings.json

Visual Studio Code の設定ファイルです。以下の内容を .vscode/settings.json に保存してください。
- VBA ファイルを保存した際に、Python スクリプトを実行するように設定します。

{
    "emeraldwalk.runonsave": {
        "commands": [
            {
                "match": ".*\\.(cls|bas)$",
                "isAsync": false,
                "cmd": "python .\\sync_vba.py --force"
            }
        ]
    }
}