xlwings API
一、apps
import xlwings as xw app1 = xw.App() # 新建一个Excel进程 app2 = xw.App() print(xw.apps) # Apps([<Excel App 64260>, <Excel App 58540>]) xw.apps.active # 返回活动工作簿 xw.apps.count # 计算app的进程数 xw.apps.add() # 新增一个app xw.apps.keys() # [49236, 64260, 58540]
for key in xw.apps.keys(): # 关闭所有程序 xw.apps(key).kill()
二、Book
for i in range(1,4): wb = xw.Book() print(wb) print(xw.books)
代码输出结果如下：
<Book [工作簿4]> <Book [工作簿5]> <Book [工作簿6]>
Books([<Book [工作簿1]>, <Book [工作簿2]>, <Book [工作簿3]>, ...])
可知：xw.Book()会新建工作簿，这里默认会新建一个App，即打开Excel程序，并新建工作簿。上面新建的3个工作簿 全部在一个进程下。
三、引用工作簿的两种方法
xw.Book('工作簿1') xw.books['工作簿1']
wb.app.calculate() # calculates all open books
wb.app.calculation = 'manual' # 设置计算模式为手动计算,manual, automatic, semiautomatic
wb.app.display_alerts = True # 默认值为True, False 的情况下执行操作时会忽略Excel弹窗消息
wb.app.screen_updating = False # 禁止屏幕更新（刷新）
wb.app.range(cell1,cell2=None) # 获取单元格
wb.app.selection # 将所选单元格作为Range返回
xw.App().version # 返回Excel 程序版本号
四、books
apps 是所有 App 的集合
books 是所有 Book 的集合
sheets 是所有 Sheet 的集合
import xlwings as xw app1 = xw.App() app2 = xw.App() print(xw.books) book_keys = xw.apps.keys() first_book = book_keys[0] # 取列表的第一个值 print(xw.apps[first_book].books) # 应用 print(app1.books.active) # 激活一个Book print('count1:',app1.books.count) # 先打印一下app1下Book的总数 app1.books.add() # 增加一个新的Book,此新建的Book将自动变成被激活的Book print('count1:',app1.books.count) # 再次打印app1下Book的总数 app1.books.open('1.xlsx') # 打开操作，如果工作簿未打开则打开，若它已经打开，则返回工作簿对象。 # 或指定绝对路径打开文件 app1.books.open('D:\datafile\1.xlsx') print(app1.books.open('1.xlsx')) # 再一次打印app1下Book的总数 print('count1:',app1.books.count)
wb = xw.Book() # 新建工作簿 wb.activate(steal_focus=True) # True则激活最前面的窗口，并将焦点从python移交给excel wb.app # 获取创建工作簿的app对象 wb.caller() # 当通过RunPython从Excel调用Python函数时引用调用的工作簿 wb.set_mock_caller() # 设置当前工作薄为Python代码的调用者即set_mock_caller让Python知道谁是调用者 wb.close() # 关闭工作簿而不进行保存 wb.selection # 返回选定的单元格作为Range wb.macro() # 在Excel VBA中运行Sub或Function wb.name # 返回工作簿的名称 wb.names # 返回一个名称集合 wb.save(path=None) # 保存工作簿，可传入保存路径，同名会直接覆盖 wb.sheets # 返回表示工作簿中所有工作表的工作表集
五、sheets
apps/ App
books/ Book
sheets/ Sheet
Range
import xlwings as xw wb = xw.Book('1.xlsx') #以xw.Book()方式打开工作簿 print(wb.sheets) #查看当前工作簿的所有Sheet详情 print(wb.sheets.active) #激活一个Sheet发现是Sheet1 # 在Sheet1前新增一个Sheet并命名 print(wb.sheets.add(name='Python知识学堂', before='Sheet1')) # print(wb.sheets.add(name='Python知识学堂', 1)) print(wb.sheets.active) #激活Sheet页，这个Sheet是新增的
# 返回激活(活动)工作表 wb.sheets.active # 新增Sheet页，参数默认均为None，其中name为名称，before指在那个页签前插入，after为哪个页签之后插入。 wb.sheets.add(name= None,before = None,after = None)
import xlwings as xw wb = xw.Book('1.xlsx') wb.sheets[0] # 使用索引值引用"2.xlsx"文件的Sheet1 wb.sheets['Sheet1'] # 直接使用名称引用"2.xlsx"文件的Sheet1 wb.sheets.add() # 新建一个Sheet。默认为Sheet3 wb.sheets.count # 获得工作簿中工作表sheet的数量
sheets/Sheet 的其它方法或属性
import xlwings as xw wb = xw.Book('1.xlsx') sheet = wb.sheets[0] # 引用工作表Sheet1 sheet.activate #获取当前活跃的工作簿 sheet.autofit() #在整个工作表上自动调整宽度,可传参数 sheet.autofit(axis='c') # 在整个工作表上自动调整列的宽度 sheet.autofit(axis='r') # 在整个工作表上自动调整行的宽度 sheet.book # 返回指定Sheet的book,输出 <Book [2.xlsx]> sheet.cells # 返回一个Range对象，该对象表示Sheet上的所有单元格（而不仅仅是当前正在使用的单元格）输出<Range [2.xlsx]Sheet1!$1:$1048576> sheet.name # 获取工作表的名称 sheet.name = '我爱python知识学堂'# 工作表重命名 sheet.clear() # 清空工作表中的内容和格式 sheet.index # 返回对应sheet的索引值，从0计数 sheet.delete() # 删除工作表 sheet.clear_contents() # 清除工作表的内容，但保留格式 # 工作表sheet中有数据区域最大的行数，法1 sheet['a1048576'].end('up').row # 工作表sheet中有数据区域最大的行数，法2 sheet.used_range.last_cell.row # 工作表sheet中有数据区域最大的列数，法1 sheet['xfd1'].end('left').column # 工作表sheet中有数据区域最大的列数，法2 sheet.used_range.last_cell.column # 返回工作表中已经使用的单元格区域 sheet.api.UsedRange # 法1 sheet.used_range # 法2 sheet.api.row('2:4').insert # 插入行，在第2-4行插入空白行 sheet.api.row('2:4').delete # 删除行 # 取值 sheet.cells(2,4).value
六、Range
import xlwings as xw wb = xw.Book('1.xlsx') range = xw.Range('A1') # 引用A1单元格 range.value # 取单元格的值 range.value = 12 # 设置单元格的值 range.raw_value # 直接获取并设置所使用（pywin32）引擎发送/接受的值，而无需进行任何xlwings数据清理/转换。 xw.Range('A1:C4').value # 引用区域值，以二维数组形式呈现 xw.Range((1,1),(2,2)) xw.Range('A1').add_hyperlink(address = 'www.baidu.com') # 添加超链接 xw.Range('A2').address # 返回表示范围参考的字符串值，输出为$a$2 xw.Range.api # 返回所使用引擎的本机对象 xw.Range('a1').autofit() # 自动调整范围内所有单元格的宽度和高度 # 自动调整列宽 wb.sheets[0].range('A1:B2').columns.autofit() # 自动调整行高 wb.sheet[0].range('A1:B2').rows.autofit() xw.Range('A1').clear() # 清除所选单元格的内容和格式，可选择范围 xw.Range('A2').clear_contents() # 清除内容，但保留格式 xw.Range('A2').color # 获取单元格的背景色 xw.Range('A1').color = (255,255,255) # 设置单元格的背景色 xw.Range('A1').color = None # 删除背景色 xw.Range('B1:C3').column # 返回所选范围第一列的列标 xw.Range('B1:C3').row # 返回所选范围第一行的行标 xw.Range('a1:d4').count # 返回所选单元格的数量 xw.Range('A1').current_region # 返回一个Range对象，该对象表示由（但不包括）空白行和空白列或者工作表的边缘的任意组合限制的范围，好比是一片链接的区域 xw.Range('A1').delete() # 删除单元格，可选参数left和up， 如省略，Excel 将根据范围的形状来决定 xw.Range('A2').end('down') # 返回一个Range对象，该对象表示包含源范围的区域末尾的单元格。参数可传down,up,left,right.其实也是ctrl+方向 xw.Range('A2').end('right') xw.Range('A2').formula = '=sum(a3:a7)' # 输入公式 print(xw.Range('A2').formula) # 输出公式 # 已制定格式返回Range的 地址 xw.Range('A1:B2').get_address() # '$A$1:$B$2' ''' 参数： row_absolute(bool, 默认为True) 设置为True 可以将 引用的行部分 作为绝对引用返回 column_absolute(bool,默认为True) 设置为True 可以将 引用的列部分 作为绝对引用返回 include_sheetname(bool,默认为Falsee)设置为True 可以在 地址中包含 工作表名称 external(bool, 默认为False) 设置为True 可以返回带有工作簿和工作表名称的外部引用 ''' xw.Range('a1:c2').height # 返回range的高度 xw.Range('a1:b3').width # 返回range的宽度 xw.Range('a1:c4').row_height # 获取range的高度 以磅为单位 xw.Range('a1:c34').row_height = 15 # 设置range的高度 # 获取范围行和范围列 xw.Range ('B2:C4').rows # 返回一个RangeRows对象，该对象表示指定范围内的行。 xw.Range ('B2:C4').columns # 返回一个RangeRows对象，该对象表示指定范围内的列。 xw.Range('B2:C4').rows.count # 获取范围行 xw.Range('B2:C4').columns.count # 获取范围列 xw.Range ('B2').left # 返回从A列的左边缘到范围左边缘的距离 xw.Range ('B2').top # 返回从第1行的顶部边缘到范围的顶部边缘的距离 xw.Range ('A1').hyperlink # 返回单元格中的超链接（对多个单元格没效） # 插入单元格 xw.Range ('A3').insert(shift='right') #返回指定范围的右下角单元格 range = xw.Range ('A1:C4').last_cell range.last_cell.row # 4 range.last_cell.column # 3 xw.Range("A4:C4").api.merge() # 合并单元格通过pywin32的api调用merge xw.Range("A4:C4").api.unmerge()# 拆分单元格 xw.Range('A1').number_format # 获取设置Range的number_format # 设置Range的number_format xw.Range('A1:C3').number_format = '0.00%' xw.Range('A1:A3').paste() # 将剪贴板中的范围粘贴到指定范围 # 调整指定范围的大小 xw.Range('A1:A3').resize(row_size = None,column_size = None ) # 选定单元格进行移动 xw.Range('B2:C4').offset(row_offset=1,column_offset=1) #row_offset行偏移，column_offset列偏移 xw.Range('B2:C4').shape # 以数组的形式返回所选范围的值 xw.Range('B2:C4').sheet # 返回Range所属的Sheet对象 xw.Range('B2:C4').size # 返回所选范围单元格个数(元素个数) xw.Range('B2:C4').options(ndim=2).value xw.Range('A1:C1').options(ndim=2).value
