Warning

This documentation needs to, and is about to be updated significantly.

Bienvenue 환영합니다 Bienvenido - ようこそ Welcome 歡迎光臨

Friendly tracebacks - Simplified Python tracebacks translatable into any language.

Code on Github

Warning

This is alpha software, currently in development. The API is subject to change without notice; such changes may not be included (yet) in this documentation. Note that most screenshots have been taken with an obsolete version. We aim to replace those when work for version 0.2 has been completed.

In a nutshell

There exists many Python projects intended to supplement the information given by Python traceback to make them more useful for advanced programmers. Friendly-traceback is not one of these projects.

Friendly-traceback is aimed primarily at beginners and/or at users who would like to get information about traceback in their own language. Please, see the Design section for a complete description of the goals of this project.

While Friendly-traceback can be used on its own with a specially designed REPL, a better option is to use it together with GUI editors/IDE that are especially designed with beginners in mind. We know of two excellent such programs: Mu and Thonny. This documentation includes a specific page for each of these two editors which explain how to use Friendly-traceback.

A quick look

Let’s have a quick look at a standard Python traceback when using the REPL.

Python IndexError

Not exactly the most helpful information for beginners …

Here’s the corresponding version from Friendly-traceback’s REPL

Friendly IndexError in English

The only thing that is shown in exactly the same way is the line showing the exception name and a message. Everything else can be made available in other languages.

Friendly IndexError in French

About the version

Typically, the version shown at the top will have the letter “a” at the end. This means that the latest update to the documentation was made after a release with a version number without the “a” was uploaded to Pypi, and that we are working towards the next release. As a result, some features shown here may be slightly different from the version available from Pypi.