v0.20.7 (Sep 3, 2020)¶ [Bug Fix] Windows: Fix a regression introduced with 0.20.0 that would cause an AttributeError: Range.CLSID with async and legacy dynamic array UDFs (GH1404).

with async and legacy dynamic array UDFs (GH1404). [Enhancement]: Matplotlib figures are now converted to 300 dpi pictures for better quality when using them with pictures.add (GH1402).

v0.20.6 (Sep 1, 2020)¶ [Bug Fix] macOS: App(visible=False) has been fixed (GH652).

has been fixed (GH652). [Bug Fix] macOS: The regression with Book.fullname that was introduce with 0.20.1 has been fixed (GH1390).

that was introduce with 0.20.1 has been fixed (GH1390). [Bug Fix] Windows: The retry mechanism has been improved (GH1398).

v0.20.5 (Aug 27, 2020)¶ [Bug Fix] The conda version check was failing with spaces in the installation path (GH1396).

[Bug Fix] Windows: when running app.quit() , the application is now properly closed without leaving a zombie process behind (GH1396).

v0.20.4 (Aug 20, 2020)¶ [Enhancement] The add-in can now optionally be installed without the password protection: xlwings addin install --unprotected (GH1392).

v0.20.3 (Aug 15, 2020)¶ [Bug Fix] The conda version check was erroneously triggered when importing UDFs on systems without conda. (GH1389).

v0.20.2 (Aug 13, 2020)¶ PRO [Feature]: Code can now be embedded by calling the new xlwings code embed [--file] CLI command (GH1380).

[Feature]: Code can now be embedded by calling the new CLI command (GH1380). [Bug Fix] Made the import UDFs functionality more robust to prevent an Automation 440 error that some users would see (GH1381).

[Enhancement] The standalone Excel file now includes all VBA dependencies to make it work on Windows and macOS (GH1349).

[Enhancement] xlwings now blocks the call if the Conda Path/Env settings are used with legacy Conda installations (GH1384).

v0.20.1 (Aug 7, 2020)¶ [Bug Fix] macOS: password-protected sheets caused an alert when calling xw.Book (GH1377).

(GH1377). [Bug Fix] macOS: calling wb.save('newname.xlsx') wasn’t updating the wb object properly and caused an alert (GH1129 and GH626 and GH957).

v0.20.0 (Jul 22, 2020)¶ This version drops support for Python 3.5 [Feature] New property xlwings.App.status_bar (GH1362).

(GH1362). [Enhancement] xlwings.view() now becomes the active window, making it easier to work with in interactive workflows (please speak up if you feel differently) (GH1353).

now becomes the active window, making it easier to work with in interactive workflows (please speak up if you feel differently) (GH1353). [Bug Fix] The UDF server has received a serious upgrade by njwhite, getting rid of the many issues that were around with using a combination of async functions and legacy dynamic arrays. You can now also call functions defined via async def , although for the time being they are still called synchronously from Excel (GH1010 and GH1164).

v0.19.5 (Jul 5, 2020)¶ [Enhancement] When you install the add-in via xlwings addin install , it autoconfigures the add-in if it can’t find an existing user config file (GH1322).

, it autoconfigures the add-in if it can’t find an existing user config file (GH1322). [Feature] New xlwings config create [--force] command that autogenerates the user config file with the Python settings from which you run the command. Can be used to reset the add-in settings with the --force option (GH1322).

command that autogenerates the user config file with the Python settings from which you run the command. Can be used to reset the add-in settings with the option (GH1322). [Feature]: There is a new option to show/hide the console window. Note that with Conda Path and Conda Env set, the console always pops up when using the UDF server. Currently only available on Windows (GH1182).

and set, the console always pops up when using the UDF server. Currently only available on Windows (GH1182). [Enhancement] The Interpreter setting has been deprecated in favor of platform-specific settings: Interpreter_Win and Interpreter_Mac , respectively. This allows you use the sheet config unchanged on both platforms (GH1345).

setting has been deprecated in favor of platform-specific settings: and , respectively. This allows you use the sheet config unchanged on both platforms (GH1345). [Enhancement] On macOS, you can now use a few environment-like variables in your settings: $HOME , $APPLICATIONS , $DOCUMENTS , $DESKTOP (GH615).

, , , (GH615). [Bug Fix]: Async functions sometimes caused an error on older Excel versions without dynamic arrays (GH1341).

v0.19.4 (May 20, 2020)¶ [Feature] xlwings addin install is now available on macOS. On Windows, it has been fixed so it should now work reliably (GH704).

is now available on macOS. On Windows, it has been fixed so it should now work reliably (GH704). [Bug Fix] Fixed a dll load failed issue with pywin32 when installed via pip on Python 3.8 (GH1315).

v0.19.3 (May 19, 2020)¶ PRO [Feature]: Added possibility to create deployment keys, see Deployment Key .

v0.19.1 (May 4, 2020)¶ [Bug Fix] Fixed an issue with the xlwings PRO license key when there was no xlwings.conf file (GH1308).

v0.19.0 (May 2, 2020)¶ [Bug Fix] Native dynamic array formulas can now be used with async formulas (GH1277)

[Enhancement] Quickstart references the project’s name when run from Python instead of the active book (GH1307) Breaking Change: Conda Base has been renamed into Conda Path to reduce the confusion with the Conda Env called base . Please adjust your settings accordingly! (GH1194)

v0.18.0 (Feb 15, 2020)¶ [Feature] Added support for merged cells: xlwings.Range.merge_area , xlwings.Range.merge_cells , xlwings.Range.merge() xlwings.Range.unmerge() (GH21).

, , (GH21). [Bug Fix] RunPython now works properly with files that have a URL as fullname , i.e. OneDrive and SharePoint (GH1253).

now works properly with files that have a URL as , i.e. OneDrive and SharePoint (GH1253). [Bug Fix] Fixed a bug with wb.names['...'].refers_to_range on macOS (GH1256).

v0.17.1 (Jan 31, 2020)¶ [Bug Fix] Handle np.float64('nan') correctly (GH1116).

v0.17.0 (Jan 6, 2020)¶ This release drops support for Python 2.7 in xlwings CE. If you still rely on Python 2.7, you will need to stick to v0.16.6.

v0.16.6 (Jan 5, 2020)¶ [Enhancement] CLI changes with respect to xlwings license (GH1227).

v0.16.5 (Dec 30, 2019)¶ [Enhancement] Improvements with regards to the Run main ribbon button (GH1207 and GH1222).

v0.16.4 (Dec 17, 2019)¶ [Enhancement] Added support for xlwings.Range.copy() (GH1214).

(GH1214). [Enhancement] Added support for xlwings.Range.paste() (GH1215).

(GH1215). [Enhancement] Added support for xlwings.Range.insert() (GH80).

(GH80). [Enhancement] Added support for xlwings.Range.delete() (GH862).

v0.16.3 (Dec 12, 2019)¶ [Bug Fix] Sometimes, xlwings would show an error of a previous run. Moreover, 0.16.2 introduced an issue that would not show errors at all on non-conda setups (GH1158 and GH1206)

[Enhancement] The xlwings CLI now prints the version number (GH1200) Breaking Change: LOG FILE has been retired and removed from the configuration/add-in.

v0.16.2 (Dec 5, 2019)¶ [Bug Fix] RunPython can now be called in parallel from different Excel instances (GH1196).

v0.16.1 (Dec 1, 2019)¶ [Enhancement] xlwings.Book() and myapp.books.open() now accept parameters like update_links , password etc. (GH1189).

and now accept parameters like , etc. (GH1189). [Bug Fix] Conda Env now works correctly with base for UDFs, too (GH1110).

now works correctly with for UDFs, too (GH1110). [Bug Fix] Conda Base now allows spaces in the path (GH1176).

now allows spaces in the path (GH1176). [Enhacement] The UDF server timeout has been increased to 2 minutes (GH1168).

v0.16.0 (Oct 13, 2019)¶ This release adds a small but very powerful feature: There’s a new Run main button in the add-in. With that, you can run your Python scripts from standard xlsx files - no need to save your workbook as macro-enabled anymore! The only condition to make that work is that your Python script has the same name as your workbook and that it contains a function called main , which will be called when you click the Run button. All settings from your config file or config sheet are still respected, so this will work even if you have the source file in a different directory than your workbook (as long as that directory is added to the PYTHONPATH in your config). The xlwings quickstart myproject has been updated accordingly. It still produces an xlsm file at the moment but you can save it as xlsx file if you intend to run it via the new Run button.

