Home » Python » xlwingsの使い方 » xlwingsで全ワークシート名を取得する－Book.sheet_namesプロパティ

xlwingsで全ワークシート名を取得する－Book.sheet_namesプロパティ

動作検証バージョン：Windows 10 + Python 3.7.3 + xlwings 0.15.5 + Excel 1906

「python xlwings シート名」
という検索キーワードでのアクセスに気が付きました。

詳細がわかりませんので、xlwingsを使った、特定のブックに含まれる全ワークシート名を、順番に取得するコードをご紹介しておきます。

［スポンサードリンク］

xlwingsで全ワークシート名をprintするスクリプト

以下のスクリプトを実行すると、Cドライブtempフォルダーのsample.xlsxブックの、全ワークシート名が出力されます。

import xlwings

bk = xlwings.Book(r'C:\temp\sample.xlsx')
for sht in bk.sheets:
print(sht.name)

Book.sheetsプロパティで、取得したすべてのワークシートを表すSheetsコレクションに対して、for文を回して順番にSheetオブジェクトを取得して

for sht in bk.sheets:

Sheet.nameプロパティで取得したシート名を、Pythonの組み込み関数であるprintで出力しています。

print(sht.name)

全ワークシート名を順番に出力するのではなく、リストとして取得したいのなら、以下のコードが参考になるでしょう。

import xlwings

bk = xlwings.Book(r'C:\temp\sample.xlsx')
sheet_names = []
for sht in bk.sheets:
sheet_names.append(sht.name)
print(sheet_names)

先ほどの、for文の中で随時printする場合は、

for sht in bk.sheets:
print(sht.name)

で済みましたが、リストにする分コードが増えています。

ただし、リスト内包表記を使えば、以下のようなシンプルなコードで済みます。

import xlwings

bk = xlwings.Book(r'C:\temp\sample.xlsx')
sheet_names = [ sht.name for sht in bk.sheets ]
print(sheet_names)

この記事はv0.15.5の時点で書いたものですが、2022年10月10日にリリースされた、v0.28.1以降ならば、Bookオブジェクトに用意されているsheet_namesプロパティで、ワークシート名一覧をリストの形で取得できます。

Book.sheet_namesプロパティは、xlwingsのmain.pyモジュールで

@property
def sheet_names(self):
return [sheet.name for sheet in self.sheets]

と定義されています。

最終更新日時：2023-04-12 16:20

［スポンサードリンク］

Home » Python » xlwingsの使い方 » xlwingsで全ワークシート名を取得する－Book.sheet_namesプロパティ

『インストラクターのネタ帳』では、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ユーザーに向けに書きました↓↓

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