A wrapper library to read, manipulate and write data in xls format. Itreads xlsx and xlsm format
.. image:: https://raw.githubusercontent.com/pyexcel/pyexcel.github.io/master/images/patreon.png :target: https://www.patreon.com/chfw
.. image:: https://raw.githubusercontent.com/pyexcel/pyexcel-mobans/master/images/awesome-badge.svg :target: https://awesome-python.com/#specific-formats-processing
.. image:: https://github.com/pyexcel/pyexcel-xls/workflows/run_tests/badge.svg :target: http://github.com/pyexcel/pyexcel-xls/actions
.. image:: https://codecov.io/gh/pyexcel/pyexcel-xls/branch/master/graph/badge.svg :target: https://codecov.io/gh/pyexcel/pyexcel-xls
.. image:: https://badge.fury.io/py/pyexcel-xls.svg :target: https://pypi.org/project/pyexcel-xls
.. image:: https://anaconda.org/conda-forge/pyexcel-xls/badges/version.svg :target: https://anaconda.org/conda-forge/pyexcel-xls
.. image:: https://pepy.tech/badge/pyexcel-xls/month :target: https://pepy.tech/project/pyexcel-xls
.. image:: https://anaconda.org/conda-forge/pyexcel-xls/badges/downloads.svg :target: https://anaconda.org/conda-forge/pyexcel-xls
.. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg :target: https://gitter.im/pyexcel/Lobby
.. image:: https://img.shields.io/static/v1?label=continuous%20templating&message=%E6%A8%A1%E7%89%88%E6%9B%B4%E6%96%B0&color=blue&style=flat-square :target: https://moban.readthedocs.io/en/latest/#at-scale-continous-templating-for-open-source-projects
.. image:: https://img.shields.io/static/v1?label=coding%20style&message=black&color=black&style=flat-square :target: https://github.com/psf/black
pyexcel-xls is a tiny wrapper library to read, manipulate and
write data in xls format and it can read xlsx and xlsm fromat.
You are likely to use it with pyexcel <https://github.com/pyexcel/pyexcel>_.
v0.6.3 removed the pin on xlrd < 2. If you have xlrd >= 2, this library will NOT read 'xlsx' format and you need to install pyexcel-xlsx. Othwise, this library can use xlrd < 2 to read xlsx format for you. So 'xlsx' support in this library will vary depending on the installed version of xlrd.
v0.6.3 can write datetime.timedelta. but when the value is read out, you will get datetime.datetime. so you as the developer decides what to do with it.
detect_merged_cells allows you to spread the same value among
all merged cells. But be aware that this may slow down its reading
performance.
skip_hidden_row_and_column allows you to skip hidden rows
and columns and is defaulted to True. It may slow down its reading
performance. And it is only valid for 'xls' files. For 'xlsx' files,
please use pyexcel-xlsx.
xls file cannot contain more than 65,000 rows. You are risking the reputation
of yourself/your company/
your country <https://www.bbc.co.uk/news/technology-54423988>_ if you keep
using xls and are not aware of its row limit.
If your company has embedded pyexcel and its components into a revenue generating
product, please support me on github, patreon <https://www.patreon.com/bePatron?u=5537627>_
or bounty source <https://salt.bountysource.com/teams/chfw-pyexcel>_ to maintain
the project and develop it further.
If you are an individual, you are welcome to support me too and for however long
you feel like. As my backer, you will receive
early access to pyexcel related contents <https://www.patreon.com/pyexcel/posts>_.
And your issues will get prioritized if you would like to become my patreon as pyexcel pro user.
With your financial support, I will be able to invest a little bit more time in coding, documentation and writing interesting posts.
Fonts, colors and charts are not supported.
Nor to read password protected xls, xlsx and ods files.
You can install pyexcel-xls via pip:
.. code-block:: bash
$ pip install pyexcel-xls
or clone it and install it:
.. code-block:: bash
$ git clone https://github.com/pyexcel/pyexcel-xls.git
$ cd pyexcel-xls
$ python setup.py install
Write to an xls file
Here's the sample code to write a dictionary to an xls file:
.. code-block:: python
>>> 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)
Read from an xls file
Here's the sample code:
.. code-block:: python
>>> 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"]]}
Write an xls to memory
Here's the sample code to write a dictionary to an xls file:
.. code-block:: python
>>> 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
Read from an xls from memory
Continue from previous example:
.. code-block:: python
>>> # 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]]}
Pagination feature
Let's assume the following file is a huge xls file:
.. code-block:: python
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)
And let's pretend to read partial data:
.. code-block:: python
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]]}
And you could as well do the same for columns:
.. code-block:: python
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]]}
Obvious, you could do both at the same time:
.. code-block:: python
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]]}
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.
Reading from an xls file
Here is the sample code:
.. code-block:: python
>>> 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 |
+-------+-------+-------+
Writing to an xls file
Here is the sample code:
.. code-block:: python
>>> sheet.save_as("another_file.xls")
Reading from a IO instance
You got to wrap the binary content with stream to get xls working:
.. code-block:: python
>>> # 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 |
+-------+-------+-------+
Writing to a StringIO instance
You need to pass a StringIO instance to Writer:
.. code-block:: python
>>> 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
New BSD License
Development steps for code changes
#. git clone https://github.com/pyexcel/pyexcel-xls.git #. cd pyexcel-xls
Upgrade your setup tools and pip. They are needed for development and testing only:
#. pip install --upgrade setuptools pip
Then install relevant development requirements:
#. pip install -r rnd_requirements.txt # if such a file exists #. pip install -r requirements.txt #. pip install -r tests/requirements.txt
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 dependecy is installed
(will be released), the future
version of the dependency in the requirements.txt will be valid.
Although nose and doctest are both used in code testing, it is adviable 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.
In alphabetical order:
John Vandenberg <https://github.com/jayvdb>_Peter Carnesciali <https://github.com/pcarn>_vinraspa <https://github.com/vinraspa>_Removed
#. #46 <https://github.com/pyexcel/pyexcel-xls/issues/46>_: remove the hard
pin on xlrd version < 2.0
Added
#. #47 <https://github.com/pyexcel/pyexcel-xls/issues/47>_: limit support to
persist datetime.timedelta. see more details in doc
Updated
#. lock down xlrd version less than version 2.0, because 2.0+ does not support xlsx read
Updated
#. Restrict this library to get installed on python 3.6+, because pyexcel-io 0.6.0+ supports only python 3.6+.
Updated
#. New style xlsx plugins, promoted by pyexcel-io v0.6.2.
Added
#. #35 <https://github.com/pyexcel/pyexcel-xls/issues/35>_, include tests
Added
#. pyexcel#151 <https://github.com/pyexcel/pyexcel/issues/151>_, read cell
error as #N/A.
Added
#. pyexcel#54 <https://github.com/pyexcel/pyexcel/issues/54>_, Book.datemode
attribute of that workbook should be passed always.
Added
#. pyexcel#120 <https://github.com/pyexcel/pyexcel/issues/120>_, xlwt cannot
save a book without any sheet. So, let's raise an exception in this case in
order to warn the developers.
Added
#. #25 <https://github.com/pyexcel/pyexcel-xls/issues/25>_, detect merged cell
in .xls
Added
#. #24 <https://github.com/pyexcel/pyexcel-xls/issues/24>_, xlsx format cannot
use skip_hidden_row_and_column. please use pyexcel-xlsx instead.
Added
#. #21 <https://github.com/pyexcel/pyexcel-xls/issues/21>_, skip hidden rows
and columns under 'skip_hidden_row_and_column' flag.
updated
#. pyexcel pyexcel#105 <https://github.com/pyexcel/pyexcel/issues/105>_,
remove gease from setup_requires, introduced by 0.5.1.
#. remove python2.6 test support
#. update its dependecy on pyexcel-io to 0.5.3
added
#. pyexcel#103 <https://github.com/pyexcel/pyexcel/issues/103>_, include
LICENSE file in MANIFEST.in, meaning LICENSE file will appear in the released
tar ball.
Updated
#. #20 <https://github.com/pyexcel/pyexcel-xls/issues/20>_, is handled in
pyexcel-io
#. 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.
Updated
#. #20 <https://github.com/pyexcel/pyexcel-xls/issues/20>_, handle unseekable
stream given by http response.
Updated
#. pyexcel-xlsx#15 <https://github.com/pyexcel/pyexcel-xlsx/issues/15>, close
file handle
#. pyexcel-io plugin interface now updated to use lml <https://github.com/chfw/lml>.
Updated
#. #18 <https://github.com/pyexcel/pyexcel-xls/issues/18>_, pass on
encoding_override and others to xlrd.
Updated
#. #16 <https://github.com/pyexcel/pyexcel-xls/issues/16>_, allow mmap to be
passed as file content
Updated
#. #14 <https://github.com/pyexcel/pyexcel-xls/issues/14>_, Python 3.6 -
cannot use LOCALE flag with a str pattern
#. fix its dependency on pyexcel-io 0.3.0
Updated
#. #13 <https://github.com/pyexcel/pyexcel-xls/issues/13>_, alert on empyty
file content
#. Support pyexcel-io v0.3.0
Updated
#. #10 <https://github.com/pyexcel/pyexcel-xls/issues/10>_, To support
generator as member of the incoming two dimensional data
Added
#. support pagination. two pairs: start_row, row_limit and start_column, column_limit help you deal with large files.
Added
#. #9 <https://github.com/pyexcel/pyexcel-xls/issues/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.
Added
#. 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.
#. '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
#. support the auto-import feature of pyexcel-io 0.2.0 #. xlwt is now used for python 2 implementation while xlwt-future is used for python 3
Added
#. Passing "streaming=True" to get_data, you will get the two dimensional array as a generator #. Passing "data=your_generator" to save_data is acceptable too.