baa8cda814
`registry.Value.__call__()` is a wrapper around access to `registry.Value.value`, that checks if the value was set before the latest call to `registry.open_registry`; and updates the `value` if needed. When accessing `registry.Value.value` directly, this cache can't be invalidated, causing the old value to still be used, until the next call to `registry.Value.__call__()`. |
||
|---|---|---|
| .. | ||
| locales | ||
| __init__.py | ||
| config.py | ||
| messages.pot | ||
| plugin.py | ||
| README.rst | ||
| test.py | ||
Documentation for the ChannelStats plugin for Supybot
Purpose
Silently listens to every message received on a channel and keeps statistics concerning joins, parts, and various other commands in addition to tracking statistics about smileys, actions, characters, and words.
Usage
This plugin keeps stats of the channel and returns them with the command 'channelstats'.
Commands
- channelstats [<channel>]
-
Returns the statistics for <channel>. <channel> is only necessary if the message isn't sent on the channel itself.
- rank [<channel>] <stat expression>
-
Returns the ranking of users according to the given stat expression. Valid variables in the stat expression include 'msgs', 'chars', 'words', 'smileys', 'frowns', 'actions', 'joins', 'parts', 'quits', 'kicks', 'kicked', 'topics', and 'modes'. Any simple mathematical expression involving those variables is permitted.
- stats [<channel>] [<name>]
-
Returns the statistics for <name> on <channel>. <channel> is only necessary if the message isn't sent on the channel itself. If <name> isn't given, it defaults to the user sending the command.
Configuration
- supybot.plugins.ChannelStats.frowns
-
This config variable defaults to ":| :-/ :-\ :\ :/ :( :-( :'(", is network-specific, and is channel-specific.
Determines what words (i.e., pieces of text with no spaces in them) are considered 'frowns' for the purposes of stats-keeping.
- supybot.plugins.ChannelStats.public
-
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
- supybot.plugins.ChannelStats.selfStats
-
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the bot will keep channel statistics on itself, possibly skewing the channel stats (especially in cases where the bot is relaying between channels on a network).
- supybot.plugins.ChannelStats.smileys
-
This config variable defaults to ":) ;) ;] :-) :-D :D :P :p (= =)", is network-specific, and is channel-specific.
Determines what words (i.e., pieces of text with no spaces in them) are considered 'smileys' for the purposes of stats-keeping.