v0.15.10 (Aug 31, 2019)¶ [Bug Fix] Fixed a Python 2.7 incompatibility introduced with 0.15.9.

v0.15.9 (Aug 31, 2019)¶ [Enhancement] The sql extension now uses the native dynamic arrays if available (GH1138).

extension now uses the native dynamic arrays if available (GH1138). [Enhancement] xlwings now support Path objects from pathlib for all file paths (GH1126).

objects from for all file paths (GH1126). [Bug Fix] Various bug fixes: (GH1118), (GH1131), (GH1102).

v0.15.8 (May 5, 2019)¶ [Bug Fix] Fixed an issue introduced with the previous release that always showed the command prompt when running UDFs, not just when using conda envs (GH1098).

v0.15.7 (May 5, 2019)¶ [Bug Fix] Conda Base and Conda Env weren’t stored correctly in the config file from the ribbon (GH1090).

and weren’t stored correctly in the config file from the ribbon (GH1090). [Bug Fix] UDFs now work correctly with Conda Base and Conda Env . Note, however, that currently there is no way to hide the command prompt in that configuration (GH1090).

and . Note, however, that currently there is no way to hide the command prompt in that configuration (GH1090). [Enhancement] Restart UDF Server now actually does what it says: it stops and restarts the server. Previously it was only stopping the server and only when the first call to Python was made, it was started again (GH1096).

v0.15.6 (Apr 29, 2019)¶ [Feature] New default converter for OrderedDict (GH1068).

(GH1068). [Enhancement] Import Functions now restarts the UDF server to guarantee a clean state after importing. (GH1092)

now restarts the UDF server to guarantee a clean state after importing. (GH1092) [Enhancement] The ribbon now shows tooltips on Windows (GH1093)

[Bug Fix] RunPython now properly supports conda environments on Windows (they started to require proper activation with packages like numpy etc). Conda >=4.6. required. A fix for UDFs is still pending (GH954). Breaking Change: [Bug Fix] RunFronzenPython now accepts spaces in the path of the executable, but in turn requires to be called with command line arguments as a separate VBA argument. Example: RunFrozenPython "C:\path\to\frozen_executable.exe", "arg1 arg2" (GH1063).

v0.15.5 (Mar 25, 2019)¶ [Enhancement] wb.macro() now accepts xlwings objects as arguments such as range , sheet etc. when the VBA macro expects the corresponding Excel object (e.g. Range , Worksheet etc.) (GH784 and GH1084) Breaking Change: Cells that contain a cell error such as #DIV/0! , #N/A , #NAME? , #NULL! , #NUM! , #REF! , #VALUE! return now None as value in Python. Previously they were returned as constant on Windows (e.g. -2146826246 ) or k.missing_value on Mac.

v0.15.4 (Mar 17, 2019)¶ [Win] BugFix: The ribbon was not showing up in Excel 2007. (GH1039)

Enhancement: Allow to install xlwings on Linux even though it’s not a supported platform: export INSTALL_ON_LINUX=1; pip install xlwings (GH1052)

v0.15.3 (Feb 23, 2019)¶ Bug Fix release: [Mac] RunPython was broken by the previous release. If you install via conda , make sure to run xlwings runpython install again! (GH1035)

was broken by the previous release. If you install via , make sure to run again! (GH1035) [Win] Sometimes, the ribbon was throwing errors (GH1041)

v0.15.2 (Feb 3, 2019)¶ Better support and docs for deployment, see Deployment: You can now package your python modules into a zip file for easier distribution (GH1016).

RunFrozenPython now allows to includes arguments, e.g. RunFrozenPython "C:\path\to\my.exe arg1 arg2" (GH588). Breaking changes: Accessing a not existing PID in the apps collection raises now a KeyError instead of an Exception (GH1002).

v0.15.1 (Nov 29, 2018)¶ Bug Fix release: [Win] Calling Subs or UDFs from VBA was causing an error (GH998).

v0.15.0 (Nov 20, 2018)¶ Dynamic Array Refactor While we’re all waiting for the new native dynamic arrays, it’s still going to take another while until the majority can use them (they are not yet part of Office 2019). In the meantime, this refactor improves the current xlwings dynamic arrays in the following way: Use of native (“legacy”) array formulas instead of having a normal formula in the top left cell and writing around it

It’s up to 2x faster

There’s no empty row/col required outside of the dynamic array anymore

It continues to overwrite existing cells (no change there)

There’s a small breaking change in the unlikely case that you were assigning values with the expand option: myrange.options(expand='table').value = [['b'] * 3] * 3 . This was previously clearing contiguous cells to the right and bottom (or one of them depending on the option), now you have to do that explicitly. Bug Fixes: Importing multiple UDF modules has been fixed (GH991).

v0.14.1 (Nov 9, 2018)¶ This is a bug fix release: [Win] Fixed an issue when the new async_mode was used together with numpy arrays (GH984)

was used together with numpy arrays (GH984) [Mac] Fixed an issue with multiple arguments in RunPython (GH905)

(GH905) [Mac] Fixed an issue with the config file (GH982)

v0.14.0 (Nov 5, 2018)¶ Features: This release adds support for asynchronous functions (like all UDF related functionality, this is only available on Windows). Making a function asynchronous is as easy as: import xlwings as xw import time @xw . func ( async_mode = 'threading' ) def myfunction ( a ): time . sleep ( 5 ) # long running tasks return a See Asynchronous UDFs for the full docs. Bug Fixes: See GH970 and GH973.

v0.13.0 (Oct 22, 2018)¶ Features: This release adds a REST API server to xlwings, allowing you to easily expose your workbook over the internet, see REST API for all the details! Enhancements: Dynamic arrays are now more robust. Before, they often didn’t manage to write everything when there was a lot going on in the workbook (GH880)

Jagged arrays (lists of lists where not all rows are of equal length) now raise an error (GH942)

xlwings can now be used with threading, see the docs: Threading and Multiprocessing (GH759).

(GH759). [Win] xlwings now enforces pywin32 224 when installing xlwings on Python 3.7 (GH959)

New xlwings.Sheet.used_range property (GH112) Bug Fixes: The current directory is now inserted in front of everything else on the PYTHONPATH (GH958)

The standalone files had an issue in the VBA module (GH960) Breaking changes: Members of the xw.apps collection are now accessed by key (=PID) instead of index, e.g.: xw.apps[12345] instead of xw.apps[0] . The apps collection also has a new xw.apps.keys() method. (GH951)

v0.12.1 (Oct 7, 2018)¶ [Py27] Bug Fix for a Python 2.7 glitch.

v0.12.0 (Oct 7, 2018)¶ Features: This release adds support to call Python functions from VBA in all Office apps (e.g. Access, Outlook etc.), not just Excel. As this uses UDFs, it is only available on Windows. See the docs: xlwings with other Office Apps. Breaking changes: Previously, Python functions were always returning 2d arrays when called from VBA, no matter whether it was actually a 2d array or not. Now you get the proper dimensionality which makes it easier if the return value is e.g. a string or scalar as you don’t have to unpack it anymore. Consider the following example using the VBA Editor’s Immediate Window after importing UDFs from a project created using by xlwings quickstart : Old behaviour ?TypeName(hello("xlwings")) Variant() ?hello("xlwings")(0,0) hello xlwings New behaviour ?TypeName(hello("xlwings")) String ?hello("xlwings") hello xlwings Bug Fixes: [Win] Support expansion of environment variables in config values (GH615)

Other bug fixes: GH889, GH939, GH940, GH943.

v0.11.8 (May 13, 2018)¶ [Win] pywin32 is now automatically installed when using pip (GH827)

xlwings.bas has been readded to the python package. This facilitates e.g. the use of xlwings within other addins (GH857)

v0.11.7 (Feb 5, 2018)¶ [Win] This release fixes a bug introduced with v0.11.6 that would’t allow to open workbooks by name (GH804)

v0.11.6 (Jan 27, 2018)¶ Bug Fixes: [Win] When constantly writing to a spreadsheet, xlwings now correctly resumes after clicking into cells, previously it was crashing. (GH587)

Options are now correctly applied when writing to a sheet (GH798)

v0.11.5 (Jan 7, 2018)¶ This is mostly a bug fix release: Config files can now additionally be saved in the directory of the workbooks, overriding the global Ribbon config, see Environment Variables (GH772)

(GH772) Reading Pandas DataFrames with a simple index was creating a MultiIndex with Pandas > 0.20 (GH786)

