Limnoria/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Limnoria/Limnoria-doc.git synced 2025-04-05 14:59:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

plugin_tutorial: use dedent=0

Browse Source
This commit is contained in:
James Lu
2023-05-07 12:46:32 -07:00
committed by James Lu
parent a88f291096
commit 007b64edb7
1 changed files with 31 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
develop/plugin_tutorial.rst
View File

@ -177,9 +177,15 @@ an ``irc`` argument in addition to ``self``.
Basic command handler Basic command handler
--------------------- ---------------------
Our first command definition can immediately follow:: Our first command definition can immediately follow:
..
note: turn off automatic dedent so that the functions appear at the right
indent level relative to the class definition
.. code-block::
:dedent: 0
# dummy comment to indent the below code consistently
@wrap @wrap
def random(self, irc, msg, args): def random(self, irc, msg, args):
"""takes no arguments """takes no arguments
@ -225,9 +231,11 @@ Command handler with parameters
------------------------------- -------------------------------
Now let's create a command with some arguments and see how we use those in our Now let's create a command with some arguments and see how we use those in our
plugin commands. This ``seed`` command lets the user pick a specific RNG seed:: plugin commands. This ``seed`` command lets the user pick a specific RNG seed:
.. code-block::
:dedent: 0
# dummy comment to indent the below code consistently
@wrap(['float']) @wrap(['float'])
def seed(self, irc, msg, args, seed): def seed(self, irc, msg, args, seed):
"""<seed> """<seed>
@ -266,9 +274,11 @@ we'll go include some more examples to illustrate common patterns.
Command handler with list-type arguments Command handler with list-type arguments
---------------------------------------- ----------------------------------------
The next sample command is named ``sample`` (no pun intended): it takes a random The next sample command is named ``sample`` (no pun intended): it takes a random
sample of arbitrary size from a list provided by the user:: sample of arbitrary size from a list provided by the user:
.. code-block::
:dedent: 0
# dummy comment to indent the below code consistently
def sample(self, irc, msg, args, n, items): def sample(self, irc, msg, args, n, items):
"""<number of items> <item1> [<item2> ...] """<number of items> <item1> [<item2> ...]
@ -279,7 +289,7 @@ sample of arbitrary size from a list provided by the user::
if n > len(items): if n > len(items):
# Calling irc.error with Raise=True is an alternative early return # Calling irc.error with Raise=True is an alternative early return
irc.error('<number of items> must be less than the number ' irc.error('<number of items> must be less than the number '
'of arguments.', Raise=True) 'of arguments.', Raise=True)
sample = self.rng.sample(items, n) sample = self.rng.sample(items, n)
sample.sort() sample.sort()
irc.reply(utils.str.commaAndify(sample)) irc.reply(utils.str.commaAndify(sample))
@ -313,9 +323,11 @@ Command handler with optional arguments
--------------------------------------- ---------------------------------------
Now for the last command that we will add to our plugin.py. This ``diceroll`` Now for the last command that we will add to our plugin.py. This ``diceroll``
command will allow the bot users to roll an arbitrary n-sided die, with n command will allow the bot users to roll an arbitrary n-sided die, with n
defaulting to 6:: defaulting to 6:
.. code-block::
:dedent: 0
# dummy comment to indent the below code consistently
def diceroll(self, irc, msg, args, n): def diceroll(self, irc, msg, args, n):
"""[<number of sides>] """[<number of sides>]
@ -384,9 +396,11 @@ the result will be::
However, this is less true if you pre-seed the RNG, as then you're guaranteed However, this is less true if you pre-seed the RNG, as then you're guaranteed
a repeatable result. The following snippet introduces a repeatable result. The following snippet introduces
``assertResponse(commandPlusArgs, expectedOutput)``, where ``commandPlusArgs`` ``assertResponse(commandPlusArgs, expectedOutput)``, where ``commandPlusArgs``
is the full bot command including arguments, all as one string:: is the full bot command including arguments, all as one string:
.. code-block::
:dedent: 0
# dummy comment to indent the below code consistently
def testSeed(self): def testSeed(self):
self.assertNotError('seed 20') self.assertNotError('seed 20')
self.assertResponse('random', '0.9056396761745207') self.assertResponse('random', '0.9056396761745207')
@ -397,9 +411,11 @@ is the full bot command including arguments, all as one string::
self.assertResponse('random', '0.9664535356921388') self.assertResponse('random', '0.9664535356921388')
Alternatively, you can use ``getMsg(command)`` to fetch the output of a bot Alternatively, you can use ``getMsg(command)`` to fetch the output of a bot
command as a string and reuse it:: command as a string and reuse it:
.. code-block::
:dedent: 0
# dummy comment to indent the below code consistently
def testSeed(self): def testSeed(self):
self.assertNotError('seed 20') self.assertNotError('seed 20')
num1 = self.getMsg('random') num1 = self.getMsg('random')
@ -420,9 +436,9 @@ a command:
compares a regexp against a bare string, not the output of a bot command. compares a regexp against a bare string, not the output of a bot command.
(For historical reasons, we have this confusing name.) (For historical reasons, we have this confusing name.)
:: .. code-block::
:dedent: 0
# dummy comment to indent the below code consistently
def testSample(self): def testSample(self):
self.assertError('sample 20 foo') # can't sample 20 from only 1 element self.assertError('sample 20 foo') # can't sample 20 from only 1 element
self.assertResponse('sample 1 foo', 'foo') self.assertResponse('sample 1 foo', 'foo')