worksheet.datavalidation【入力規則】モジュール

from openpyxl import Workbook
from openpyxl.worksheet.datavalidation import DataValidation

# ワークブック作成
WORKBOOK = 'sample.xlsx'
wb = Workbook()
ws = wb.active

# 入力規則作成 (セル指定なし)
validation = DataValidation(
    type='whole',
    operator='between',
    formula1=1,
    formula2=9,

    showInputMessage=True,
    promptTitle='タイトル (入力メッセージ)',
    prompt='入力メッセージ',

    showErrorMessage=True,
    errorTitle='タイトル (エラーメッセージ)',
    error='エラーメッセージ',
)

# 対象セル追加 (Cell 指定)
cell = ws['B2']
cell.value = 1
validation.add(cell)

# 対象セル追加 (セルアドレス 指定)
ws['B3'] = 2
validation.add('B3')

# 対象セル追加 (プロパティ 指定)
# validation.sqref = ('B2', 'B3')
# validation.sqref = ['B2', 'B3']
# validation.sqref = 'B2 B3'

# ワークシートに入力規則 追加
ws.add_data_validation(validation)

# 入力規則作成 (セル指定)
ws['C2'] = 3
ws['C3'] = 4
ws['C4'] = 5
ws['C6'] = 6
validation = DataValidation(
    type='whole',
    operator='between',
    formula1=1,
    formula2=9,
    showInputMessage=True,
    promptTitle='タイトル (入力メッセージ)',
    prompt='入力メッセージ',

    sqref=('C2:C4', 'C6'),
    # sqref=['C2:C4', 'C6'],
    # sqref='C2:C4 C6',
)

# ワークシートに入力規則 追加
ws.add_data_validation(validation)

# 各種チェック
print('C4' in validation)
# 出力：True
print('C5' in validation)
# 出力：False
print(ws['C6'] in validation)
# 出力：True
print('C2:C4' in validation)
# 出力：True
print('C2:C5' in validation)
# 出力：False
print(ws.data_validations.count)
# 出力：2
print(len(ws.data_validations))
# 出力：2

# ワークブック保存
wb.save(WORKBOOK)

from openpyxl import Workbook
from openpyxl.worksheet.datavalidation import DataValidation
from openpyxl.styles import borders, Border, Side

# ワークブック作成
WORKBOOK = 'sample.xlsx'
wb = Workbook()
ws = wb.active

# 罫線
COLOR_BORDER = '000000FF'
side = Side(
    border_style=borders.BORDER_THICK,
    color=COLOR_BORDER)
border = Border(side, side, side, side)

# 入力規則設定 (すべての値：入力時メッセージ)
validation = DataValidation(
    type=None,
    showInputMessage=True,
    promptTitle='タイトル (入力メッセージ)',
    prompt='入力メッセージ',
)
ws['B2'] = 'B-2'
ws['B3'] = 'B-3'
ws['B2'].border = border
ws['B3'].border = border
validation.add('B2:B3')
ws.add_data_validation(validation)

# 入力規則設定 (リスト：カンマ区切りの項目)
validation = DataValidation(
    type='list',
    formula1='"List1,List2,List3"',
)
ws['C2'] = 'List2'
ws['C2'].border = border
validation.add('C2')
ws.add_data_validation(validation)

# 入力規則設定 (リスト：項目のセル範囲アドレス)
ws['D4'] = 'ListA'
ws['D5'] = 'ListB'
ws['D6'] = 'ListC'
validation = DataValidation(
    type='list',
    formula1='D4:D6',
)
ws['D2'] = 'ListB'
ws['D2'].border = border
validation.add('D2')
ws.add_data_validation(validation)

# 入力規則設定 (リスト：名前定義)
ws['E4'] = 'ListX'
ws['E5'] = 'ListY'
ws['E6'] = 'ListZ'
NAME_LIST = 'name_list'
wb.create_named_range(NAME_LIST, None, 'Sheet!$E$4:$E$6')
validation = DataValidation(
    type='list',
    formula1=NAME_LIST,
)
ws['E2'] = 'ListY'
ws['E2'].border = border
validation.add('E2')
ws.add_data_validation(validation)

