openpyxl【Excel ファイル操作ライブラリ】

メモ ( インストール方法 実行バージョンの取得 基本操作 ) パッケージ・モジュール・クラス
構成パッケージ ( workbook【ワークブック】 worksheet【ワークシート】 cell【セル】 )

メモ

概要

索引
  • Excel ファイルの操作ライブラリ
    • Excel 2010 以降の xlsx・xlsm・xltx・xltm ファイルが対象
    • ブックシートセルに対して基本的な操作が可能
  • このドキュメントは、openpyxl 3.0 以降に対応:3.0.9 (2021-09-22)対応  (最新)
    • openpyxl 3.0 以降は、Python 3.6 以上が必要
  • インストール方法については、 Installation (英語) 参照
  • 実行バージョンの取得〔
    • openpyxl:
      • openpyxl.__version__
      • get_version()
    • Python: ( Python 実行バージョン も参照 )
      • platform.python_version()
      • sys.version_info

構成パッケージ・基本モジュール・基本クラス 等

基本操作


パッケージ
モジュール
クラス・関数

パッケージ
モジュールクラス関数 等
cell【セル】〔パッケージ 一覧
cell【セル】 Cell【セル】
MergedCell【結合セル】
get_time_format
get_type
WriteOnlyCell
read_only EmptyCell
ReadOnlyCell
text InlineFont
PhoneticProperties
PhoneticText
RichText
Text
 
chart【チャート】〔パッケージ 一覧
area_chart AreaChart
AreaChart3D
axis ChartLines
DateAxis
DisplayUnitsLabel
DisplayUnitsLabelList
NumericAxis
Scaling
SeriesAxis
SeriesAxis
bar_chart【棒グラフ】 BarChart
BarChart3D
bubble_chart【バブルチャート】 BubbleChart
chartspace ChartContainer
ChartSpace
ExternalData
Protection
data_source AxDataSource
Level
MultiLevelStrData
MultiLevelStrRef
NumData
NumDataSource
NumFmt
NumRef
NumVal
NumberValueDescriptor
StrData
StrRef
StrVal
descriptors【ディスクリプタ】 NestedGapAmount
NestedOverlap
NumberFormatDescriptor
error_bar【エラーバー】 ErrorBars
label【ラベル】 DataLabel
DataLabelList
layout【レイアウト】 Layout
ManualLayout
legend【凡例】 Legend
LegendEntry
line_chart【折れ線グラフ】 LineChart
LineChart3D
marker【マーカー】 DataPoint
Marker
picture PictureOptions
pie_chart【円グラフ】 CustomSplit
DoughnutChart
PieChart
PieChart3D
ProjectedPieChart
pivot【ピボット】 PivotFormat
PivotSource
plotarea DataTable
PlotArea
print_settings PageMargins
PrintSettings
radar_chart【レーダーチャート】 RadarChart
reader【レーダー】 read_chart
reference DummyWorksheet
Reference
scatter_chart【分散図】 ScatterChart
series Series
SeriesLabel
XYSeries
series_factory SeriesFactory
shapes【図形】 GraphicalProperties
stock_chart【株価】 StockChart
surface_chart BandFormat
BandFormatList
SurfaceChart
SurfaceChart3D
text【テキスト】 RichText
Text
title【タイトル】 Title
TitleDescriptor
title_maker
trendline【トレンドライン】 Trendline
TrendlineLabel
updown_bars UpDownBars
chartsheet【グラフシート】〔パッケージ 一覧
chartsheet【グラフシート】 Chartsheet
custom【カスタム】 CustomChartsheetView
CustomChartsheetViews
properties【プロパティ】 ChartsheetProperties
protection【保護】 ChartsheetProtection
publish【パブリッシュ】 WebPublishItem
WebPublishItems
relation【リレーション】 DrawingHF
SheetBackgroundPicture
views【ビュー】 ChartsheetView
ChartsheetViewList
 
