Wing Tips

Unit Testing in Wing Pro

Thu, 08 Jun 2023 01:00:00 GMT

This Wing Tip introduces the Testing tool in Wing Pro, which can be used to run and debug unit tests designed for the unittest, pytest, doctest, nose, or Django testing frameworks. Wing can collect code coverage statistics, so you can see if your tests are properly exercising your code, and so that Wing can determine which tests need to be re-run after you make edits to your code.

Identifying Test Files

You can identify files to run as tests in your project either by setting Test file patterns under the Testing tab in Project Properties (accessed from the Project menu) or by adding individual test files with Add Single File and Add Current File in the Testing menu.

Running and Debugging Tests

Once you have identified test files, you should see them listed in the Testing tool and can use the Run Tests button to run them. The Testing tool will update as tests complete, indicating which tests passed and failed. This includes display of any exception encountered and output from the tests.

Failed tests may then be debugged by selecting them in the Testing tool and pressing the Debug Tests button:

Shown above: Running unit tests in Wing Pro, inspecting test results, and debugging one failed test.

The items in the Testing menu can be used to run or re-run tests selectively, for example only those at the caret in the editor, those that previously failed, or those that have not yet been run.

Code Coverage

To enable collection of code coverage statistics, make sure you have installed coverage (for example with pip install coverage), select Use Code Coverage in the Testing tool, and then run some or all of your unit tests. Wing annotates every line of code in editors to indicate whether that line was reached by any of the unit tests that you have run. Hover the mouse cursor over lines marked in green to see which tests reached that line:

Shown above: Code coverage marks indicate which lines of code have been tested.

When code coverage is enabled, Wing will watch your edits in order to determine which previously run test results are invalidated by those edits. Any tests that reached the edited code will be marked as invalid in the Testing tool by changing the color of the test result icon to yellow:

Shown above: A unit test result is invalidated by editing code that was reached by that test. All the tests with invalidated test results are then re-run with Run Stale Tests in the Testing menu.

An HTML code coverage report and various code coverage data export options are available in the Testing menu.

For more information on unit testing and code coverage in Wing Pro, see the Unit Testing documentation.

That's it for now! We'll be back soon with more Wing Tips for Wing Python IDE.

As always, please don't hesitate to email support@wingware.com if you run into problems or have any questions.

Source Assistant in Wing Pro

Thu, 08 Jun 2023 01:00:00 GMT

This Wing Tip introduces the Source Assistant tool in Wing Pro, which provides context-sensitive at-your-fingertips code intelligence and documentation as you navigate through or write Python code.

The Source Assistant is where Wing Pro shows details about the type of a symbol, including documentation, call signature, and information about object inheritance and overridden methods. For builtin types and the standard library, this includes also links into Python documentation.

The Source Assistant is integrated with every part of Wing IDE, so it shows information for the current selection in the editor, auto-completer, Python Shell, Source Browser, Project manager, and Debug Console. It continuously updates as you move through your code or write new code.

Here are some examples of the Source Assistant in action in the editor, auto-completer, and Source Browser:

Shown above: Moving through code in the editor, the auto-completer, and Source Browser to view type signature, documentation, and other code intelligence in Wing Pro's Source Assistant tool.

See the Source Assistant documentation for details.

That's it for now! We'll be back soon with more Wing Tips for Wing Python IDE.

As always, please don't hesitate to email support@wingware.com if you run into problems or have any questions.

Live Interactive Python Coding in Wing Pro

Thu, 08 Jun 2023 01:00:00 GMT

This Wing Tip describes how to use the debugger in Wing Pro to write new Python code with direct access to the runtime state that the code is intended for, so you can immediately try out the code that you write. This is a far more efficient way to write most code, compared with working offline.

The key to working interactively in Wing is to run the debugger to a breakpoint in the code that you are working on. Once this is done, the auto-completer and other code intelligence features in Wing use both static analysis and runtime type analysis in code that is active on the debug process stack. The source of a symbol in the completer is indicated with the cog "runtime" icon.

In this context, you can immediately try out newly written code, and retry it as often as needed after correcting errors, by executing it in Wing Pro's Debug Console tool. You do need to be mindful of what the (possibly incorrect) code that you try does to the runtime state and restart the debugger if it becomes invalid. But in most cases it is possible to re-run corrected code and work iteratively without restarting your code.

Here is an example of live interactive coding in Wing Pro after running to a breakpoint in the editor:

Shown above: Entering code while the debugger is at a breakpoint, with auto-completion and auto-editing features that inspect the live runtime state of the debug process, then trying out an invocation in the Debug Console.

Notice that the above example uses a conditional breakpoint, as described in the previous Wing Tip. These are a great way to select the specific runtime case for which you want to write new code, for example to fix a bug that occurs only in a particular scenario.

Active Ranges

The above example simply copied and pasted code into the Debug Console in order to try it out. In many cases it's easier to select a range of lines that you are working on and mark those as the "active range", so that they can be executed and re-executed repeatedly as needed.

This is done by selecting the lines in the editor and pressing the active range icon in the top right of the Debug Console. Once an active range is set, the icon in the Debug Console will execute it in the current debug stack frame.