[Win] The xlwings dlls are now properly versioned, allowing to use pre 0.11 releases in parallel with >0.11 releases (GH743)

[Mac] Sheet.names.add() was always adding the names on workbook level (GH771)

[Mac] UDF decorators now don’t cause errors on Mac anymore (GH780)

v0.11.4 (Jul 23, 2017)¶ This release brings further improvements with regards to the add-in: The add-in now shows the version on the ribbon. This makes it easy to check if you are using the correct version (GH724):

[Mac] On Mac Excel 2016, the ribbon now only shows the available functionality (GH723):

[Mac] Mac Excel 2011 is now supported again with the new add-in. However, since Excel 2011 doesn’t support the ribbon, the config file has be created/edited manually, see Environment Variables (GH714). Also, some new docs: [Win] How to use imported functions in VBA, see Call UDFs from VBA .

. For more up-to-date installations via conda, use the conda-forge channel, see Installation .

channel, see . A troubleshooting section: Troubleshooting .

v0.11.3 (Jul 14, 2017)¶ Bug Fix: When using the xlwings.conf sheet, there was a subscript out of range error (GH708)

sheet, there was a subscript out of range error (GH708) Enhancement: The add-in is now password protected (pw: xlwings ) to declutter the VBA editor (GH710) You need to update your xlwings add-in to get the fixes!

v0.11.2 (Jul 6, 2017)¶ Bug Fix: The sql extension was sometimes not correctly assigning the table aliases (GH699)

Bug Fix: Permission errors during pip installation should be resolved now (GH693)

v0.11.1 (Jul 5, 2017)¶ Bug Fix: The sql extension installs now correctly (GH695)

Added migration guide for v0.11, see Migrate to v0.11 (Add-in)

v0.11.0 (Jul 2, 2017)¶ Big news! This release adds a full blown add-in! We also throw in a great In-Excel SQL Extension and a few bug fixes: Add-in¶ A few highlights: Settings don’t have to be manipulated in VBA code anymore, but can be either set globally via Ribbon/config file or for the workbook via a special worksheet

UDF server can be restarted directly from the add-in

You can still use a VBA module instead of the add-in, but the recommended way is the add-in

Get all the details here: Add-in & Settings In-Excel SQL Extension¶ The add-in can be extended with own code. We throw in an sql function, that allows you to perform SQL queries on data in your spreadsheets. It’s pretty awesome, get the details here: Extensions. Bug Fixes¶ [Win]: Running Debug > Compile is not throwing errors anymore (GH678)

is not throwing errors anymore (GH678) Pandas deprecation warnings have been fixed (GH675 and GH664)

[Mac]: Errors are again shown correctly in a pop up (GH660)

[Mac]: Like Windows, Mac now also only shows errors in a popup. Before it was including stdout, too (GH666) Breaking Changes¶ RunFrozenPython now requires the full path to the executable.

now requires the full path to the executable. The xlwings CLI xlwings template functionality has been removed. Use quickstart instead.

