black

Code/irc/madlibbot/madlibbot.py

@@ -15,33 +15,56 @@ import operator
 from .. import util
 import madlib
 
+
 class State:
-    idle = 0 # When the bot is started and after it has finished a story
-    thinking = 1 # I intentionally speed throttle this bot so it feels a little more natural
-    story_selection = 2 # When the bot is waiting for a user input for story selection
-    word_input = 3 # When the bot is waiting for user input after prompted for a word
+    idle = 0  # When the bot is started and after it has finished a story
+    thinking = (
+        1
+    )  # I intentionally speed throttle this bot so it feels a little more natural
+    story_selection = 2  # When the bot is waiting for a user input for story selection
+    word_input = 3  # When the bot is waiting for user input after prompted for a word
+
 
 # Globals
-MAX_LINE = 80 # The maximum number of characters in a line
-MAX_STORIES = 5 # The maximum number of stories a user can pick from
-THROTTLE_FACTOR = 1 # A factor by which all sleep event durations will be multiplied
+MAX_LINE = 80  # The maximum number of characters in a line
+MAX_STORIES = 5  # The maximum number of stories a user can pick from
+THROTTLE_FACTOR = 1  # A factor by which all sleep event durations will be multiplied
 # Allow madlbibbot to run multiple simultaneous stories
-state = {} # The current state of the bot
-stories = {} # The list of stories available to users
-story = {} # The madlib story currently being worked on
-nextword = {} # The word that the bot is currently expecting data for
+state = {}  # The current state of the bot
+stories = {}  # The list of stories available to users
+story = {}  # The madlib story currently being worked on
+nextword = {}  # The word that the bot is currently expecting data for
 
 parser = OptionParser()
 
-parser.add_option("-s", "--server", dest="server", default='127.0.0.1',
-                  help="the server to connect to", metavar="SERVER")
-parser.add_option("-c", "--channel", dest="channel", default='#madlibs',
-                  help="the channel to join", metavar="CHANNEL")
-parser.add_option("-n", "--nick", dest="nick", default='madlibbot',
-                  help="the nick to use", metavar="NICK")
+parser.add_option(
+    "-s",
+    "--server",
+    dest="server",
+    default="127.0.0.1",
+    help="the server to connect to",
+    metavar="SERVER",
+)
+parser.add_option(
+    "-c",
+    "--channel",
+    dest="channel",
+    default="#madlibs",
+    help="the channel to join",
+    metavar="CHANNEL",
+)
+parser.add_option(
+    "-n",
+    "--nick",
+    dest="nick",
+    default="madlibbot",
+    help="the nick to use",
+    metavar="NICK",
+)
 
 (options, args) = parser.parse_args()
 
+
 def resetGlobals(channel=""):
     global state
     global stories
@@ -59,6 +82,7 @@ def resetGlobals(channel=""):
         story[channel] = ""
         nextword[channel] = {}
 
+
 def get_stories(channel, botnick):
     global state
     global stories
@@ -73,9 +97,13 @@ def get_stories(channel, botnick):
         for idx, story in enumerate(stories[channel]):
             sendmsg(channel, "[{}] {} ({} words)".format(idx, story[0], story[2]))
             time.sleep(0.5 * THROTTLE_FACTOR)
-        sendmsg(channel, "Please select a story by index by saying '{}: <number>':".format(botnick))
+        sendmsg(
+            channel,
+            "Please select a story by index by saying '{}: <number>':".format(botnick),
+        )
         state[channel] = State.story_selection
 
+
 # Handle user input when the bot is directly addressed
 def handle_bot_msg(channel, msg, botnick):
     global state
@@ -100,11 +128,13 @@ def handle_bot_msg(channel, msg, botnick):
     else:
         state[channel] = State.idle
 
+
 # Handle how to quit the game
 def quit_game(channel):
     resetGlobals(channel)
     sendmsg(channel, "Ok, quitting the current game.")
 
+
 # Handle user input when we are in story selection mode
 def handle_story_selection(channel, msg, botnick):
     global stories
@@ -115,16 +145,19 @@ def handle_story_selection(channel, msg, botnick):
             sendmsg(channel, "Selection out of bounds. Try again!")
             return
         time.sleep(1 * THROTTLE_FACTOR)
-        sendmsg(channel, "Give me a second to load up {}".format(stories[channel][imsg][0]))
+        sendmsg(
+            channel, "Give me a second to load up {}".format(stories[channel][imsg][0])
+        )
 
         with open(stories[channel][imsg][1], "r") as storyFile:
             story[channel] = storyFile.read()
-        stories[channel] = {} # Clear out the saved selectable stories in memory
+        stories[channel] = {}  # Clear out the saved selectable stories in memory
         story_start(channel, botnick)
     except ValueError:
         sendmsg(channel, "Invalid selection. Try again!")
         state[channel] = State.story_selection
 
+
 # Handle when a story is being started
 def story_start(channel, botnick):
     global story
@@ -132,12 +165,18 @@ def story_start(channel, botnick):
     global nextword
 
     state[channel] = State.thinking
