Using logging or messages from a plugin?

Support
, ,
1

Exploring developing a plugin. Wanting to log information for debugging in the Python plugin script. Documentation for the plugin.xml suggests you can direct stdout and stderr to the SynFig log or a message presented to the user. Does this work? I’m trying to direct log messages to either using Python “print” statements. No message is displayed to me. And I’m not sure where the SynFig log file is located.

Any insight appreciated…

Thanks!

2

As written in Plugins — Synfig User Manual 1.5.1 documentation

stdout

What to do with the script standard output:

  • ignore output is discarded
  • log the output is shown in the Synfig log
  • message an error message is shown to the user

stderr

Same as above, but for standard error

Example:

<exec>myscript.py</exec>

Changing stream behaviour:

<exec stdout="log" stderr="ignore">myscript.py</exec>

So you should set “log” for both stdout and stderr and start Synfig from a terminal/console to see the log.
If you are under Windows, you should use “synfigstudio.exe --console” to start it.

3

Thanks for the info. I was not aware there is a console available. So I launched a copy of synfigstudio.exe with the --console parameter. Synfig came up but I’m not sure where the console is.

Also, is this documented and I just missed it?

4

It exists since 1.0

Or even on Github

Everywhere where we talk about to obtain logs to solve an issue …
Note that this parameter is specific to Windows, which is not the primary target for development.
Starting SynfigStudio from the terminal in Linux displays everything.