Migrate to v0.11 (Add-in)¶ This migration guide shows you how you can start using the new xlwings add-in as opposed to the old xlwings VBA module (and the old add-in that consisted of just a single import button). Upgrade the xlwings Python package¶ Check where xlwings is currently installed >>> import xlwings >>> xlwings . __path__ If you installed xlwings with pip, for once, you should first uninstall xlwings: pip uninstall xlwings Check the directory that you got under 1): if there are any files left over, delete the xlwings folder and the remaining files manually Install the latest xlwings version: pip install xlwings Verify that you have >= 0.11 by doing >>> import xlwings >>> xlwings . __version__ Install the add-in¶ If you have the old xlwings addin installed, find the location and remove it or overwrite it with the new version (see next step). If you installed it via the xlwings command line client, you should be able to do: xlwings addin remove . Close Excel. Run xlwings addin install from a command prompt. Reopen Excel and check if the xlwings Ribbon appears. If not, copy xlwings.xlam (from your xlwings installation folder under addin\xlwings.xlam manually into the XLSTART folder. You can find the location of this folder under Options > Trust Center > Trust Center Settings… > Trusted Locations, under the description Excel default location: User StartUp . Restart Excel and you should see the add-in. Upgrade existing workbooks¶ Make a backup of your Excel file Open the file and go to the VBA Editor ( Alt-F11 ) Remove the xlwings VBA module Add a reference to the xlwings addin, see Installation If you want to use workbook specific settings, add a sheet xlwings.conf , see Workbook Config: xlwings.conf Sheet Note: To import UDFs, you need to have the reference to the xlwings add-in set!

v0.10.4 (Feb 19, 2017)¶ [Win] Bug Fix: v0.10.3 introduced a bug that imported UDFs by default with volatile=True , this has now been fixed. You will need to reimport your functions after upgrading the xlwings package.

v0.10.3 (Jan 28, 2017)¶ This release adds new features to User Defined Functions (UDFs): categories

volatile option

suppress calculation in function wizard Syntax: import xlwings as xw @xw.func ( category = "xlwings" , volatile = False , call_in_wizard = True ) def myfunction (): return ... For details, check out the (also new) and comprehensive API docs about the decorators: UDF decorators

v0.10.2 (Dec 31, 2016)¶ [Win] Python 3.6 is now supported (GH592)

v0.10.1 (Dec 5, 2016)¶ Writing a Pandas Series with a MultiIndex header was not writing out the header (GH572)

[Win] Docstrings for UDF arguments are now working (GH367)

[Mac] Range.clear_contents() has been fixed (it was doing clear() instead) (GH576)

has been fixed (it was doing instead) (GH576) xw.Book(...) and xw.books.open(...) raise now the same error in case the file doesn’t exist (GH540)

v0.10.0 (Sep 20, 2016)¶ Dynamic Array Formulas¶ This release adds an often requested & powerful new feature to User Defined Functions (UDFs): Dynamic expansion for array formulas. While Excel offers array formulas, you need to specify their dimensions up front by selecting the result array first, then entering the formula and finally hitting Ctrl-Shift-Enter . While this makes sense from a data integrity point of view, in practice, it often turns out to be a cumbersome limitation, especially when working with dynamic arrays such as time series data. This is a simple example that demonstrates the syntax and effect of UDF expansion: import numpy as np @xw.func @xw.ret ( expand = 'table' ) def dynamic_array ( r , c ): return np . random . randn ( int ( r ), int ( c )) Note: Expanding array formulas will overwrite cells without prompting and leave an empty border around them, i.e. they will clear the row to the bottom and the column to the right of the array. Bug Fixes¶ The int converter works now always as you would expect (e.g.: xw.Range('A1').options(numbers=int).value ). Before, it could happen that the number was off by 1 due to floating point issues (GH554).

v0.9.3 (Aug 22, 2016)¶ [Win] App.visible wasn’t behaving correctly (GH551).

wasn’t behaving correctly (GH551). [Mac] Added support for the new 64bit version of Excel 2016 on Mac (GH549).

Unicode book names are again supported (GH546).

xlwings.Book.save() now supports relative paths. Also, when saving an existing book under a new name without specifying the full path, it’ll be saved in Python’s current working directory instead of in Excel’s default directory (GH185).

v0.9.2 (Aug 8, 2016)¶ Another round of bug fixes: [Mac]: Sometimes, a column was referenced instead of a named range (GH545)

[Mac]: Python 2.7 was raising a LookupError: unknown encoding: mbcs (GH544)

(GH544) Fixed docs regarding set_mock_caller (GH543)

v0.9.1 (Aug 5, 2016)¶ This is a bug fix release: As to be expected after a rewrite, there were some rough edges that have now been taken care of: [Win] Opening a file via xw.Book() was causing an additional Book1 to be opened in case Excel was not running yet (GH531)

was causing an additional to be opened in case Excel was not running yet (GH531) [Win] Some users were getting an ImportError (GH533)

[PY 2.7] RunPython was broken with Python 2.7 (GH537)

was broken with Python 2.7 (GH537) Some corrections in the docs (GH538 and GH536)

v0.9.0 (Aug 2, 2016)¶ Exciting times! v0.9.0 is a complete rewrite of xlwings with loads of syntax changes (hence the version jump). But more importantly, this release adds a ton of new features and bug fixes that would have otherwise been impossible. Some of the highlights are listed below, but make sure to check out the full migration guide for the syntax changes in details. Note, however, that the syntax for user defined functions (UDFs) did not change. At this point, the API is fairly stable and we’re expecting only smaller changes on our way towards a stable v1.0 release. Active book instead of current book: xw.Range('A1') goes against the active sheet of the active book like you’re used to from VBA. Instantiating an explicit connection to a Book is not necessary anymore: >>> import xlwings as xw >>> xw . Range ( 'A1' ) . value = 11 >>> xw . Range ( 'A1' ) . value 11.0

Excel Instances: Full support of multiple Excel instances (even on Mac!) >>> app1 = xw . App () >>> app2 = xw . App () >>> xw . apps Apps([<Excel App 1668>, <Excel App 1644>])

New powerful object model based on collections and close to Excel’s original, allowing to fully qualify objects: xw.apps[0].books['MyBook.xlsx'].sheets[0].range('A1:B2').value It supports both Python indexing (square brackets) and Excel indexing (round brackets): xw.books[0].sheets[0] is the same as xw.books(1).sheets(1) It also supports indexing and slicing of range objects: >>> rng = xw . Range ( 'A1:E10' ) >>> rng [ 1 ] <Range [Workbook1]Sheet1!$B$1> >>> rng [: 2 , : 2 ] <Range [Workbook1]Sheet1!$A$1:$B$2> For more details, see Syntax Overview.

UDFs can now also be imported from packages, not just modules (GH437)

Named Ranges: Introduction of full object model and proper support for sheet and workbook scope (GH256)

Excel doesn’t become the active window anymore so the focus stays on your Python environment (GH414)

When writing to ranges while Excel is busy, xlwings is now retrying until Excel is idle again (GH468)

xlwings.view() has been enhanced to accept an optional sheet object (GH469)

Objects like books, sheets etc. can now be compared (e.g. wb1 == wb2 ) and are properly hashable

Note that support for Python 2.6 has been dropped Some of the new methods/properties worth mentioning are: xlwings.App.display_alerts

xlwings.App.macro() in addition to xlwings.Book.macro()

in addition to xlwings.App.kill()

xlwings.Sheet.cells

xlwings.Range.rows

xlwings.Range.columns

xlwings.Range.end()

xlwings.Range.raw_value Bug Fixes¶ See here for details about which bugs have been fixed.

Migrate to v0.9¶ The purpose of this document is to enable you a smooth experience when upgrading to xlwings v0.9.0 and above by laying out the concept and syntax changes in detail. If you want to get an overview of the new features and bug fixes, have a look at the release notes. Note that the syntax for User Defined Functions (UDFs) didn’t change. Full qualification: Using collections¶ The new object model allows to specify the Excel application instance if needed: old : xw.Range('Sheet1', 'A1', wkb=xw.Workbook('Book1'))

: new: xw.apps[0].books['Book1'].sheets['Sheet1'].range('A1') See Syntax Overview for the details of the new object model. Connecting to Books¶ old : xw.Workbook()

: new: xw.Book() or via xw.books if you need to control the app instance. See Connect to a Book for the details. Active Objects¶ # Active app (i.e. Excel instance) >>> app = xw . apps . active # Active book >>> wb = xw . books . active # in active app >>> wb = app . books . active # in specific app # Active sheet >>> sht = xw . sheets . active # in active book >>> sht = wb . sheets . active # in specific book # Range on active sheet >>> xw . Range ( 'A1' ) # on active sheet of active book of active app Round vs. Square Brackets¶ Round brackets follow Excel’s behavior (i.e. 1-based indexing), while square brackets use Python’s 0-based indexing/slicing. As an example, the following all reference the same range: xw . apps [ 0 ] . books [ 0 ] . sheets [ 0 ] . range ( 'A1' ) xw . apps ( 1 ) . books ( 1 ) . sheets ( 1 ) . range ( 'A1' ) xw . apps [ 0 ] . books [ 'Book1' ] . sheets [ 'Sheet1' ] . range ( 'A1' ) xw . apps ( 1 ) . books ( 'Book1' ) . sheets ( 'Sheet1' ) . range ( 'A1' ) Access the underlying Library/Engine¶ old : xw.Range('A1').xl_range and xl_sheet etc.

: and etc. new: xw.Range('A1').api , same for all other objects This returns a pywin32 COM object on Windows and an appscript object on Mac. Cheat sheet¶ Note that sht stands for a sheet object, like e.g. (in 0.9.0 syntax): sht = xw.books['Book1'].sheets[0] v0.9.0 v0.7.2 Active Excel instance xw.apps.active unsupported New Excel instance app = xw.App() unsupported Get app from book app = wb.app app = xw.Application(wb) Target installation (Mac) app = xw.App(spec=...) wb = xw.Workbook(app_target=...) Hide Excel Instance app = xw.App(visible=False) wb = xw.Workbook(app_visible=False) Selected Range app.selection wb.get_selection() Calculation mode app.calculation = 'manual' app.calculation = xw.constants.Calculation.xlCalculationManual All books in app app.books unsupported Fully qualified book app.books['Book1'] unsupported Active book in active app xw.books.active xw.Workbook.active() New book in active app wb = xw.Book() wb = xw.Workbook() New book in specific app wb = app.books.add() unsupported All sheets in book wb.sheets xw.Sheet.all(wb) Call a macro in an addin app.macro('MacroName') unsupported First sheet of book wb wb.sheets[0] xw.Sheet(1, wkb=wb) Active sheet wb.sheets.active xw.Sheet.active(wkb=wb) or wb.active_sheet Add sheet wb.sheets.add() xw.Sheet.add(wkb=wb) Sheet count wb.sheets.count or len(wb.sheets) xw.Sheet.count(wb) Add chart to sheet chart = wb.sheets[0].charts.add() chart = xw.Chart.add(sheet=1, wkb=wb) Existing chart wb.sheets['Sheet 1'].charts[0] xw.Chart('Sheet 1', 1) Chart Type chart.chart_type = '3d_area' chart.chart_type = xw.constants.ChartType.xl3DArea Add picture to sheet wb.sheets[0].pictures.add('path/to/pic') xw.Picture.add('path/to/pic', sheet=1, wkb=wb) Existing picture wb.sheets['Sheet 1'].pictures[0] xw.Picture('Sheet 1', 1) Matplotlib sht.pictures.add(fig, name='x', update=True) xw.Plot(fig).show('MyPlot', sheet=sht, wkb=wb) Table expansion sht.range('A1').expand('table') xw.Range(sht, 'A1', wkb=wb).table Vertical expansion sht.range('A1').expand('down') xw.Range(sht, 'A1', wkb=wb).vertical Horizontal expansion sht.range('A1').expand('right') xw.Range(sht, 'A1', wkb=wb).horizontal Set name of range sht.range('A1').name = 'name' xw.Range(sht, 'A1', wkb=wb).name = 'name' Get name of range sht.range('A1').name.name xw.Range(sht, 'A1', wkb=wb).name mock caller xw.Book('file.xlsm').set_mock_caller() xw.Workbook.set_mock_caller('file.xlsm')

v0.7.2 (May 18, 2016)¶ Bug Fixes¶ [Win] UDFs returning Pandas DataFrames/Series containing nan were failing (GH446).

were failing (GH446). [Win] RunFrozenPython was not finding the executable (GH452).

was not finding the executable (GH452). The xlwings VBA module was not finding the Python interpreter if PYTHON_WIN or PYTHON_MAC contained spaces (GH461).

v0.7.1 (April 3, 2016)¶ Enhancements¶ [Win]: User Defined Functions (UDFs) support now optional/default arguments (GH363)

[Win]: User Defined Functions (UDFs) support now multiple source files, see also under API changes below. For example (VBA settings): UDF_MODULES="common;myproject"

VBA Subs & Functions are now callable from Python: As an example, this VBA function: Function MySum ( x , y ) MySum = x + y End Function can be accessed like this: >>> import xlwings as xw >>> wb = xw . Workbook . active () >>> my_sum = wb . macro ( 'MySum' ) >>> my_sum ( 1 , 2 ) 3.0

New xw.view method: This opens a new workbook and displays an object on its first sheet. E.g.: >>> import xlwings as xw >>> import pandas as pd >>> import numpy as np >>> df = pd . DataFrame ( np . random . rand ( 10 , 4 ), columns = [ 'a' , 'b' , 'c' , 'd' ]) >>> xw . view ( df )

New docs about Matplotlib & Plotly Charts and Custom Converter

New method: xlwings.Range.formula_array() (GH411) API changes¶ VBA settings: PYTHON_WIN and PYTHON_MAC must now include the interpreter if you are not using the default ( PYTHON_WIN = "" ) (GH289). E.g.: PYTHON_WIN : "C:\Python35\pythonw.exe" PYTHON_MAC : "/usr/local/bin/python3.5"

[Win]: VBA settings: UDF_PATH has been replaced with UDF_MODULES . The default behaviour doesn’t change though (i.e. if UDF_MODULES = "" , then a Python source file with the same name as the Excel file, but with .py ending will be imported from the same directory as the Excel file). New: UDF_MODULES: "mymodule" PYTHONPATH: "C:\path\to" Old: UDF_PATH: "C:\path\to\mymodule.py" Bug Fixes¶ Numpy scalars issues were resolved (GH415)

[Win]: xlwings was failing with freezers like cx_Freeze (GH413)

[Win]: UDFs were failing if they were returning None or np.nan (GH390)

or (GH390) Multiindex Pandas Series have been fixed (GH383)

[Mac]: xlwings runpython install was failing (GH424)

v0.7.0 (March 4, 2016)¶ This version marks an important first step on our path towards a stable release. It introduces converters, a new and powerful concept that brings a consistent experience for how Excel Ranges and their values are treated both when reading and writing but also across xlwings.Range objects and User Defined Functions (UDFs). As a result, a few highlights of this release include: Pandas DataFrames and Series are now supported for reading and writing, both via Range object and UDFs

New Range converter options: transpose , dates , numbers , empty , expand

, , , , New dictionary converter

New UDF debug server

No more pyc files when using RunPython Converters are accessed via the new options method when dealing with xlwings.Range objects or via the @xw.arg and @xw.ret decorators when using UDFs. As an introductory sample, let’s look at how to read and write Pandas DataFrames: Range object: >>> import xlwings as xw >>> import pandas as pd >>> wb = xw . Workbook () >>> df = xw . Range ( 'A1:D5' ) . options ( pd . DataFrame , header = 2 ) . value >>> df a b c d e ix 10 1 2 3 20 4 5 6 30 7 8 9 # Writing back using the defaults: >>> Range ( 'A1' ) . value = df # Writing back and changing some of the options, e.g. getting rid of the index: >>> Range ( 'B7' ) . options ( index = False ) . value = df UDFs: This is the same sample as above (starting in Range('A13') on screenshot). If you wanted to return a DataFrame with the defaults, the @xw.ret decorator can be left away. @xw . func @xw . arg ( 'x' , pd . DataFrame , header = 2 ) @xw . ret ( index = False ) def myfunction ( x ): # x is a DataFrame, do something with it return x Enhancements¶ Dictionary ( dict ) converter: >>> Range ( 'A1:B2' ) . options ( dict ) . value {'a': 1.0, 'b': 2.0} >>> Range ( 'A4:B5' ) . options ( dict , transpose = True ) . value {'a': 1.0, 'b': 2.0}

transpose option: This works in both directions and finally allows us to e.g. write a list in column orientation to Excel (GH11): Range ( 'A1' ) . options ( transpose = True ) . value = [ 1 , 2 , 3 ]

dates option: This allows us to read Excel date-formatted cells in specific formats: >>> import datetime as dt >>> Range ( 'A1' ) . value datetime.datetime(2015, 1, 13, 0, 0) >>> Range ( 'A1' ) . options ( dates = dt . date ) . value datetime.date(2015, 1, 13)

empty option: This allows us to override the default behavior for empty cells: >>> Range ( 'A1:B1' ) . value [None, None] >>> Range ( 'A1:B1' ) . options ( empty = 'NA' ) ['NA', 'NA']

numbers option: This transforms all numbers into the indicated type. >>> xw . Range ( 'A1' ) . value = 1 >>> type ( xw . Range ( 'A1' ) . value ) # Excel stores all numbers interally as floats float >>> type ( xw . Range ( 'A1' ) . options ( numbers = int ) . value ) int

expand option: This works the same as the Range properties table , vertical and horizontal but is only evaluated when getting the values of a Range: >>> import xlwings as xw >>> wb = xw . Workbook () >>> xw . Range ( 'A1' ) . value = [[ 1 , 2 ], [ 3 , 4 ]] >>> rng1 = xw . Range ( 'A1' ) . table >>> rng2 = xw . Range ( 'A1' ) . options ( expand = 'table' ) >>> rng1 . value [[1.0, 2.0], [3.0, 4.0]] >>> rng2 . value [[1.0, 2.0], [3.0, 4.0]] >>> xw . Range ( 'A3' ) . value = [ 5 , 6 ] >>> rng1 . value [[1.0, 2.0], [3.0, 4.0]] >>> rng2 . value [[1.0, 2.0], [3.0, 4.0], [5.0, 6.0]] All these options work the same with decorators for UDFs, e.g. for transpose: @xw . arg ( 'x' , transpose = True ) @xw . ret ( transpose = True ) def myfunction ( x ): # x will be returned unchanged as transposed both when reading and writing return x Note: These options ( dates , empty , numbers ) currently apply to the whole Range and can’t be selectively applied to e.g. only certain columns. UDF debug server The new UDF debug server allows you to easily debug UDFs: just set UDF_DEBUG_SERVER = True in the VBA Settings, at the top of the xlwings VBA module (make sure to update it to the latest version!). Then add the following lines to your Python source file and run it: if __name__ == '__main__' : xw . serve () When you recalculate the Sheet, the code will stop at breakpoints or print any statements that you may have. For details, see: Debugging.

pyc files: The creation of pyc files has been disabled when using RunPython , leaving your directory in an uncluttered state when having the Python source file next to the Excel workbook (GH326). API changes¶ UDF decorator changes (it is assumed that xlwings is imported as xw and numpy as np ): New Old @xw.func @xw.xlfunc @xw.arg @xw.xlarg @xw.ret @xw.xlret @xw.sub @xw.xlsub Pay attention to the following subtle change: New Old @xw.arg("x", np.array) @xw.xlarg("x", "nparray")

Samples of how the new options method replaces the old Range keyword arguments: New Old Range('A1:A2').options(ndim=2) Range('A1:A2', atleast_2d=True) Range('A1:B2').options(np.array) Range('A1:B2', asarray=True) Range('A1').options(index=False, header=False).value = df Range('A1', index=False, header=False).value = df

Upon writing, Pandas Series are now shown by default with their name and index name, if they exist. This can be changed using the same options as for DataFrames (GH276): import pandas as pd # unchanged behaviour Range ( 'A1' ) . value = pd . Series ([ 1 , 2 , 3 ]) # Changed behaviour: This will print a header row in Excel s = pd . Series ([ 1 , 2 , 3 ], name = 'myseries' , index = pd . Index ([ 0 , 1 , 2 ], name = 'myindex' )) Range ( 'A1' ) . value = s # Control this behaviour like so (as with DataFrames): Range ( 'A1' ) . options ( header = False , index = True ) . value = s

NumPy scalar values Previously, NumPy scalar values were returned as np.atleast_1d . To keep the same behaviour, this now has to be set explicitly using ndim=1 . Otherwise they’re returned as numpy scalar values. New Old Range('A1').options(np.array, ndim=1).value Range('A1', asarray=True).value Bug Fixes¶ A few bugfixes were made: GH352, GH359.

v0.6.4 (January 6, 2016)¶ API changes¶ None Enhancements¶ Quickstart: It’s now easier than ever to start a new xlwings project, simply use the commmand line client (GH306): xlwings quickstart myproject will produce a folder with the following files, ready to be used (see Command Line Client (CLI)): myproject |-- myproject . xlsm |-- myproject . py

New documentation about how to use xlwings with other languages like R and Julia, see xlwings with R and Julia. Bug Fixes¶ [Win]: Importing UDFs with the add-in was throwing an error if the filename was including characters like spaces or dashes (GH331). To fix this, close Excel completely and run xlwings addin update .

. [Win]: Workbook.caller() is now also accessible within functions that are decorated with @xlfunc . Previously, it was only available with functions that used the @xlsub decorator (GH316).

is now also accessible within functions that are decorated with . Previously, it was only available with functions that used the decorator (GH316). Writing a Pandas DataFrame failed in case the index was named the same as a column (GH334).

v0.6.3 (December 18, 2015)¶ Bug Fixes¶ [Mac]: This fixes a bug introduced in v0.6.2: When using RunPython from VBA, errors were not shown in a pop-up window (GH330).

v0.6.2 (December 15, 2015)¶ API changes¶ LOG_FILE: So far, the log file has been placed next to the Excel file per default (VBA settings). This has been changed as it was causing issues for files on SharePoint/OneDrive and Mac Excel 2016: The place where LOG_FILE = "" refers to depends on the OS and the Excel version. Enhancements¶ [Mac]: This version adds support for the VBA module on Mac Excel 2016 (i.e. the RunPython command) and is now feature equivalent with Mac Excel 2011 (GH206). Bug Fixes¶ [Win]: On certain systems, the xlwings dlls weren’t found (GH323).

v0.6.1 (December 4, 2015)¶ Bug Fixes¶ [Python 3]: The command line client has been fixed (GH319).

[Mac]: It now works correctly with psutil>=3.0.0 (GH315).

v0.6.0 (November 30, 2015)¶ API changes¶ None Enhancements¶ User Defined Functions (UDFs) - currently Windows only The ExcelPython project has been fully merged into xlwings. This means that on Windows, UDF’s are now supported via decorator syntax. A simple example: from xlwings import xlfunc @xlfunc def double_sum ( x , y ): """Returns twice the sum of the two arguments""" return 2 * ( x + y ) For array formulas with or without NumPy , see the docs: User Defined Functions (UDFs)

Command Line Client The new xlwings command line client makes it easy to work with the xlwings template and the developer add-in (the add-in is currently Windows-only). E.g. to create a new Excel spreadsheet from the template, run: xlwings template open For all commands, see the docs: Command Line Client (CLI)

Other enhancements : New method: xlwings.Sheet.delete() New method: xlwings.Range.top() New method: xlwings.Range.left()



v0.5.0 (November 10, 2015)¶ API changes¶ None Enhancements¶ This version adds support for Matplotlib! Matplotlib figures can be shown in Excel as pictures in just 2 lines of code: Get a matplotlib figure object: via PyPlot interface: import matplotlib.pyplot as plt fig = plt . figure () plt . plot ([ 1 , 2 , 3 , 4 , 5 ])

via object oriented interface: from matplotlib.figure import Figure fig = Figure ( figsize = ( 8 , 6 )) ax = fig . add_subplot ( 111 ) ax . plot ([ 1 , 2 , 3 , 4 , 5 ])

via Pandas: import pandas as pd import numpy as np df = pd . DataFrame ( np . random . rand ( 10 , 4 ), columns = [ 'a' , 'b' , 'c' , 'd' ]) ax = df . plot ( kind = 'bar' ) fig = ax . get_figure () Show it in Excel as picture: plot = Plot ( fig ) plot . show ( 'Plot1' ) See the full API: xlwings.Plot() . There’s also a new example available both on GitHub and as download on the homepage. Other enhancements: New xlwings.Shape() class

class New xlwings.Picture() class

class The PYTHONPATH in the VBA settings now accepts multiple directories, separated by ; (GH258)

in the VBA settings now accepts multiple directories, separated by (GH258) An explicit exception is raised when Range is called with 0-based indices (GH106) Bug Fixes¶ Sheet.add was not always acting on the correct workbook (GH287)

was not always acting on the correct workbook (GH287) Iteration over a Range only worked the first time (GH272)

only worked the first time (GH272) [Win]: Sometimes, an error was raised when Excel was not running (GH269)

[Win]: Non-default Python interpreters (as specified in the VBA settings under PYTHON_WIN ) were not found if the path contained a space (GH257)

v0.4.1 (September 27, 2015)¶ API changes¶ None Enhancements¶ This release makes it easier than ever to connect to Excel from Python! In addition to the existing ways, you can now connect to the active Workbook (on Windows across all instances) and if the Workbook is already open, it’s good enough to refer to it by name (instead of having to use the full path). Accordingly, this is how you make a connection to… (GH30 and GH226): a new workbook: wb = Workbook()

the active workbook [New!]: wb = Workbook.active()

an unsaved workbook: wb = Workbook('Book1')

a saved (open) workbook by name (incl. xlsx etc.) [New!]: wb = Workbook('MyWorkbook.xlsx')

a saved (open or closed) workbook by path: wb = Workbook(r'C:\\path\\to\\file.xlsx') Also, there are some new docs: Connect to a Book

Missing Features Bug Fixes¶ The Excel template was updated to the latest VBA code (GH234).

Connections to files that are saved on OneDrive/SharePoint are now working correctly (GH215).

Various issues with timezone-aware objects were fixed (GH195).

[Mac]: A certain range of integers were not written to Excel (GH227).

v0.4.0 (September 13, 2015)¶ API changes¶ None Enhancements¶ The most important update with this release was made on Windows: The methodology used to make a connection to Workbooks has been completely replaced. This finally allows xlwings to reliably connect to multiple instances of Excel even if the Workbooks are opened from untrusted locations (network drives or files downloaded from the internet). This gets rid of the dreaded Filename is already open... error message that was sometimes shown in this context. It also allows the VBA hooks ( RunPython ) to work correctly if the very same file is opened in various instances of Excel. Note that you will need to update the VBA module and that apart from pywin32 there is now a new dependency for the Windows version: comtypes . It should be installed automatically though when installing/upgrading xlwings with pip . Other updates: Added support to manipulate named Ranges (GH92): >>> wb = Workbook () >>> Range ( 'A1' ) . name = 'Name1' >>> Range ( 'A1' ) . name >>> 'Name1' >>> del wb . names [ 'Name1' ]

New Range properties (GH81): xlwings.Range.column_width() xlwings.Range.row_height() xlwings.Range.width() xlwings.Range.height()

Range now also accepts Sheet objects, the following 3 ways are hence all valid (GH92): r = Range ( 1 , 'A1' ) r = Range ( 'Sheet1' , 'A1' ) sheet1 = Sheet ( 1 ) r = Range ( sheet1 , 'A1' )

[Win]: Error pop-ups show now the full error message that can also be copied with Ctrl-C (GH221). Bug Fixes¶ The VBA module was not accepting lower case drive letters (GH205).

Fixed an error when adding a new Sheet that was already existing (GH211).

v0.3.6 (July 14, 2015)¶ API changes¶ Application as attribute of a Workbook has been removed ( wb is a Workbook object): Correct Syntax (as before) Removed Application(wkb=wb) wb.application Enhancements¶ Excel 2016 for Mac Support (GH170) Excel 2016 for Mac is finally supported (Python side). The VBA hooks ( RunPython ) are currently not yet supported. In more details: This release allows Excel 2011 and Excel 2016 to be installed in parallel.

Workbook() will open the default Excel installation (usually Excel 2016).

The new keyword argument app_target allows to connect to a different Excel installation, e.g.: Workbook ( app_target = '/Applications/Microsoft Office 2011/Microsoft Excel' ) Note that app_target is only available on Mac. On Windows, if you want to change the version of Excel that xlwings talks to, go to Control Panel > Programs and Features and Repair the Office version that you want as default.

The RunPython calls in VBA are not yet available through Excel 2016 but Excel 2011 doesn’t get confused anymore if Excel 2016 is installed on the same system - make sure to update your VBA module! Other enhancements New method: xlwings.Application.calculate() (GH207) Bug Fixes¶ [Win]: When using the OPTIMIZED_CONNECTION on Windows, Excel left an orphaned process running after closing (GH193). Various improvements regarding unicode file path handling, including: [Mac]: Excel 2011 for Mac now supports unicode characters in the filename when called via VBA’s RunPython (but not in the path - this is a limitation of Excel 2011 that will be resolved in Excel 2016) (GH154).

(but not in the path - this is a limitation of Excel 2011 that will be resolved in Excel 2016) (GH154). [Win]: Excel on Windows now handles unicode file paths correctly with untrusted documents. (GH154).

v0.3.5 (April 26, 2015)¶ API changes¶ Sheet.autofit() and Range.autofit() : The integer argument for the axis has been removed (GH186). Use string arguments rows or r for autofitting rows and columns or c for autofitting columns (as before). Enhancements¶ New methods: xlwings.Range.row() (GH143)

(GH143) xlwings.Range.column() (GH143)

(GH143) xlwings.Range.last_cell() (GH142) Example: >>> rng = Range ( 'A1' ) . table >>> rng . row , rng . column (1, 1) >>> rng . last_cell . row , rng . last_cell . column (4, 5) Bug Fixes¶ The unicode bug on Windows/Python3 has been fixed (GH161)

v0.3.4 (March 9, 2015)¶ Bug Fixes¶ The installation error on Windows has been fixed (GH160)

v0.3.3 (March 8, 2015)¶ API changes¶ None Enhancements¶ New class Application with quit method and properties screen_updating und calculation (GH101, GH158, GH159). It can be conveniently accessed from within a Workbook (on Windows, Application is instance dependent). A few examples: >>> from xlwings import Workbook , Calculation >>> wb = Workbook () >>> wb . application . screen_updating = False >>> wb . application . calculation = Calculation . xlCalculationManual >>> wb . application . quit ()

New headless mode: The Excel application can be hidden either during Workbook instantiation or through the application object: >>> wb = Workbook ( app_visible = False ) >>> wb . application . visible False >>> wb . application . visible = True

Newly included Excel template which includes the xlwings VBA module and boilerplate code. This is currently accessible from an interactive interpreter session only: >>> from xlwings import Workbook >>> Workbook . open_template () Bug Fixes¶ [Win]: datetime.date objects were causing an error (GH44).

objects were causing an error (GH44). Depending on how it was instantiated, Workbook was sometimes missing the fullname attribute (GH76).

attribute (GH76). Range.hyperlink was failing if the hyperlink had been set as formula (GH132).

was failing if the hyperlink had been set as formula (GH132). A bug introduced in v0.3.0 caused frozen versions (eg. with cx_Freeze ) to fail (GH133).

) to fail (GH133). [Mac]: Sometimes, xlwings was causing an error when quitting the Python interpreter (GH136).

