Limnoria/plugins/Debug/README.rst

.. _plugin-Debug:

Documentation for the Debug plugin for Supybot
==============================================

Purpose
-------
This is for developers debugging their plugins; it provides an eval command
as well as some other useful commands.
It should not be loaded with a default installation.

Usage
-----
This plugin provides debugging abilities for Supybot. It
should not be loaded with a default installation.

Commands
--------
channeldb [<channel>]
  Returns the result of the channeldb converter.

collect [<times>]
  Does <times> gc collections, returning the number of objects collected each time. <times> defaults to 1.

environ takes no arguments
  Returns the environment of the supybot process.

eval <expression>
  Evaluates <expression> (which should be a Python expression) and returns its value. If an exception is raised, reports the exception (and logs the traceback to the bot's logfile).

exec <statement>
  Execs <code>. Returns success if it didn't raise any exceptions.

exn <exception name>
  Raises the exception matching <exception name>.

sendquote <raw IRC message>
  Sends (not queues) the raw IRC message given.

settrace [<filename>]
  Starts tracing function calls to <filename>. If <filename> is not given, sys.stdout is used. This causes much output.

simpleeval <expression>
  Evaluates the given expression.

unsettrace takes no arguments
  Stops tracing function calls on stdout.

Configuration
-------------
supybot.plugins.Debug.public
  This config variable defaults to "True", is not network-specific, and is  not channel-specific.

  Determines whether this plugin is publicly visible.
all plugins: auto-generate READMEs Starting with this commit, there should be no "original" text in READMEs. Instead, the entire text should be in docstrings, and READMEs should be automatically generated from these docstrings. Motivation: * The same help is available both via IRC and in the README (although the README can be more detailed, as only the first paragraph will be shown on IRC) * This will allow auto-generating plugin help on docs.limnoria.net using the same content as the README, as it's sourced from the docstrings Additionally, this converts all READMEs from Markdown to ReST, because the documentation already uses ReST, and other docstrings in the codebase are in ReST for this reason. 2021-04-05 17:29:49 +02:00			`.. _plugin-Debug:`

			`Documentation for the Debug plugin for Supybot`
			`==============================================`

			`Purpose`
			`-------`
			`This is for developers debugging their plugins; it provides an eval command`
			`as well as some other useful commands.`
			`It should not be loaded with a default installation.`

			`Usage`
			`-----`
			`This plugin provides debugging abilities for Supybot. It`
			`should not be loaded with a default installation.`

			`Commands`
			`--------`
			`channeldb [<channel>]`
			`Returns the result of the channeldb converter.`

			`collect [<times>]`
			`Does <times> gc collections, returning the number of objects collected each time. <times> defaults to 1.`

			`environ takes no arguments`
			`Returns the environment of the supybot process.`

			`eval <expression>`
			`Evaluates <expression> (which should be a Python expression) and returns its value. If an exception is raised, reports the exception (and logs the traceback to the bot's logfile).`

			`exec <statement>`
			`Execs <code>. Returns success if it didn't raise any exceptions.`

			`exn <exception name>`
			`Raises the exception matching <exception name>.`

			`sendquote <raw IRC message>`
			`Sends (not queues) the raw IRC message given.`

			`settrace [<filename>]`
			`Starts tracing function calls to <filename>. If <filename> is not given, sys.stdout is used. This causes much output.`

			`simpleeval <expression>`
			`Evaluates the given expression.`

			`unsettrace takes no arguments`
			`Stops tracing function calls on stdout.`

			`Configuration`
			`-------------`
			`supybot.plugins.Debug.public`
			`This config variable defaults to "True", is not network-specific, and is not channel-specific.`

			`Determines whether this plugin is publicly visible.`