Home » Python » OpenPyXLの使い方 » OpenPyXLでシートを削除する－Workbook.remove()／Pythonのdel文

OpenPyXLでシートを削除する－Workbook.remove()／Pythonのdel文

動作検証バージョン：Windows 10 + Python 3.7.3 + OpenPyXL 2.6.2

「python excel ワークシート削除 xlsx」
という検索キーワードでアクセスがありました。

Pythonを使ってExcelのワークシートを削除するには、どのようなコードを書けばいいのかを探していた方による検索です。

Workbook.remove()メソッドでシートを削除するスクリプト

Cドライブのtempフォルダーに複数のシートが存在するブックfoo.xlsxを用意しておいて、以下のスクリプトを実行すると末尾のシートが削除され、foo2.xlsxとして保存されます。

import openpyxl

wb = openpyxl.load_workbook(r'C:\temp\foo.xlsx')
wb.remove(wb.worksheets[-1])

wb.save(r'C:\temp\foo2.xlsx')

DeprecationWarning: Call to deprecated function remove_sheet (Use wb.remove(worksheet) or del wb[sheetname]).

このWarningの指示どおり、Workbook.remove()メソッドを使ったのが上記のスクリプトです。

DeprecationWarningに従って試してみると、Pythonのdel文を使った以下のようなスクリプトでも「Sheet」という名前のシートを削除できます。

import openpyxl

wb = openpyxl.load_workbook(r'C:\temp\foo.xlsx')
del wb['Sheet']

wb.save(r'C:\temp\foo2.xlsx')

OpenPyXLの基本設計が垣間見える興味深いコードですが、通常は先のWorkbook.remove()メソッドを使うほうが良さそうに、今の私には感じられます。

OpenPyXLで、1枚しかシートが存在しないブックからシートを削除しようとしたときの挙動は、Excel VBAと大きく異なります。

Excel VBAで、1枚しかないシートを削除しようとした場合、

ブックのシートをすべて削除または非表示にすることはできません。
選択したシートを非表示、削除、または移動するには、まず新しいシートを挿入するか、非表示のシートを表示してください。

という実行時エラーが発生して、処理は中断されます。

これに対しOpenPyXLの場合、シートの削除は実行されるものの、保存時に、

KeyError: 'Worksheet Sheet does not exist.'

とエラーが発生し、Excelでは正常に開くことのできないfoo2.xlsxファイルが作られます。

Excel VBAユーザーのためのOpenPyXL入門：Pythonの定番ライブラリの特徴をちゃんと知ろう

伊藤潔人 2023-03-18

最終更新日時：2023-05-08 11:34

［スポンサードリンク］

Home » Python » OpenPyXLの使い方 » OpenPyXLでシートを削除する－Workbook.remove()／Pythonのdel文

『インストラクターのネタ帳』では、2003年10月からMicrosoft Officeの使い方などを紹介し続けています。
Excel VBAの経験がある方を対象に、Word VBAの基本をキンドル本としてまとめました↓↓

Excel VBAユーザーの方を対象として、Wordの表をVBAで操作する基礎をまとめました↓↓

『インストラクターのネタ帳』を運営する伊藤潔人が、初めて書かせていただいた書籍です↓↓

PowerPoint VBA本は、実はオブジェクトブラウザーの使い方を徹底的に解説した本です↓↓

日経BP社から出版された、Excel VBAユーザー向けのPython超入門書です↓↓

上記の『Excel VBAユーザーのためのPythonプログラミング』の、元になったキンドル本です↓↓

Pythonの文字列フォーマットの基本をキンドル本としてまとめました↓↓

小数とPythonのdecimalモジュールの基本をキンドル本としてまとめました↓↓

数式を使った条件付き書式設定が苦手な方に向けたKindle本を書きました↓↓

図形を操作するExcel VBAの基本を解説したキンドル本を書きました↓↓

グラフを操作するExcel VBAの基本を解説したキンドル本も出しました↓↓

Pythonの外部ライブラリOpenPyXL（オープンパイエクセル）の入門書を、Excel VBAユーザーに向けに書きました↓↓

「OpenPyXLの使い方」の記事一覧