A wrapper library to read, manipulate and write data in xlsx and xlsmformat
Project description
pyexcel-xlsx is a tiny wrapper library to read, manipulate and write data in xlsx and xlsm format using read_only mode reader, write_only mode writer from openpyxl. You are likely to use it with pyexcel.
Please note:
- auto_detect_int flag will not take effect because openpyxl detect integer in python 3 by default.
- skip_hidden_row_and_column will get a penalty where read_only mode cannot be used.
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-xlsx via pip:
$ pip install pyexcel-xlsx
or clone it and install it:
$ git clone https://github.com/pyexcel/pyexcel-xlsx.git
$ cd pyexcel-xlsx
$ python setup.py install
Usage
As a standalone library
Write to an xlsx file
Here’s the sample code to write a dictionary to an xlsx file:
>>> from pyexcel_xlsx 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.xlsx", data)
Read from an xlsx file
Here’s the sample code:
>>> from pyexcel_xlsx 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"]]}
Write an xlsx to memory
Here’s the sample code to write a dictionary to an xlsx file:
>>> from pyexcel_xlsx 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 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 | +-------+-------+-------+
Writing to an xlsx file
Here is the sample code:
>>> sheet.save_as("another_file.xlsx")
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 | +-------+-------+-------+
Writing to a StringIO instance
You need to pass a StringIO instance to Writer:
>>> data = [ ... [1, 2, 3], ... [4, 5, 6] ... ] >>> io = StringIO() >>> sheet = pe.Sheet(data) >>> io = sheet.save_to_memory("xlsx", io) >>> # then do something with io >>> # In reality, you might give it to your http response >>> # object for downloading
License
New BSD License
Developer guide
Development steps for code changes
- git clone https://github.com/pyexcel/pyexcel-xlsx.git
- cd pyexcel-xlsx
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.rst.
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.
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
- New style xlsx plugins, promoted by pyexcel-io v0.6.2.
0.5.6 - 26.03.2018
Added
- #24, remove deprecated warning from merged_cell_ranges and get_sheet_by_name
0.5.4 - 2.11.2017
Updated
- Align the behavior of skip_hidden_row_and_column. Default it to True.
0.5.2 - 23.10.2017
updated
- pyexcel pyexcel#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
0.5.1 - 20.10.2017
added
- 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
- 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.
Removed
- #18, is handled in pyexcel-io
0.4.1 - 16.07.2017
Removed
- Removed useless code
0.4.0 - 19.06.2017
Updated
0.3.0 - 22.12.2016
Updated
- Code refactoring with pyexcel-io v 0.3.0
- #13, turn read_only flag on openpyxl.
0.2.3 - 05.11.2016
Updated
- #12, remove UserWarning: Using a coordinate with ws.cell is deprecated. Use ws[coordinate]
0.2.2 - 31.08.2016
Added
- support pagination. two pairs: start_row, row_limit and start_column, column_limit help you deal with large files.
0.2.1 - 12.07.2016
Added
- #8, 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
- ‘library=pyexcel-xlsx’ was added 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
0.1.0 - 17.01.2016
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.
Updated
- compatibility with pyexcel-io 0.1.0
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size pyexcel_xlsx-0.6.0-py2.py3-none-any.whl (9.6 kB) | File type Wheel | Python version py2.py3 | Upload date | Hashes View |
Filename, size pyexcel-xlsx-0.6.0.tar.gz (78.8 kB) | File type Source | Python version None | Upload date | Hashes View |
Hashes for pyexcel_xlsx-0.6.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 16530f96a77c97ebcba7941517d2756ac52d3ce2903d81eecd7f300778d5242a |
|
MD5 | 201b265664a23a4b8fc16a211b2b230b |
|
BLAKE2-256 | 6e2580131799ac6ab63c01749bb0d34664ebfd8478e51fbdda0dcef6a3556162 |