v0.3.2 (January 17, 2015)¶ API changes¶ None Enhancements¶ None Bug Fixes¶ The xlwings.Workbook.save() method has been fixed to show the expected behavior (GH138): Previously, calling save() without a path argument would always create a new file in the current working directory. This is now only happening if the file hasn’t been previously saved.

v0.3.1 (January 16, 2015)¶ API changes¶ None Enhancements¶ New method xlwings.Workbook.save() (GH110).

New method xlwings.Workbook.set_mock_caller() (GH129). This makes calling files from both Excel and Python much easier: import os from xlwings import Workbook , Range def my_macro (): wb = Workbook . caller () Range ( 'A1' ) . value = 1 if __name__ == '__main__' : # To run from Python, not needed when called from Excel. # Expects the Excel file next to this source file, adjust accordingly. path = os . path . abspath ( os . path . join ( os . path . dirname ( __file__ ), 'myfile.xlsm' )) Workbook . set_mock_caller ( path ) my_macro ()

The simulation example on the homepage works now also on Mac. Bug Fixes¶ [Win]: A long-standing bug that caused the Excel file to close and reopen under certain circumstances has been fixed (GH10): Depending on your security settings (Trust Center) and in connection with files downloaded from the internet or possibly in connection with some add-ins, Excel was either closing the file and reopening it or giving a “file already open” warning. This has now been fixed which means that the examples downloaded from the homepage should work right away after downloading and unzipping.