See the Interactive Debug Console documentation for details.

That's it for now! We'll be back soon with more Wing Tips for Wing Python IDE.

As always, please don't hesitate to email support@wingware.com if you run into problems or have any questions.

Auto Completion in Wing Pro

Thu, 08 Jun 2023 01:00:00 GMT

In this issue of Wing Tips we introduce Wing Pro's auto-completer, which can be used to find and more quickly enter symbols, imports, and snippets into Python code.

By default, Wing shows the auto-completer as you type in the editor, populating the completer with whatever code symbols and snippets are relevant to the particular context you are working in. The arrow keys can be used to move up and down the completion list and a completion is selected by pressing Tab or other completion key configured with the Editor > Auto-completion > Completion Keys preference in Wing. The same preferences group lets you specify whether to show the completer immediately or only after a certain number of characters or elapsed time, how to place the completion, and various other options.

Here is what the completer looks like in action:

Shown above: Using the auto-completer to enter new Python code in Wing Pro.

Notice that the auto-completer contains two columns of icons like and that indicate the origin and type of the symbol. These are described in detail in Auto-completion Icons.

Auto-Import

In Wing 9.1 and later the auto-completer also contains suggestions for modules you may want to import for the code that you are writing. When these completions are selected, Wing enters the symbol for the selected import at the current position in the editor and also adds the necessary import statement at the top of your file:

Shown above: Using the auto-completer to enter code and new import statements simultaneously.

The Editor > Auto-completion > Python Auto-Imports preference controls whether to always show auto-imports, show them only on request, or to hide them entirely from the completer. See also the Imports tool.

Snippets

The completer also offers code snippets appropriate for the current context. These are indicated with the scissors icon. The default set of snippets that come with Wing Pro may be viewed and altered in the Snippets tool in the Tools menu.

Here is an example of entering snippets with the auto-completer, using the Tab key to move between and fill out fields in the snippets:

Shown above: Using the auto-completer to enter code snippets for a class, a method, and a nested definition, showing how snippets can take different forms depending on their context in the code.

See the Code Snippets documentation for more information.

That's it for now! We'll be back next week with more Wing Tips for Wing Python IDE.

Turbo Completion Mode in Wing Pro

Wed, 19 Jan 2022 01:00:00 GMT

In this issue of Wing Tips we look at how to use Wing Pro's turbo completion mode for Python. Auto-completion normally requires pressing a completion key, as configured by the Editor > Auto-completion > Completion Keys preference, before a completion is entered into the editor.

Wing Pro also provides a Python Turbo Mode for auto-completion, where completion occurs on any key that cannot be part of a symbol. This allows you to type just enough of a symbol until it is selected in the completer, then move right on to typing the code that follows that symbol. It takes some getting used to, but it can greatly reduce typing once you become comfortable with it.