comments【コメント】〔パッケージ 一覧
author【作成者】 AuthorList
comment_sheet【コメント シート】 CommentRecord
CommentSheet
Properties
comments【コメント】 Comment
shape_writer ShapeWriter
descriptors【ディスクリプタ】〔パッケージ 一覧
MetaSerialisable
MetaStrict
Strict
base ASCII
Alias
Bool
Convertible
DateTime
Default
Descriptor
Float
Integer
Length
MatchPattern
Max
Min
MinMax
NoneSet
Set
String
Text
Tuple
Typed
excel【Excel】 Base64Binary
CellRange
Extension
ExtensionList
Guid
HexBinary
Percentage
Relation
TextPoint
UniversalMeasure
namespace【名前空間】 namespaced
nested【ネスト】 EmptyTag
Nested
NestedBool
NestedFloat
NestedInteger
NestedMinMax
NestedNoneSet
NestedSet
NestedString
NestedText
NestedValue
sequence【シーケンス】 MultiSequence
MultiSequencePart
NestedSequence
Sequence
ValueSequence
serialisable【シリアル化可能】 Serialisable
drawing【ドローイング】〔パッケージ 一覧
colors【色】 ColorChoice
ColorChoiceDescriptor
ColorMapping
HSLColor
RGBPercent
SchemeColor
SystemColor
Transform
connector【コネクタ】 Connection
ConnectorLocking
ConnectorNonVisual
ConnectorShape
NonVisualConnectorProperties
Shape
ShapeMeta
drawing【ドローイング】 Drawing
effect【エフェクト】 AlphaBiLevelEffect
AlphaCeilingEffect
AlphaFloorEffect
AlphaInverseEffect
AlphaModulateEffect
AlphaModulateFixedEffect
AlphaReplaceEffect
BiLevelEffect
BlurEffect
Color
ColorChangeEffect
ColorReplaceEffect
DuotoneEffect
EffectContainer
EffectList
FillOverlayEffect
GlowEffect
GrayscaleEffect
HSLEffect
InnerShadowEffect
LuminanceEffect
OuterShadow
PresetShadowEffect
ReflectionEffect
SoftEdgesEffect
TintEffect
fill【塗りつぶし】 Blip
BlipFillProperties
GradientFillProperties
GradientStop
LinearShadeProperties
PathShadeProperties
PatternFillProperties
RelativeRect
SolidColorFillProperties
StretchInfoProperties
TileInfoProperties
geometry【ジオメトリ】 AdjPoint2D
AdjustHandleList
Backdrop
Bevel
Camera
ConnectionSite
ConnectionSiteList
CustomGeometry2D
FontReference
GeomGuide
GeomGuideList
GeomRect
GroupTransform2D
LightRig
Path2D
Path2DList
Point2D
Point3D
PositiveSize2D
PresetGeometry2D
Scene3D
Shape3D
ShapeStyle
SphereCoords
StyleMatrixReference
Transform2D
Vector3D
graphic【グラフィック】 GraphicData
GraphicFrame
GraphicFrameLocking
GraphicObject
GroupShape
NonVisualGraphicFrame
NonVisualGraphicFrameProperties
image【イメージ】 Image
line【ライン】 DashStop
DashStopList
LineEndProperties
LineProperties
picture【ピクチャ】 NonVisualPictureProperties
PictureFrame
PictureLocking
PictureNonVisual
properties【プロパティ】 GroupLocking
GroupShapeProperties
NonVisualDrawingProps
NonVisualDrawingShapeProps
NonVisualGroupDrawingShapeProps
NonVisualGroupShape
relation【リレーション】 ChartRelation
spreadsheet_drawing AbsoluteAnchor
AnchorClientData
AnchorMarker
OneCellAnchor
SpreadsheetDrawing
TwoCellAnchor
text【テキスト】 AutonumberBullet
CharacterProperties
EmbeddedWAVAudioFile
Font
GeomGuide
GeomGuideList
Hyperlink
LineBreak
ListStyle
Paragraph
ParagraphProperties
PresetTextShape
RegularTextRun
RichTextProperties
Spacing
TabStop
TabStopList
TextField
TextNormalAutofit
xdr XDRPoint2D
XDRPositiveSize2D
XDRTransform2D
formatting【書式】〔パッケージ 一覧
条件付き書式 例
formatting【書式】 ConditionalFormatting【条件付き書式】
ConditionalFormattingList【条件付き書式リスト】
rule【書式ルール】 ColorScale【カラー スケール】
DataBar【データ バー】
FormatObject【値オブジェクト (条件付き書式)】
IconSet【アイコン セット】
Rule【書式ルール】
RuleType【値情報】
ValueDescriptor【値ディスクリプタ】
CellIsRule【書式ルール生成 (セルの値)】
ColorScaleRule【書式ルール生成 (カラー スケール)】
DataBarRule【書式ルール生成 (データ バー)】
FormulaRule【書式ルール生成 (数式)】
IconSetRule【書式ルール生成 (アイコン セット)】
 
