thonny-pseudocode 0.1.6

A Thonny plugin that generates inline pseudocode explaining the Python source code line-by-line.

thonny-pseudocode

A Thonny plug-in that generates inline pseudocode on-demand, explaining the Python source code line-by-line, powered by the PyToPseu project.

The plug-in currently supports generating pseudocode in English and French (depending on the UI language set by the user in Thonny's settings).

Table of contents:
Installation
User Guide
Limitations

Installation

Inside Thonny, click on Tools > Manage plug-ins... to open the plug-ins dialog. Search for the "thonny-pseudocode" package and install it. Make sure your installed version is at least 0.1.3.

Once installed, restart Thonny to load the plug-in.

User Guide

You can generate pseudocode with the plug-in's "Explain with pseudocode" command. There are 3 ways to trigger the command:

1. From the menu:

2. From the toolbar:

3. Using the Ctrl+E/Cmd+E hotkey:

Once generated, the command may be used again to erase the generated pseudocode:

Note: When the plug-in erases generated pseudocode, it will systematically remove all trailing whitespaces on all lines.

Since the generated pseudocode is actually appended to the source code in the form of comments (preserving the developer's own comments), the developer may continue to edit the code afterwards. Using the command again on edited code will immediately regenerate pseudocode for the new code. As soon as the command is used a second time on a particular piece of code, the plug-in will erase the generated pseudocode.

Limitations

The plug-in currently has the following limitations:

• It cannot generate pseudocode for code with the slightest syntax error
• It may insert new-lines in the source code to have enough space for the pseudocode, but will not remove those new-lines when it erases the generated pseudocode
• Generated pseudocode goes into (and "pollutes") the editing history, which means that erasing pseudocode then undoing the last change will bring back the pseudocode