-    sendmsg(channel, "Alright! Let's get started! Say '{}: <word>' to give me words.".format(botnick))
+    sendmsg(
+        channel,
+        "Alright! Let's get started! Say '{}: <word>' to give me words.".format(
+            botnick
+        ),
+    )
     nextword[channel] = madlib.find_next_word(story[channel], True)
     time.sleep(0.5 * THROTTLE_FACTOR)
     sendmsg(channel, "Give me {}:".format(nextword[channel][1]))
     state[channel] = State.word_input
 
+
 # Handle user input when we have asked the user for input and are expecting a
 # response
 def handle_story_step(channel, msg):
@@ -146,7 +185,7 @@ def handle_story_step(channel, msg):
     global nextword
 
     state[channel] = State.thinking
-    word = nextword[channel] #madlib.find_next_word(story[channel])
+    word = nextword[channel]  # madlib.find_next_word(story[channel])
     if word is not None:
         story[channel] = madlib.replace_word(story[channel], nextword[channel][0], msg)
     time.sleep(1 * THROTTLE_FACTOR)
@@ -155,62 +194,86 @@ def handle_story_step(channel, msg):
     if nextword[channel] is None:
         finish_story(channel)
         return
-    #else
+    # else
     count = madlib.count_words(story[channel])
-    sendmsg(channel, "Thanks! Now give me {} ({} words left)".format(nextword[channel][1], count))
+    sendmsg(
+        channel,
+        "Thanks! Now give me {} ({} words left)".format(nextword[channel][1], count),
+    )
     state[channel] = State.word_input
 
+
 # Finish the story
 def finish_story(channel):
     global state
     global story
 
-    sendmsg(channel, "Ok, here's the story...");
-    sendmsg(channel, '=' * MAX_LINE)
+    sendmsg(channel, "Ok, here's the story...")
+    sendmsg(channel, "=" * MAX_LINE)
     for line in story[channel].splitlines():
         for part in madlib.yield_lines(line, MAX_LINE):
             time.sleep(0.6 * THROTTLE_FACTOR)
             sendmsg(channel, part)
-    padlen = (MAX_LINE - 9)/2
+    padlen = (MAX_LINE - 9) / 2
     mod = (MAX_LINE - 9) % 2
-    sendmsg(channel, '=' * padlen + ' THE END ' + '=' * (padlen + mod))
+    sendmsg(channel, "=" * padlen + " THE END " + "=" * (padlen + mod))
 
     story[channel] = ""
     state[channel] = State.idle
 
+
 # System things
 def ping(pong):
     ircsock.send("PONG {}\n".format(pong))
 
-def sendmsg(chan , msg):
+
+def sendmsg(chan, msg):
     ircsock.send("PRIVMSG {} :{}\n".format(chan, msg))
 
+
 def joinchan(chan):
     global state
     state[chan] = State.idle
     ircsock.send("JOIN {}\n".format(chan))
 
+
 def rollcall(channel, botnick):
     global state
     if channel not in state:
         state[channel] = State.idle
 
     if state[channel] == State.idle:
-        sendmsg(channel, "Do you like MadLibs? Start a collaborative story by saying '{}: startgame'".format(botnick))
+        sendmsg(
+            channel,
+            "Do you like MadLibs? Start a collaborative story by saying '{}: startgame'".format(
+                botnick
+            ),
+        )
     else:
-        sendmsg(channel, "A game is already in progress. Say '{}: <word>' to provide me with the next word or '{}: !quit' to stop the current game".format(botnick, botnick))
+        sendmsg(
+            channel,
+            "A game is already in progress. Say '{}: <word>' to provide me with the next word or '{}: !quit' to stop the current game".format(
+                botnick, botnick
+            ),
+        )
+
 
 def connect(server, channel, botnick):
     ircsock.connect((server, 6667))
-    ircsock.send("USER {} {} {} :krowbar\n".format(botnick, botnick, botnick)) # user authentication
+    ircsock.send(
+        "USER {} {} {} :krowbar\n".format(botnick, botnick, botnick)
+    )  # user authentication
     ircsock.send("NICK {}\n".format(botnick))
     joinchan(channel)
 
+
 def listen(botnick):
-    botmsgre = re.compile('^{}\:?\s*(.*)$'.format(botnick)) # re to strip the bot's name from a message
+    botmsgre = re.compile(
+        "^{}\:?\s*(.*)$".format(botnick)
+    )  # re to strip the bot's name from a message
     while 1:
         ircmsg = ircsock.recv(2048)
-        ircmsg = ircmsg.strip('\n\r')
+        ircmsg = ircmsg.strip("\n\r")
 
         if ircmsg[:4] == "PING":
             ping(ircmsg.split(" ")[1])
@@ -227,7 +290,10 @@ def listen(botnick):
         channel = split[3]
         message = split[4]
 
-        if message.startswith("!rollcall") == True or message.startswith("!help") == True:
+        if (
+            message.startswith("!rollcall") == True
+            or message.startswith("!help") == True
+        ):
             rollcall(channel, botnick)
         elif message.startswith(botnick) == True:
             botmsg = botmsgre.match(message).group(1)
@@ -236,6 +302,7 @@ def listen(botnick):
         sys.stdout.flush()
         time.sleep(1 * THROTTLE_FACTOR)
 
+
 ircsock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
 connect(options.server, options.channel, options.nick)
 listen(options.nick)