v0.3.0 (November 26, 2014)¶ API changes¶ To reference the calling Workbook when running code from VBA, you now have to use Workbook.caller() . This means that wb = Workbook() is now consistently creating a new Workbook, whether the code is called interactively or from VBA. New Old Workbook.caller() Workbook() Enhancements¶ This version adds two exciting but still experimental features from ExcelPython (Windows only!): Optimized connection: Set the OPTIMIZED_CONNECTION = True in the VBA settings. This will use a COM server that will keep the connection to Python alive between different calls and is therefore much more efficient. However, changes in the Python code are not being picked up until the pythonw.exe process is restarted by killing it manually in the Windows Task Manager. The suggested workflow is hence to set OPTIMIZED_CONNECTION = False for development and only set it to True for production - keep in mind though that this feature is still experimental!

in the VBA settings. This will use a COM server that will keep the connection to Python alive between different calls and is therefore much more efficient. However, changes in the Python code are not being picked up until the process is restarted by killing it manually in the Windows Task Manager. The suggested workflow is hence to set for development and only set it to for production - keep in mind though that this feature is still experimental! User Defined Functions (UDFs): Using ExcelPython’s wrapper syntax in VBA, you can expose Python functions as UDFs, see User Defined Functions (UDFs) for details. Note: ExcelPython’s developer add-in that autogenerates the VBA wrapper code by simply using Python decorators isn’t available through xlwings yet. Further enhancements include: New method xlwings.Range.resize() (GH90).

