Limnoria/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Limnoria/Limnoria-doc.git synced 2025-04-06 15:29:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document dynamicScope.

Browse Source
This commit is contained in:
Valentin Lorentz
2014-01-20 10:58:19 +01:00
parent 6c3d4fa07c
commit 2df3137061
2 changed files with 35 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
develop/using_utils.rst
View File

@ -377,3 +377,28 @@ supybot.utils.iter - iterable utilities
predicate p
* choice(iterable) - Returns a random element from the iterable
supybot.dynamicScope / dynamic - accessing variables in the stack
-----------------------------------------------------------------
This feature is not in `supybot.utils` but still deserves to be documented
as a utility.
Althrough you should avoid using this feature as long as you can, it is
sometimes necessary to access variables the Supybot API does not provide you.
For instance, the `Aka` plugin provides per-channel aliases by overriding
:ref:`getCommandMethod <commands_handling>`. However, the channel where the
command is called is not passed to this functions, so when writing `Aka` I
could either add this parameter (and thus break all plugins all plugins
already overriding this method) or use this hack. I choosed this hack.
How does it work? This is quite simple: ``dynamic.channel`` is a shortcut
for ``supybot.dynamicScope.DynamicScope.__getattr__('channel')``, which
browse the call stack backwards, looking for a variable named ``channel``,
and then returns is as far as it finds it (and returns ``None`` if there
is no such variale).
Note that you don't have to import ``dynamicScope``, the ``dynamic`` object
is automatically set as a global variable when Supybot starts.