Canopy Release Notes

This section lists major new features, fixes, and uncorrected issues known at release time. Where possible, we suggest workarounds.

Summary of release notes

Release notes for Canopy 1.5.1 (24 November 2014)

Resolved: Not clear that subscribers must log in to use debugger (#3169, #3187)

It was not clear to subscribers that they must log in to Canopy to gain access to the debugger features. This has been clarified in the UI and documentation.

Resolved: Issue fetching or using debugger license (#3177, #3178)

The email login ID was inappropriately case-sensitive during debugger license authentication. This resulted in the debugger not being enabled for the user if they logged in with a user ID with upper/lower case differences. This has been fixed.

Resolved: Migration errror (#3176)

Upgrading from Canopy < 1.4.0 could cause a failure in one of the migration scripts due to the use of older APIs. This specific migration script is not needed any longer due to other changes so it has been disabled.

Resolved: IPython Notebook fails loading content (#3181)

It was possible that only the first 2 cells of a notebook would be loaded from a saved IPython notebook file. This has been fixed.

Resolved: Update failure with corrupted preferences file (#3183)

If Canopy’s preferences file had incorrect syntax or other errors then it could cause a Canopy update to fail. Canopy will now gracefully recover from this problem situation.

Resolved: Unicode errors on non-ascii pathnames (#3180)

Added better handling of Python executable paths which might contain non-ascii characters.

Resolved: Missing item on Python pane directory drop-down menu (#3190)

The “Change working directory” menu item on the Python pane’s drop-down menu was missing, and now has been restored.

Release notes for Canopy 1.5.0 (19 November 2014)

New: Python Debugger (Beta)

Canopy now includes a Python GUI debugger, available to subscribers. It is tightly integrated with IPython’s debugger, and adds GUI tools for stepping through code and setting breakpoints. It also provides a variable browser that makes it quick and easy to inspect variables in the current Python namespace, including complex objects such as NumPy arrays. Full documentation is available within Canopy in the Help menu’s Documentation Browser, and online at Canopy Debugger Guide.

New: Run Configuration (#353)

When running a program from the Canopy Editor you can now specify the working directory and the command-line parameters that should be used when running the program. These are specified in the Run Configurations dialog, accessible from the Run Menu or the Run toolbar dropdown menu. The same run configurations can also be used when running the program in the new debugger.

New: Canopy Update notice in Package Manager (#1586)

When a Canopy GUI application update is available, a notice will now be shown in the Package Manager, in addition to the Welcome window as before..

New: IPython pane scrollback length (#1386)

A new item has been added to the Canopy Preferences dialog (Python tab) that allows the user to set the number of lines that will be buffered for scrolling back, in the IPython pane in the editor window.

Updated: IPython used within Canopy GUI updated to version 2.3 (#2964)

The IPython console and IPython notebooks in the Canopy GUI editor now use IPython 2.3. IPython 2 was a major release with many changes to notebooks including support for interactive widgets, directory navigation, modal user interface, improved security, and many other enhancements and bug fixes. See What’s new in IPython 2. Note that the latest version of IPython is usually available in a Canopy Command Prompt or Canopy Terminal window (see https://support.enthought.com/entries/22305234).

Updated: Package Manager improvements

The Canopy Package Manager internals have been updated to use the newer enstaller APIs. The Package Manager is now more robust. Multiple-package installs (e.g. “install all...”) can be canceled cleanly.

Issue: Linux: Default editor font is not fixed-width on CentOS (#2822)

When running Canopy on the Centos Linux distribution, the default editor font is proportionally spaced instead of being fixed-spaced. This causes text columns to not line up correctly. A fixed-spaced font can be selected by going to Edit -> Preferences and selecting a different font.

This issue is not present on other Linux distributions that we test on.

Resolved: Highlight active pane in the Editor (#1750)

The active pane in the code editor window is now highlighted to help the user keep track of the keyboard focus.

Resolved: Improved login credentials management (#1482, #1482)

User logins are now better synchronized between the Canopy Welcome window, Canopy Package Manager, and command-line enstaller/enpkg.

Resolved: Font preference changes required restart (#2418)

Changes to the editor font preferences on Windows now take effect immediately instead of requiring a restart.

Resolved: Qt SVG plugin fixed (#1974)

Changes have been made that fix the runtime finding and loading of the Qt SVG plugin image handler, as well as other Qt plugins.

Resolved: Autoscroll the Python pane (#1071, #2537)

Canopy is now smarter about keeping the final lines of the Python pane visible when there is output, or when input is needed.

Resolved: Drag and Drop of files to editor (#2201)

Drag and drop of unrecognized file types will no longer be refused, even if the filename extension is not recognized, provided that the file contains plain text.

Resolved: Protect proxy environment values in subprocesses (#2978)

To improve security: when providing proxy settings in the Preferences dialog, you may now specify that Canopy should not pass these proxy settings via environment variables to the IPython kernel process, nor to a Canopy Command Prompt or Terminal.

Resolved: Keep IPython CWD synced to editor (#3021, #3041)

If IPython was busy sometimes the current working directory would not stay in sync with the current directory of the active editor, when this option was chosen.

Resolved: Automatic update preference setting ignored (#2453)

By default Canopy automatically downloads, but does not install, application updates. This behavior can be disabled by going to the Canopy Preferences Dialog (Edit -> Preferences or, on Mac OS, Canopy -> Preferences), and unchecking the toggle button. A bug in previous versions caused the updates to be downloaded but not reported. This has been corrected and Canopy no longer checks for the availability of updates, or downloads them, when the preference is unselected.

Resolved: Linux: Canopy can hang when Preferences Dialog opened when Canopy run as background process (#1933)

On Linux and Mac OS systems, it is common to start applications from a terminal and then place them into the background with the shell command ‘bg’. This disconnects the application from the terminal input. In general this has no impact on Canopy, but a problem with the Preference Dialog would cause Canopy to hang if the dialog is opened after Canopy is placed in the background. This problem has been corrected.

Resolved: Some error dialogs displayed even when “–no-gui-setup” is specified (#2098)

Canopy offers a number of options for installing and setting up Canopy via command-line commands. One of the options, –no-gui-setup, allows the user setup process to be run without GUI interaction. In previous releases, several error dialogs could be displayed, either incorrectly appearing to users to resulting in incorrect error messages in the terminal (“Unable to connect to X server” on Linux systems). This has been corrected.

Resolved: Misleading error when incorrect credentials used during Welcome Screen login (#1633)

When logging in through the Canopy Welcome Screen, if wrong credentials (username or password) were used the error message indicated that it could be a network connectivity issue. The error message has been corrected to better indicate the source of the problem.

Resolved: Password reset failed in Welcome Screen (#2922)

The “Forgot your password” feature in the Canopy Welcome screen login page gave a “Connection Error”. This has been corrected.

Resolved: Windows: PTVS Intellisense shows too many packages when used with Canopy (#2947)

PTVS is Microsoft’s Python Tools for Visual Studio application. Canopy includes integration that allows it to work seamlessly with PTVS. In the previous release, the integration would cause the auto-completion (Intellisense) features in PTVS to incorrectly show packages in virtual environments which were not accessible. This has been corrected.

And many more...

In addition to the above there have been many changes to improve the stability and security of Canopy, and also many little changes to improve the look and feel and ease of use.

Release notes for Canopy 1.4.1 (11 June 2014)

New: Support for multiple virtual environments in Python Tools for Visual Studio (#1819)

Canopy 1.3 added support for using Microsoft’s Python Tools for Visual Studio (PTVS) package with Canopy. Canopy’s User Python environment automatically apears in the PTVS Python Environments list. However, there was no way to get additional virtual environments created from the command line to appear in the list.

With this release, you can now register a virtual environment and it will automatically appear in the Python Environments list. For more details see the Canopy Users Guide description of the command line interface, canopy_cli register / unregister.

Resolved: Better handling of plugin and addon failures (#1543, #1581, #2110, #2135)

Only show plugin load failure warnings once instead of each time Canopy starts, and do better cleanup of plugins that have been removed.

Resolved: Python executable framework build on OSX (#2082)

The command-line python binary on OSX is now a framework build again. This means that it is equivalent to using the pythonw executable, and can be used to run applications which use wxPython.

Resolved: Better handling of migration script errors (#1224)

Canopy uses migration scripts during the update process to update internal files and settings from release-to-release. Failure handling around the running of these scripts has been improved to reduce some causes of upgrade failures.

Resolved: (Windows) “Process cannot access file because it is being used by another process” (#1776, #1952)

This error occurs when Canopy is already running and the user tries to run Canopy from the command line or open a file with Canopy from the Windows desktop (such as double-click a .py file). Typically the error is reported against the file “bootstrap.log”. The startup process has been changed to be more tolerant of locked log files and to use an alternate file name.

Resolved: Display standard output from C code (#1959)

Any stdout and stderr output from C extension modules or the libraries they use will now be shown in the IPython panel in Canopy, similar to how the Python sys.stdout and sys.stderr streams are already being handled. This means that if an extension module calls the C printf function, or similar APIs, then that text will be seen by the user when the code is running in Canopy.

This resolves an issue where C extensions which generate substantial output to stdout or stderr could cause the Canopy IPython prompt to hang.

Resolved: (Windows) Window appears in upper, left coner of screen, partially off screen

After the Canopy 1.4 update some Windows could appear in the upper-left corner of the screen and up too high such that the window frame was off screen. This has been corrected.

Resolved: Level 1 updates (#2132)

A problem that was preventing Level 1 updates (simpler, egg-only updates) from working was fixed.

Resolved: Undo goes too far back (#858)

The undo feature in the code editor has been fixed to only go back as far as the loading of the file, instead of allowing the user to undo back to before the file was loaded.

New: Add Find feature for IPython Notebooks (#1851)

The user can now search for text within the Python Notebook in the Editor window, using the Seach/Find menu item or the associated shortcut key.

New: Restart in recovery mode (#1536)

The bug reporter dialog will now give the user the option of restarting Canopy in recovery mode, in order to perform a factory reset of the System virtual environment. The “factor reset” mode does not impact the User Python environment and helps Canopy recover from some failure-to-start errors.

Resolved: Better font sizes in documentation browser (#2242)

A bug was fixed which caused the fonts used by default in the documentation browser to be either too small or to large, depending on platform.

Resolved: Loading files with incorrect encoding (#1653)

Previoiusly files with an encoding indicator line which used an unknown ecoding name would fail to load. Now they will be loaded using a default encoding.

New: Canopy preferences path (#2243)

The CANOPY_CONFIG environment variable can now be used to specify the location of the Canopy preference files, log files, etc. This environment variable specifies the path to the directory containing the preference.ini file and other configuration files for Canopy.

By default these files are located in the following directories.

OS Default path
Windows %APPDATA%\Enthought\Canopy
Linux & Mac OS ~/.canopy

Release notes for Canopy 1.4.0 (21 April 2014)

New: Canopy Command Prompt or Terminal (#1022)

Users can now open a new Canopy Command Prompt (Windows) or Canopy Terminal (Mac OS or Linux) from the Canopy application’s Tools menu. This can be used to perform command-line installation in the Canopy User Python environment, or to run ipython or other command-line tools or scripts in that User environment. Details at Canopy Command Prompt or Terminal.

New: Package Manager Updates (#1491, 1492)

Some changes have been made to the Package Manager and the enpkg command-line tool to help clarify which packages are part of the supported Enthought distribution, and which come from the unsupported pool of community / PyPI packages that Enthoughts offers on an as-is basis.

New: Copy Package Manager history to clipboard (#1367)

The package install, update and remove history in Package Manager can now be copied to the clipboard by right-clicking on the history items. This will be helpful information for some types of support requests.

New: Open IPython Notebooks with Canopy (#948)

On Windows and OS X, Canopy can now be used to open IPython Notebook files (*.ipynb files) by double-clicking them on the Desktop or in the system file browser, or by using the “Open with...” option from a context menu.

New: Proxy environment variables (#1319, 1045)

The ‘Network’ tab of the preferences dialog now shows the values of environment variables related to network proxies. This feature can be helpful in figuring how whether Canopy is connecting to a proxy service, and what values it is using.

Canopy also now recognizes and either corrects or reports mal-formed values specified by these environment variables. Some corporate environments use non-standard forms that previous were not recognized by Canopy.

New: Knowledge base access (#1350)

A new menu item on the Help menu labeled “Support Knowledge Base” will take you to Enthought’s support site. This site is continuously updated with answers to common questions, late-breaking problems and solution, and other important information.

New: Enpkg installed in new virtual environments (venvs) (#1200)

When a new virtual environment is created with the Command line interface, Enthought’s enstaller package (containing the ‘enpkg’ command and other utilities) is now installed into the new environment by default. This provides an easy means to start installing additional packages.

Resolved: Unclear how to exit IPython help when viewing multiple pages (#303)

Previously it was unclear how to exit from viewing the IPython pane’s help text when the text spanned multiple pages (press Esc). The pager has been modified to show the available keyboard commands.

Resolved: Use .py extension by default (#303)

Canopy will now default to using the .py filename extension when saving new files.

Resolved: (OS X) IPython notebook tool icons (#1047)

The toolbar icons used in the IPython Notebook, which were broken on OS X, have been fixed.

Resolved: Multiple file selection through bug-reporter file dialog (#654)

Selecting and attaching multiple files is now possible through the file dialog of the bug reporter.

Resolved: Syntax highlighter in the Python pane (#1567)

A bug that caused incorrect context-sensitive syntax highlighting in the Python pane has been fixed.

Resolved: Windows: Window is located off-screen, can’t be moved (#84)

In the Windows version it was previous possible for Canopy to start up with the default location of a window off the visible screen where it couldn’t be found or moved. This could happen when switching from a multiple-monitor setup to a single-monitor setup.

As of Canopy 1.4, when Canopy starts, it now ensures that the sizes and positions of windows that are restored from the last session are still valid. This caused problems when the number or size of monitors attached to the user’s computer had changed since the last session.

Resolved: (Windows) Automatic directory changes on network shares (#1162)

When the ‘Keep Directory Synced to Editor’ feature was enabled, and the current file was on a Windows network share, an incorrect %cd (change directory) command was generated, causing the sync to fail. This has been fixed.

New: Copy file paths to clipboard (#1007)

A context menu action in the file browser pane now allows a file’s path to be copied to the clipboard.

Resolved: Mac OSX: Shortcut keys in IPython Notebook (#955)

Clipboard shortcut keys like Cmd+V now work as expected in IPython Notebooks when they are used within the Canopy application. In addition shortcuts for zoom-in and zoom-out (Cmd+/-) have been implemented.

Resolved: Windows (64-bit): Package installation fails with “invalid command ‘egg_inst’” or similar (#1760)

On Windows with Canopy 1.3 there was a problem when installing eggs with the package manager or with the enpkg command-line tool which resulted in incomplete installation of the egg’s meta-data. This problem has been fixed, and when Canopy 1.4 is run for the first time any incorrect egg installations in the User Python environment will be repaired automatically. If the user has other venvs they have created themselves then those can also be repaired using the enpkg-repair command-line tool.

Details can be found in the Enthought Knowledge Base.

Resolved: Incorrect build flags in distutils and python-config (#1585)

This affected Canopy 1.3.0 - mostly on Linux, and to a lesser extent on OSX. Python 2.7.6 made a small change in how the compile and link flags are generated when building extension modules. As a result, when using Canopy to build an extension module, the build folders (non-existent on user machines) were used, instead of the correct installation folders. Canopy has now adapted to this change in Python, so the compile and link flags, generated from python-config and when using distutils and setuptools, will now refer to the correct installation folders.

Resolved: Robustness and stability improvements

Various other fixes have been implemented that improve the stability of Canopy and its tools, solving several less frequent but still annoying bugs. In addition some changes have been made to help Canopy recover better when problems do happen, and also to better report problems back to Enthought.

Release notes for Canopy 1.3.1 (21 April 2014)

Resolved: Windows 64-bit update issues

A problem was found in the update mechanism when dealing with DLLs loaded in memory with a base address above the 32-bit address space. This causes the Canopy platform updates to fail. The Canopy 1.3.1 update corrects the problem and is required to update 64-bit Windows versions to version 1.4. Other versions of Canopy do not require this patch.

Release notes for Canopy 1.3.0 (31 January 2014)

New: Python updated to 2.7.6

Canopy’s python distribution has been updated to 2.7.6 from 2.7.3. This is a minor patch release to Python meaning that all existing 2.7.3 code is expected to run the same as before. Please see this Enthought Knowledge Base article for details.

Resolved: Python Tools for Visual Studio is unable to find symbols for python27.dll

Support for Microsoft’s Python Tools for Visual Studio (PTVS) was introduced in Canopy 1.2. An issue with finding a debug symbol library makes the mixed-mode debug option harder to use. This has been corrected in 1.3, details can be found in this knowledge base article.

Resolved: Canopy won’t let me update some packages in Package Manager

In some cases, the Package Manager UI would show an available update to one of the Canopy packages, but no option was provided to install the package. This issue is resolved and details are available in this knowledge base article.

Resolved: Incorrect font used for Canopy GUI on Mac OSX “Mavericks”

A change in the latest Mac OSX version “Mavericks” caused Qt to select the wrong system font, and thus the display font in Canopy wasn’t right. We have applied a patch to Qt to correct the issue and the fonts should display correctly now.

Resolved: Avoid hang-at-exit problem on OSX

In some situations Canopy on OSX could run into a deadlock when trying to exit the application. This would cause Canopy to still be shown as a running application even though it had been terminated. When performing an update, it would also cause a dialog to appear asking you to kill the existing Canopy processes. A workaround has been added to avoid the deadlock so Canopy can exit cleanly in a timely manner.

Updated: Qt and PySide

The PySide package has been updated to verison 1.2.1 with some additional community fixes added to Enthought’s builds. These changes improve the stability of the Canopy GUI. Users writing Python code that uses PySide and Qt should note the change as well as this change updates the user-visibile versions as well. No compatibility breaks are expected.

Issue: Use of enpkg in virtual environments created by user requires workaround

In Canopy 1.3 (and 1.2), there are several issues with virtual environments created with the Canopy CLI or directly with venv. These issues should be fixed in the Canopy 1.4 release. Please see this Knowledge Base article for more information.

Release notes for Canopy 1.2.0 (20 December 2013)

New: Windows: Python Tools for Visual Studio (PTVS) integration

Python Tools for Visual Studio is a free, open-source plugin which adds Python suport to the Microsoft Visual Studio development environment. Visual Studio with PTVS is a professional software development environment ideal for users and teams who need to develop and debug significant applications, especially those with mixed Python/C++/C environments. This compares with the Canopy analysis desktop which is tuned for scientists and analysts working with Python scripts and smaller applications, especially for interactive work with the IPython console and other analysis tools.

Canopy has been extended with native PTVS integration, allowing PTVS to automatically recognize Canopy. To examine the Python enviroments detected by PTVS, in Visual Studio go to TOOLS -> Python Tools -> Python Environments. Canopy is shown as “Enthought Canopy”.

The PTVS completion database will need to be refreshed from the Python Environments window before the first use to enable full code completion. Similarly, after new Python packages are installed via Canopy’s Package Manager it is necessary to refresh the completion database before the new packages will be available for completion.

Canopy supports PTVS under Visual Studio versions 2010, 2012, and 2013.

Resolved: Mac OS “Mavericks” support

The latest release of Apple’s Mac OS operating system code named “Mavericks” causes some compatiblity with the interactive IPython prompt and with IPython Notebooks. The issue causes both to run extremely slowly. If possible we recommend not updating your OS until the issuss are understood and resolved.

For users who are running Mavericks, Canopy 1.2 includes a fix that addresses most or all of the issues in the interactive IPython prompt and in IPython Notebooks. For ongoing status updates, see https://support.enthought.com/entries/22861925-OS-X-10-9-Mavericks-Python-Canopy.

New: pip installed in User virtual environment by default

The ‘pip’ command provide access to Python packages available on the PyPI repository and through other sources. This command has always been available to be installed via the ‘enpkg’ or ‘easy_install’ commands. With Canopy 1.2 ‘pip’ is now installed by default. The command can be found in the User\Scripts directory on Windows, or User/bin on Linux and Mac OS.

Note: users with existing Canopy installations will still need to install it manually if desired. The command to install ‘pip’ is:

easy_install pip

The easy_install command can be found in the User\Scripts directory on Windows or User/bin on Linux and Mac OS.

New: PySide & Qt developer tools included

The PySide and Qt installations within Canopy have been upgraded to include the respective developer tools such as ‘qmake’ and the UIC compiler. These tools can be found in the core Canopy installation tree. The “Core” installation is the location where Canopy is initially installed. See Where are all of the Python packages in my User Python Environment? As a reminder, you never run Python directly from Core (except to start Canopy itself), but rather from a User environment which inherits from Core.

Note: Windows: “This installation package is not supported by your processor type”

This error typically occurs when the 64-bit Canopy install is run on a 32-bit Windows system. Users on 32-bit machines should make sure they select the 32-bit installer when downloading Canopy from https://www.enthought.com/downloads.

Resolved: “Unexpected error:ParseError:Invalid line at line “1”

This error occurred primarily on Windows systems and was the result of the preferences.ini file becoming corrupted. On earlier versions of Canopy the workaround is to exit Canopy and delete the preferences.ini file located in each user’s account.

Canopy 1.2 detects malformed preferences files, renames the file with a ‘.bak’ extension, and then loads with the default preferences.

Resolved: Canopy fails to start if environment variable HTTP_PROXY is set to invalid value

The environment variables HTTP_PROXY and HTTPS_PROXY are used on most operating systems to specify the host, port, and (optionally) a username and password of a proxy firewall to use when connecting to the internet. Many organizations use such servers. Canopy will honor these settings when making outgoing connections unless they are overridden from the Canopy preferences dialog.

Both environment variables are expected to be set to a value URL. For example:

http://user:passwd@proxy.enthought.com:8080

In previous releases if either environment variable was set to an invalid URL Canopy would fail to start. This release partially corrects this behavior to ignore the invalid value, but the error is only reported in the log file ‘main.log’ (i.e., the user is not notified directly).

Resolved: Linux, Mac OS: ‘canopy_cli venv’ creates scripts in bin directory with incorrect Python path

When using the canopy_cli venv command to create a new virtual environment, if the target directory is specified with a relative path, any scripts in the ‘/bin’ directory of the new virtual environment would have the wrong path to the Python interpreter (the “#!” line at the start of the file).

This issue was corrected for some virtual environments in the previous release and has been completely corrected now.

Resolved: Windows: –no-gui-setup does not work on headless servers

The Canopy_cli.exe command supports setting up and configuring Canopy environments from the command line, enabling deployment automation. The –no-gui-setup switch turns off GUI interactions for command-line usage. In the previous version the command still showed a progress dialog, causing the command to fail on headless servers.

This issue has been resolved.

Resolved: Windows: canopy_cli is not a valid win32 app

The 32-bit Canopy 1.1 installer incorrectly included a 64-bit binary version of the canopy_cli executable. This prevented the command from running on 32-bit system. This has been corrected.

Resolved: Windows: Python ‘PythonPath’ now set in Windows registry

When Canopy is set as the default Python environment on Windows it sets the following standard Python registry keys:

HKEY_CURRENT_USER\Software\Python\PythonCore\2.7\InstallPath
HKEY_CURRENT_USER\Software\Python\PythonCore\2.7\PythonPath

These are set to point to the User python environment and the Python executable under User, respectively. These keys are used by many third-party tools to integrate with Python.

Previous releases of Canopy did not set the second registry key, PythonPath. This value can be set in current installations by going to Edit -> Preferences and clicking ‘Set as Default’.

Resolved: MacOS: Open relative paths from the command line does not work

From the Mac OS command line, files can be opened directly in the Canopy editor via the ‘canopy’ command like this:

canopy myfile.py

This will open the file ‘myfile.py’ in the currently running Canopy instance or, if Canopy is not running, will start Canopy then open the file.

In Canopy 1.1 and 1.1.1 this command would fail when given a relative path to the file. This has been corrected.

Resolved: Linux: Warning: Unable to load library ‘icu18n’

On many Linux systems Canopy would issue this warning at startup. The warning was harmless and could be ignored and is no longer shown in Canopy 1.2.

Release notes for Canopy 1.1.1 (3 October 2013)

New: Updated to IPython 1.1

After tremendous work, the IPython team and community achieved their 1.0 release, quickly followed by version 1.1, with even more features. The Canopy GUI’s integrated IPython prompt in the editor window now uses IPython 1.1.

Please note that when ipython is run from an OS command prompt (terminal or shell), it will be whatever IPython version is installed in the Canopy User Python environment. This version may or may not match the IPython version used in the Canopy GUI itself, and can be independently changed. To install IPython 1.1 or any other version for use from the OS command line, go to the Canopy Package Manager and update the IPython package.

Issue: Canopy crashes occasionally during tab completion

We are investigating an issue in the integration between the code editor and the Qt text editor widget that can cause Canopy to crash when using the code completion feature (‘tab’ to complete symbol names). The failure happens rarely, particularly when ‘tab’ is pressed several times in quick succession, and appears to be timing-dependent. We can reproduce the crash and are investigating, with a target of fixing it for the 1.2 release in early November.

Issue partially resolved: Linux, Mac OS: ‘canopy_cli venv’ creates scripts in bin directory with incorrect Python path

When using the canopy_cli venv command to create a new virtual environment, if the target directory is specified with a relative path, any scripts in the ‘/bin’ directory of the new virtual environment will have the wrong path to the Python interpreter (the “#!” line at the start of the file). This path must be manually corrected in order for the script to work correctly.

This issue has been corrected for any virtual environments created, from now on, which are based on the Canopy User environment.

However, when such virtual environments are created from the core installation directory specifying a relative target path, the resulting scripts will still be incorrect in Canopy 1.1.1.

Workaround: to avoid having to manually edit the “#!” lines in these scripts, always specify an absolute path when creating such virtual environments.

This defect will be corrected in the 1.2 release planned for early November. Note that any scripts already created incorrectly will not be fixed, and must be manually corrected, or the virtual environment re-created.

Issue: ‘Canopy_cli.exe –no-gui-setup’ fails on Windows

On Windows, this option pops up a dialog, thus breaking installation automation. This will be fixed in Canopy 1.2. If you need a simple fix for this sooner, please contact canopy.support@enthought.com.

Resolved: Linux: Canopy fails to start on some X servers, VNC servers

At startup Canopy would begin to show the splash screen and then abort with no error message. The log file would only show the following message:

QtWarningMsg: fatal IO: client killed

The problem has been tracked down to an issue with some older X Window System servers which appear to be unable to handle high-resolution application icons. We have changed the icon and Canopy now works correctly on all tested X servers (including XMing on Windows) and VNC servers. Please report any continuing issues to canopy.support@enthought.com.

Resolved: Lock files, remaining after crash, block restart

After a crash or forced quit of Canopy, users were sometimes unable to restart Canopy without manually deleting several lock files in the user’s preferences directory. Canopy should now delete these files when appropriate.

Issue: Canopy reports stray Python processes running, fails with Unicode decode error

During the update process, Canopy will sometimes report that stray Python processes are still running and need to be closed before Canopy continues. This is primarily an issue on Windows where running processes often hold locks on files, thus preventing some files being updated. Canopy will prompt to terminate these processes before continuing. We are working to eliminate stray processes caused by Canopy’s operation; some are caused by execution of user code.

In some cases the dialog showing the remaining Python processes would cause Canopy to crash due to Unicode (non-English characters) in a path name. This issue has been resolved and Unicode characters are handled correctly.

Resolved: Check for updates appears to hang or take many minutes

The ‘About Canopy’ dialog box offers the option to check for application updates. In the previous release if no updates were present the ‘spinner’ indicating that a check was on-going would continue spinning for several minutes after the last check. This has been corrected.

Issue/Resolved: IPython Notebook cannot open local file when proxy set

In the previous release, an IPython Notebook would fail to open a local file when an HTTP proxy is set. The issue was that references to localhost were incorrectly passed to the proxy server as well.

On Windows and Linux this issue has been corrected. The issue is still open on Mac OS and will be corrected in the Canopy 1.2 release in early November.

Release notes for Canopy 1.1 (22 August 2013)

New: All-new command line interface (CLI)

A new command line interface (CLI) has been added for users who prefer to work from the command line, are writing automation scripts, or working on a machine without a graphical interface. The CLI supports setting up Canopy installations in networked environments where users wish to share a common environment, and creation of new virtual environments.

See Canopy Command Line Interface for details.

New: Full installers available to subscribers

For each OS platform, two versions of the Canopy installer are now available to subscribers. These differ only in the number of packages which are bundled into the installer file for immediate installation into Canopy User Python, when Canopy is first started. Canopy’s Express installer contains approximately 40 packages, including the entire core SciPy software stack. Subscribers can subsequently install additional packages as needed, via Canopy’s Package Manager. Canopy’s Full installer contains all 140+ Canopy packages.

The Express installers work well for subscribers who want to avoid installing unused packages. Likewise, if you started as a free Canopy Express user, and are now a subscriber, you can simply use Package Manager to add subscriber packages as needed. The Full installers are for subscribers who want to install all packages immediately, including those who are installing into environments with limited or no internet connectivity. The difference in installer sizes and disk usage is given below.

Platform Express Installer Express Disk Usage Full Installer Full Disk Usage
Windows 230 MB 900 MB 380 MB 1400 MB
Linux 280 MB 1180 MB 420 MB 1800 MB
Mac OS 230 MB 870 MB 350 MB 1550 MB

New: Support for non-GUI installs

One aspect of the new command line interface is support for non-GUI installs. This comes up when users don’t have access to a Graphical User Interface on their machine (such as when connecting via ssh), prerfer the command line, or need to automate the installation on a network or cluster environment.

The new canopy_cli utility supports a new switch --no-gui-setup which guides you through the setup from the console. See Setting up the User environment without a GUI in the Users Guide for more details.

New: Full production version on Linux

Canopy for Linux is now out of beta and in full production. Canopy is supported on RedHat Enterprise 5 (and compatible) systems and Ubuntu 12.04 LTS. In general, Canopy typically works without issue on RedHat Enterprise 6 (RH6) systems and other distributions. In particular, full support for RH6 is coming after additional testing on RH6 systems.

Security: Documentation Browser could execute arbitrary Python code

The Documentation Browser previously identified code segments in documentation and added icons for opening the code in the Canopy editor or executing the code in IPython. A potentially malicious webpage could have been crafted such that it automatically executed the Python code without the user taking action. This would only happen if the user navigated to the malicious page by entering a URL in the Documentation Browser’s address bar.

The Documentation Browser has been modified to no longer present the icons. Instead, a right- click menu generated by Python (instead of JavaScript) has been added with the same functionality. This removes the ability for JavaScript code to execute Python code.

Resolved: Package manager can not be interrupted during download, install

The previous version of Package Manager did not support a means of interrupting the download or install of a batch of packages. For large packages, or a large number of packages such as when “Install All Canopy Packages” was pressed, this could take a long time to complete, especially over slower Internet connections.

This has been corrected and there is now a ‘Cancel’ button on the UI.

New: System-level default preferences

On multi-user systems it is now possible to configure system-wide default preference settings. The preference file is the same format as the per-user preferences.ini file (see Where are the preference and log files located?). The system preference can be set by creating a preference.ini file (or copying a per-user one) to the root installation directory of Canopy. The default path to the root installation directory is shown below by operating system.

Operating System Default path
Windows C:\Program Files\Enthought\Canopy\App or see per-user install paths
Mac OS /Applications/Canopy.app
Linux ~/Canopy

Resolved: Canopy fails to set up environment when first run

In some cases Canopy would fail with the error “Failed to set up your environment”. This error could be triggered when the user’s home directory was stored on a network drive. The issue has been corrected.

Resolved: Linux: Canopy crashes when update was available and ‘Install on Quit’ is clicked

In the About Canopy dialog box, when an update was available clicking ‘Install on Quit’ could cause Canopy to abort. This was caused by an error in the code that closed the GUI and particularly showed up under Linux. This issue has been corrected.

Resolved: Windows: File opened from the command line now shown with the correct case

The Canopy command can be used on all platforms to open files from the command line simply by adding the name of a file to the command line. For example:

canopy.exe my_file.py

In the previous release, the file was opened using the case as typed on the command line instead of the case of the file itself. On case-insensitive file systems such as on Windows this worked correctly. However, it was then possible to have the same file open multiple times in Canopy, resulting in a confusing display. This has been corrected and the file is opened with the actual case of the file itself.

Resolved: Windows: MSI version reported as ‘0.9.1’

The MSI version in previous releases was not correctly tracking the actual Canopy version installed. This has been corrected and is reported as ‘1.1.0’ for this release. The MSI version will reflect the version of Canopy installed via an MSI, which may be an older version than is running if Canopy updates have been applied.

New: Canopy venv implementation support arbitrarily deep nesting of virtual environments

From Canopy you can create new virtual environment with the canopy_cli venv command. In the past venv supported nesting two layers deep. This restriction has been removed and it is possible to create arbitrarily-nested virtual environment.

For example:

canopy_cli.exe venv -s C:\venv1
C:\venv1\Scripts\venv.exe -s C:\venv2
C:\venv2\Scripts\venv.exe -s C:\venv3

In this example, since the -s switch is provided, venv3 can import any package that is installed into venv3, venv2, or venv1.

A common scenario for using nested virtual environments is to experiment with package changes without impacting a stable, working environment. For example, is venv1 is being used for a project and is work, venv2 can be created as above and it starts out with all of the packages from venv1. Then alternate package versions can selectively be installed in venv2 and code run it in for testing without impacting venv1.

Release notes for Canopy 1.0.5 (22 August 2013)

Resolved: Application hang when installing updates via “Install and Relaunch”

The previous release would frequently hang when applying some types of Canopy updates when “Install and Relaunch” was used. This update corrects the issue in advance of the 1.1 release.

Release notes for Canopy 1.0.4 (1 August 2013)

Resolved: Critical editor bug resulting in some buffers not being marked ‘modified’

Under rare circumstances, the ‘modified’ flag in the text editor is incorrectly set to ‘unmodified’. This results in no changes being saved when File -> Save is used and Canopy will not warn of unsaved changes before exiting. This can result in a loss of any edits made in the tool.

This issue has been corrected and we recommend all Canopy users update from 1.0.3 to 1.0.4.

Resolved: Windows: “Canopy is not your default Python environment” shown when not true

The preferences dialog (Edit -> Preferences) displays an informational message if Canopy is not currently configured as your default Python environment and provides a button to set up your environment to make it the default. In Canopy 1.0.3 on Windows this informational message is sometimes displayed when Canopy is the default environment, even after clicking the button to make it so.

This issue has been resolved and the detection algorithm has been improved. The display now also includes information indicating if another Python environment has been configured in the system PATH specification, making it so Canopy cannot be made the default.

Release notes for Canopy 1.0.3 (27 June 2013)

New: Proxy firewall support

Proxy firewalls are used by many organizations to control traffic to/from their networks and require that applications connect through the proxy server in order to access resources on the Internet. Canopy now supports preference items for configuring proxy support, available under Edit -> Preferences (Canopy -> Preferences on Mac OS). See the ‘Network’ tab.

Details of the proxy support and how to configure the settings are described in this knowledge base article on https://support.enthought.com.

Resolved: Windows: Third-party installers & tools unable to find Canopy install

The previous version of Canopy did not set a standard registry key that many third-party installers and Python tools use to find the default Python environment on Windows systems. As a result, non-Enthought Python package installers such as those produced by Christoph Gohlke were unable to install packages into Canopy. This has been corrected. When Canopy is made the default Python environment these installers should now find the User Python Environment.

Resolved: Linux Canopy installation files have User and Group ID set to “506”

When Canopy was installed to an NFS4-mounted file system under Linux the installation had the uid and gui set to “506”. This has been corrected and when the files are now extracted using the ‘tar’ command the -no-same-id flag is passed.

Resolved: Canopy update appears to hang at 100%

When applying an update to Canopy at times it would appear to “hang” at 98% or 100% complete and not return. This was a UI issue where the progress bar reflected the download process, but not the installation process, which could sometimes take several minutes or more. The UI has been changed to reflect the separate operations of download and installation.

New: clear recent files list

A context-sensitive (right-click) menu item now allows the recent files list in the code editor navigation tree to be cleared. A second menu item allows any missing / deleted files to be cleared. Additionally, individual files can be removed from the list by right-clicking on the item.

New: top-level directories added to navigation pane persist outside of sessions

The file navigation pane in the Code Editor (left-side of window by default) defaults to showing your home directory. This can be configured by right-clicking in the navigation tree and adding or removing directories from the list.

In the previous version this configuration was persisted when a session was saved (Window -> Save Window as Session or Window -> Save All Windows as a Session) and restored only when a session was restored. This has been changed to persist the configuration independently as well to a session so a session does not need to be restored. When you do restore a session with a different configuration of the tree, the configuration saved in the session takes precedences.

Resolved: Tcl / Tkinter is missing or does not function correctly

A combination of build errors caused some or all of the Tkinter (and Tck/TK dependencies) to be missing on Windows, Mac OS, and Linux installations. In some cases this would cause Tkinter to not import, and in others the package would import but would fail during usage. This has been corrected and Tkinter should function correctly on all platforms.

Resolved: Canopy setup fails when %HOME% is set to invalid directory

On Windows the environment variable %HOME% is not always set, and is sometimes set by third-party applications. If %HOME% is set to something other than your home directory, or particularly to an unwritable directory, Canopy would fail with an Unexpected Error during initial setup. This has been corrected.

New: preference for disabling automatic update checking

By default Canopy automatically checks for and downloads product updates as they become available. These updates are not installed until explicitly done so by going to Help -> Canopy Application Updates...

A new preference item has been added to disable the automatic downloading of updates for users with limited or metered Internet access. Updates can be explicitly downloaded by going to Help -> Canopy Application Updates... and clicking ‘Check for Updates’.

Resolved: Running an unsaved file with unicode content fails

Attempting to run a file in the IPython prompt (Run -> Run File) that has not yet been saved and contains unicode content would result in an Unexpected Error dialog. This has been corrected.

Resolved: OSError: Could not find C library or load any of its variants

On Mac OS Canopy sets the DYLD_FALLBACK_LIBRARY_PATH so modules can find shared libraries in the user Python environment as well as the core application install. The default for this environment variable was set incorrectly so some modules failed to find the C library. This has been corrected.

Resolved: Linux: libjpeg62 missing

Canopy depends on the library libjpeg62 to read JPEG-format images. Previous releases did not include this library and depended on it being available on the user’s system. However, this version is old enough that some Linux distributions no longer provide it. Canopy now includes this library.

Resolved: Windows: SSL/TLS libraries missing for Qt

The previous version of Canopy was missing some libraries necessary for SSL/TLS support, and thus the ability to display secured HTTP (HTTPS) pages in the documentation browser. This would cause the pages to show a network error. This has been corrected and HTTPS pages now display correctly in Canopy.

New: Option to remove end-of-line white space from files

White space (spaces, tabs mostly) at the end of lines of programs doesn’t usually have an effect, though many programming editors automatical remove it. If some editors remove it and some don’t, this can cause problems when comparing two versions of a file if the comparison utility doesn’t ignore white space differences.

An option has been added to the Preferences dialog under the ‘editor’ tab to automatically strip white space at the end of lines. This occurs whenever the file is saved. By default, this option is off for compatibility with previous Canopy versions.

Release notes for Canopy 1.0.2 (27 June 2013)

Resolved: Update installation fails or hangs if Canopy installed as admin / root user

NOTE: Please look for the Canopy 1.0.3 release following closely after 1.0.2

A defect in previous releases could cause the installation of Canopy updates to hang and fail if Canopy was installed using escalated privileges. For example, this could happen if Canopy was installed as an Administrator user but tries to apply the updates when running at standard user access levels. The issue would occur when Canopy attempted to request increased access levels from the OS (Windows, Linux, or Mac OS).

The 1.0.2 release fixes this issue in preparation for the 1.0.3 release. As such, 1.0.3 will only be visible after 1.0.2 has been applied.

New: Update notifications available on Welcome Window

An indicator showing when Canopy updates are available has been added to the Welcome Window. A green update indicator will be shown in the bottom right corner of the window.

Resolved: In-app account registration does not work

In-app registration via the Canopy welcome screen fails with a “403: forbidden” error. This has been corrected and registration should now work correctly. The workaround for previous versions is to register for a user account directly at https://www.enthought.com/accounts/register/ and then log in via the Canopy welcome screen.

Resolved: Clicking ‘Subscribe’ in Package Manager results in a ‘404’ Error

The Canopy Package Manager supports in-app purchases of subscriptions to the package repository. This is done by displaying the Enthought.com purchase web page in the application. After some updates to the website, the purchase URL was not correctly updated and resulted in a “page not found” (404) error. The URL has been corrected and the purchase page displays correctly now.

Release notes for Canopy 1.0.1 (23 May 2013)

Resolved: Command line utilities installed via Package Manager use wrong executable

In the previous release, packages such as Pip that install command line utilities were installed using the wrong Python executable when installed via Package Manager. Instead of using Python from the ‘User’ virtual environment, the Pythone executable from the ‘System’ virtual environment was selected. This resulted in Python packages potentially being installed in the wrong environment or Python not finding an installed package.

This release corrects the issue and automatically fixes any incorrectly installed packages.

Experimental: Added proxy support for updates, Package Manager

Canopy now has very basic, experimental support for connecting through proxy firewalls. This functionality is still being tested and is being made available for users who require it and wish to help test it and provide feedback.

The proxy support enables the Package Manager, Canopy software update fuctionality, and Documentation Brower to make HTTP and HTTPS connections when connecting through some common proxy server configurations. The proxy functionality can be configured in one of two ways: by editing the Canopy preferences.ini file or by setting an environment variable.

To edit the preferences.ini file, follow the following steps:

Exit Canopy. This is important because Canopy overwrites the preference.ini file on exit.

Now using a standard text editor, open preferences.ini (see See Where are the preference and log files located? for the location of the preference.ini file on each OS) and add the following lines:

[main]
proxy_server = *server_name*
proxy_port = *port_number*
proxy_username = *username*
proxy_password = *password*

The values proxy_server and proxy_port must be set to the name of the server and the port number to connect to. The proxy_username and proxy_password settings are optional and only need to be provided if your proxy server requires authentication.

Important: If you set proxy_password you will be storing your password in plain text which is insecure. In some environments this password is regularly set in environment variables and is considered insecure already so this is not an issue. If the password is expected to be secure it should not be set here. Future Canopy versions will correctly store this password securely.

Once these changes have been made, save the file and restart Canopy. When the Package Manager is opened it should now be able to correctly download the index of packages and install new packages.

As an example, a typical configuration looks something like this:

[main]
proxy_server = proxy.myorg.com
proxy_port = 8080
proxy_username = proxyuser
proxy_password = passwd

Release notes for Canopy 1.0.0 (9 April 2013)

New: Linux Beta Support

Canopy is now supported on Linux as well as Microsoft Windows and Apple Mac OS. Canopy is supported on Ubuntu 12.04 and RedHat Enterprise 5 and 6 though should work on most Linux distributions.

The Linux version of Canopy is still in beta but contains all of the functionality of the Windows and Mac OS versions.

Notice: Accessing full library of Canopy Python packages

The Canopy installers include the core SciPy software stack and other packages listed in the Canopy Express version. When Canopy is installed all of these packages are installed in the user Python environment.

Subscribers have access to the full Canopy Python repository via the Canopy Package Manager. Additional packages can be installed individually as needed or users can install all available packages. To install all packages, click the button labeled “Install All Canopy Packages” found in the lower-right corner of the Package Manager window. This option is available to Canopy (EPD) subscribers.

../_images/add-all-pkgs-btn.png

Issue: No proxy firewall support

Canopy does not currently support proxy firewalls. Please see How do I use Canopy when behind a proxy firewall? for more information.

Issue: Canopy is an ‘unidentified application’ on Mac OS 10.8 (Mountain Lion)

In Mac OS 10.8 Mountain Lion, Apple introduced a feature called “Gatekeeper” that restricts unidentified applications from installing and running. The Canopy application has not yet been been added to the Gatekeeper identification system.

As a result you may see a message like this if you attempt to start the Canopy application:

../_images/release-notes-open-err-1.png

To open Canopy the first time, you need to Control-click the Canopy application icon to bring up a context menu, and select “Open”. You will then see a dialog which has a message:

../_images/release-notes-open-err-2.png

Click “Open” and Canopy will start.

You only need to do this once. After this you will be able to start Canopy application normally by double-clicking its icon.

Issue: ‘Use Canopy as my default Python’ does not override Windows system settings

When Canopy is run for the first time, it setups up your Python environment and offers to make Canopy the default Python environment. It does this by pre-pending the location of Canopy’s Python interpreter to the front of the PATH environment variable. In most cases this has the desired behavior and makes Canopy the default for the Windows Command Prompt and other terminals.

This method does not work if another application with Python has been installed on the system by an administrator and the path to that application has been added to the system PATH setting. Windows first uses the system’s PATH setting and then the user’s PATH, so the other application will be found first.

The workaround is to manually adjust the system PATH setting if possible. Alternately, PATH must be set once the Windows Command Prompt has been started.

Table Of Contents

Previous topic

Canopy Command Line Interface (CLI)

Next topic

Recording, Editing, and Writing Macros

This Page