pyexcel-xls 0.7.1

As a standalone library

>>> from pyexcel_xls 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.xls", data)

>>> from pyexcel_xls import get_data
>>> data = get_data("your_file.xls")
>>> import json
>>> print(json.dumps(data))
{"Sheet 1": [[1, 2, 3], [4, 5, 6]], "Sheet 2": [["row 1", "row 2", "row 3"]]}

>>> from pyexcel_xls 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 = StringIO()
>>> save_data(io, data)
>>> # do something with the io
>>> # In reality, you might give it to your http response
>>> # object for downloading

>>> # This is just an illustration
>>> # In reality, you might deal with xls file upload
>>> # where you will read from requests.FILES['YOUR_XLS_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]]}

>>> 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.xls", sheetx)

>>> partial_data = get_data("huge_file.xls", start_row=2, row_limit=3)
>>> print(json.dumps(partial_data))
{"huge": [[3, 23, 33], [4, 24, 34], [5, 25, 35]]}

>>> partial_data = get_data("huge_file.xls", start_column=1, column_limit=2)
>>> print(json.dumps(partial_data))
{"huge": [[21, 31], [22, 32], [23, 33], [24, 34], [25, 35], [26, 36]]}

>>> partial_data = get_data("huge_file.xls",
...     start_row=2, row_limit=3,
...     start_column=1, column_limit=2)
>>> print(json.dumps(partial_data))
{"huge": [[23, 33], [24, 34], [25, 35]]}

As a pyexcel plugin

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 xls format, installing it is enough.

>>> import pyexcel as pe
>>> sheet = pe.get_book(file_name="your_file.xls")
>>> sheet
Sheet 1:
+---+---+---+
| 1 | 2 | 3 |
+---+---+---+
| 4 | 5 | 6 |
+---+---+---+
Sheet 2:
+-------+-------+-------+
| row 1 | row 2 | row 3 |
+-------+-------+-------+

>>> sheet.save_as("another_file.xls")

>>> # This is just an illustration
>>> # In reality, you might deal with xls file upload
>>> # where you will read from requests.FILES['YOUR_XLS_FILE']
>>> xlsfile = "another_file.xls"
>>> with open(xlsfile, "rb") as f:
...     content = f.read()
...     r = pe.get_book(file_type="xls", file_content=content)
...     print(r)
...
Sheet 1:
+---+---+---+
| 1 | 2 | 3 |
+---+---+---+
| 4 | 5 | 6 |
+---+---+---+
Sheet 2:
+-------+-------+-------+
| row 1 | row 2 | row 3 |
+-------+-------+-------+

>>> data = [
...     [1, 2, 3],
...     [4, 5, 6]
... ]
>>> io = StringIO()
>>> sheet = pe.Sheet(data)
>>> io = sheet.save_to_memory("xls", io)
>>> # then do something with io
>>> # In reality, you might give it to your http response
>>> # object for downloading

How to test your contribution

Although 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

Before you commit

Please run:

$ make format

so as to beautify your code otherwise your build may fail your unit test.

0.7.1 - 07.03.2024

Removed

1. #52: remove xlsm support for xlrd > 2.0.0

Updated

1. #54: first project in pyexcel to migrate to pytest

0.7.0 - 07.10.2021

Removed

1. #46: remove the hard pin on xlrd version < 2.0

Added

1. #47: limit support to persist datetime.timedelta. see more details in doc

0.6.2 - 12.12.2020

Updated

1. lock down xlrd version less than version 2.0, because 2.0+ does not support xlsx read

0.6.1 - 21.10.2020

Updated

1. Restrict this library to get installed on python 3.6+, because pyexcel-io 0.6.0+ supports only python 3.6+.

0.6.0 - 8.10.2020

Updated

1. New style xlsx plugins, promoted by pyexcel-io v0.6.2.

0.5.9 - 29.08.2020

Added

1. #35, include tests

0.5.8 - 22.08.2018

Added

1. pyexcel#151, read cell error as #N/A.

0.5.7 - 15.03.2018

Added

1. pyexcel#54, Book.datemode attribute of that workbook should be passed always.

0.5.6 - 15.03.2018

Added

1. pyexcel#120, xlwt cannot save a book without any sheet. So, let’s raise an exception in this case in order to warn the developers.

0.5.5 - 8.11.2017

Added

1. #25, detect merged cell in .xls

0.5.4 - 2.11.2017

Added

1. #24, xlsx format cannot use skip_hidden_row_and_column. please use pyexcel-xlsx instead.

0.5.3 - 2.11.2017

Added

1. #21, skip hidden rows and columns under ‘skip_hidden_row_and_column’ flag.

0.5.2 - 23.10.2017

updated

1. pyexcel pyexcel#105, remove gease from setup_requires, introduced by 0.5.1.

2. remove python2.6 test support

3. update its dependecy on pyexcel-io to 0.5.3

0.5.1 - 20.10.2017

added

1. pyexcel#103, include LICENSE file in MANIFEST.in, meaning LICENSE file will appear in the released tar ball.

0.5.0 - 30.08.2017

Updated

1. #20, is handled in pyexcel-io

2. put dependency on pyexcel-io 0.5.0, which uses cStringIO instead of StringIO. Hence, there will be performance boost in handling files in memory.

0.4.1 - 25.08.2017

Updated

1. #20, handle unseekable stream given by http response.

0.4.0 - 19.06.2017

Updated

1. pyexcel-xlsx#15, close file handle

2. pyexcel-io plugin interface now updated to use lml.

0.3.3 - 30/05/2017

Updated

1. #18, pass on encoding_override and others to xlrd.

0.3.2 - 18.05.2017

Updated

1. #16, allow mmap to be passed as file content

0.3.1 - 16.01.2017

Updated

1. #14, Python 3.6 - cannot use LOCALE flag with a str pattern

2. fix its dependency on pyexcel-io 0.3.0

0.3.0 - 22.12.2016

Updated

1. #13, alert on empyty file content

2. Support pyexcel-io v0.3.0

0.2.3 - 20.09.2016

Updated

1. #10, To support generator as member of the incoming two dimensional data

0.2.2 - 31.08.2016

Added

1. support pagination. two pairs: start_row, row_limit and start_column, column_limit help you deal with large files.

0.2.1 - 13.07.2016

Added

1. #9, skip_hidden_sheets is added. By default, hidden sheets are skipped when reading all sheets. Reading sheet by name or by index are not affected.

0.2.0 - 01.06.2016

Added

1. By default, float will be converted to int where fits. auto_detect_int, a flag to switch off the autoatic conversion from float to int.

2. ‘library=pyexcel-xls’ was added so as to inform pyexcel to use it instead of other libraries, in the situation where there are more than one plugin for a file type, e.g. xlsm

Updated

1. support the auto-import feature of pyexcel-io 0.2.0

2. xlwt is now used for python 2 implementation while xlwt-future is used for python 3

0.1.0 - 17.01.2016

Added

1. Passing “streaming=True” to get_data, you will get the two dimensional array as a generator

2. Passing “data=your_generator” to save_data is acceptable too.