Skip to main content

Read xlsx file using partial xml

Project description

https://raw.githubusercontent.com/pyexcel/pyexcel.github.io/master/images/patreon.png https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg https://travis-ci.org/pyexcel/pyexcel-xlsxr.svg?branch=master https://codecov.io/gh/pyexcel/pyexcel-xlsxr/branch/master/graph/badge.svg https://badge.fury.io/py/pyexcel-xlsxr.svg https://pepy.tech/badge/pyexcel-xlsxr/month https://img.shields.io/gitter/room/gitterHQ/gitter.svg 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 https://img.shields.io/static/v1?label=coding%20style&message=black&color=black&style=flat-square

pyexcel-xlsxr is a specialized xlsx reader using lxml. It does partial reading, meaning it wont load all content into memory.

lxml installation

This library depends on lxml. Because its availablity, the use of this library is restricted.

for PyPy, lxml == 3.4.4 are tested to work well. But lxml above 3.4.4 is difficult to get installed.

for Python 3.7, please use lxml==4.1.1.

Otherwise, this library works OK with lxml 3.4.4 or above.

Support the project

If your company has embedded pyexcel and its components into a revenue generating product, please support me on github, patreon or bounty source 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.

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.

Known constraints

Fonts, colors and charts are not supported.

Installation

You can install pyexcel-xlsxr via pip:

$ pip install pyexcel-xlsxr

or clone it and install it:

$ git clone https://github.com/pyexcel/pyexcel-xlsxr.git
$ cd pyexcel-xlsxr
$ python setup.py install

Usage

As a standalone library

Read from an xlsx file

Here’s the sample code:

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

Read from an xlsx from memory

Continue from previous example:

>>> # This is just an illustration
>>> # In reality, you might deal with xlsx file upload
>>> # where you will read from requests.FILES['YOUR_XLSX_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 xlsx 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.xlsx", sheetx)

And let’s pretend to read partial data:

>>> partial_data = get_data("huge_file.xlsx", 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.xlsx", 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.xlsx",
...     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 xlsx format, installing it is enough.

Reading from an xlsx file

Here is the sample code:

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

Reading from a IO instance

You got to wrap the binary content with stream to get xlsx working:

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

License

New BSD License

Developer guide

Development steps for code changes

  1. git clone https://github.com/pyexcel/pyexcel-xlsxr.git

  2. cd pyexcel-xlsxr

Upgrade your setup tools and pip. They are needed for development and testing only:

  1. pip install –upgrade setuptools pip

Then install relevant development requirements:

  1. pip install -r rnd_requirements.txt # if such a file exists

  2. pip install -r requirements.txt

  3. pip install -r tests/requirements.txt

Once you have finished your changes, please provide test case(s), relevant documentation and update CHANGELOG.rst.

How to test your contribution

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 systems, please issue this command:

> test.bat

Before you commit

Please run:

$ make format

so as to beautify your code otherwise travis-ci may fail your unit test.

Change log

0.6.0 - 10.10.2020

Updated

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

0.5.3 - 23.06.2020

Fixed

  1. #5: AttributeError when a cell text is None

  2. #2: unit test failed in OpenSuSE

0.5.2 - 15.09.2018

Updated

  1. Fix python 3 compactibility

0.5.1 - 14.07.2018

Updated

  1. #1: fix xml parsing problem when the microsoft spreadsheetml 2009 ac name space ‘x14ac’ made lxml an idiot

0.5.0 - 24.11.2017

Added

  1. Initial release. In order align it with pyexcel 0.5.0 release, its version start from 0.5.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyexcel-xlsxr-0.6.0.tar.gz (15.9 kB view hashes)

Uploaded Source

Built Distribution

pyexcel_xlsxr-0.6.0-py2.py3-none-any.whl (10.4 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page