packaging【パッケージング】〔パッケージ 一覧
core【コア】 DocumentProperties
NestedDateTime
QualifiedDateTime
extended【拡張】 DigSigBlob
ExtendedProperties
VectorLpstr
VectorVariant
get_version【バージョン取得】
interface【インタフェース】 ISerialisableFile
manifest【マニフェスト】 FileExtension
Manifest
Override
relationship【リレーションシップ】 Relationship
RelationshipList
get_dependents
get_rel
get_rels_path
workbook【ワークブック】 ChildSheet
FileRecoveryProperties
PivotCache
WorkbookPackage
 
pivot【ピボット】〔パッケージ 一覧
cache CacheDefinition
CacheField
CacheHierarchy
CacheSource
CalculatedItem
CalculatedMember
Consolidation
DiscretePr
FieldGroup
FieldUsage
FieldsUsage
GroupItems
GroupLevel
GroupLevels
GroupMember
GroupMembers
Groups
LevelGroup
MeasureDimensionMap
MeasureGroup
OLAPSet
OLAPSets
PCDKPI
PCDSDTCEntries
Page
PageItem
PivotDimension
Query
QueryCache
RangePr
RangeSet
ServerFormat
ServerFormatList
SharedItems
TupleCache
WorksheetSource
fields【フィールド】 Boolean
DateTimeField
Error
Index
Missing
Number
Text
Tuple
TupleList
record【レコード】 Record
RecordList
table【テーブル】 AutoSortScope
ChartFormat
ColHierarchiesUsage
ConditionalFormat
DataField
FieldItem
Format
HierarchyUsage
Location
MemberList
MemberProperty
PageField
PivotArea
PivotField
PivotFilter
PivotFilters
PivotHierarchy
PivotTableStyle
Reference
RowColField
RowColItem
RowHierarchiesUsage
TableDefinition
 