New method xlwings.Range.offset() (GH89).

New property xlwings.Range.shape (GH109).

New property xlwings.Range.size (GH109).

New property xlwings.Range.hyperlink and new method xlwings.Range.add_hyperlink() (GH104).

New property xlwings.Range.color (GH97).

The len built-in function can now be used on Range (GH109): >>> len ( Range ( 'A1:B5' )) 5

The Range object is now iterable (GH108): for cell in Range ( 'A1:B2' ): if cell . value < 2 : cell . color = ( 255 , 0 , 0 )

[Mac]: The VBA module finds now automatically the default Python installation as per PATH variable on .bash_profile when PYTHON_MAC = "" (the default in the VBA settings) (GH95).

The VBA error pop-up can now be muted by setting SHOW_LOG = False in the VBA settings. To be used with care, but it can be useful on Mac, as the pop-up window is currently showing printed log messages even if no error occurred(GH94). Bug Fixes¶ [Mac]: Environment variables from .bash_profile are now available when called from VBA, e.g. by using: os.environ['USERNAME'] (GH95)

v0.2.3 (October 17, 2014)¶ API changes¶ None Enhancements¶ New method Sheet.add() (GH71): >>> Sheet . add () # Place at end with default name >>> Sheet . add ( 'NewSheet' , before = 'Sheet1' ) # Include name and position >>> new_sheet = Sheet . add ( after = 3 ) >>> new_sheet . index 4

New method Sheet.count() : >>> Sheet . count () 3

autofit() works now also on Sheet objects, not only on Range objects (GH66): >>> Sheet ( 1 ) . autofit () # autofit columns and rows >>> Sheet ( 'Sheet1' ) . autofit ( 'c' ) # autofit columns

New property number_format for Range objects (GH60): >>> Range ( 'A1' ) . number_format 'General' >>> Range ( 'A1:C3' ) . number_format = '0.00%' >>> Range ( 'A1:C3' ) . number_format '0.00%' Works also with the Range properties table , vertical , horizontal : >>> Range ( 'A1' ) . value = [ 1 , 2 , 3 , 4 , 5 ] >>> Range ( 'A1' ) . table . number_format = '0.00%'

New method get_address for Range objects (GH7): >>> Range (( 1 , 1 )) . get_address () '$A$1' >>> Range (( 1 , 1 )) . get_address ( False , False ) 'A1' >>> Range ( 'Sheet1' , ( 1 , 1 ), ( 3 , 3 )) . get_address ( True , False , include_sheetname = True ) 'Sheet1!A$1:C$3' >>> Range ( 'Sheet1' , ( 1 , 1 ), ( 3 , 3 )) . get_address ( True , False , external = True ) '[Workbook1]Sheet1!A$1:C$3'

New method Sheet.all() returning a list with all Sheet objects: >>> Sheet . all () [<Sheet 'Sheet1' of Workbook 'Book1'>, <Sheet 'Sheet2' of Workbook 'Book1'>] >>> [ i . name . lower () for i in Sheet . all ()] ['sheet1', 'sheet2'] >>> [ i . autofit () for i in Sheet . all ()] Bug Fixes¶ xlwings works now also with NumPy < 1.7.0. Before, doing something like Range('A1').value = 'Foo' was causing a NotImplementedError: Not implemented for this type error when NumPy < 1.7.0 was installed (GH73).

was causing a error when NumPy < 1.7.0 was installed (GH73). [Win]: The VBA module caused an error on the 64bit version of Excel (GH72).

[Mac]: The error pop-up wasn’t shown on Python 3 (GH85).

[Mac]: Autofitting bigger Ranges, e.g. Range('A:D').autofit() was causing a time out (GH74).

was causing a time out (GH74). [Mac]: Sometimes, calling xlwings from Python was causing Excel to show old errors as pop-up alert (GH70).

v0.2.2 (September 23, 2014)¶ API changes¶ The Workbook qualification changed: It now has to be specified as keyword argument. Assume we have instantiated two Workbooks like so: wb1 = Workbook() and wb2 = Workbook() . Sheet , Range and Chart classes will default to wb2 as it was instantiated last. To target wb1 , use the new wkb keyword argument: New Old Range('A1', wkb=wb1).value wb1.range('A1').value Chart('Chart1', wkb=wb1) wb1.chart('Chart1') Alternatively, simply set the current Workbook before using the Sheet , Range or Chart classes: wb1 . set_current () Range ( 'A1' ) . value