# 入力規則設定 (ユーザー設定：偶数のみ有効)
validation = DataValidation(
    type='custom',
    formula1='=MOD(F2,2)=0',
    prompt='偶数のみ有効'
)
ws['F2'] = 2
ws['F2'].border = border
validation.add('F2')
ws.add_data_validation(validation)

# 入力規則設定 (小数点数：次の値の間・定数)
validation = DataValidation(
    type='decimal',
    operator='between',
    formula1=1.0,
    formula2=2.0,
    prompt='小数点数：1.0 ～ 2.0'
)
ws['B9'] = 1.5
ws['B9'].border = border
validation.add('B9')
ws.add_data_validation(validation)

# 入力規則設定 (文字列の長さ指定：次の値に等しい・値のセルアドレス)
ws['C11'] = 5
validation = DataValidation(
    type='textLength',
    operator='equal',
    formula1='C11',
    prompt='文字列 (長さ指定)：[B9]の値'
)
ws['C9'] = 'ABCDE'
ws['C9'].border = border
validation.add('C9')
ws.add_data_validation(validation)

# 入力規則設定 (日付：次の値より小さい・値になる数式)
validation = DataValidation(
    type='date',
    operator='lessThan',
    formula1='=TODAY()',
    prompt='日付：本日より前'
)
ws['D9'] = '2001/2/3'
ws['D9'].border = border
validation.add('D9')
ws.add_data_validation(validation)

# 入力規則設定 (時刻：次の値以上・名前定義)
from datetime import time
ws['E11'] = time(12, 0, 0)
NAME_TIME = 'name_time'
wb.create_named_range(NAME_TIME, ws, '$E$11')
validation = DataValidation(
    type='time',
    operator='greaterThanOrEqual',
    formula1=NAME_TIME,
    prompt=f'時刻：[{NAME_TIME}] 値以上'
)
ws['E9'] = time(12, 34, 56)
ws['E9'].border = border
validation.add('E9')
ws.add_data_validation(validation)

# ワークブック保存
wb.save(WORKBOOK)

from openpyxl.worksheet.datavalidation import (
    collapse_cell_addresses,
    expand_cell_ranges,
)

# collapse_cell_addresses
lst_cells = ['A1', 'A2', 'A3', 'B1', 'B2', 'B3']
adr = collapse_cell_addresses(lst_cells)
print(adr)
# 出力：A1:A3 B1:B3
tpl_cells = ('A1', 'A2', 'A3', 'B3', 'B4', 'B5')
adr = collapse_cell_addresses(tpl_cells)
print(adr)
# 出力：A1:A3 B3:B5
cells = ['A1', 'B1', 'C1']
adr = collapse_cell_addresses(cells)
print(adr)
# 出力：A1 B1 C1
cells = ['A1', 'A3', 'A5', 'A4', 'A2']
adr = collapse_cell_addresses(cells)
print(adr)
# 出力：A1:A5

# collapse_cell_addresses (input_ranges 指定)
cells = ['A3', 'A2', 'A1', 'C2', 'C1', 'C3']
lst_input = ['B1', 'B3', 'B2']
adr = collapse_cell_addresses(cells, lst_input)
print(adr)
# 出力：B1 B3 B2 A1:A3 C1:C3
tpl_input = ('A4', 'B4', 'C4')
adr = collapse_cell_addresses(cells, tpl_input)
print(adr)
# 出力：A4 B4 C4 A1:A3 C1:C3

# expand_cell_ranges
adr = expand_cell_ranges('A1:A5')
print(type(adr))
# 出力：<class 'set'>
print(adr)
# 出力：{'A3', 'A2', 'A1', 'A5', 'A4'}
adr = expand_cell_ranges('A1:A2 B1:B2')
print(adr)
# 出力：{'A1', 'B2', 'A2', 'B1'}