reader【リーダー】〔パッケージ 一覧
drawings【ドローイング】 find_images
excel【Excel】 ExcelReader
load_workbook【ワークブック読み込み】
(別名:open)
strings【ストリング】 read_string_table
workbook【ワークブック】 WorkbookParser
styles【スタイル】〔パッケージ 一覧
alignment【配置】 Alignment【配置】
borders【罫線】 Border【罫線】
Side【罫線スタイル】
builtins【組み込みセルスタイル】
cell_style【セル スタイル】 ArrayDescriptor
CellStyle
CellStyleList
StyleArray
colors【色】 Color
ColorDescriptor
ColorList
RGB
RgbColor
differential【差異】 DifferentialStyle【差異スタイル】
DifferentialStyleList【差異スタイル リスト】
fills【塗りつぶし】 Fill【塗りつぶし (基底)】
GradientFill【塗りつぶし (グラデーション)】
PatternFill【塗りつぶし (パターン)】
Stop【グラデーション停止色】
StopList【グラデーション停止色リスト】
fonts【フォント】 Font【フォント】
named_styles【名前付きセルスタイル】 NamedStyle【名前付きセルスタイル】
NamedStyleList【名前付きセルスタイル リスト】
numbers【表示形式】 NumberFormat【表示形式】
NumberFormatDescriptor【表示形式ディスクリプタ】
NumberFormatList【表示形式リスト】
builtin_format_code【組み込み表示形式 取得】
builtin_format_id【組み込み表示形式インデックス 取得】
is_builtin【組み込み表示形式チェック】
is_date_format【日付表示形式チェック】
is_datetime【日時表示形式チェック】
is_timedelta_format【経過時間表示形式チェック】
protection【セル保護】 Protection【セル保護】
proxy【プロクシ】 StyleProxy
styleable【スタイラブル】 NamedStyleDescriptor
NumberFormatDescriptor
StyleArrayDescriptor
StyleDescriptor
StyleableObject
stylesheet【スタイルシート】 Stylesheet apply_stylesheet
write_stylesheet
table【テーブル】 TableStyle
TableStyleElement
TableStyleList
utils【ユーティリティ】〔パッケージ 一覧
bound_dictionary BoundDictionary
cell【セル関連】 absolute_coordinate【セルアドレス ⇒ 絶対セルアドレス 変換】
cols_from_range【セル範囲アドレス ⇒ 列単位セルアドレス】
column_index_from_string【列文字列 ⇒ 列番号 変換】
coordinate_from_string【セルアドレス ⇒ 列文字列・行番号 変換】
coordinate_to_tuple【セルアドレス ⇒ 行列番号 変換】
get_column_interval【列範囲 ⇒ 列文字列リスト 変換】
get_column_letter【列番号→列文字列 変換】
quote_sheetname【シート名シングルクォート囲み】
range_boundaries【セル範囲アドレス ⇒ 行列番号 変換】
range_to_tuple【セル範囲アドレス ⇒ 行列番号 変換 (シート名対応)】
rows_from_range【セル範囲アドレス ⇒ 行単位セルアドレス】
dataframe【データフレ-ム関連】 dataframe_to_rows
expand_index
datetime【日時関連】 days_to_time
from_ISO8601
from_excel
time_to_days
timedelta_to_days
to_ISO8601
to_excel
escape【エスケープ関連】 escape
unescape
exceptions【例外関連】 CellCoordinatesException
IllegalCharacterError
InvalidFileException
NamedRangeException
ReadOnlyWorkbookException
SheetTitleException
WorkbookAlreadySaved
indexed_list IndexedList
inference【推論関連】 cast_numeric
cast_percentage
cast_time
protection【保護関連】 hash_password
units【単位関連】 DEFAULT_HEADER
EMU_to_cm
EMU_to_inch
EMU_to_pixels
angle_to_degrees
cm_to_EMU
cm_to_dxa
degrees_to_angle
dxa_to_cm
dxa_to_inch
inch_to_EMU
inch_to_dxa
pixels_to_EMU
pixels_to_points
points_to_pixels
short_color
workbook【ワークブック】〔パッケージ 一覧
child avoid_duplicate_name
defined_name【名前定義】 DefinedName【名前定義】
DefinedNameList【名前定義リスト】
external_reference ExternalReference
function_group FunctionGroup
FunctionGroupList
properties CalcProperties
FileVersion
WorkbookProperties
protection【ブック保護】 DocumentSecurity【ブック保護 (別名)】
FileSharing【ファイル共有】
WorkbookProtection【ブック保護】
smart_tags SmartTag
SmartTagList
SmartTagProperties
views BookView
CustomWorkbookView
web WebPublishObject
WebPublishObjectList
WebPublishing
workbook【ワークブック】 Workbook【ワークブック】
 
