メインコンテンツへスキップ
見出し画像

win32comのDispatchは「開いているExcel」につながる|DispatchExで自分専用のExcelを起動して必ず閉じる

    こんにちは、すきまログです。

    以前、openpyxlで数式の値が取れないので、Excelに再計算させて読むという記事を書きました。Python から Excel 本体を動かして、数式を計算させてから値を読む方法です。

    その「Excel 本体を動かす」部分で、あとから3つの問題を踏みました。どれもエラーにならないか、エラーが別の場所で出るものでした。今日は、その3つと、最終的に落ち着いた書き方をまとめます。

    1. Dispatch は、すでに開いている Excel につながる

    最初に書いていたのは、よく見かけるこの形です。

    import win32com.client
    xl = win32com.client.Dispatch("Excel.Application")

    Dispatch は、すでに Excel が起動していれば、その Excel につながります。新しい Excel を起動するとは限りません。

    これが問題になるのは、処理の最後に xl.Quit() を呼ぶときです。もし人が別のブックを Excel で開いて作業していたら、その Excel ごと閉じることになります。未保存の変更があってもです。そのときはたまたま誰も Excel を開いていなかったので実害はありませんでしたが、気づいたときはひやっとしました。

    対策は、DispatchEx を使うことです。DispatchEx は、必ず新しい Excel のプロセスを起動します。

    xl = win32com.client.DispatchEx("Excel.Application")   # 🔴 Dispatch ではなく DispatchEx

    2. Quit しても、窓の無い Excel が残る

    次の問題は、Quit() を呼んだのに Excel のプロセスが残ることでした。タスクマネージャーを見ると、窓の無い Excel が2つ残っていました。

    Python 側が Excel のオブジェクト(ブックやシートの参照)を持ったままだと、Quit しても Excel が終われないことがあるようです。

    そして、この残った Excel がファイルを握ったままになっていました。そのあと openpyxl でそのファイルを保存しようとしたら、PermissionError で失敗しました。

    ここで、もうひとつ失敗をしています。保存できない理由を、確かめずに「誰かがExcelで開いたままにしている」と思い込んで、そう報告してしまったのです。実際には、自分のスクリプトが残した Excel でした。それを止めたら、普通に保存できました。

    対策として、起動した Excel のプロセス番号を最初に控えておき、終わるときに、閉じる→Quit→参照を捨てる→それでも残っていたら、その番号だけ止めるようにしました。

    def read_cells(path, sheet, cells):
        pythoncom.CoInitialize()
        xl = win32com.client.DispatchEx("Excel.Application")
        pid = win32process.GetWindowThreadProcessId(xl.Hwnd)[1]
        out = {}
        try:
            xl.Visible = False
            xl.DisplayAlerts = False
            wb = xl.Workbooks.Open(os.path.abspath(path), ReadOnly=True)
            try:
                xl.CalculateFull()
                ws = wb.Worksheets(sheet)
                for c in cells:
                    out[c] = ws.Range(c).Value
                del ws
            finally:
                wb.Close(SaveChanges=False)
                del wb
        finally:
            try:
                xl.Quit()
            except Exception:
                pass
            del xl
            gc.collect()
            for _ in range(20):                 # 最大2秒待って、残っていれば自分の番号だけ止める
                if not _alive(pid):
                    break
                time.sleep(0.1)
            if _alive(pid):
                _kill(pid)
            pythoncom.CoUninitialize()
        return out

    xl.Hwnd(Excel の窓のハンドル)から GetWindowThreadProcessId でプロセス番号を取っています。止めるのは自分で起動したこの番号だけなので、人が開いている Excel を巻き込むことはありません。

    ブックは読み取り専用で開いて、保存もしません。値を読むだけなら、元のファイルを書き換える理由がないからです。

    3. gen_py のキャッシュが壊れていて落ちる

    3つ目は、pywin32 の型情報のキャッシュ(gen_py)が壊れていて、起動の時点で落ちる問題でした。

    AttributeError: ... has no attribute 'CLSIDToClassMap'

    一時フォルダの gen_py の中に、__init__.py の無い作りかけのフォルダが残っていたのが原因でした。前に何かの処理が途中で止まって、中途半端な状態で残ったようです。

    対策として、このスクリプトではキャッシュの置き場所を自分専用のフォルダに付け替えています。壊れた既存のキャッシュを使わずに済みます。

    import tempfile
    import win32com
    
    _GEN = os.path.join(tempfile.gettempdir(), "gen_py_excel_safe")
    os.makedirs(_GEN, exist_ok=True)
    win32com.__gen_path__ = _GEN          # 壊れた既存の gen_py キャッシュを使わない
    import win32com.client  # noqa: E402

    ここで、また横展開の漏れがありました。この付け替えは、最初に問題を踏んだスクリプトにだけ入れていて、同じように win32com で Excel や Word を動かしている別のスクリプトには広げていなかったのです。1週間後、その別のスクリプトが同じエラーで止まりました。今は、win32com を使っているスクリプトを grep で洗い出して、全部に同じ対策を入れています。

    最終的な形

    まとめると、Python から Excel を動かすときは、こうしています。

    • DispatchEx で自分専用の Excel を起動する(開いている Excel にはつながない)

    • 起動したプロセス番号を控え、最後に残っていたらその番号だけ止める

    • ブックは読み取り専用で開き、保存しない

    • gen_py の置き場所を自分専用に付け替える

    • これを1つの関数にまとめて、自分で毎回 win32com を書かない

    最後の点が大事だと思っています。毎回その場で書くと、どこかで Dispatch に戻ったり、後始末を書き忘れたりします。安全な書き方を1か所にまとめて、そこを呼ぶだけにしました。

    学んだこと

    • 🔴 Dispatch は、すでに開いている Excel につながる。 最後に Quit すると、人の Excel を未保存のまま閉じかねない。DispatchEx を使う

    • Quit しても、窓の無い Excel が残ってファイルを握ることがある。 自分のプロセス番号を控えて、残っていたらそれだけ止める

    • ファイルが保存できないとき、人のせいにする前に自分の残骸を疑う

    • 対策を入れたら、同じライブラリを使う他のスクリプトにも広げる


    同じ「Excelの自動化」の話

    日々の自動化の詰まりどころは X でも書いています → @Sukima___log

    この記事が参加している募集

    あなたへのおすすめ