The following example shows the code that can be produced simply by typing the characters p=x.p.e.P( without pressing any completion keys:

This particular case requires only a single character to match each symbol in the auto-completer. In a more cluttered name space, it may take more characters to match the desired symbol, but in many cases two or three characters is all that is needed before you can move on to the next part of the expression you are trying to type.

Notice that turbo mode distinguishes between contexts where a new symbol may be defined and those where an existing symbol must be used. For example, if you type c followed by = on a new line, Wing knows that the = indicates you may be defining a new symbol and does not place the current selection from the auto-completer. When you do want completion to occur in a defining context, you can press Tab or another completion key.

In a context where you are trying to type something other than what is in the completer, you can press Ctrl, Alt or Command briefly by itself to hide the auto-completer and thus disable turbo-completion until you type more symbol characters and the completer is displayed once again.

Turbo completion is enabled with the Editor > Auto-completion > Python Turbo Mode preference in Wing Pro.

That's it for now! We'll be back next week with more Wing Tips for Wing Python IDE.

Debug Python Code Run by Docker Compose with Wing Pro

Tue, 21 Sep 2021 01:00:00 GMT

This Wing Tip describes how to configure Docker Compose so that Python code running on selected container services can be debugged with Wing Pro. This makes it easy to develop and debug containerized applications written in Python.

Getting Started

Before you can work with Docker Compose you will need to download and install it and then create a working test cluster. See Install Docker Compose for details.

You should also install Wing Pro if you don't already have it.

Configuration

To configure Wing to use New Project in the Project menu. After selecting your source directory, choose Use Existing Python on the second dialog page, and then select Cluster:

Next create a new cluster configuration by pressing the New button. This displays the cluster configuration dialog. You will need to enter an identifier to use within Wing and point it at the docker-compose.yml file for the cluster. You will also need to select the main service to use as the default place to run your Python Shell and unit test processes:

Once you have created your cluster configuration, submit the New Project dialog to complete your project setup.

Working with the Cluster

You can now control your cluster from Wing's Containers tool, found in the Tools menu. This tool lists the services in your cluster and their status. You can right-click on items here or use the Options menu to build, start, debug, and stop your cluster:

Debug processes, unit tests, Wing's integrated Python Shell and OS Commands can all be run in context of the cluster, or optionally instead within isolated containers that match the cluster configuration but run without launching the whole cluster.

See Using Wing Pro with Docker Compose for more information working with clusters in Wing Pro.

That's it for now! We'll be back soon with more Wing Tips for Wing Python IDE.

As always, please don't hesitate to email support@wingware.com if you run into problems, have any questions, or have topic suggestions for future Wing Tips!

Using Docker with Wing Pro 8

Mon, 13 Sep 2021 01:00:00 GMT

Wing Pro 8 significantly improved support for working with Python code that runs on containers like those provided by Docker, making it easier to configure projects that use Docker, and adding support for creating new Docker environments during project creation.

Prerequisites

Before you can work with Docker you will need to download and install it.

On Windows and macOS, downloading Docker Desktop from the Docker website is the easiest way to install it. Be sure to launch the Docker Desktop after you install it, so the daemon is started.

On most Linux distributions, Docker CE (the free community edition) can be installed with the docker-engine package as described here.

You should also install Wing Pro if you don't already have it.

Project Configuration

You can either create a new Docker container along with a new Wing project or use an existing container configuration.

In order to experiment with Docker, the easier of these two options is to create a new Docker container along with your project. To do this, choose New Project from the Project menu, select or create a source directory, and then on the second dialog screen choose Create New Environment with environment type Docker and Create New Container. You should be able to use the default values entered for Image ID, Host-side Directory, and Container-side Directory and simply go ahead with the environment and project creation by pressing Create Project:

If you want to use an existing Docker container configuration instead, create a new project with New Project in the Project menu, select or create a source directory, and then on the second dialog page select Create New Environment with environment type Docker and With Existing Container. You will need to enter at least the container image and host-to-container file mapping. In most cases, selecting a Dockerfile is easier than entering and image ID, since this also reads the host to container file mapping from the Dockerfile:

Both of these options create a new container configuration and set up Python Executable in your new project's Project Properties to use that container. You can make later changes to your configuration from there.

If you created a new Docker container, it will be built in the Containers tool, which is available in Wing's Tools menu. The container won't be ready for use until that process completes. This may take some time if container images are being downloaded.

How it Works

Once your project setup is complete and the Docker container has been built, Wing will run debug processes, unit tests, and the Python Shell on an instance of the selected container. Filenames are mapped automatically between the local and container-side copy of files. The debugger will display the local file even though the container's copy of the file is being executed.

OS Commands can optionally run commands on the container or on the local host. This is controlled by toggling the Run in Container option in the OS Command configuration.

Note that each debug process, each unit test run, and each instance of the Python Shell creates its own independent instance of the container.

Python Package Management in Wing Python IDE

Sun, 12 Sep 2021 01:00:00 GMT

Last time we looked at how to configure and create Python environments from Wing Pro. In this Wing Tip we'll take a look at managing your pip, Poetry, pipenv, or conda Python environment from Wing Pro's Packages tool.

Prerequisites

Wing Pro's Packages tool (in the Tools menu) can work with Python environments that are managed by pip, Poetry, pipenv, or conda. Regardless of which one is used, Wing assumes that pip is available in your selected Python installation. This is almost always the case in modern Python versions, or use getpip.py to install it.

Before trying Wing's package management features, you will want to set up a new project with a new virtualenv, Poetry, pipenv, or conda environment and save the project to the top level of your source directory. This way you can experiment with the Packages tool without altering one of your Python environments unexpectedly.

Conda package management will only work from Wing if the base Anaconda installation can be found. See Package Management with conda for details.

Viewing Packages

Once your project is saved, Wing should auto-detect which package manager is in use in the Python environment you selected for the project and determine whether a requirements.txt file is in use. A summary of the found Python environment is shown in the Packages tool, along with a list of packages installed into that environment:

Managing Packages

To install new packages into your environment, use Install New Packages in the Packages tool's Options menu:

You can remove, update, or set a specific package version by right-clicking on the packages list:

Wing runs the appropriate package management operations, updates the package list, and displays any output from the package management command in a console that may be viewed with Show Console in the Packages tool's Options menu.

Updating requirements.txt

If you are using pip or conda, Wing can automatically update a requirements.txt that is located in the same directory as your project file or in the Project Home Directory configured under the Options tab of Project Properties.

A new requirements.txt file may be created from your current Python environment with Initialize requirements.txt from the Options menu and later updated with Freeze to requirements.txt. If the Auto-Update requirements.txt item is checked in the Options menu, then the file will automatically be updated after all package management operations run from Wing:

From here you can also set up your Python environment based on an existing requirements.txt file, with Install Missing Packages and Remove Unused Packages. This is useful the first time you check out a code base on a new machine, in order to get your Python environment set up quickly.

Poetry

If you are using Poetry, Wing defers to Poetry to keep its package management files up to date as you issue package management commands. You can however refresh the Poetry.lock file from the Packages tool's Options menu and Install Missing Packages can be used to initialize a Poetry environment from Poetry.lock on a new development machine.

Pipenv

Similarly, if you are using pipenv, Pipfile and Pipfile.lock are used instead of requirements.txt. Wing defers to pipenv to keep the Pipfile up to date as you issue package management commands. You can however refresh the Pipfile.lock file from the Packages tool's Options menu and Install Missing Packages can be used to initialize a pipenv environment from Pipfile.lock on a new development machine.

Conclusion

In most cases, these are all the package management operations you will need in order to set up and manage your Python environment on each development machine.

See the Package Manager documentation for a detailed description of all the available package management features and options. This also describes the quirks of each package management system, some of which you may need to understand in order to use them successfully with Wing.

That's it for now! We'll be back soon with more Wing Tips for Wing Python IDE.

As always, please don't hesitate to email support@wingware.com if you run into problems or have any questions.

Using virtualenv, Poetry, pipenv, and Anaconda environments with Wing Python IDE

Sat, 11 Sep 2021 01:00:00 GMT

Last time we looked at how to create projects in Wing. In this Wing Tip let's look more closely at how to configure your project to use or create Python environments managed by virtualenv, Poetry, pipenv, or Anaconda.

Configuring an Existing Project

For an existing Wing project, you can specify an environment as the Python Executable in Project Properties (from the Project menu) in one of two ways:

(1) Select Activated Env and enter the full path to the environments activation script. This is the activate or activate.bat associated with the environment:

The drop down menu next to the entry area lists discovered environments and those which have been used recently:

or (2) Select Command Line and enter the full path to the environment's python or python.exe. This executable both activates the env and runs Python, so all the code Wing launches will run in the environment:

When in doubt about which path to use, run your environment outside of Wing and inspect the value of sys.executable after import sys. That is the value you want to use.

Activated environments can be used in the same way in other settings where a Python Executable can be specified, for example for Launch Configurations and in a Remote Host configuration.

Creating a New Project

There are two options available for environments, when starting a new project from the Project menu: (1) Creating a new enviroment and new Wing project at the same time, or (2) Creating a new Wing project that uses an existing environment.

Creating a New Environment

To create a new environment along with your project, select New Project from the Project menu, select or create your source directory, and press Next. On the second screen, choose Create New Environment and select the type of environment you wish to create. You will then need to enter the name for the environment, select a parent directory, and optionally specify packages to install and/or the base Python Executable to use. For example:

The options to enter vary slightly by type of environment being created. For example, Poetry and pipenv use the selected source directory and does not need environment name and parent directory. Also, Anaconda environments require that you install at least one package.

When you press Create Project, Wing will create the environment, install packages, and then configure and save a project file. You can immediately start working in your new environment, which Wing automatically activates for you whenever you have the project open.

Using an Existing Environment

To use an existing virtualenv or Anaconda environment, select New Project from the Project menu, select or create your source directory, and press Next. On the second screen, select Use Existing Python and select Activated Env under Python Executable. You can then select a recent or found environment from the drop down or manually enter your activation command:

To use an existing Poetry or pipenv directory, you instead simply select Use Existing Directory in the New Project dialog and Wing will auto-detect that this directory already contains a Poetry or pipenv environment to use with the project:

In this case, Wing immediately displays the Create Project button and will use that environment with your project.

Notes

Once your project has been set up, you can use the Packages tool in the Tools menu to add, remove, or upgrade packages in your Python environment. We'll describe this in more details the next Wing Tip, or see Package Manager for details.

For some additional details on each type of environment, see Using Wing with virtualenv, Using Wing with pipenv, Using Wing with Poetry, and Using Wing with Anaconda.

That's it for now! We'll be back soon with more Wing Tips for Wing Python IDE.

As always, please don't hesitate to email support@wingware.com if you run into problems or have any questions.

Creating a Project for an Existing Code Base

Fri, 10 Sep 2021 01:00:00 GMT

Wing 8 introduced some improvements and new capabilities for the project creation process. In this Wing Tip, we'll take a look at the options available during project creation in Wing Pro.

Note that Wing Personal also has the concept of projects, but omits support for remote development, cloning from revision control repositories, creating Python environments with the project, and support for specific third party packages and tools like Django, Flask, Jupyter, Docker, Poetry, pipenv, and others. As a result, many of the options described below are not available in Wing Personal.

Selecting Directory and Project Type

New projects are created with New Project in the Project menu. This displays a dialog that allows you to select the source code to use with the new project and to select or configure the Python environment you plan to use:

From here it's possible to create an entirely blank project, which you can configure later, or you can set up your project with an existing source directory or create a new source directory along with the project.

Note that you can create a project for remote development here, but for now ignore this option and leave Host set to Local Host. We'll talk about remote development in future Wing Tips.

Using an Existing Directory

If you already have a Python code base you want to use with Wing, select Use Existing Directory and choose the directory to use:

Creating a New Directory

If you are starting a new project from scratch, select Create New Directory and enter the directory name, parent directory, optionally select a revision control repository to clone into the new directory (for example, by entering a Github repository url), and select the unit testing framework that you plan to use, if any:

Project Type

Whether you're using an existing directory or creating a new one, you will be able to specify a Project Type from this page of the New Project dialog. If you are using a Python package listed in the Project Type drop down, select that also. This tells Wing how to configure your project to work properly with your code:

If your project type is not listed, leave this value set to Custom. In this case, you can opt to ask Wing to configure your project to allow debug processes to be launched from outside of the IDE, for example by a web server or another app. If this will be the case, check on the Use wingdbstub for Debugging option. If you don't yet know how you will launch debug, leave this unchecked. You can always configure this later.

Selecting a Python Environment

At this point, if you used an existing source directory, Wing looks in the directory for a Python environment managed by Poetry, pipenv, or virtualenv and pip. If it finds one, it will use that with the new project and you can simply press the Create Project button.

Otherwise, press Next to select or configure a Python environment for the project.

You can then either use an existing Python environment with your project or create a new one. If you already have a Python environment to use, select Use Existing Python:

You can specify the Python to use by selecting the default Python, entering a custom command line that invokes Python, selecting an activated environment, or setting up a container or cluster environment. The latter two options will be described in future Wing Tips.

The Use default option causes Wing to use the Python that is run from the command line or the latest found version if Python is not on the PATH.

Command Line is used to specify the full path command line that invokes Python. For virtualenv, Poetry, and pipenv this can be the python or python.exe executable that is found in the environment.

Activated Env is used to specify the activation command for an existing Python environment. Wing runs this command and then starts Python within the env.

Both the Command Line and Activated Env options provide a drop down that lists all the found Python installations and environments Wing was able to find on your system.

Creating a Python Environment

Another option is to create a new Python environment along with your project. This is done by selecting Create New Environment on the second New Project screen and then choosing the type of environment to create:

Wing can create environments managed by Anaconda, Docker, Poetry, pipenv, and virtualenv with pip. The options entered for each of these differ. We'll describe this in more detail in the next Wing Tip or take a look at these links for more information: Poetry | Anaconda | Docker | pipenv | virtualenv

Finishing Up

Once your Python environment has been selected or configured, press Create Project and Wing will show a progress dialog as it creates and configures everything.

As part of this process, Wing saves the project automatically if you created a new source directory. Otherwise, you will need to save the project, which is typically best done to the top level of your project source tree.

That's it for now! We'll be back next week to continue this Wing Tips mini-series on navigating Python code with Wing.

As always, please don't hesitate to email support@wingware.com if you run into problems or have any questions.

Multiple Selections in Wing Python IDE

Thu, 01 Oct 2020 01:00:00 GMT

In this issue of Wing Tips we look at how to use multiple concurrent selections in Wing's editor. These can be used to replace all occurrences of some text or to apply the same edits to any number of selections, for example surround them all with quotes or remove common surrounding characters. Multiple selections can be created from the keyboard, from the mouse, or by using commands that select all occurrences of some text found within a selected code.

Creating Multiple Selections

The most common way to make multiple selections is to select a range of text in Wing's editor and then add other occurrences of the same text with Add Selection for Next Occurrence in the Edit > Multiple Selections menu. The default key binding for this is Ctrl-D, or Command-D on macOS, and Ctrl-> in the emacs keyboard personality.

Another way to add selections is to click on the multi-selection toolbar item . This menu includes items to select all occurrences in a file, class, function/method, or block of code:

Editing Selections

Once the selections are made your edits will be applied to all of them in the same way, as in the following example which replaces all occurrences of the word "stocks" with "trades":

Edits applied to all selections may include cursor movement, pasting, and other editing actions. For example selecting a number of commas, pressing the right arrow key, and then Space adds a space after all the commas:

Multi-Selecting with the Mouse

Multiple selections can also be made by clicking or double-clicking the mouse while holding Ctrl-Alt (or Option-Command on macOS). This allows selecting ranges that don't necessarily contain the same text:

Omitting Selections

By default, Wing displays a floating window that enumerates the selection made. You can omit selections from here by moving the mouse over an item and clicking on the red X icon that appears over it. Edits made subsequently are applied only to the selections that remain:

Configuration Options

Whether occurrences used for multi-selection match any text or only whole words, and whether they are case sensitive, may be controlled from the Edit > Multiple Selections menu or the multi-selection toolbar item .

The multi-selection popup window can also be entirely enabled or disabled from here, with the Configure Selections Window item.

That's it for now! We'll be back next week with more Wing Tips for Wing Python IDE.

Extend Microsoft Excel with Python Using Wing and PyXLL

Wed, 24 Jun 2020 01:00:00 GMT

This Wing Tip describes how to use Wing and PyXLL to develop and debug Microsoft Excel add-ins that are written in Python. PyXLL is a commercial product that embeds Python into Microsoft Excel on Windows. It allows you to expose Python code to Excel as worksheet functions, macros, menus, and ribbon toolbars.

Install PyXLL

Before getting started you will need to install Microsoft Excel, Python or Anaconda, Wing, and PyXLL if you don't already have them.

Important: Excel, PyXLL and Python all need to be either 32 bit or 64 bit and can't be mixed. To find out what version of Excel you have see Do I have 32 bit or 64 bit Excel? You will also need to match the version of PyXLL that you download to your Python version.

To install PyXLL, unzip the download and then edit the included pyxll.cfg and set executable to the full path of your Python executable. This can be a python.exe from a virtualenv or conda env, or a base Python install. For example:

[PYTHON]
executable = C:\Users\joebloggs\Anaconda\envs\py38\python.exe

Next, install the PyXLL add-in into Excel. To do that, open Excel and select the File menu. Navigate to Options, then Add-Ins, and click the Manage Excel Add-Ins button. Select Browse, navigate to the folder where you unzipped the PyXLL download, and select the pyxll.xll file. If Excel asks if you want to copy the add-in to your add-ins folder, select No as you want to leave it where it is. The PyXLL add-in should now appear in your list of loaded add-ins.

If you're having trouble installing the add-in, check the PyXLL log file located in the logs folder where you unzipped PyXLL. You can change the log level to debug in your pyxll.cfg file to obtain more detailed logging. If you get stuck contact the PyXLL support team who will help you get started.

You can also find more detailed installation instructions in Installing the PyXLL Excel Add-In.

Create a Wing Project

Next create a new project in Wing with New Project in the Project menu. Select Use Existing Directory and select the directory where you installed PyXLL and set Project Type to PyXLL.

After pressing Next, select Use Existing Python, set Python Executable to Command Line and enter the same Python used as the executable in pyxll.cfg above:

Now you can submit the dialog and Wing will create and configure your new project.

Write an Excel Function With PyXLL

Before we look at setting up Wing's debugger, let's write an Excel function to debug. This example uses pandas and numpy, so you will need to make sure those are installed into the Python you configured above. If you are using Anaconda, then you should already have them. In other cases, this can be done with pip. For example:

C:\Users\joebloggs\Anaconda\envs\py38\python.exe -m pip install pandas numpy

Now create a Python module for your Excel function by creating a new directory on disk and placing a Python file into that directory, with the following contents:

from pyxll import xl_func
import pandas as pd
import numpy as np

@xl_func("int, int: dataframe<index=True>", auto_resize=True)
def random_dataframe(rows, columns):
    """
    Creates a DataFrame of random numbers.

    :param rows: Number of rows to create the DataFrame with.
    :param columns: Number of columns to create the DataFrame with.
    """
    data = np.random.rand(rows, columns)
    column_names = [chr(ord('A') + x) for x in range(columns)]
    df = pd.DataFrame(data, columns=column_names)

    return df

The directory and filenames can be anything, but in this example we'll use C:\Users\joebloggs\Projects\PyXLL\src for the directory and xlfuncs.py as the file name.

Next update the pythonpath and modules setting in the same pyxll.cfg file where you set executable earlier:

[PYTHON]
pythonpath =
    C:\Users\joebloggs\Projects\PyXLL\src

[PYXLL]
modules =
    xlfuncs

Note that the entry under modules omits the .py in the filename.

Once this is done, reload the PyXLL add-in via the PyXLL ribbon tool bar or the add-ins menu in Excel, or restart Excel. PyXLL can also be configured to auto-reload after any change made to the Python code. See Reloading in the PyXLL guide for details.

How it Works

As you may already have figured out, the example Excel function random_dataframe given above creates a pandas DataFrame containing random data, and returns that to Excel as an array function.

The @xl_func decorator tells PyXLL to use it as an Excel worksheet function. The first argument to the decorator is an optional function signature. PyXLL uses this to determine how arguments and return values should be converted between the Excel and Python data types. The example here uses the dataframe return type to tell PyXLL to expand the pandas DataFrame to an array of values when returning to Excel, including the index. The auto_resize option tells PyXLL that the Excel formula should be resized automatically to fit the size of the returned array.

Tip: In order for Wing to recognise the @xl_func decorator as a valid defined symbol, you will need to install the .whl file included in the PyXLL download using pip install followed by the full path of the .whl file. You can also invoke pip with the -m command line argument for Python, as shown above for installation of pandas and numpy.

Invoke the PyXLL Function

Now you should be able to call the random_dataframe function from Excel by entering it as a formula in an Excel worksheet. This is done in the same way as Excel's standard functions by using = followed by the function name, for example =random_dataframe(10, 10):

Shown Above: Type "=random_dataframe(10,10)" and press Enter to insert a random DataFrame into Excel

For complete instructions on writing Excel worksheet functions in Python with PyXLL, please see Worksheet Functions in the PyXLL user guide.

Set up Wing's Debugger

To enable debugging, you need to tell Wing to accept connections from Python code running under Excel and then configure and load the debugger into Excel. To do this from the project you created earlier, click on the bug icon in the lower left of Wing's window, and check Accept Debug Connections:

Now hovering your mouse over the bug icon should show that Wing is listening for externally initiated debug connections on the local host:

If Wing is not listening, it may be that it has not been allowed to do so by Windows. In that case, try restarting Wing so that Windows will prompt you to allow network connections.

Next, find the Install Directory listed in the About box accessed from the Help menu in Wing. Copy wingdbstub.py from that directory to the directory that contains xlfuncs.py.

Then open your copy of wingdbstub.py and make the following changes:

Make sure WINGHOME is set to the full path of your Wing installation, where you just found wingdbstub.py. This is usually set automatically during installation of the IDE.

Change the value of kEmbedded to 1. This alters some aspects of how code is debugged, to match the environment your Python code will be running in.

To get Excel to load Wing's debugger, add wingdbstub to the modules list in your pyxll.cfg file:

[PYXLL]
modules =
    wingdbstub
    xlfuncs

Finally, restart Excel or reload the PyXLL add-in. When the wingdbstub module is loaded it will connect to Wing and the bug icon in the lower left of Wing's window will turn green, in order to let you know that the debugger is connected:

Debugging Python Code Invoked from Excel

You can now step through the Python code running in Excel.

To try it out, set a breakpoint in xlfuncs.py by opening it in Wing and clicking on the leftmost margin next to the the line that reads data = np.random.rand(rows, columns) within random_dataframe. When you call the function from Excel, the debugger will stop on the breakpoint:

Shown Above: Enter "random_dataframe(10,10)" into Excel on the left, reach a breakpoint in Wing on the right, and step through code

From here, you can inspect your debug process in the Debug Console (Wing Pro only) or Stack Data in Wing's Tools menu, set other breakpoints or conditional breakpoints (Wing Pro only), step through code, and so forth. For more information on the capabilities of Wing's debugger, see the Debugger Quick Start or the Tutorial in Wing's Help menu.

That's it for now! We'll be back soon with more Wing Tips for Wing Python IDE.

As always, please don't hesitate to email support@wingware.com if you run into problems, have any questions, or have topic suggestions for future Wing Tips!

Configuring Wing's Python Debugger for Your Code Base

Thu, 04 Jun 2020 01:00:00 GMT

This Wing Tip provides a roadmap to the configuration options available for Wing Pro's debugger, to make it easier to understand the available possibilities and how these can be applied to your development projects.

In short: Wing can develop and debug just about any kind of Python code, regardless of whether is resides locally or on a remote host, on a container or cluster, whether it's launched by the IDE from from the outside, and whether it is asynchronous, threaded, or runs in multiple processes. Read on for the details.

Configuration Options

Broadly speaking there are six ways to configure Wing's debugger:

Local Stand-Alone Code -- Wing can debug stand-alone scripts and applications that run on your local machine and that are launched on demand from within Wing. This development approach can be used for anything that is convenient to launch from the IDE, including scripts, desktop apps, and most web frameworks. See the Debugger Quick-Start for a quick introduction to this simple case.

Remote Stand-Alone Code -- Wing Pro can also debug stand-alone code running on a remote host, virtual machine or device, in the same way as it debugs locally running code. Wing uses a remote agent launched by SSH in order to work directly with files stored on the remote host, as if Wing were itself running on that system. For details, see Remote Development with Wing Pro.

Container and Cluster Code -- Wing Pro can debug code that runs on a container like those hosted by Docker or LXC/LXD, or clusters hosted by Docker Compose. In this case, editing, version control, and search operate files stored on your local disk, but code is transparently executed and debugged in the context of a container instance. For details, see Working with Containers and Clusters.

Local Externally Launched or Embedded Code -- Wing can debug locally running code that is launched by a web server or framework, embedded Python code that is used to script a larger application, and any other Python code that cannot be directly launched from the IDE. In this case, the code is started from outside of Wing and connects to the IDE by importing Wing's debugger. Debug can be controlled from the IDE and through an API accessible from the debug process. For details, see Debugging Externally Launched Code

Remote Externally Launched or Embedded Code -- Wing Pro can also debug externally launched or embedded code that is running on a remote system. In this case, Wing uses a remote agent to access the remote host via SSH and the debugged code imports Wing's debugger in order to connect back to the IDE through an automatically established reverse SSH tunnel. See Debugging Externally Launched Remote Code for brief instructions or Remote Web Development for a more detailed guide.

Manually Configured Remote Debugging -- For remote hosts and devices that are not accessible through SSH, or where Wing's remote agent cannot be run, Wing provides a manual configuration option to make debugging on these systems possible. In this case, the device must be able to connect to the host where Wing is running via TCP/IP, and there must be some file sharing configuration so files are available both locally and on the remote system. In this approach, connectivity, file sharing, and other configuration needed to make debugging possible is accomplished entirely manually, so it can be tailored to unusual custom environments. For details, see Manually Configured Remote Debugging.

VirtualEnv, Poetry, pipenv, and Anaconda Environments

In context of the above , Wing may be used with or without an environment created by virtualenv, Poetry, pipenv, or Anaconda's conda create.

Environments can be created with your Wing project as described in Creating Python Environments.

Alternatively, environments may be selected after the fact. For local debugging, this is done by setting the Python Executable in Project Properties. For remote debugging, it is set in the remote host configuration.

For virtualenv, Poetry, and pipenv, you can either set the Python Executable to Command Line and enter the full path to the environment's Python, or you can select Activated Env and enter the command that activates the environment. See Using Wing with virtualenv, Using Wing with Poetry, and Using Wing with pipenv for details.

For Anaconda environments, you must select Activated Env and then choose the environment from the drop down list to the right of this field. See Using Wing with Anaconda for details.

If you are working with containers or clusters, Wing uses the environment set up and managed by the container. See Working with Containers and Clusters, Using Wing with Docker, and Using Wing with LXC/LXD for details.

Specific Frameworks and Tools

Some frameworks and tools require some additional custom configuration to make them easy to work with in Wing. In addition to understanding the general options explained above, it is a good idea to seek out configuration details for the frameworks and tools that you use:

Wing's documentation contains configuration instructions for specific frameworks and tools such as Flask, Django, Jupyter, wxPython, PyQt, Blender, Maya, and others.
There is also additional information available for specific kinds of remote development for AWS, Docker, Vagrant, Windows Subsystem for Linux, Raspberry Pi, and others.

The New Project dialog accessed from the Project menu provides some assistance for setting up new Wing projects for most of these.

Multi-threaded and Multi-process Debugging

Wing automatically debugs any multi-threaded code without any additional configuration.

Multi-process code can also be debugged but requires turning on the Debug/Execute > Debug Child Processes option in Project Properties before child processes are automatically debugged. In this case, you may also want to configure specific options for how Wing handles and terminates child processes. See Multi-Process Debugging for details.

That's it for now! We'll be back soon with more Wing Tips for Wing Python IDE.

As always, please don't hesitate to email support@wingware.com if you run into problems or have any questions.

Conditional Breakpoints Wing Pro's Python Debugger

Wed, 20 May 2020 01:00:00 GMT

This Wing Tip describes how to use conditional breakpoints in Wing Pro to stop in Python code only when certain conditions are true. This is useful for isolating a single case out of many that may be processed by the same code in a particular run, in order to investigate how that case is being handled.

Conditional breakpoints are also a great way to select the runtime state for which you want to write new Python code, with the ability to immediately try out what you write.

To set a conditional breakpoint, right-click on the breakpoint margin in the editor and select Set Conditional Breakpoint:

Shown above: Right-click on the breakpoint margin to set a conditional breakpoint.

Then start debug with Start/Continue in the Debug menu, from the toolbar, or as shown here with Debug Tests in the Testing tool:

Shown above: Select a set of unit tests and debug them to reach the conditional breakpoint, then run to the next hit, step over a few lines, and press Shift-Space to view the value of all visible variables.

That's it for now! We'll be back soon with more Wing Tips for Wing Python IDE.

As always, please don't hesitate to email support@wingware.com if you run into problems or have any questions.

Moving the Program Counter in Wing's Python Debugger

Tue, 12 May 2020 01:00:00 GMT

This Wing Tip describes how to move the program counter while debugging Python code in Wing Personal and Wing Pro. This is a good way to go back and re-execute previously visited Python code, in order to trace through to the cause of a bug without having to restart the debug process.

To move the program counter, the debugger must be running and paused or stopped at a breakpoint. Then right-click on the target line in the editor and select Move Program Counter Here:

Shown above: Right-click to select Move Program Counter Here, then continue stepping with Step Over and Step Into in the toolbar.

Limitations: Due to the way Python is implemented, the program counter can only be moved within the current inner-most stack frame and it may not be moved within an exception handler, after an exception has been raised but not yet handled.

That's it for now! We'll be back soon with more Wing Tips for Wing Python IDE.

As always, please don't hesitate to email support@wingware.com if you run into problems or have any questions.

Wing Tips

Unit Testing in Wing Pro

Identifying Test Files

Running and Debugging Tests

Code Coverage

Source Assistant in Wing Pro

Live Interactive Python Coding in Wing Pro

Active Ranges

Auto Completion in Wing Pro

Auto-Import

Snippets

Turbo Completion Mode in Wing Pro

Debug Python Code Run by Docker Compose with Wing Pro

Getting Started

Configuration

Working with the Cluster

Using Docker with Wing Pro 8

Prerequisites

Project Configuration

How it Works

Further Reading

Python Package Management in Wing Python IDE

Prerequisites

Viewing Packages

Managing Packages

Updating requirements.txt

Poetry

Pipenv

Conclusion

Using virtualenv, Poetry, pipenv, and Anaconda environments with Wing Python IDE

Configuring an Existing Project

Creating a New Project

Creating a New Environment

Using an Existing Environment

Notes

Creating a Project for an Existing Code Base

Selecting Directory and Project Type

Using an Existing Directory

Creating a New Directory

Project Type

Selecting a Python Environment

Creating a Python Environment

Finishing Up

Multiple Selections in Wing Python IDE

Creating Multiple Selections

Editing Selections

Multi-Selecting with the Mouse

Omitting Selections

Configuration Options

Extend Microsoft Excel with Python Using Wing and PyXLL

Install PyXLL

Create a Wing Project

Write an Excel Function With PyXLL

How it Works

Invoke the PyXLL Function

Set up Wing's Debugger

Debugging Python Code Invoked from Excel

Configuring Wing's Python Debugger for Your Code Base

Configuration Options

VirtualEnv, Poetry, pipenv, and Anaconda Environments

Specific Frameworks and Tools

Multi-threaded and Multi-process Debugging

Conditional Breakpoints Wing Pro's Python Debugger

Moving the Program Counter in Wing's Python Debugger