Class - builtin.flatfile.flatfile.iov2.excel.ExcelInput
¶
JSON Schema¶
ExcelInput¶
Inputter for Excel xls and xlsx files. xls files are read using the xlrd package. xlsx files are read using the openpyxl package. start_row and start_column are both 0-indexed values. Originally, support for both file formats was provided via xlrd, but xlrd eventually dropped support for xlsx. openpyxl was used to add support for xlsx, which xlrd was retained for xls. |
||||
type |
object |
|||
properties |
||||
|
Source |
|||
The name of the Excel file for processing. |
||||
type |
string |
|||
|
Tab Regex |
|||
Regex pattern to match sheet/tab names. |
||||
type |
string |
|||
default |
||||
|
Sheet |
|||
Sheet name (string) or index (integer) to read data from. |
||||
default |
0 |
|||
anyOf |
type |
string |
||
type |
integer |
|||
|
Start Row |
|||
0-based index of the first row to process. |
||||
type |
integer |
|||
minimum |
0 |
|||
default |
0 |
|||
|
Stop Row |
|||
0-based index of the last row to process (exclusive). |
||||
type |
integer |
|||
|
Start Column |
|||
0-based index of the first column to process. |
||||
type |
integer |
|||
minimum |
0 |
|||
default |
0 |
|||
|
Stop Column |
|||
0-based index of the last column to process (exclusive). |
||||
type |
integer |
|||
|
Encoding |
|||
Encoding used to read the Excel file. Leave blank for default. |
||||
type |
string |
|||
default |
||||
|
Includes Header |
|||
Indicates whether the first row contains column headers. |
||||
type |
boolean |
|||
examples |
true |
|||
false |
||||
default |
True |
|||
|
Noneify |
|||
Controls which values are converted to None. If True, converts all empty strings to None. If a list or tuple of strings, only those specific values are converted to None. |
||||
examples |
(‘’, ‘#Error’) |
|||
[‘none’, ‘NONE’, ‘None’] |
||||
default |
True |
|||
anyOf |
type |
array |
||
items |
type |
string |
||
type |
array |
|||
items |
type |
string |
||
type |
boolean |
|||
|
Convert Bad Dates To None |
|||
Replace invalid date values with None. |
||||
type |
boolean |
|||
examples |
true |
|||
false |
||||
default |
False |
|||
additionalProperties |
False |