Firepup650/bitbot-3.11-fork
2
0
Fork 0
Code Issues Pull requests Activity Actions

update words.py to use command specs (and not docstrings)

Browse source
This commit is contained in:
jesopo 2020-02-15 00:26:07 +00:00
parent aa02ba843c
commit 60c2e1138d
1 changed files with 10 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
modules/words.py
View file

@ -129,13 +129,11 @@ class Module(ModuleManager.BaseModule):
target_user.nickname, total, this_channel, event["target"].name, target_user.nickname, total, this_channel, event["target"].name,
since)) since))
@utils.hook("received.command.trackword", min_args=1) @utils.hook("received.command.trackword")
@utils.kwarg("help", "Start tracking a word")
@utils.kwarg("permission", "track-word")
@utils.spec("!<word>wordlower")
def track_word(self, event): def track_word(self, event):
"""
:help: Start tracking a word
:usage: <word>
:permission: track-word
"""
word = event["args_split"][0].lower() word = event["args_split"][0].lower()
tracked_words = event["server"].get_setting("tracked-words", []) tracked_words = event["server"].get_setting("tracked-words", [])
if not word in tracked_words: if not word in tracked_words:
@ -146,10 +144,9 @@ class Module(ModuleManager.BaseModule):
event["stderr"].write("Already tracking '%s'" % word) event["stderr"].write("Already tracking '%s'" % word)
@utils.hook("received.command.trackedwords") @utils.hook("received.command.trackedwords")
@utils.kwarg("help",
"List which words are being tracked on the current network")
def tracked_words(self, event): def tracked_words(self, event):
"""
:help: List which words are being tracked on the current network
"""
event["stdout"].write("Tracked words: %s" % ", ".join( event["stdout"].write("Tracked words: %s" % ", ".join(
event["server"].get_setting("tracked-words", []))) event["server"].get_setting("tracked-words", [])))
@ -159,12 +156,10 @@ class Module(ModuleManager.BaseModule):
nickname = utils.prevent_highlight(nickname) nickname = utils.prevent_highlight(nickname)
return nickname return nickname
@utils.hook("received.command.wordusers", min_args=1) @utils.hook("received.command.wordusers")
@utils.kwarg("help", "Show who has used a tracked word the most")
@utils.spec("!<word>wordlower")
def word_users(self, event): def word_users(self, event):
"""
:help: Show who has used a tracked word the most
:usage: <word>
"""
word = event["args_split"][0].lower() word = event["args_split"][0].lower()
if word in event["server"].get_setting("tracked-words", []): if word in event["server"].get_setting("tracked-words", []):
word_users = event["server"].get_all_user_settings( word_users = event["server"].get_all_user_settings(
@ -180,13 +175,9 @@ class Module(ModuleManager.BaseModule):
event["stderr"].write("That word is not being tracked") event["stderr"].write("That word is not being tracked")
@utils.hook("received.command.wordiest") @utils.hook("received.command.wordiest")
@utils.kwarg("help", "Show wordiest users")
@utils.spec("!-channelonly ?<start>date ?<end>date") @utils.spec("!-channelonly ?<start>date ?<end>date")
def wordiest(self, event): def wordiest(self, event):
"""
:help: Show wordiest users
:usage: [startdate
"""
date_str = "" date_str = ""
if event["spec"][0]: if event["spec"][0]: