Package: pyexcel-xlsx
pyexcel-xlsxis a tiny wrapper library to read, manipulate and write data in xlsx and xlsm format usingread_onlymode reader,write_onlymode writer from openpyxl. You are likely to use it withpyexcel.Please note:auto_detect_intflag will not take effect because openpyxl detect integer in python 3 by default.skip_hidden_row_and_columnwill get a penalty whereread_onlymode cannot be used.Support the projectIf your company has embedded pyexcel and its components into a revenue generating
product, please support me on github,patreonorbounty sourceto 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 receiveearly access to pyexcel related contents.And your issues will get prioritized if you would like to become my patreon aspyexcel 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 constraintsFonts, colors and charts are not supported.InstallationYou can install pyexcel-xlsx via pip:$pipinstallpyexcel-xlsxor clone it and install it:$gitclonehttps://github.com/pyexcel/pyexcel-xlsx.git$cdpyexcel-xlsx$pythonsetup.pyinstallUsageAs a standalone libraryWrite to an xlsx fileHere’s the sample code to write a dictionary to an xlsx file:>>>frompyexcel_xlsximportsave_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 fileHere’s the sample code:>>>frompyexcel_xlsximportget_data>>>data=get_data("your_file.xlsx")>>>importjson>>>print(json.dumps(data)){"Sheet 1":[[1,2,3],[4,5,6]],"Sheet 2":[["row 1","row 2","row 3"]]}Write an xlsx to memoryHere’s the sample code to write a dictionary to an xlsx file:>>>frompyexcel_xlsximportsave_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 downloadingRead from an xlsx from memoryContinue 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 featureLet’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 pluginNo 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 fileHere is the sample code:>>>importpyexcelaspe>>>sheet=pe.get_book(file_name="your_file.xlsx")>>>sheetSheet1:+---+---+---+|1|2|3|+---+---+---+|4|5|6|+---+---+---+Sheet2:+-------+-------+-------+|row1|row2|row3|+-------+-------+-------+Writing to an xlsx fileHere is the sample code:>>>sheet.save_as("another_file.xlsx")Reading from a IO instanceYou 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">>>withopen(xlsxfile,"rb")asf:...content=f.read()...r=pe.get_book(file_type="xlsx",file_content=content)...print(r)...Sheet1:+---+---+---+|1|2|3|+---+---+---+|4|5|6|+---+---+---+Sheet2:+-------+-------+-------+|row1|row2|row3|+-------+-------+-------+Writing to a StringIO instanceYou 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 downloadingLicenseNew BSD LicenseDeveloper guideDevelopment steps for code changesgit clonehttps://github.com/pyexcel/pyexcel-xlsx.gitcd pyexcel-xlsxUpgrade your setup tools and pip. They are needed for development and testing only:pip install –upgrade setuptools pipThen install relevant development requirements:pip install -r rnd_requirements.txt # if such a file existspip install -r requirements.txtpip install -r tests/requirements.txtOnce you have finished your changes, please provide test case(s), relevant documentation
and update CHANGELOG.rst.NoteAs 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 contributionAlthoughnoseanddoctestare both used in code testing, it is adviable that unit tests are put in tests.doctestis 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:$ makeOn Windows systems, please issue this command:> test.batBefore you commitPlease run:$ make formatso as to beautify your code otherwise travis-ci may fail your unit test.Change log0.6.0 - 10.10.2020UpdatedNew style xlsx plugins, promoted by pyexcel-io v0.6.2.0.5.8 - 28.12.2019Updated#34: pin
openpyxl>=2.6.10.5.7 - 15.02.2019Addedpyexcel-io#66pin
openpyxl < 2.6.00.5.6 - 26.03.2018Added#24, remove deprecated
warning from merged_cell_ranges and get_sheet_by_name0.5.5 - 18.12.2017Added#22, to detect merged
cell in xlsx - fast tracked patreon request.0.5.4 - 2.11.2017UpdatedAlign the behavior of skip_hidden_row_and_column. Default it to True.0.5.3 - 2.11.2017Added#20, skip hidden rows
and columns under ‘skip_hidden_row_and_column’ flag.0.5.2 - 23.10.2017updatedpyexcelpyexcel#105,
remove gease from setup_requires, introduced by 0.5.1.remove python2.6 test supportupdate its dependecy on pyexcel-io to 0.5.30.5.1 - 20.10.2017addedpyexcel#103, include
LICENSE file in MANIFEST.in, meaning LICENSE file will appear in the released
tar ball.0.5.0 - 30.08.2017Updatedput 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-io0.4.2 - 25.08.2017Updated#18, handle unseekable
stream given by http response0.4.1 - 16.07.2017RemovedRemoved useless code0.4.0 - 19.06.2017Updated#14, close file handlepyexcel-io plugin interface now updated to uselml.0.3.0 - 22.12.2016UpdatedCode refactoring with pyexcel-io v 0.3.0#13, turn read_only
flag on openpyxl.0.2.3 - 05.11.2016Updated#12, remove
UserWarning: Using a coordinate with ws.cell is deprecated. Use
ws[coordinate]0.2.2 - 31.08.2016Addedsupport pagination. two pairs: start_row, row_limit and start_column,
column_limit help you deal with large files.0.2.1 - 12.07.2016Added#8,skip_hidden_sheetsis 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.2016Added‘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. xlsmUpdatedsupport the auto-import feature of pyexcel-io 0.2.00.1.0 - 17.01.2016AddedPassing “streaming=True” to get_data, you will get the two dimensional array
as a generatorPassing “data=your_generator” to save_data is acceptable too.Updatedcompatibility with pyexcel-io 0.1.0