A wrapper library that provides one API to read, manipulate and writedata in different excel formats
.. 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/workflows/run_tests/badge.svg :target: http://github.com/pyexcel/pyexcel/actions
.. image:: https://codecov.io/gh/pyexcel/pyexcel/branch/master/graph/badge.svg :target: https://codecov.io/gh/pyexcel/pyexcel
.. image:: https://badge.fury.io/py/pyexcel.svg :target: https://pypi.org/project/pyexcel
.. image:: https://anaconda.org/conda-forge/pyexcel/badges/version.svg :target: https://anaconda.org/conda-forge/pyexcel
.. image:: https://pepy.tech/badge/pyexcel/month :target: https://pepy.tech/project/pyexcel
.. image:: https://anaconda.org/conda-forge/pyexcel/badges/downloads.svg :target: https://anaconda.org/conda-forge/pyexcel
.. 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 .. image:: https://readthedocs.org/projects/pyexcel/badge/?version=latest :target: http://pyexcel.readthedocs.org/en/latest/
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.
.. table:: A list of supported file formats
============ =======================================================
file format definition
============ =======================================================
csv comma separated values
tsv tab separated values
csvz a zip file that contains one or many csv files
tsvz a zip file that contains one or many tsv files
xls a spreadsheet file format created by
MS-Excel 97-2003
xlsx MS-Excel Extensions to the Office Open XML
SpreadsheetML File Format.
xlsm an MS-Excel Macro-Enabled Workbook file
ods open document spreadsheet
fods flat open document spreadsheet
json java script object notation
html html table of the data structure
simple simple presentation
rst rStructured Text presentation of the data
mediawiki media wiki table
============ =======================================================
.. image:: https://github.com/pyexcel/pyexcel/raw/dev/docs/source/_static/images/architecture.svg
One application programming interface(API) to handle multiple data sources:
One API to read and write data in various excel file formats.
For large data sets, data streaming are supported. A genenerator can be returned to you. Checkout iget_records, iget_array, isave_as and isave_book_as.
You can install pyexcel via pip:
.. code-block:: bash
$ pip install pyexcel
or clone it and install it:
.. code-block:: bash
$ git clone https://github.com/pyexcel/pyexcel.git
$ cd pyexcel
$ python setup.py install
This section shows you how to get data from your excel files and how to export data to excel files in one line
Get a list of dictionaries
Suppose you want to process History of Classical Music <https://www.naxos.com/education/brief_history.asp>_:
History of Classical Music:
=============== ============= ==================================== Name Period Representative Composers Medieval c.1150-c.1400 Machaut, Landini Renaissance c.1400-c.1600 Gibbons, Frescobaldi Baroque c.1600-c.1750 JS Bach, Vivaldi Classical c.1750-c.1830 Joseph Haydn, Wolfgan Amadeus Mozart Earley Romantic c.1830-c.1860 Chopin, Mendelssohn, Schumann, Liszt Late Romantic c.1860-c.1920 Wagner,Verdi =============== ============= ====================================
Let's get a list of dictionary out from the xls file:
.. code-block:: python
records = p.get_records(file_name="your_file.xls")
And let's check what do we have:
.. code-block:: python
for row in records: ... print(f"{row['Representative Composers']} are from {row['Name']} period ({row['Period']})") Machaut, Landini are from Medieval period (c.1150-c.1400) Gibbons, Frescobaldi are from Renaissance period (c.1400-c.1600) JS Bach, Vivaldi are from Baroque period (c.1600-c.1750) Joseph Haydn, Wolfgan Amadeus Mozart are from Classical period (c.1750-c.1830) Chopin, Mendelssohn, Schumann, Liszt are from Earley Romantic period (c.1830-c.1860) Wagner,Verdi are from Late Romantic period (c.1860-c.1920)
Get two dimensional array
Instead, what if you have to use pyexcel.get_array to do the same:
.. code-block:: python
for row in p.get_array(file_name="your_file.xls", start_row=1): ... print(f"{row[2]} are from {row[0]} period ({row[1]})") Machaut, Landini are from Medieval period (c.1150-c.1400) Gibbons, Frescobaldi are from Renaissance period (c.1400-c.1600) JS Bach, Vivaldi are from Baroque period (c.1600-c.1750) Joseph Haydn, Wolfgan Amadeus Mozart are from Classical period (c.1750-c.1830) Chopin, Mendelssohn, Schumann, Liszt are from Earley Romantic period (c.1830-c.1860) Wagner,Verdi are from Late Romantic period (c.1860-c.1920)
where start_row skips the header row.
Get a dictionary
You can get a dictionary too:
Now let's get a dictionary out from the spreadsheet:
.. code-block:: python
my_dict = p.get_dict(file_name="your_file.xls", name_columns_by_row=0)
And check what do we have:
.. code-block:: python
from pyexcel._compact import OrderedDict isinstance(my_dict, OrderedDict) True for key, values in my_dict.items(): ... print(key + " : " + ','.join([str(item) for item in values])) Name : Medieval,Renaissance,Baroque,Classical,Earley Romantic,Late Romantic Period : c.1150-c.1400,c.1400-c.1600,c.1600-c.1750,c.1750-c.1830,c.1830-c.1860,c.1860-c.1920 Representative Composers : Machaut, Landini,Gibbons, Frescobaldi,JS Bach, Vivaldi,Joseph Haydn, Wolfgan Amadeus Mozart,Chopin, Mendelssohn, Schumann, Liszt,Wagner,Verdi
Please note that my_dict is an OrderedDict.
Get a dictionary of two dimensional array
Suppose you have a multiple sheet book as the following:
pyexcel:Sheet 1:
===================== = = 1 2 3 4 5 6 7 8 9 ===================== = =
pyexcel:Sheet 2:
===================== = = X Y Z 1 2 3 4 5 6 ===================== = =
pyexcel:Sheet 3:
===================== = = O P Q 3 2 1 4 3 2 ===================== = =
Here is the code to obtain those sheets as a single dictionary:
.. code-block:: python
book_dict = p.get_book_dict(file_name="book.xls")
And check:
.. code-block:: python
isinstance(book_dict, OrderedDict) True import json for key, item in book_dict.items(): ... print(json.dumps({key: item})) {"Sheet 1": [[1, 2, 3], [4, 5, 6], [7, 8, 9]]} {"Sheet 2": [["X", "Y", "Z"], [1, 2, 3], [4, 5, 6]]} {"Sheet 3": [["O", "P", "Q"], [3, 2, 1], [4, 3, 2]]}
Export an array
Suppose you have the following array:
.. code-block:: python
data = [[1, 2, 3], [4, 5, 6], [7, 8, 9]]
And here is the code to save it as an excel file :
.. code-block:: python
p.save_as(array=data, dest_file_name="example.xls")
Let's verify it:
.. code-block:: python
>>> p.get_sheet(file_name="example.xls")
pyexcel_sheet1:
+---+---+---+
| 1 | 2 | 3 |
+---+---+---+
| 4 | 5 | 6 |
+---+---+---+
| 7 | 8 | 9 |
+---+---+---+
And here is the code to save it as a csv file :
.. code-block:: python
p.save_as(array=data, ... dest_file_name="example.csv", ... dest_delimiter=':')
Let's verify it:
.. code-block:: python
with open("example.csv") as f: ... for line in f.readlines(): ... print(line.rstrip()) ... 1:2:3 4:5:6 7:8:9
Export a list of dictionaries
.. code-block:: python
>>> records = [
... {"year": 1903, "country": "Germany", "speed": "206.7km/h"},
... {"year": 1964, "country": "Japan", "speed": "210km/h"},
... {"year": 2008, "country": "China", "speed": "350km/h"}
... ]
>>> p.save_as(records=records, dest_file_name='high_speed_rail.xls')
Export a dictionary of single key value pair
.. code-block:: python
>>> henley_on_thames_facts = {
... "area": "5.58 square meters",
... "population": "11,619",
... "civial parish": "Henley-on-Thames",
... "latitude": "51.536",
... "longitude": "-0.898"
... }
>>> p.save_as(adict=henley_on_thames_facts, dest_file_name='henley.xlsx')
Export a dictionary of single dimensonal array
.. code-block:: python
>>> ccs_insights = {
... "year": ["2017", "2018", "2019", "2020", "2021"],
... "smart phones": [1.53, 1.64, 1.74, 1.82, 1.90],
... "feature phones": [0.46, 0.38, 0.30, 0.23, 0.17]
... }
>>> p.save_as(adict=ccs_insights, dest_file_name='ccs.csv')
Export a dictionary of two dimensional array as a book
Suppose you want to save the below dictionary to an excel file :
.. code-block:: python
a_dictionary_of_two_dimensional_arrays = { ... 'Sheet 1': ... [ ... [1.0, 2.0, 3.0], ... [4.0, 5.0, 6.0], ... [7.0, 8.0, 9.0] ... ], ... 'Sheet 2': ... [ ... ['X', 'Y', 'Z'], ... [1.0, 2.0, 3.0], ... [4.0, 5.0, 6.0] ... ], ... 'Sheet 3': ... [ ... ['O', 'P', 'Q'], ... [3.0, 2.0, 1.0], ... [4.0, 3.0, 2.0] ... ] ... }
Here is the code:
.. code-block:: python
p.save_book_as( ... bookdict=a_dictionary_of_two_dimensional_arrays, ... dest_file_name="book.xls" ... )
If you want to preserve the order of sheets in your dictionary, you have to pass on an ordered dictionary to the function itself. For example:
.. code-block:: python
data = OrderedDict() data.update({"Sheet 2": a_dictionary_of_two_dimensional_arrays['Sheet 2']}) data.update({"Sheet 1": a_dictionary_of_two_dimensional_arrays['Sheet 1']}) data.update({"Sheet 3": a_dictionary_of_two_dimensional_arrays['Sheet 3']}) p.save_book_as(bookdict=data, dest_file_name="book.xls")
Let's verify its order:
.. code-block:: python
book_dict = p.get_book_dict(file_name="book.xls") for key, item in book_dict.items(): ... print(json.dumps({key: item})) {"Sheet 2": [["X", "Y", "Z"], [1, 2, 3], [4, 5, 6]]} {"Sheet 1": [[1, 2, 3], [4, 5, 6], [7, 8, 9]]} {"Sheet 3": [["O", "P", "Q"], [3, 2, 1], [4, 3, 2]]}
Please notice that "Sheet 2" is the first item in the book_dict, meaning the order of sheets are preserved.
.. note::
Please note that pyexcel-cli can perform file transcoding at command line.
No need to open your editor, save the problem, then python run.
The following code does a simple file format transcoding from xls to csv:
.. code-block:: python
p.save_as(file_name="birth.xls", dest_file_name="birth.csv")
Again it is really simple. Let's verify what we have gotten:
.. code-block:: python
sheet = p.get_sheet(file_name="birth.csv") sheet birth.csv: +-------+--------+----------+ | name | weight | birth | +-------+--------+----------+ | Adam | 3.4 | 03/02/15 | +-------+--------+----------+ | Smith | 4.2 | 12/11/14 | +-------+--------+----------+
.. NOTE::
Please note that csv(comma separate value) file is pure text file. Formula, charts, images and formatting in xls file will disappear no matter which transcoding tool you use. Hence, pyexcel is a quick alternative for this transcoding job.
Let use previous example and save it as xlsx instead
.. code-block:: python
p.save_as(file_name="birth.xls", ... dest_file_name="birth.xlsx") # change the file extension
Again let's verify what we have gotten:
.. code-block:: python
sheet = p.get_sheet(file_name="birth.xlsx") sheet pyexcel_sheet1: +-------+--------+----------+ | name | weight | birth | +-------+--------+----------+ | Adam | 3.4 | 03/02/15 | +-------+--------+----------+ | Smith | 4.2 | 12/11/14 | +-------+--------+----------+
Merge all excel files in directory into a book where each file become a sheet
The following code will merge every excel files into one file, say "output.xls":
.. code-block:: python
from pyexcel.cookbook import merge_all_to_a_book
import glob
merge_all_to_a_book(glob.glob("your_csv_directory\*.csv"), "output.xls")
You can mix and match with other excel formats: xls, xlsm and ods. For example, if you are sure you have only xls, xlsm, xlsx, ods and csv files in your_excel_file_directory, you can do the following:
.. code-block:: python
from pyexcel.cookbook import merge_all_to_a_book
import glob
merge_all_to_a_book(glob.glob("your_excel_file_directory\*.*"), "output.xls")
Split a book into single sheet files
Suppose you have many sheets in a work book and you would like to separate each into a single sheet excel file. You can easily do this:
.. code-block:: python
from pyexcel.cookbook import split_a_book split_a_book("megabook.xls", "output.xls") import glob outputfiles = glob.glob("*_output.xls") for file in sorted(outputfiles): ... print(file) ... Sheet 1_output.xls Sheet 2_output.xls Sheet 3_output.xls
for the output file, you can specify any of the supported formats
Extract just one sheet from a book
Suppose you just want to extract one sheet from many sheets that exists in a work book and you would like to separate it into a single sheet excel file. You can easily do this:
.. code-block:: python
>>> from pyexcel.cookbook import extract_a_sheet_from_a_book
>>> extract_a_sheet_from_a_book("megabook.xls", "Sheet 1", "output.xls")
>>> if os.path.exists("Sheet 1_output.xls"):
... print("Sheet 1_output.xls exists")
...
Sheet 1_output.xls exists
for the output file, you can specify any of the supported formats
Most pyexcel users do not know, but other library users were requesting partial read <https://github.com/jazzband/tablib/issues/467>_
When you are dealing with huge amount of data, e.g. 64GB, obviously you would not like to fill up your memory with those data. What you may want to do is, record data from Nth line, take M records and stop. And you only want to use your memory for the M records, not for beginning part nor for the tail part.
Hence partial read feature is developed to read partial data into memory for processing.
You can paginate by row, by column and by both, hence you dictate what portion of the data to read back. But remember only row limit features help you save memory. Let's you use this feature to record data from Nth column, take M number of columns and skip the rest. You are not going to reduce your memory footprint.
This feature depends heavily on the implementation details.
pyexcel-xls_ (xlrd), pyexcel-xlsx_ (openpyxl), pyexcel-ods_ (odfpy) and
pyexcel-ods3_ (pyexcel-ezodf) will read all data into memory. Because xls,
xlsx and ods file are effective a zipped folder, all four will unzip the folder
and read the content in xml format in full, so as to make sense of all details.
Hence, during the partial data is been returned, the memory consumption won't differ from reading the whole data back. Only after the partial data is returned, the memory comsumption curve shall jump the cliff. So pagination code here only limits the data returned to your program.
With that said, pyexcel-xlsxr, pyexcel-odsr and pyexcel-htmlr_ DOES read
partial data into memory. Those three are implemented in such a way that they
consume the xml(html) when needed. When they have read designated portion of the
data, they stop, even if they are half way through.
In addition, pyexcel's csv readers can read partial data into memory too.
Let's assume the following file is a huge csv file:
.. code-block:: python
import datetime import pyexcel as pe data = [ ... [1, 21, 31], ... [2, 22, 32], ... [3, 23, 33], ... [4, 24, 34], ... [5, 25, 35], ... [6, 26, 36] ... ] pe.save_as(array=data, dest_file_name="your_file.csv")
And let's pretend to read partial data:
.. code-block:: python
pe.get_sheet(file_name="your_file.csv", start_row=2, row_limit=3) your_file.csv: +---+----+----+ | 3 | 23 | 33 | +---+----+----+ | 4 | 24 | 34 | +---+----+----+ | 5 | 25 | 35 | +---+----+----+
And you could as well do the same for columns:
.. code-block:: python
pe.get_sheet(file_name="your_file.csv", start_column=1, column_limit=2) your_file.csv: +----+----+ | 21 | 31 | +----+----+ | 22 | 32 | +----+----+ | 23 | 33 | +----+----+ | 24 | 34 | +----+----+ | 25 | 35 | +----+----+ | 26 | 36 | +----+----+
Obvious, you could do both at the same time:
.. code-block:: python
pe.get_sheet(file_name="your_file.csv", ... start_row=2, row_limit=3, ... start_column=1, column_limit=2) your_file.csv: +----+----+ | 23 | 33 | +----+----+ | 24 | 34 | +----+----+ | 25 | 35 | +----+----+
The pagination support is available across all pyexcel plugins.
.. note::
No column pagination support for query sets as data source.
If you are transcoding a big data set, conventional formatting method would not help unless a on-demand free RAM is available. However, there is a way to minimize the memory footprint of pyexcel while the formatting is performed.
Let's continue from previous example. Suppose we want to transcode "your_file.csv" to "your_file.xls" but increase each element by 1.
What we can do is to define a row renderer function as the following:
.. code-block:: python
def increment_by_one(row): ... for element in row: ... yield element + 1
Then pass it onto save_as function using row_renderer:
.. code-block:: python
pe.isave_as(file_name="your_file.csv", ... row_renderer=increment_by_one, ... dest_file_name="your_file.xlsx")
.. note::
If the data content is from a generator, isave_as has to be used.
We can verify if it was done correctly:
.. code-block:: python
pe.get_sheet(file_name="your_file.xlsx") your_file.csv: +---+----+----+ | 2 | 22 | 32 | +---+----+----+ | 3 | 23 | 33 | +---+----+----+ | 4 | 24 | 34 | +---+----+----+ | 5 | 25 | 35 | +---+----+----+ | 6 | 26 | 36 | +---+----+----+ | 7 | 27 | 37 | +---+----+----+
When you are dealing with BIG excel files, you will want pyexcel to use constant memory.
This section shows you how to get data from your BIG excel files and how to export data to excel files in two lines at most, without eating all your computer memory.
Get a list of dictionaries
Suppose you want to process the following coffee data again:
Top 5 coffeine drinks:
===================================== =============== ============= Coffees Serving Size Caffeine (mg) Starbucks Coffee Blonde Roast venti(20 oz) 475 Dunkin' Donuts Coffee with Turbo Shot large(20 oz.) 398 Starbucks Coffee Pike Place Roast grande(16 oz.) 310 Panera Coffee Light Roast regular(16 oz.) 300 ===================================== =============== =============
Let's get a list of dictionary out from the xls file:
.. code-block:: python
records = p.iget_records(file_name="your_file.xls")
And let's check what do we have:
.. code-block:: python
for r in records: ... print(f"{r['Serving Size']} of {r['Coffees']} has {r['Caffeine (mg)']} mg") venti(20 oz) of Starbucks Coffee Blonde Roast has 475 mg large(20 oz.) of Dunkin' Donuts Coffee with Turbo Shot has 398 mg grande(16 oz.) of Starbucks Coffee Pike Place Roast has 310 mg regular(16 oz.) of Panera Coffee Light Roast has 300 mg
Please do not forgot the second line to close the opened file handle:
.. code-block:: python
p.free_resources()
Get two dimensional array
Instead, what if you have to use pyexcel.get_array to do the same:
.. code-block:: python
for row in p.iget_array(file_name="your_file.xls", start_row=1): ... print(f"{row[1]} of {row[0]} has {row[2]} mg") venti(20 oz) of Starbucks Coffee Blonde Roast has 475 mg large(20 oz.) of Dunkin' Donuts Coffee with Turbo Shot has 398 mg grande(16 oz.) of Starbucks Coffee Pike Place Roast has 310 mg regular(16 oz.) of Panera Coffee Light Roast has 300 mg
Again, do not forgot the second line:
.. code-block:: python
p.free_resources()
where start_row skips the header row.
Export an array
Suppose you have the following array:
.. code-block:: python
data = [[1, 2, 3], [4, 5, 6], [7, 8, 9]]
And here is the code to save it as an excel file :
.. code-block:: python
p.isave_as(array=data, dest_file_name="example.xls")
But the following line is not required because the data source are not file sources:
.. code-block:: python
p.free_resources()
Let's verify it:
.. code-block:: python
>>> p.get_sheet(file_name="example.xls")
pyexcel_sheet1:
+---+---+---+
| 1 | 2 | 3 |
+---+---+---+
| 4 | 5 | 6 |
+---+---+---+
| 7 | 8 | 9 |
+---+---+---+
And here is the code to save it as a csv file :
.. code-block:: python
p.isave_as(array=data, ... dest_file_name="example.csv", ... dest_delimiter=':')
Let's verify it:
.. code-block:: python
with open("example.csv") as f: ... for line in f.readlines(): ... print(line.rstrip()) ... 1:2:3 4:5:6 7:8:9
Export a list of dictionaries
.. code-block:: python
>>> records = [
... {"year": 1903, "country": "Germany", "speed": "206.7km/h"},
... {"year": 1964, "country": "Japan", "speed": "210km/h"},
... {"year": 2008, "country": "China", "speed": "350km/h"}
... ]
>>> p.isave_as(records=records, dest_file_name='high_speed_rail.xls')
Export a dictionary of single key value pair
.. code-block:: python
>>> henley_on_thames_facts = {
... "area": "5.58 square meters",
... "population": "11,619",
... "civial parish": "Henley-on-Thames",
... "latitude": "51.536",
... "longitude": "-0.898"
... }
>>> p.isave_as(adict=henley_on_thames_facts, dest_file_name='henley.xlsx')
Export a dictionary of single dimensonal array
.. code-block:: python
>>> ccs_insights = {
... "year": ["2017", "2018", "2019", "2020", "2021"],
... "smart phones": [1.53, 1.64, 1.74, 1.82, 1.90],
... "feature phones": [0.46, 0.38, 0.30, 0.23, 0.17]
... }
>>> p.isave_as(adict=ccs_insights, dest_file_name='ccs.csv')
>>> p.free_resources()
Export a dictionary of two dimensional array as a book
Suppose you want to save the below dictionary to an excel file :
.. code-block:: python
a_dictionary_of_two_dimensional_arrays = { ... 'Sheet 1': ... [ ... [1.0, 2.0, 3.0], ... [4.0, 5.0, 6.0], ... [7.0, 8.0, 9.0] ... ], ... 'Sheet 2': ... [ ... ['X', 'Y', 'Z'], ... [1.0, 2.0, 3.0], ... [4.0, 5.0, 6.0] ... ], ... 'Sheet 3': ... [ ... ['O', 'P', 'Q'], ... [3.0, 2.0, 1.0], ... [4.0, 3.0, 2.0] ... ] ... }
Here is the code:
.. code-block:: python
p.isave_book_as( ... bookdict=a_dictionary_of_two_dimensional_arrays, ... dest_file_name="book.xls" ... )
If you want to preserve the order of sheets in your dictionary, you have to pass on an ordered dictionary to the function itself. For example:
.. code-block:: python
from pyexcel._compact import OrderedDict data = OrderedDict() data.update({"Sheet 2": a_dictionary_of_two_dimensional_arrays['Sheet 2']}) data.update({"Sheet 1": a_dictionary_of_two_dimensional_arrays['Sheet 1']}) data.update({"Sheet 3": a_dictionary_of_two_dimensional_arrays['Sheet 3']}) p.isave_book_as(bookdict=data, dest_file_name="book.xls") p.free_resources()
Let's verify its order:
.. code-block:: python
import json book_dict = p.get_book_dict(file_name="book.xls") for key, item in book_dict.items(): ... print(json.dumps({key: item})) {"Sheet 2": [["X", "Y", "Z"], [1, 2, 3], [4, 5, 6]]} {"Sheet 1": [[1, 2, 3], [4, 5, 6], [7, 8, 9]]} {"Sheet 3": [["O", "P", "Q"], [3, 2, 1], [4, 3, 2]]}
Please notice that "Sheet 2" is the first item in the book_dict, meaning the order of sheets are preserved.
.. note::
Please note that the following file transcoding could be with zero line. Please install pyexcel-cli and you will do the transcode in one command. No need to open your editor, save the problem, then python run.
The following code does a simple file format transcoding from xls to csv:
.. code-block:: python
import pyexcel p.save_as(file_name="birth.xls", dest_file_name="birth.csv")
Again it is really simple. Let's verify what we have gotten:
.. code-block:: python
sheet = p.get_sheet(file_name="birth.csv") sheet birth.csv: +-------+--------+----------+ | name | weight | birth | +-------+--------+----------+ | Adam | 3.4 | 03/02/15 | +-------+--------+----------+ | Smith | 4.2 | 12/11/14 | +-------+--------+----------+
.. note::
Please note that csv(comma separate value) file is pure text file. Formula, charts, images and formatting in xls file will disappear no matter which transcoding tool you use. Hence, pyexcel is a quick alternative for this transcoding job.
Let use previous example and save it as xlsx instead
.. code-block:: python
import pyexcel p.isave_as(file_name="birth.xls", ... dest_file_name="birth.xlsx") # change the file extension
Again let's verify what we have gotten:
.. code-block:: python
sheet = p.get_sheet(file_name="birth.xlsx") sheet pyexcel_sheet1: +-------+--------+----------+ | name | weight | birth | +-------+--------+----------+ | Adam | 3.4 | 03/02/15 | +-------+--------+----------+ | Smith | 4.2 | 12/11/14 | +-------+--------+----------+
.. _file-format-list: .. _a-map-of-plugins-and-file-formats:
.. table:: A list of file formats supported by external plugins
======================== ======================= =================
Package name Supported file formats Dependencies
======================== ======================= =================
pyexcel-io_ csv, csvz [#f1], tsv,
tsvz [#f2]
pyexcel-xls_ xls, xlsx(read only), xlrd,
xlsm(read only) xlwt
pyexcel-xlsx_ xlsx openpyxl_
pyexcel-ods3_ ods pyexcel-ezodf,
lxml
pyexcel-ods ods odfpy_
======================== ======================= =================
.. table:: Dedicated file reader and writers
======================== ======================= =================
Package name Supported file formats Dependencies
======================== ======================= =================
pyexcel-xlsxw_ xlsx(write only) XlsxWriter_
pyexcel-libxlsxw_ xlsx(write only) libxlsxwriter_
pyexcel-xlsxr_ xlsx(read only) lxml
pyexcel-xlsbr_ xlsb(read only) pyxlsb
pyexcel-odsr_ read only for ods, fods lxml
pyexcel-odsw_ write only for ods loxun
pyexcel-htmlr_ html(read only) lxml,html5lib
pyexcel-pdfr_ pdf(read only) camelot
======================== ======================= =================
Since 2020, all pyexcel-io plugins have dropped the support for python versions which are lower than 3.6. If you want to use any of those Python versions, please use pyexcel-io and its plugins versions that are lower than 0.6.0.
Except csv files, xls, xlsx and ods files are a zip of a folder containing a lot of xml files
The dedicated readers for excel files can stream read
In order to manage the list of plugins installed, you need to use pip to add or remove a plugin. When you use virtualenv, you can have different plugins per virtual environment. In the situation where you have multiple plugins that does the same thing in your environment, you need to tell pyexcel which plugin to use per function call. For example, pyexcel-ods and pyexcel-odsr, and you want to get_array to use pyexcel-odsr. You need to append get_array(..., library='pyexcel-odsr').
.. _pyexcel-io: https://github.com/pyexcel/pyexcel-io .. _pyexcel-xls: https://github.com/pyexcel/pyexcel-xls .. _pyexcel-xlsx: https://github.com/pyexcel/pyexcel-xlsx .. _pyexcel-ods: https://github.com/pyexcel/pyexcel-ods .. _pyexcel-ods3: https://github.com/pyexcel/pyexcel-ods3 .. _pyexcel-odsr: https://github.com/pyexcel/pyexcel-odsr .. _pyexcel-odsw: https://github.com/pyexcel/pyexcel-odsw .. _pyexcel-pdfr: https://github.com/pyexcel/pyexcel-pdfr
.. _pyexcel-xlsxw: https://github.com/pyexcel/pyexcel-xlsxw .. _pyexcel-libxlsxw: https://github.com/pyexcel/pyexcel-libxlsxw .. _pyexcel-xlsxr: https://github.com/pyexcel/pyexcel-xlsxr .. _pyexcel-xlsbr: https://github.com/pyexcel/pyexcel-xlsbr .. _pyexcel-htmlr: https://github.com/pyexcel/pyexcel-htmlr
.. _xlrd: https://github.com/python-excel/xlrd .. _xlwt: https://github.com/python-excel/xlwt .. _openpyxl: https://bitbucket.org/openpyxl/openpyxl .. _XlsxWriter: https://github.com/jmcnamara/XlsxWriter .. _pyexcel-ezodf: https://github.com/pyexcel/pyexcel-ezodf .. _odfpy: https://github.com/eea/odfpy .. _libxlsxwriter: http://libxlsxwriter.github.io/getting_started.html
.. table:: Other data renderers
======================== ======================= ================= ==================
Package name Supported file formats Dependencies Python versions
======================== ======================= ================= ==================
pyexcel-text_ write only:rst, tabulate_ 2.6, 2.7, 3.3, 3.4
mediawiki, html, 3.5, 3.6, pypy
latex, grid, pipe,
orgtbl, plain simple
read only: ndjson
r/w: json
pyexcel-handsontable_ handsontable in html handsontable_ same as above
pyexcel-pygal_ svg chart pygal_ 2.7, 3.3, 3.4, 3.5
3.6, pypy
pyexcel-sortable_ sortable table in html csvtotable_ same as above
pyexcel-gantt_ gantt chart in html frappe-gantt_ except pypy, same
as above
======================== ======================= ================= ==================
.. _pyexcel-text: https://github.com/pyexcel/pyexcel-text .. _tabulate: https://bitbucket.org/astanin/python-tabulate .. _pyexcel-handsontable: https://github.com/pyexcel/pyexcel-handsontable .. _handsontable: https://cdnjs.com/libraries/handsontable .. _pyexcel-pygal: https://github.com/pyexcel/pyexcel-chart .. _pygal: https://github.com/Kozea/pygal .. _pyexcel-matplotlib: https://github.com/pyexcel/pyexcel-matplotlib .. _matplotlib: https://matplotlib.org .. _pyexcel-sortable: https://github.com/pyexcel/pyexcel-sortable .. _csvtotable: https://github.com/vividvilla/csvtotable .. _pyexcel-gantt: https://github.com/pyexcel/pyexcel-gantt .. _frappe-gantt: https://github.com/frappe/gantt
.. rubric:: Footnotes
.. [#f1] zipped csv file .. [#f2] zipped tsv file
All great work have been done by odf, ezodf, xlrd, xlwt, tabulate and other individual developers. This library unites only the data access code.
New BSD License
In alphabetical order:
Akshaya Kumar Sharma <https://github.com/akshayakrsh>_Andre Almar <https://github.com/andrealmar>_Arunkumar Rajendran <https://github.com/arunkumar-ra>_Ayan Banerjee <https://github.com/ayan-b>_Chris Hill-Scott <https://github.com/quis>_Craig Anderson <https://github.com/craiga>_Daryl Yu <https://github.com/darylyu>_J Harley <https://github.com/julzhk>_Joel Nothman <https://github.com/jnothman>_John Vandenberg <https://github.com/jayvdb>_Linghui Zeng <https://github.com/mathsyouth>_Nik Nyby <https://github.com/nikolas>_Rintze M. Zelle, PhD <https://github.com/rmzelle>_Simeon Visser <https://github.com/svisser>_Simon Allen <https://github.com/garfunkel>_simon klemenc <https://github.com/hiaselhans>_Tim Gates <https://github.com/timgates42>_Wesley A. Cheng <https://github.com/wesleyacheng>_William Jamir Silva <https://github.com/williamjamir>_Fixed
#. #250 <https://github.com/pyexcel/pyexcel/issues/250>_: RecursionError
raised on deepcopy of a sheet
Updated
#. #255 <https://github.com/pyexcel/pyexcel/issues/255>_: pyexcel.get_array
documentation page seems to be a copy of pyexcel.get_sheet
Removed
#. #249 <https://github.com/pyexcel/pyexcel/issues/249>_: drop the support for
dummy import statements pyexcel.ext.*
Updated
#. #243 <https://github.com/pyexcel/pyexcel/issues/243>_: fix small typo.
#. add chardet as explicit dependency
Updated
#. #233 <https://github.com/pyexcel/pyexcel/issues/233>_: dynamically resize
the table matrix on set_value. sheet['AA1'] = 'test' will work in this
release.
Updated
#. update queryset source to work with pyexcel-io 0.6.0
Updated
#. #219 <https://github.com/pyexcel/pyexcel/issues/219>_: book created from
dict no longer discards order.
fixed
#. #214 <https://github.com/pyexcel/pyexcel/issues/214>_: remove leading and
trailing whitespace for column names
removed
#. python 2 compatibility have been permanently removed.
fixed
#. #109 <https://github.com/pyexcel/pyexcel/issues/109>_: Control the column
order when write the data output
fixed
#. #203 <https://github.com/pyexcel/pyexcel/issues/203>_: texttable was
dropped out in 0.6.0 as compulsary dependency. end user may experience it
when a sheet/table is printed in a shell. otherwise, new user of pyexcel
won't see it. As of release date, no issues were created
updated
#. #199 <https://github.com/pyexcel/pyexcel/issues/199>: += in place; = +
shall return new instance
#. #195 <https://github.com/pyexcel/pyexcel/issues/195>: documentation
update. however small is welcome
removed
#. Dropping the test support for python version lower than 3.6. v0.6.0 should work with python 2.7 but is not guaranteed to work. Please upgrade to python 3.6+.
updated
#. #185 <https://github.com/pyexcel/pyexcel/issues/185>_: fix a bug with http
data source. The real fix lies in pyexcel-io v0.5.19. this release just put
the version requirement in.
updated
#. #182 <https://github.com/pyexcel/pyexcel/issues/182>_: support
dest_force_file_type on save_as and save_book_as
updated
#. #176 <https://github.com/pyexcel/pyexcel/issues/176>_: get_sheet
{IndexError}list index out of range // XLSX can't be opened
updated
#. #174 <https://github.com/pyexcel/pyexcel/issues/174>_: include examples in
tarbar
updated
#. #169 <https://github.com/pyexcel/pyexcel/issues/169>_: remove
pyexcel-handsontalbe in test
#. add tests, and docs folder in distribution
updated
#. #157 <https://github.com/pyexcel/pyexcel/issues/157>_: Please use
scan_plugins_regex, which lml 0.7 complains about
#. updated dependency on pyexcel-io to 0.5.11
updated
#. to require pyexcel-io 0.5.9.1 and use lml at least version 0.0.2
added
#. support len. len(book) returns the number of sheets and len(sheet)
returns the number of rows
#. #144 <https://github.com/pyexcel/pyexcel/issues/144>: memory-efficient way
to read sheet names.
#. #148 <https://github.com/pyexcel/pyexcel/issues/148>: force_file_type is
introduced. When reading a file on a disk, this parameter allows you to
choose a reader. i.e. csv reader for a text file. xlsx reader for a xlsx file
but with .blob file suffix.
#. finally, pyexcel got import pyexcel.version
updated
#. Sheet.to_records() returns a generator now, saving memory
#. #115 <https://github.com/pyexcel/pyexcel/issues/115>, Fix set membership
test to run faster in python2
#. #140 <https://github.com/pyexcel/pyexcel/issues/140>, Direct writes to
cells yield weird results
added
#. #125 <https://github.com/pyexcel/pyexcel/issues/125>_, sort book sheets
updated
#. #126 <https://github.com/pyexcel/pyexcel/issues/126>, dest_sheet_name in
save_as will set the sheet name in the output
#. #115 <https://github.com/pyexcel/pyexcel/issues/115>, Fix set membership
test to run faster in python2
added
#. pyexcel-io#46 <https://github.com/pyexcel/pyexcel-io/issues/46>_, expose
bulk_save to developer.
removed
#. #105 <https://github.com/pyexcel/pyexcel/issues/105>, remove gease from
setup_requires, introduced by 0.5.5.
#. removed testing against python 2.6
#. #103 <https://github.com/pyexcel/pyexcel/issues/103>, include LICENSE file
in MANIFEST.in, meaning LICENSE file will appear in the released tar ball.
removed
#. #105 <https://github.com/pyexcel/pyexcel/issues/105>, remove gease from
setup_requires, introduced by 0.5.5.
#. removed testing against python 2.6
#. #103 <https://github.com/pyexcel/pyexcel/issues/103>, include LICENSE file
in MANIFEST.in, meaning LICENSE file will appear in the released tar ball.
fixed
#. #100 <https://github.com/pyexcel/pyexcel/issues/100>_, Sheet.to_dict() gets
out of range error because there is only one row.
updated
#. Updated the baseline of pyexcel-io to 0.5.1.
added
#. #95 <https://github.com/pyexcel/pyexcel/issues/95>, respect the order of
records in iget_records, isave_as and save_as.
#. #97 <https://github.com/pyexcel/pyexcel/issues/97>, new feature to allow
intuitive initialization of pyexcel.Book.
Updated
#. embeded the enabler for pyexcel-htmlr. http source does not support text/html as mime type.
Updated
#. support saving SheetStream and BookStream to database targets. This is needed for pyexcel-webio and its downstream projects.
Added
#. Sheet.top() and Sheet.top_left() for data browsing
#. add html as default rich display in Jupyter notebook when pyexcel-text and
pyexcel-chart is installed
#. add svg as default rich display in Jupyter notebook when pyexcel-chart and
one of its implementation plugin(pyexcel-pygal, etc.) are is installed
#. new dictionary source supported: a dictionary of key value pair could be read
into a sheet.
#. added dynamic external plugin loading. meaning if a pyexcel plugin is
installed, it will be loaded implicitly. And this change would remove
unnecessary info log for those who do not use pyexcel-text and pyexcel-gal
#. save_book_as before 0.5.0 becomes isave_book_as and save_book_as in 0.5.0
convert BookStream to Book before saving.
#. #83 <https://github.com/pyexcel/pyexcel/issues/83>_, file closing mechanism
is enfored. free_resource is added and it should be called when iget_array,
iget_records, isave_as and/or isave_book_as are used.
Updated
#. array is passed to pyexcel.Sheet as reference. it means your array data will be modified.
Removed
#. pyexcel.Writer and pyexcel.BookWriter were removed #. pyexcel.load_book_from_sql and pyexcel.load_from_sql were removed #. pyexcel.deprecated.load_from_query_sets, pyexcel.deprecated.load_book_from_django_models and pyexcel.deprecated.load_from_django_model were removed #. Removed plugin loading code and lml is used instead
Updated
#. #80 <https://github.com/pyexcel/pyexcel/issues/80>_: remove pyexcel-chart
import from v0.4.x
Updated
#. #68 <https://github.com/pyexcel/pyexcel/issues/68>: regression
save_to_memory() should have returned a stream instance which has been reset
to zero if possible. The exception is sys.stdout, which cannot be reset.
#. #74 <https://github.com/pyexcel/pyexcel/issues/74>: Not able to handle
decimal.Decimal
Removed
#. remove get_{{file_type}}_stream functions from pyexcel.Sheet and pyexcel.Book introduced since 0.4.3.
Added
#. '.stream' attribute are attached to ~pyexcel.Sheet and ~pyexcel.Book to
get direct access the underneath stream in responding to file type
attributes, such as sheet.xls. it helps provide a custom stream to external
world, for example, Sheet.stream.csv gives a text stream that contains csv
formatted data. Book.stream.xls returns a xls format data in a byte stream.
Updated
#. Better error reporting when an unknown parameters or unsupported file types were given to the signature functions.
Updated
#. Raise exception if the incoming sheet does not have column names. In other
words, only sheet with column names could be saved to database. sheet with
row names cannot be saved. The alternative is to transpose the sheet, then
name_columns_by_row and then save.
#. fix iget_records where a non-uniform content should be given, e.g. [["x",
"y"], [1, 2], [3]], some record would become non-uniform, e.g. key 'y' would
be missing from the second record.
#. skip_empty_rows is applicable when saving a python data structure to
another data source. For example, if your array contains a row which is
consisted of empty string, such as ['', '', '' ... ''], please specify
skip_empty_rows=False in order to preserve it. This becomes subtle when you
try save a python dictionary where empty rows is not easy to be spotted.
#. #69 <https://github.com/pyexcel/pyexcel/issues/69>_: better documentation
for save_book_as.
Updated
#. #68 <https://github.com/pyexcel/pyexcel/issues/68>_: regression
save_to_memory() should have returned a stream instance.
Added
#. Flask-Excel#19 <https://github.com/pyexcel/Flask-Excel/issues/19>_ allow
sheet_name parameter
#. pyexcel-xls#11 <https://github.com/pyexcel/pyexcel-xls/issues/11>_
case-insensitive for file_type. xls and XLS are treated in the same way
Updated
#. #66 <https://github.com/pyexcel/pyexcel/issues/66>_: export_columns is
ignored
#. Update dependency on pyexcel-io v0.3.0
Updated
#. #63 <https://github.com/pyexcel/pyexcel/issues/63>_: cannot display empty
sheet(hence book with empty sheet) as texttable
Updated
#. #62 <https://github.com/pyexcel/pyexcel/issues/62>_: optional module import
error become visible.
Added:
#. file type setters for Sheet and Book, and its documentation
#. iget_records returns a generator for a list of records and should have
better memory performance, especially dealing with large csv files.
#. iget_array returns a generator for a list of two dimensional array and
should have better memory performance, especially dealing with large csv
files.
#. Enable pagination support, and custom row renderer via pyexcel-io v0.2.3
Updated
#. Take isave_as out from save_as. Hence two functions are there for save a
sheet as
#. #60 <https://github.com/pyexcel/pyexcel/issues/60>: encode 'utf-8' if the
console is of ascii encoding.
#. #59 <https://github.com/pyexcel/pyexcel/issues/59>: custom row renderer
#. #56 <https://github.com/pyexcel/pyexcel/issues/56>_: set cell value does
not work
#. pyexcel.transpose becomes pyexcel.sheets.transpose
#. iterator functions of pyexcel.Sheet were converted to generator functions
pyexcel.Sheet.enumerate()pyexcel.Sheet.reverse()pyexcel.Sheet.vertical()pyexcel.Sheet.rvertical()pyexcel.Sheet.rows()pyexcel.Sheet.rrows()pyexcel.Sheet.columns()pyexcel.Sheet.rcolumns()pyexcel.Sheet.named_rows()pyexcel.Sheet.named_columns()#. ~pyexcel.Sheet.save_to_memory and ~pyexcel.Book.save_to_memory return the
actual content. No longer they will return a io object hence you cannot call
getvalue() on them.
Removed:
#. content and out_file as function parameters to the signature functions
are no longer supported.
#. SourceFactory and RendererFactory are removed
#. The following methods are removed
pyexcel.to_arraypyexcel.to_dictpyexcel.utils.to_one_dimensional_arraypyexcel.dict_to_arraypyexcel.from_recordspyexcel.to_records#. pyexcel.Sheet.filter has been re-implemented and all filters were removed:
pyexcel.filters.ColumnIndexFilterpyexcel.filters.ColumnFilterpyexcel.filters.RowFilterpyexcel.filters.EvenColumnFilterpyexcel.filters.OddColumnFilterpyexcel.filters.EvenRowFilterpyexcel.filters.OddRowFilterpyexcel.filters.RowIndexFilterpyexcel.filters.SingleColumnFilterpyexcel.filters.RowValueFilterpyexcel.filters.NamedRowValueFilterpyexcel.filters.ColumnValueFilterpyexcel.filters.NamedColumnValueFilterpyexcel.filters.SingleRowFilter#. the following functions have been removed
add_formatterremove_formatterclear_formattersfreeze_formattersadd_filterremove_filterclear_filtersfreeze_formatters#. pyexcel.Sheet.filter has been re-implemented and all filters were removed:
Updated:
#. #58 <https://github.com/pyexcel/pyexcel/issues/58>_: texttable should have
been made as compulsory requirement
Updated:
#. For python 2, writing to sys.stdout by pyexcel-cli raise IOError.
Updated:
#. For python 3, do not seek 0 when saving to memory if sys.stdout is passed on. Hence, adding support for sys.stdin and sys.stdout.
Updated:
#. Explicit imports, no longer needed #. Depends on latest setuptools 18.0.1 #. NotImplementedError will be raised if parameters to core functions are not supported, e.g. get_sheet(cannot_find_me_option="will be thrown out as NotImplementedError")
Added:
#. add pyexcel-text file types as attributes of pyexcel.Sheet and pyexcel.Book,
related to #31 <https://github.com/pyexcel/pyexcel/issues/31>__
#. auto import pyexcel-text if it is pip installed
Updated:
#. code refactoring done for easy addition of sources.
#. bug fix #29 <https://github.com/pyexcel/pyexcel/issues/29>, Even if the
format is a string it is displayed as a float
#. pyexcel-text is no longer a plugin to pyexcel-io but to pyexcel.sources, see
pyexcel-text#22 <https://github.com/pyexcel/pyexcel-text/issues/22>
Removed:
#. pyexcel.presentation is removed. No longer the internal decorate @outsource
is used. related to #31 <https://github.com/pyexcel/pyexcel/issues/31>_
Updated
#. adopt pyexcel-io yield key word to return generator as content #. pyexcel.save_as and pyexcel.save_book_as get performance improvements
Added
#. Support pyramid-excel which does the database commit on its own.
Added
#. get excel data from a http url
Added
#. Support django #. texttable as default renderer
Added
#. Added sqlalchemy support
Added
#. added csvz and tsvz format
Updated
#. Support python 3
Features:
#. read and write csv, ods, xls, xlsx and xlsm files(which are referred later as excel files) #. various iterators for the reader #. row and column filters for the reader #. utilities to get array and dictionary out from excel files. #. cookbok receipes for some common and simple usage of this library.