pyexcel-ods is a tiny wrapper library to read, manipulate and write data in ods format using python 2.6 and python 2.7. You are likely to use it with pyexcel. pyexcel-ods3 is a sister library that depends on ezodf and lxml. pyexcel-odsr is the other sister library that has no external dependency but do ods reading only
If your company uses pyexcel and its components in a revenue-generating product, please consider supporting the project on GitHub or Patreon. Your financial support will enable me to dedicate more time to coding, improving documentation, and creating engaging content.
Fonts, colors and charts are not supported.
Nor to read password protected xls, xlsx and ods files.
You can install pyexcel-ods via pip:
$ pip install pyexcel-ods
or clone it and install it:
$ git clone https://github.com/pyexcel/pyexcel-ods.git $ cd pyexcel-ods $ python setup.py install
.. testcode:: :hide: >>> import os >>> import sys >>> from io import BytesIO >>> from collections import OrderedDict
Here's the sample code to write a dictionary to an ods file:
>>> from pyexcel_ods import save_data >>> data = OrderedDict() # from collections import OrderedDict >>> data.update({"Sheet 1": [[1, 2, 3], [4, 5, 6]]}) >>> data.update({"Sheet 2": [["row 1", "row 2", "row 3"]]}) >>> save_data("your_file.ods", data)
Here's the sample code:
>>> from pyexcel_ods import get_data >>> data = get_data("your_file.ods") >>> import json >>> print(json.dumps(data)) {"Sheet 1": [[1, 2, 3], [4, 5, 6]], "Sheet 2": [["row 1", "row 2", "row 3"]]}
Here's the sample code to write a dictionary to an ods file:
>>> from pyexcel_ods import save_data >>> data = OrderedDict() >>> data.update({"Sheet 1": [[1, 2, 3], [4, 5, 6]]}) >>> data.update({"Sheet 2": [[7, 8, 9], [10, 11, 12]]}) >>> io = BytesIO() >>> save_data(io, data) >>> # do something with the io >>> # In reality, you might give it to your http response >>> # object for downloadingRead from an ods from memory
Continue from previous example:
>>> # This is just an illustration >>> # In reality, you might deal with ods file upload >>> # where you will read from requests.FILES['YOUR_ODS_FILE'] >>> data = get_data(io) >>> print(json.dumps(data)) {"Sheet 1": [[1, 2, 3], [4, 5, 6]], "Sheet 2": [[7, 8, 9], [10, 11, 12]]}
Special notice 30/01/2017: due to the constraints of the underlying 3rd party library, it will read the whole file before returning the paginated data. So at the end of day, the only benefit is less data returned from the reading function. No major performance improvement will be seen.
With that said, please install pyexcel-odsr and it gives better performance in pagination.
Let's assume the following file is a huge ods file:
>>> huge_data = [ ... [1, 21, 31], ... [2, 22, 32], ... [3, 23, 33], ... [4, 24, 34], ... [5, 25, 35], ... [6, 26, 36] ... ] >>> sheetx = { ... "huge": huge_data ... } >>> save_data("huge_file.ods", sheetx)
And let's pretend to read partial data:
>>> partial_data = get_data("huge_file.ods", start_row=2, row_limit=3) >>> print(json.dumps(partial_data)) {"huge": [[3, 23, 33], [4, 24, 34], [5, 25, 35]]}
And you could as well do the same for columns:
>>> partial_data = get_data("huge_file.ods", start_column=1, column_limit=2) >>> print(json.dumps(partial_data)) {"huge": [[21, 31], [22, 32], [23, 33], [24, 34], [25, 35], [26, 36]]}
Obvious, you could do both at the same time:
>>> partial_data = get_data("huge_file.ods", ... start_row=2, row_limit=3, ... start_column=1, column_limit=2) >>> print(json.dumps(partial_data)) {"huge": [[23, 33], [24, 34], [25, 35]]}
.. testcode:: :hide: >>> os.unlink("huge_file.ods")
No longer, explicit import is needed since pyexcel version 0.2.2. Instead, this library is auto-loaded. So if you want to read data in ods format, installing it is enough.
Here is the sample code:
>>> import pyexcel as pe >>> sheet = pe.get_book(file_name="your_file.ods") >>> sheet Sheet 1: +---+---+---+ | 1 | 2 | 3 | +---+---+---+ | 4 | 5 | 6 | +---+---+---+ Sheet 2: +-------+-------+-------+ | row 1 | row 2 | row 3 | +-------+-------+-------+
Here is the sample code:
>>> sheet.save_as("another_file.ods")Reading from a IO instance
You got to wrap the binary content with stream to get ods working:
>>> # This is just an illustration >>> # In reality, you might deal with ods file upload >>> # where you will read from requests.FILES['YOUR_ODS_FILE'] >>> odsfile = "another_file.ods" >>> with open(odsfile, "rb") as f: ... content = f.read() ... r = pe.get_book(file_type="ods", file_content=content) ... print(r) ... Sheet 1: +---+---+---+ | 1 | 2 | 3 | +---+---+---+ | 4 | 5 | 6 | +---+---+---+ Sheet 2: +-------+-------+-------+ | row 1 | row 2 | row 3 | +-------+-------+-------+Writing to a BytesIO instance
You need to pass a BytesIO instance to Writer:
>>> data = [ ... [1, 2, 3], ... [4, 5, 6] ... ] >>> io = BytesIO() >>> sheet = pe.Sheet(data) >>> io = sheet.save_to_memory("ods", io) >>> # then do something with io >>> # In reality, you might give it to your http response >>> # object for downloading
New BSD License
Development steps for code changes
Upgrade your setup tools and pip. They are needed for development and testing only:
Then install relevant development requirements:
Once you have finished your changes, please provide test case(s), relevant documentation and update changelog.yml
Note
As to rnd_requirements.txt, usually, it is created when a dependent library is not released. Once the dependency is installed (will be released), the future version of the dependency in the requirements.txt will be valid.
How to test your contributionAlthough nose and doctest are both used in code testing, it is advisable that unit tests are put in tests. doctest is incorporated only to make sure the code examples in documentation remain valid across different development releases.
On Linux/Unix systems, please launch your tests like this:
$ make
On Windows, please issue this command:
> test.bat
Please run:
$ make format
so as to beautify your code otherwise your build may fail your unit test.
ODSReader is originally written by Marco Conti
.. testcode:: :hide: >>> import os >>> os.unlink("your_file.ods") >>> os.unlink("another_file.ods")
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4