Home » Python » OpenPyXLの使い方 » OpenPyXLのwb.sheetnamesとは

OpenPyXLのwb.sheetnamesとは

動作検証バージョン：Windows 10 Pro（64-bit）+ Python 3.11.1（64-bit） + OpenPyXL 3.0.10

「python wb.sheetnames」
といった検索で、時折アクセスがあります。

OpenPyXLについて紹介しているWebページ等で見かける、「wb.sheetnames」というコードについて調べていらしたのではないかと想像しています。

あるいは、少し前に出版された書籍等に掲載されているOpenPyXLのサンプルを実行したところ、

DeprecationWarning: Call to deprecated function get_sheet_names (Use wb.sheetnames).

メッセージが表示されたのかもしれません。

OpenPyXLで全シート名を取得するWorkbook.get_sheet_names()メソッド使用時のDeprecationWarning

OpenPyXLではWorkbookを代入する変数にwbがよく使われる

この「wb」は、OpenPyXLでブックを表すWorkbookオブジェクトを代入する変数の場合によく使われる名前です。

OpenPyXL公式サイトで「wb」を検索してみると、複数のページがヒットします。

ですからOpenPyXLのコード「wb.sheetnames」は、ブックの全シート名をリストの形で返してくれるWorkbookオブジェクトのsheetnames属性を呼んでいるコードということになります。

wb.sheetnamesのサンプル

以下のスクリプトを実行した場合は、

import openpyxl

wb = openpyxl.Workbook()
print(wb.sheetnames)

メモリー上に新規ブックを表すWorkbookオブジェクトが作成されて変数wbに代入され、シート名「Sheet」が、

['Sheet']

とリストの形で出力されます。

openpyxl.Workbook()関数でブックを作成した場合のシート名とオブジェクト名

変数wbにWorkbookを代入して使用するサンプル

以下のスクリプトを実行した場合、

import openpyxl
# ブックの新規作成
wb = openpyxl.Workbook()
print(wb.sheetnames)

# シートの挿入
wb.create_sheet()
print(wb.sheetnames)

# シートのコピー作成
wb.copy_worksheet(wb.worksheets[-1])
print(wb.sheetnames)
# シートの削除
wb.remove(wb['Sheet'])
print(wb.sheetnames)

以下のように出力されます。

['Sheet']
['Sheet', 'Sheet1']
['Sheet', 'Sheet1', 'Sheet1 Copy']
['Sheet1', 'Sheet1 Copy']

OpenPyXLではWorksheetを代入する変数にwsがよく使われる

「ws」も、OpenPyXLでよく見かける変数名で、こちらはワークシートを表すWorksheetオブジェクトを代入する際によく使われます。

「wb」「ws」も「w」で始まるため、うっかり読み間違えることがあり、Workbookオブジェクトを代入する変数名として、私個人としては、「wb」ではなく「bk」等が好みです。

Workbookオブジェクトを代入する変数をbkとした場合、先ほどのスクリプトは以下のとおりです。

import openpyxl
# ブックの新規作成
bk = openpyxl.Workbook()
print(bk.sheetnames)

# シートの挿入
bk.create_sheet()
print(bk.sheetnames)

# シートのコピー作成
bk.copy_worksheet(bk.worksheets[-1])
print(bk.sheetnames)
# シートの削除
bk.remove(bk['Sheet'])
print(bk.sheetnames)