Warning

Most of the documentation was written prior to version 0.5 and needs to be updated. This work has now started for version 0.7 and we aim to have it completed before version 0.8 is available.

Friendly object

What happens if someone uses an object with the same name as a friendly helper function?

As you can see, these functions are also available as static methods of a Friendly object. So, as long as you don’t use Friendly as the name of an object in your program, you don’t have to worry about not being able to use any of Friendly’s interactive functions.

If you simply enter the name of that object, you can see a summary of each available method of that object.

A somewhat similar short description is available for each individual functions. These descriptions are available in both French and English as shown below.

For advanced users

If you use set_debug() to enter a debugging mode, you get access to more methods of the Friendly object. These can be used to explore normally hidden values related to tracebacks.

These are only available as methods of Friendly and not as individual functions.

Here is one example illustrating the type of information that could be available for SyntaxError cases: