1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
"""
This module contains the XLS extension to :class:`Table <agate.table.Table>`.
"""
import datetime
from collections import OrderedDict
import agate
import olefile
import xlrd
EXCEL_TO_AGATE_TYPE = {
xlrd.biffh.XL_CELL_EMPTY: agate.Boolean(),
xlrd.biffh.XL_CELL_TEXT: agate.Text(),
xlrd.biffh.XL_CELL_NUMBER: agate.Number(),
xlrd.biffh.XL_CELL_DATE: agate.DateTime(),
xlrd.biffh.XL_CELL_BOOLEAN: agate.Boolean(),
xlrd.biffh.XL_CELL_ERROR: agate.Text(),
xlrd.biffh.XL_CELL_BLANK: agate.Boolean(),
}
def from_xls(cls, path, sheet=None, skip_lines=0, header=True, encoding_override=None, row_limit=None, **kwargs):
"""
Parse an XLS file.
:param path:
Path to an XLS file to load or a file-like object for one.
:param sheet:
The names or integer indices of the worksheets to load. If not specified
then the first sheet will be used.
:param skip_lines:
The number of rows to skip from the top of the sheet.
:param header:
If :code:`True`, the first row is assumed to contain column names.
:param row_limit:
Limit how many rows of data will be read.
"""
if not isinstance(skip_lines, int):
raise ValueError('skip_lines argument must be an int')
def open_workbook(f):
try:
book = xlrd.open_workbook(file_contents=f.read(), encoding_override=encoding_override, on_demand=True)
except xlrd.compdoc.CompDocError:
# This is not a pure XLS file; we'll try to read it though.
# Let's try the Compound File Binary Format:
ole = olefile.OleFileIO(f)
if ole.exists('Workbook'):
d = ole.openstream('Workbook')
book = xlrd.open_workbook(file_contents=d.read(), on_demand=True)
else:
raise OSError('No Workbook stream found in OLE file')
return book
if hasattr(path, 'read'):
book = open_workbook(path)
else:
with open(path, 'rb') as f:
book = open_workbook(f)
try:
multiple = agate.utils.issequence(sheet)
if multiple:
sheets = sheet
else:
sheets = [sheet]
tables = OrderedDict()
for i, sheet in enumerate(sheets):
if isinstance(sheet, str):
sheet = book.sheet_by_name(sheet)
elif isinstance(sheet, int):
sheet = book.sheet_by_index(sheet)
else:
sheet = book.sheet_by_index(0)
if header:
offset = 1
column_names = []
else:
offset = 0
column_names = None
columns = []
column_types = []
for i in range(sheet.ncols):
if row_limit is None:
values = sheet.col_values(i, skip_lines + offset)
types = sheet.col_types(i, skip_lines + offset)
else:
values = sheet.col_values(i, skip_lines + offset, skip_lines + offset + row_limit)
types = sheet.col_types(i, skip_lines + offset, skip_lines + offset + row_limit)
excel_type = determine_excel_type(types)
agate_type = determine_agate_type(excel_type)
if excel_type == xlrd.biffh.XL_CELL_BOOLEAN:
values = normalize_booleans(values)
elif excel_type == xlrd.biffh.XL_CELL_DATE:
values, with_date, with_time = normalize_dates(values, book.datemode)
if not with_date:
agate_type = agate.TimeDelta()
if not with_time:
agate_type = agate.Date()
if header:
name = str(sheet.cell_value(skip_lines, i)) or None
column_names.append(name)
columns.append(values)
column_types.append(agate_type)
rows = []
if columns:
for i in range(len(columns[0])):
rows.append([c[i] for c in columns])
if 'column_names' in kwargs:
if not header:
column_names = kwargs['column_names']
del kwargs['column_names']
if 'column_types' in kwargs:
column_types = kwargs['column_types']
del kwargs['column_types']
tables[sheet.name] = agate.Table(rows, column_names, column_types, **kwargs)
finally:
book.release_resources()
if multiple:
return agate.MappedSequence(tables.values(), tables.keys())
return tables.popitem()[1]
def determine_agate_type(excel_type):
try:
return EXCEL_TO_AGATE_TYPE[excel_type]
except KeyError:
return agate.Text()
def determine_excel_type(types):
"""
Determine the correct type for a column from a list of cell types.
"""
types_set = set(types)
types_set.discard(xlrd.biffh.XL_CELL_EMPTY)
# Normalize mixed types to text
if len(types_set) > 1:
return xlrd.biffh.XL_CELL_TEXT
try:
return types_set.pop()
except KeyError:
return xlrd.biffh.XL_CELL_EMPTY
def normalize_booleans(values):
normalized = []
for value in values:
if value is None or value == '':
normalized.append(None)
else:
normalized.append(bool(value))
return normalized
def normalize_dates(values, datemode=0):
"""
Normalize a column of date cells.
"""
normalized = []
with_date = False
with_time = False
for v in values:
if not v:
normalized.append(None)
continue
v_tuple = xlrd.xldate.xldate_as_datetime(v, datemode).timetuple()
if v_tuple[3:6] == (0, 0, 0):
# Date only
normalized.append(datetime.date(*v_tuple[:3]))
with_date = True
elif v_tuple[:3] == (0, 0, 0):
# Time only
normalized.append(datetime.time(*v_tuple[3:6]))
with_time = True
else:
# Date and time
normalized.append(datetime.datetime(*v_tuple[:6]))
with_date = True
with_time = True
return (normalized, with_date, with_time)
agate.Table.from_xls = classmethod(from_xls)
|