external_link.external ExternalBook
ExternalCell
ExternalDefinedName
ExternalLink
ExternalRow
ExternalSheetData
ExternalSheetDataSet
ExternalSheetNames
read_external_link
worksheet【ワークシート】〔パッケージ 一覧
cell_range CellRange
MultiCellRange
cell_watch CellWatch
CellWatches
controls【コントロール】 Control
ControlProperty
Controls
copier WorksheetCopy
custom【カスタム】 CustomProperties
CustomProperty
datavalidation【入力規則】 DataValidation【入力規則】
DataValidationList【入力規則リスト】
collapse_cell_addresses【セルアドレス折りたたみ】
expand_cell_ranges【セルアドレス展開】
dimensions【ディメンション】 ColumnDimension
Dimension
DimensionHolder
RowDimension
SheetDimension
SheetFormatProperties
drawing【ドローイング】 Drawing
errors【エラー】 Extension
ExtensionList
IgnoredError
IgnoredErrors
filters【フィルタ】 AutoFilter
ColorFilter
CustomFilter
CustomFilters
DateGroupItem
DynamicFilter
FilterColumn
Filters
IconFilter
SortCondition
SortState
SortState
header_footer【ヘッダー・フッター】 _HeaderFooterPart【ヘッダー/フッター パーツ】
HeaderFooter【ヘッダー・フッター】
HeaderFooterItem【ヘッダー/フッター アイテム】
(フォーマットコード)
hyperlink【ハイパーリンク】 Hyperlink【ハイパーリンク】
HyperlinkList【ハイパーリンク リスト】
merge【結合】 MergeCell
MergeCells
MergedCellRange
ole【OLE】 ObjectAnchor
ObjectPr
OleObject
OleObjects
page【ページ設定】 PageMargins【余白 (ページ設定)】
PrintOptions【印刷オプション】
PrintPageSetup【ページ設定】
pagebreak【改ページ】 Break【改ページ】
ColBreak【改ページ リスト (列)】
PageBreak【改ページ リスト (行)】 (RowBreak の別名)
RowBreak【改ページ リスト (行)】
picture【ピクチャ】 SheetBackgroundPicture
properties【プロパティ】 Outline
PageSetupProperties
WorksheetProperties【ワークシート プロパティ】
protection【シート保護】 SheetProtection【シート保護】
related Related
scenario【シナリオ】 InputCells
Scenario
ScenarioList
smart_tag【スマートタグ】 CellSmartTag
CellSmartTagPr
CellSmartTags
SmartTags
table【テーブル】 Table
TableColumn
TableFormula
TableList
TableNameDescriptor
TablePartList
TableStyleInfo
XMLColumnProps
views【ビュー】 Pane【ビューペイン(区画)情報】
Selection【ビュー選択情報】
SheetView【シートビュー】
SheetViewList【シートビュー リスト】
worksheet【ワークシート】 Worksheet【ワークシート】 シートの表示状態【SHEETSTATE_~】定数
用紙サイズ【PAPERSIZE_~】定数
用紙方向【ORIENTATION_~】定数
 
writer【ライター】〔パッケージ 一覧
excel【Excel】 ExcelWriter save_virtual_workbook
save_workbook
theme【テーマ】 write_theme
 
xml【XML】〔パッケージ 一覧
defusedxml_available
defusedxml_env_set
lxml_available
lxml_env_set
constants【コンスタント】
functions【関数】 localname
whitespace

実行バージョン

import openpyxl

print(openpyxl.__version__)
# 出力例:3.0.9
import platform
import sys

print(platform.python_version())
# 出力例:3.10.0
print(sys.version_info)
# 出力例:sys.version_info(major=3, minor=10, micro=0, releaselevel='final', serial=0)
print(sys.version_info >= (3, 9))
# 出力例:True
print(sys.version_info >= (3, 10))
# 出力例:True
print(sys.version_info >= (3, 11))
# 出力例:False

基本操作

from openpyxl import Workbook

# ワークブック作成
wb = Workbook()
WORKBOOK = 'sample.xlsx'
# ワークシート参照 (アクティブ)
ws = wb.active
# セル参照 (アドレス形式)
cell = ws['B2']
# セル操作 (値設定)
cell.value = 'セルの値'
# ワークブック保存
wb.save(WORKBOOK)
from openpyxl import load_workbook

# ワークブック読み込み
WORKBOOK = 'sample.xlsx'
wb = load_workbook(filename=WORKBOOK)
# ワークシート参照 (シート名)
ws = wb['Sheet']
# セル参照 (行・列 形式)
cell_from = ws.cell(2, 2)  # B2
cell_to = ws.cell(4, 2)    # D2
# セル操作 (値取得・値設定)
cell_to.value = cell_from.value
# ワークブック保存
wb.save(WORKBOOK)