Through the introduction of the Sheet class (see Enhancements), a few methods moved from the Workbook to the Sheet class. Assume the current Workbook is: wb = Workbook() : New Old Sheet('Sheet1').activate() wb.activate('Sheet1') Sheet('Sheet1').clear() wb.clear('Sheet1') Sheet('Sheet1').clear_contents() wb.clear_contents('Sheet1') Sheet.active().clear_contents() wb.clear_contents()

The syntax to add a new Chart has been slightly changed (it is a class method now): New Old Chart.add() Chart().add() Enhancements¶ [Mac]: Python errors are now also shown in a Message Box. This makes the Mac version feature equivalent with the Windows version (GH57):

New Sheet class: The new class handles everything directly related to a Sheet. See the Python API section about Sheet for details (GH62). A few examples: >>> Sheet ( 1 ) . name 'Sheet1' >>> Sheet ( 'Sheet1' ) . clear_contents () >>> Sheet . active () <Sheet 'Sheet1' of Workbook 'Book1'>

The Range class has a new method autofit() that autofits the width/height of either columns, rows or both (GH33). Arguments: axis : string or integer , default None - To autofit rows , use one of the following : 'rows' or 'r' - To autofit columns , use one of the following : 'columns' or 'c' - To autofit rows and columns , provide no arguments Examples: # Autofit column A Range ( 'A:A' ) . autofit () # Autofit row 1 Range ( '1:1' ) . autofit () # Autofit columns and rows, taking into account Range('A1:E4') Range ( 'A1:E4' ) . autofit () # AutoFit rows, taking into account Range('A1:E4') Range ( 'A1:E4' ) . autofit ( 'rows' )

The Workbook class has the following additional methods: current() and set_current() . They determine the default Workbook for Sheet , Range or Chart . On Windows, in case there are various Excel instances, when creating new or opening existing Workbooks, they are being created in the same instance as the current Workbook. >>> wb1 = Workbook () >>> wb2 = Workbook () >>> Workbook . current () <Workbook 'Book2'> >>> wb1 . set_current () >>> Workbook . current () <Workbook 'Book1'>

If a Sheet , Range or Chart object is instantiated without an existing Workbook object, a user-friendly error message is raised (GH58).

New docs about Debugging and Data Structures Tutorial. Bug Fixes¶ The atleast_2d keyword had no effect on Ranges consisting of a single cell and was raising an error when used in combination with the asarray keyword. Both have been fixed (GH53): >>> Range ( 'A1' ) . value = 1 >>> Range ( 'A1' , atleast_2d = True ) . value [[1.0]] >>> Range ( 'A1' , atleast_2d = True , asarray = True ) . value array([[1.]])

[Mac]: After creating two new unsaved Workbooks with Workbook() , any Sheet , Range or Chart object would always just access the latest one, even if the Workbook had been specified (GH63).

[Mac]: When xlwings was imported without ever instantiating a Workbook object, Excel would start upon quitting the Python interpreter (GH51).

[Mac]: When installing xlwings, it now requires psutil to be at least version 2.0.0 (GH48).

v0.2.1 (August 7, 2014)¶ API changes¶ None Enhancements¶ All VBA user settings have been reorganized into a section at the top of the VBA xlwings module: PYTHON_WIN = "" PYTHON_MAC = GetMacDir ( "Home" ) & "/anaconda/bin" PYTHON_FROZEN = ThisWorkbook . Path & " \b uild\exe.win32-2.7" PYTHONPATH = ThisWorkbook . Path LOG_FILE = ThisWorkbook . Path & "\xlwings_log.txt"

Calling Python from within Excel VBA is now also supported on Mac, i.e. Python functions can be called like this: RunPython("import bar; bar.foo()") . Running frozen executables ( RunFrozenPython ) isn’t available yet on Mac though. Note that there is a slight difference in the way that this functionality behaves on Windows and Mac: Windows : After calling the Macro (e.g. by pressing a button), Excel waits until Python is done. In case there’s an error in the Python code, a pop-up message is being shown with the traceback.

: After calling the Macro (e.g. by pressing a button), Excel waits until Python is done. In case there’s an error in the Python code, a pop-up message is being shown with the traceback. Mac: After calling the Macro, the call returns instantly but Excel’s Status Bar turns into “Running…” during the duration of the Python call. Python errors are currently not shown as a pop-up, but need to be checked in the log file. I.e. if the Status Bar returns to its default (“Ready”) but nothing has happened, check out the log file for the Python traceback. Bug Fixes¶ None Special thanks go to Georgi Petrov for helping with this release.

v0.2.0 (July 29, 2014)¶ API changes¶ None Enhancements¶ Cross-platform: xlwings is now additionally supporting Microsoft Excel for Mac. The only functionality that is not yet available is the possibility to call the Python code from within Excel via VBA macros.

The clear and clear_contents methods of the Workbook object now default to the active sheet (GH5): wb = Workbook () wb . clear_contents () # Clears contents of the entire active sheet Bug Fixes¶ DataFrames with MultiHeaders were sometimes getting truncated (GH41).

v0.1.1 (June 27, 2014)¶ API Changes¶ If asarray=True , NumPy arrays are now always at least 1d arrays, even in the case of a single cell (GH14): >>> Range ( 'A1' , asarray = True ) . value array([34.])

Similar to NumPy’s logic, 1d Ranges in Excel, i.e. rows or columns, are now being read in as flat lists or 1d arrays. If you want the same behavior as before, you can use the atleast_2d keyword (GH13). Note The table property is also delivering a 1d array/list, if the table Range is really a column or row. >>> Range ( 'A1' ) . vertical . value [1.0, 2.0, 3.0, 4.0] >>> Range ( 'A1' , atleast_2d = True ) . vertical . value [[1.0], [2.0], [3.0], [4.0]] >>> Range ( 'C1' ) . horizontal . value [1.0, 2.0, 3.0, 4.0] >>> Range ( 'C1' , atleast_2d = True ) . horizontal . value [[1.0, 2.0, 3.0, 4.0]] >>> Range ( 'A1' , asarray = True ) . table . value array([ 1., 2., 3., 4.]) >>> Range ( 'A1' , asarray = True , atleast_2d = True ) . table . value array([[ 1.], [ 2.], [ 3.], [ 4.]])

The single file approach has been dropped. xlwings is now a traditional Python package. Enhancements¶ xlwings is now officially suppported on Python 2.6-2.7 and 3.1-3.4

Support for Pandas Series has been added (GH24): >>> import numpy as np >>> import pandas as pd >>> from xlwings import Workbook , Range >>> wb = Workbook () >>> s = pd . Series ([ 1.1 , 3.3 , 5. , np . nan , 6. , 8. ]) >>> s 0 1.1 1 3.3 2 5.0 3 NaN 4 6.0 5 8.0 dtype: float64 >>> Range ( 'A1' ) . value = s >>> Range ( 'D1' , index = False ) . value = s

Excel constants have been added under their original Excel name, but categorized under their enum (GH18), e.g.: # Extra long version import xlwings as xl xl . constants . ChartType . xlArea # Long version from xlwings import constants constants . ChartType . xlArea # Short version from xlwings import ChartType ChartType . xlArea

Slightly enhanced Chart support to control the ChartType (GH1): >>> from xlwings import Workbook , Range , Chart , ChartType >>> wb = Workbook () >>> Range ( 'A1' ) . value = [[ 'one' , 'two' ],[ 10 , 20 ]] >>> my_chart = Chart () . add ( chart_type = ChartType . xlLine , name='My Chart', source_data=Range('A1').table) alternatively, the properties can also be set like this: >>> my_chart = Chart () . add () # Existing Charts: my_chart = Chart('My Chart') >>> my_chart . name = 'My Chart' >>> my_chart . chart_type = ChartType . xlLine >>> my_chart . set_source_data ( Range ( 'A1' ) . table )

pytz is no longer a dependency as datetime object are now being read in from Excel as time-zone naive (Excel doesn’t know timezones). Before, datetime objects got the UTC timezone attached.

The Workbook class has the following additional methods: close()

The Range class has the following additional methods: is_cell() , is_column() , is_row() , is_table() Bug Fixes¶ Writing None or np.nan to Excel works now (GH16 & GH15).

or to Excel works now (GH16 & GH15). The import error on Python 3 has been fixed (GH26).

Python 3 now handles Pandas DataFrames with MultiIndex headers correctly (GH39).

Sometimes, a Pandas DataFrame was not handling nan correctly in Excel or numbers were being truncated (GH31) & (GH35).

correctly in Excel or numbers were being truncated (GH31) & (GH35). Installation is now putting all files in the correct place (GH20).