blob: a3ab2cc75168271bb80def2d7a0946be001dfba0 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
|
orcus.gnumeric
==============
.. py:function:: orcus.gnumeric.read
Read an Gnumeric file from a specified file path and create a
:py:class:`orcus.Document` instance object.
:param stream: file object containing byte streams.
:param bool recalc: optional parameter specifying whether or not to recalculate
the formula cells on load. Defaults to ``False``.
:param str error_policy: optional parameter indicating what to do when
encountering formula cells with invalid formula expressions. The value
must be either ``fail`` or ``skip``. Defaults to ``fail``.
:rtype: :py:class:`orcus.Document`
:return: document instance object that stores the content of the file.
Example::
from orcus import gnumeric
with open("path/to/file.gnumeric", "rb") as f:
doc = gnumeric.read(f, recalc=True, error_policy="fail")
|
