概述

databook接口主要功能是对影刀内置的数据表格进行处理,如设置行内容、获取行内容、遍历行内容等

详情

get_row

获取数据表格指定行内容

get_row(row_num)
参数:

  • row_num:指定行号,行号从1开始

返回值:

  • List[str]:返回读取到的内容列表,如[‘a’, ‘b’, ‘c’, ‘d’]

示例1:
获取数据表格第一行内容

  1. from xbot import app
  2. def main(args):
  3. list_value = app.databook.get_row(1)

set_row

设置数据表格行内容

set_row(row_num, values, begin_column_name = ‘A’)
参数:

  • row_num:要设置的数据表格行号,行号从1开始
  • values:要设置的值,必须是一个列表类型,如[‘abc’, 123, 123.456]
  • begin_column_name:设置开始的单元格列名,默认值为A

返回值:

示例1:
设置数据表格第 1 行第 A 列单元格的值为 hello world

  1. from xbot import app
  2. def main(args):
  3. app.databook.set_row(1, ['helloword'], begin_column_name = 'A')

append_row

在数据表格最后追加一行内容

append_row(values, begin_column_name = ‘A’)
参数:

  • values:要设置的值, 必须是一个列表类型,如[‘abc’, 123, 123.456]
  • begin_column_name:设置开始的单元格列名, 默认值为A

返回值:

示例1:
在数据表格的最后追加一行内容,起始写入单元格的列名为 B,内容为 [1,2,3,4,5,6,7,8,9,0]

  1. from xbot import app
  2. def main(args):
  3. app.databook.append_row([1,2,3,4,5,6,7,8,9,0], begin_column_name = 'B')

insert_row

往数据表格中插入一行内容

insert_row(row_num, values, begin_column_name = ‘A’)
参数:

  • row_num:插入位置的行号,行号从1开始
  • values:要设置的值,必须是一个列表类型,如[‘abc’, 123, 123.456]
  • begin_column_name:设置开始的单元格列名,默认值为A

返回值:

示例1:
往数据表格第 10 行插入一条记录,行开始单元格列名为 A 插入值为 [1,2,3,4,5,6,7,8,9,0]

  1. from xbot import app
  2. def main(args):
  3. app.databook.insert_row(10, [1,2,3,4,5,6,7,8,9,0], begin_column_name = 'A')

remove_row

移除数据表的某一行内容

remove_row(row_num)
参数:

  • row_num:要移除的行号

返回值:

示例1:
移除数据表格中第 10 行的数据

  1. from xbot import app
  2. def main(args):
  3. app.databook.remove_row(10)

get_cell

获取数据表格指定单元格内容

get_cell(row_num, col_name)
参数:

  • row_num:指定单元格的行号
  • col_name:指定单元格的列名

返回值:

  • str:返回数据表格指定单元格内容

示例1:
获取数据表格第 10 行第 B 列单元中的内容

  1. from xbot import app
  2. def main(args):
  3. value = app.databook.get_cell(10, 'B')

set_cell

设置数据表格指定单元格内容

set_cell(row_num, col_name, value)
参数:

  • row_num:指定单元格的行号
  • col_name:指定单元格的列名
  • value:要设置到单元格中的内容

返回值:

示例1:
设置数据表格第 10 行第 B 列单元格的值为 helloword

  1. from xbot import app
  2. def main(args):
  3. app.databook.set_cell(10, 'B', 'helloword')

get_column

获取数据表格指定列内容

get_column(col_name)
参数:

  • col_name:需要获取的列名

返回值:

  • list[str]:返回获取的字符串列表

示例1:
获取 ‘C’ 列内容

  1. from xbot import app
  2. def main(args):
  3. list_value = app.databook.get_column('A')


set_column

设置数据表格列内容

set_column(col_name, values, begin_row_num = 1)
参数:

  • col_name:需要设置的列名
  • values:要设置的值, 必须是一个列表类型
  • begin_row_num:需要设置的列的起始行号,行号从1开始

返回值:

示例1:
从第 1 行开始设置第 A 列数据值为 [1,2,3,4,5,6,7,8,9,0]

  1. from xbot import app
  2. def main(args):
  3. app.databook.set_column('A', [1,2,3,4,5,6,7,8,9,0], begin_row_num = 1)

clear

清空数据表格内容

clear()
参数:

返回值:

示例1:
清空数据表格内容

  1. from xbot import app
  2. def main(args):
  3. app.databook.clear()

get_row_count

获取数据表格的总行数

get_row_count()
参数:

返回值:

  • int:返回数据表格的总行数

示例1:
获取数据表格当前数据的总行数

  1. from xbot import app
  2. def main(args):
  3. count = app.databook.get_row_count()

get_range

获取数据表格指定区域的内容

get_range(area_begin_row_num, area_begin_column_name, area_end_row_num, area_end_column_name)
参数:

  • area_begin_row_num:起始单元格行号,行号从1开始
  • area_begin_column_name:起始单元格列名,列名从A开始
  • area_end_row_num:结束单元格行号, 行号从1开始
  • area_end_column_name:结束单元格列名,列名从A开始

返回值:

  • List[Tuple]:返回读取内容组合

示例1:
获取数据表格 A1 单元格到 F3 单元格中的内容

  1. from xbot import app
  2. def main(args):
  3. list_value = app.databook.get_range(1, 'A', 3, 'F')

set_range

设置数据表格指定区域内容

set_range(row_num, col_name, values)
参数:

  • row_num:设置区域起始行号,行号从1开始
  • col_name:设置区域起始列名,列名从A开始
  • values:要设置的内容,必须是一个二维数组

返回值:

示例1:
设置数据表格从 A1 单元格开始的值为

  1. from xbot import app
  2. def main(args):
  3. app.databook.set_range(1, 'A', [['1','2','3'],['a','b','c']])

import_data

数据表格导入

import_data(file_path, sheet_name)
参数:

  • file_path:填写要导入的文件路径
  • sheet_name:Sheet页名称

返回值:

示例:

  1. import xbot
  2. from xbot import print, sleep
  3. from .import package
  4. def main(args):
  5. xbot.app.databook.import_data(r'C:\Users\37530\Desktop\测试数据.xlsx', 'Sheet1')

export_data

数据表格导出

export_data(file_path)
参数:

  • file_path:设置导出文件的保存路径

返回值:

示例:

  1. import xbot
  2. from xbot import print, sleep
  3. from .import package
  4. def main(args):
  5. xbot.app.databook.export_data(r'C:\Users\37530\Desktop\测试数据2.xlsx')