forked from python-openxml/python-docx
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtable.py
More file actions
409 lines (351 loc) · 11.9 KB
/
table.py
File metadata and controls
409 lines (351 loc) · 11.9 KB
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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
# encoding: utf-8
"""
The |Table| object and related proxy classes.
"""
from __future__ import absolute_import, print_function, unicode_literals
from .blkcntnr import BlockItemContainer
from .enum.style import WD_STYLE_TYPE
from .oxml.simpletypes import ST_Merge
from .shared import lazyproperty, Parented
class Table(Parented):
"""
Proxy class for a WordprocessingML ``<w:tbl>`` element.
"""
def __init__(self, tbl, parent):
super(Table, self).__init__(parent)
self._tbl = tbl
def add_column(self):
"""
Return a |_Column| instance, newly added rightmost to the table.
"""
tblGrid = self._tbl.tblGrid
gridCol = tblGrid.add_gridCol()
for tr in self._tbl.tr_lst:
tr.add_tc()
return _Column(gridCol, self)
def add_row(self):
"""
Return a |_Row| instance, newly added bottom-most to the table.
"""
tbl = self._tbl
tr = tbl.add_tr()
for gridCol in tbl.tblGrid.gridCol_lst:
tr.add_tc()
return _Row(tr, self)
@property
def alignment(self):
"""
Read/write. A member of :ref:`WdRowAlignment` or None, specifying the
positioning of this table between the page margins. |None| if no
setting is specified, causing the effective value to be inherited
from the style hierarchy.
"""
return self._tblPr.alignment
@alignment.setter
def alignment(self, value):
self._tblPr.alignment = value
@property
def autofit(self):
"""
|True| if column widths can be automatically adjusted to improve the
fit of cell contents. |False| if table layout is fixed. Column widths
are adjusted in either case if total column width exceeds page width.
Read/write boolean.
"""
return self._tblPr.autofit
@autofit.setter
def autofit(self, value):
self._tblPr.autofit = value
def cell(self, row_idx, col_idx):
"""
Return |_Cell| instance correponding to table cell at *row_idx*,
*col_idx* intersection, where (0, 0) is the top, left-most cell.
"""
cell_idx = col_idx + (row_idx * self._column_count)
return self._cells[cell_idx]
def column_cells(self, column_idx):
"""
Sequence of cells in the column at *column_idx* in this table.
"""
cells = self._cells
idxs = range(column_idx, len(cells), self._column_count)
return [cells[idx] for idx in idxs]
@lazyproperty
def columns(self):
"""
|_Columns| instance representing the sequence of columns in this
table.
"""
return _Columns(self._tbl, self)
def row_cells(self, row_idx):
"""
Sequence of cells in the row at *row_idx* in this table.
"""
column_count = self._column_count
start = row_idx * column_count
end = start + column_count
return self._cells[start:end]
@lazyproperty
def rows(self):
"""
|_Rows| instance containing the sequence of rows in this table.
"""
return _Rows(self._tbl, self)
@property
def style(self):
"""
Read/write. A |_TableStyle| object representing the style applied to
this table. The default table style for the document (often `Normal
Table`) is returned if the table has no directly-applied style.
Assigning |None| to this property removes any directly-applied table
style causing it to inherit the default table style of the document.
Note that the style name of a table style differs slightly from that
displayed in the user interface; a hyphen, if it appears, must be
removed. For example, `Light Shading - Accent 1` becomes `Light
Shading Accent 1`.
"""
style_id = self._tbl.tblStyle_val
return self.part.get_style(style_id, WD_STYLE_TYPE.TABLE)
@style.setter
def style(self, style_or_name):
style_id = self.part.get_style_id(
style_or_name, WD_STYLE_TYPE.TABLE
)
self._tbl.tblStyle_val = style_id
@property
def table(self):
"""
Provide child objects with reference to the |Table| object they
belong to, without them having to know their direct parent is
a |Table| object. This is the terminus of a series of `parent._table`
calls from an arbitrary child through its ancestors.
"""
return self
@property
def _cells(self):
"""
A sequence of |_Cell| objects, one for each cell of the layout grid.
If the table contains a span, one or more |_Cell| object references
are repeated.
"""
col_count = self._column_count
cells = []
for tc in self._tbl.iter_tcs():
for grid_span_idx in range(tc.grid_span):
if tc.vMerge == ST_Merge.CONTINUE:
cells.append(cells[-col_count])
elif grid_span_idx > 0:
cells.append(cells[-1])
else:
cells.append(_Cell(tc, self))
return cells
@property
def _column_count(self):
"""
The number of grid columns in this table.
"""
return self._tbl.col_count
@property
def _tblPr(self):
return self._tbl.tblPr
class _Cell(BlockItemContainer):
"""
Table cell
"""
def __init__(self, tc, parent):
super(_Cell, self).__init__(tc, parent)
self._tc = tc
def add_paragraph(self, text='', style=None):
"""
Return a paragraph newly added to the end of the content in this
cell. If present, *text* is added to the paragraph in a single run.
If specified, the paragraph style *style* is applied. If *style* is
not specified or is |None|, the result is as though the 'Normal'
style was applied. Note that the formatting of text in a cell can be
influenced by the table style. *text* can contain tab (``\\t``)
characters, which are converted to the appropriate XML form for
a tab. *text* can also include newline (``\\n``) or carriage return
(``\\r``) characters, each of which is converted to a line break.
"""
return super(_Cell, self).add_paragraph(text, style)
def add_table(self, rows, cols):
"""
Return a table newly added to this cell after any existing cell
content, having *rows* rows and *cols* columns. An empty paragraph is
added after the table because Word requires a paragraph element as
the last element in every cell.
"""
new_table = super(_Cell, self).add_table(rows, cols)
self.add_paragraph()
return new_table
def merge(self, other_cell):
"""
Return a merged cell created by spanning the rectangular region
having this cell and *other_cell* as diagonal corners. Raises
|InvalidSpanError| if the cells do not define a rectangular region.
"""
tc, tc_2 = self._tc, other_cell._tc
merged_tc = tc.merge(tc_2)
return _Cell(merged_tc, self._parent)
@property
def paragraphs(self):
"""
List of paragraphs in the cell. A table cell is required to contain
at least one block-level element and end with a paragraph. By
default, a new cell contains a single paragraph. Read-only
"""
return super(_Cell, self).paragraphs
@property
def tables(self):
"""
List of tables in the cell, in the order they appear. Read-only.
"""
return super(_Cell, self).tables
@property
def text(self):
"""
The entire contents of this cell as a string of text. Assigning
a string to this property replaces all existing content with a single
paragraph containing the assigned text in a single run.
"""
return '\n'.join(p.text for p in self.paragraphs)
@text.setter
def text(self, text):
"""
Write-only. Set entire contents of cell to the string *text*. Any
existing content or revisions are replaced.
"""
tc = self._tc
tc.clear_content()
p = tc.add_p()
r = p.add_r()
r.text = text
@property
def width(self):
"""
The width of this cell in EMU, or |None| if no explicit width is set.
"""
return self._tc.width
@width.setter
def width(self, value):
self._tc.width = value
class _Column(Parented):
"""
Table column
"""
def __init__(self, gridCol, parent):
super(_Column, self).__init__(parent)
self._gridCol = gridCol
@property
def cells(self):
"""
Sequence of |_Cell| instances corresponding to cells in this column.
"""
return tuple(self.table.column_cells(self._index))
@property
def table(self):
"""
Reference to the |Table| object this column belongs to.
"""
return self._parent.table
@property
def width(self):
"""
The width of this column in EMU, or |None| if no explicit width is
set.
"""
return self._gridCol.w
@width.setter
def width(self, value):
self._gridCol.w = value
@property
def _index(self):
"""
Index of this column in its table, starting from zero.
"""
return self._gridCol.gridCol_idx
class _Columns(Parented):
"""
Sequence of |_Column| instances corresponding to the columns in a table.
Supports ``len()``, iteration and indexed access.
"""
def __init__(self, tbl, parent):
super(_Columns, self).__init__(parent)
self._tbl = tbl
def __getitem__(self, idx):
"""
Provide indexed access, e.g. 'columns[0]'
"""
try:
gridCol = self._gridCol_lst[idx]
except IndexError:
msg = "column index [%d] is out of range" % idx
raise IndexError(msg)
return _Column(gridCol, self)
def __iter__(self):
for gridCol in self._gridCol_lst:
yield _Column(gridCol, self)
def __len__(self):
return len(self._gridCol_lst)
@property
def table(self):
"""
Reference to the |Table| object this column collection belongs to.
"""
return self._parent.table
@property
def _gridCol_lst(self):
"""
Sequence containing ``<w:gridCol>`` elements for this table, each
representing a table column.
"""
tblGrid = self._tbl.tblGrid
return tblGrid.gridCol_lst
class _Row(Parented):
"""
Table row
"""
def __init__(self, tr, parent):
super(_Row, self).__init__(parent)
self._tr = tr
@property
def cells(self):
"""
Sequence of |_Cell| instances corresponding to cells in this row.
"""
return tuple(self.table.row_cells(self._index))
@property
def table(self):
"""
Reference to the |Table| object this row belongs to.
"""
return self._parent.table
@property
def _index(self):
"""
Index of this row in its table, starting from zero.
"""
return self._tr.tr_idx
class _Rows(Parented):
"""
Sequence of |_Row| objects corresponding to the rows in a table.
Supports ``len()``, iteration, indexed access, and slicing.
"""
def __init__(self, tbl, parent):
super(_Rows, self).__init__(parent)
self._tbl = tbl
def __getitem__(self, idx):
"""
Provide indexed access, (e.g. 'rows[0]')
"""
return list(self)[idx]
def __iter__(self):
return (_Row(tr, self) for tr in self._tbl.tr_lst)
def __len__(self):
return len(self._tbl.tr_lst)
@property
def table(self):
"""
Reference to the |Table| object this row collection belongs to.
"""
return self._parent.table