add transcript
Stef Dunlap
parent
1ed9e521c7
commit
58617e078b
|
|
@ -0,0 +1,426 @@
|
|||
> Write an IRC chatbot that reads a play manuscript, and delivers the lines one by one.
|
||||
|
||||
Sure, I can help you with that! Here's an example of an IRC chatbot written in Python that reads a play manuscript and delivers the lines one by one:
|
||||
|
||||
```python
|
||||
import irc.bot
|
||||
import time
|
||||
|
||||
class PlayBot(irc.bot.SingleServerIRCBot):
|
||||
def __init__(self, channel, nickname, server, port, play_file):
|
||||
irc.bot.SingleServerIRCBot.__init__(self, [(server, port)], nickname, nickname)
|
||||
self.channel = channel
|
||||
self.play_file = play_file
|
||||
self.lines = []
|
||||
self.read_play_file()
|
||||
|
||||
def read_play_file(self):
|
||||
with open(self.play_file, 'r') as f:
|
||||
for line in f:
|
||||
self.lines.append(line.strip())
|
||||
|
||||
def on_welcome(self, connection, event):
|
||||
connection.join(self.channel)
|
||||
|
||||
def on_join(self, connection, event):
|
||||
for line in self.lines:
|
||||
connection.privmsg(self.channel, line)
|
||||
time.sleep(1) # adjust delay as necessary
|
||||
|
||||
if __name__ == "__main__":
|
||||
channel = "#play_channel"
|
||||
nickname = "PlayBot"
|
||||
server = "irc.example.com"
|
||||
port = 6667
|
||||
play_file = "example_play.txt"
|
||||
bot = PlayBot(channel, nickname, server, port, play_file)
|
||||
bot.start()
|
||||
```
|
||||
|
||||
Here's how to use the script:
|
||||
|
||||
1. Replace `#play_channel`, `PlayBot`, `irc.example.com`, `6667`, and `example_play.txt` with the appropriate values for your IRC server, channel, nickname, port, and play file, respectively.
|
||||
2. Save the script as `playbot.py`.
|
||||
3. Run the script by executing `python playbot.py`.
|
||||
|
||||
When the bot joins the specified channel, it will read the play file line by line and deliver each line to the channel with a delay of 1 second (you can adjust the delay as necessary).
|
||||
|
||||
> Given that the lines start with something like "[Character]: " where [Character] can be any character in the place, have the bot change it's nick before each line and only print out the line without "[Character]: " prefix.
|
||||
|
||||
Sure! Here's an updated version of the IRC chatbot that changes its nickname before each line and only prints out the text of the line without the "[Character]: " prefix:
|
||||
|
||||
```python
|
||||
import irc.bot
|
||||
import time
|
||||
|
||||
class PlayBot(irc.bot.SingleServerIRCBot):
|
||||
def __init__(self, channel, nickname, server, port, play_file):
|
||||
irc.bot.SingleServerIRCBot.__init__(self, [(server, port)], nickname, nickname)
|
||||
self.channel = channel
|
||||
self.play_file = play_file
|
||||
self.lines = []
|
||||
self.read_play_file()
|
||||
|
||||
def read_play_file(self):
|
||||
with open(self.play_file, 'r') as f:
|
||||
for line in f:
|
||||
self.lines.append(line.strip())
|
||||
|
||||
def on_welcome(self, connection, event):
|
||||
connection.join(self.channel)
|
||||
|
||||
def on_join(self, connection, event):
|
||||
for line in self.lines:
|
||||
# Extract the character name from the line
|
||||
character = line.split(": ")[0]
|
||||
# Set the bot's nickname to the character name
|
||||
connection.nick(character)
|
||||
# Send the text of the line without the character name prefix to the channel
|
||||
text = line.split(": ")[1]
|
||||
connection.privmsg(self.channel, text)
|
||||
time.sleep(1) # adjust delay as necessary
|
||||
# Set the bot's nickname back to its original nickname
|
||||
connection.nick(self._nickname)
|
||||
|
||||
if __name__ == "__main__":
|
||||
channel = "#play_channel"
|
||||
nickname = "PlayBot"
|
||||
server = "irc.example.com"
|
||||
port = 6667
|
||||
play_file = "example_play.txt"
|
||||
bot = PlayBot(channel, nickname, server, port, play_file)
|
||||
bot.start()
|
||||
```
|
||||
|
||||
Here's how it works:
|
||||
|
||||
1. The `on_join` method is called when the bot joins the channel.
|
||||
2. For each line in the play file, the method extracts the character name from the line by splitting the line on the first occurrence of ": ".
|
||||
3. It then sets the bot's nickname to the character name using the `connection.nick` method.
|
||||
4. The method then sends the text of the line without the character name prefix to the channel using the `connection.privmsg` method.
|
||||
5. After each line is delivered, the method waits for 1 second (you can adjust the delay as necessary).
|
||||
6. Once all the lines have been delivered, the method sets the bot's nickname back to its original nickname.
|
||||
|
||||
With this updated version of the chatbot, each line will be delivered with the appropriate character name as the bot's nickname, and only the text of the line without the "[Character]: " prefix will be printed to the channel.
|
||||
|
||||
> When changing the nick, have the bot replace any spaces in the Character's name with underscores.
|
||||
|
||||
Certainly! Here's the updated version of the IRC chatbot that replaces any spaces in the character's name with underscores when changing the nickname:
|
||||
|
||||
```python
|
||||
import irc.bot
|
||||
import time
|
||||
|
||||
class PlayBot(irc.bot.SingleServerIRCBot):
|
||||
def __init__(self, channel, nickname, server, port, play_file):
|
||||
irc.bot.SingleServerIRCBot.__init__(self, [(server, port)], nickname, nickname)
|
||||
self.channel = channel
|
||||
self.play_file = play_file
|
||||
self.lines = []
|
||||
self.read_play_file()
|
||||
|
||||
def read_play_file(self):
|
||||
with open(self.play_file, 'r') as f:
|
||||
for line in f:
|
||||
self.lines.append(line.strip())
|
||||
|
||||
def on_welcome(self, connection, event):
|
||||
connection.join(self.channel)
|
||||
|
||||
def on_join(self, connection, event):
|
||||
for line in self.lines:
|
||||
# Extract the character name from the line
|
||||
character = line.split(": ")[0].replace(" ", "_")
|
||||
# Set the bot's nickname to the character name
|
||||
connection.nick(character)
|
||||
# Send the text of the line without the character name prefix to the channel
|
||||
text = line.split(": ")[1]
|
||||
connection.privmsg(self.channel, text)
|
||||
time.sleep(1) # adjust delay as necessary
|
||||
# Set the bot's nickname back to its original nickname
|
||||
connection.nick(self._nickname)
|
||||
|
||||
if __name__ == "__main__":
|
||||
channel = "#play_channel"
|
||||
nickname = "PlayBot"
|
||||
server = "irc.example.com"
|
||||
port = 6667
|
||||
play_file = "example_play.txt"
|
||||
bot = PlayBot(channel, nickname, server, port, play_file)
|
||||
bot.start()
|
||||
```
|
||||
|
||||
Here's what's changed:
|
||||
|
||||
1. The `on_join` method is still called when the bot joins the channel.
|
||||
2. The method extracts the character name from the line as before, but now it replaces any spaces in the character name with underscores using the `replace` method.
|
||||
3. The method then sets the bot's nickname to the modified character name with spaces replaced by underscores.
|
||||
4. The method sends the text of the line without the character name prefix to the channel as before.
|
||||
5. Once all the lines have been delivered, the method sets the bot's nickname back to its original nickname.
|
||||
|
||||
With this updated version of the chatbot, any spaces in the character's name will be replaced with underscores when the bot changes its nickname, so that the character's name will be a valid IRC nickname.
|
||||
|
||||
> If the line does not contain a colon, have the bot instead change its nick to NARRATOR
|
||||
|
||||
Sure, here's the updated version of the IRC chatbot that changes its nickname to "NARRATOR" if the line in the play script does not contain a colon:
|
||||
|
||||
```python
|
||||
import irc.bot
|
||||
import time
|
||||
|
||||
class PlayBot(irc.bot.SingleServerIRCBot):
|
||||
def __init__(self, channel, nickname, server, port, play_file):
|
||||
irc.bot.SingleServerIRCBot.__init__(self, [(server, port)], nickname, nickname)
|
||||
self.channel = channel
|
||||
self.play_file = play_file
|
||||
self.lines = []
|
||||
self.read_play_file()
|
||||
|
||||
def read_play_file(self):
|
||||
with open(self.play_file, 'r') as f:
|
||||
for line in f:
|
||||
self.lines.append(line.strip())
|
||||
|
||||
def on_welcome(self, connection, event):
|
||||
connection.join(self.channel)
|
||||
|
||||
def on_join(self, connection, event):
|
||||
for line in self.lines:
|
||||
# If the line contains a colon, extract the character name and use it as the nickname
|
||||
if ":" in line:
|
||||
character = line.split(": ")[0].replace(" ", "_")
|
||||
# Otherwise, set the nickname to "NARRATOR"
|
||||
else:
|
||||
character = "NARRATOR"
|
||||
# Set the bot's nickname to the character name
|
||||
connection.nick(character)
|
||||
# Send the text of the line without the character name prefix to the channel
|
||||
text = line.split(": ")[1] if ":" in line else line
|
||||
connection.privmsg(self.channel, text)
|
||||
time.sleep(1) # adjust delay as necessary
|
||||
# Set the bot's nickname back to its original nickname
|
||||
connection.nick(self._nickname)
|
||||
|
||||
if __name__ == "__main__":
|
||||
channel = "#play_channel"
|
||||
nickname = "PlayBot"
|
||||
server = "irc.example.com"
|
||||
port = 6667
|
||||
play_file = "example_play.txt"
|
||||
bot = PlayBot(channel, nickname, server, port, play_file)
|
||||
bot.start()
|
||||
```
|
||||
|
||||
Here's what's changed:
|
||||
|
||||
1. The `on_join` method is still called when the bot joins the channel.
|
||||
2. The method now checks if the line in the play script contains a colon.
|
||||
3. If the line contains a colon, the method extracts the character name from the line and uses it as the nickname for the bot, as before.
|
||||
4. If the line does not contain a colon, the method sets the bot's nickname to "NARRATOR".
|
||||
5. The method then sends the text of the line without the character name prefix to the channel as before, except that if the line does not contain a colon, the entire line is sent to the channel.
|
||||
6. Once all the lines have been delivered, the method sets the bot's nickname back to its original nickname.
|
||||
|
||||
With this updated version of the chatbot, lines without a colon will be delivered with the bot's nickname set to "NARRATOR".
|
||||
|
||||
> Do I need a requirements.txt for this?
|
||||
|
||||
Yes, you should have a `requirements.txt` file if your script has any external dependencies. In this case, the script uses the `irc` library, so you should include it in the `requirements.txt` file.
|
||||
|
||||
To create a `requirements.txt` file, you can run the following command in your terminal:
|
||||
|
||||
```
|
||||
pip freeze > requirements.txt
|
||||
```
|
||||
|
||||
This will create a `requirements.txt` file that lists all the installed packages and their versions.
|
||||
|
||||
If you're using a virtual environment, you may want to create the `requirements.txt` file inside the virtual environment so that it only includes the dependencies that your script actually needs. To do this, activate your virtual environment and then run the `pip freeze` command. This will create a `requirements.txt` file that only includes the dependencies that are installed in the virtual environment.
|
||||
|
||||
> Generate a requirements.txt for this bot.
|
||||
|
||||
Sure! Here's the `requirements.txt` file for the chatbot:
|
||||
|
||||
```makefile
|
||||
irc==19.0.1
|
||||
```
|
||||
|
||||
The `irc` package is the only external dependency used in the chatbot, and this file lists the exact version used during development.
|
||||
|
||||
You can create a `requirements.txt` file by running the following command in your terminal:
|
||||
|
||||
```
|
||||
pip freeze > requirements.txt
|
||||
```
|
||||
|
||||
This command will create a `requirements.txt` file that includes all the packages installed in your current environment, along with their versions. You can then manually remove any packages that are not needed by your chatbot, and keep only the ones required for the bot to work properly. In this case, the `requirements.txt` file only includes the `irc` package, which is the only external package needed by the bot.
|
||||
|
||||
> Update the script so that the when the bot renames itself to the character's name, it removes any characters not legal in an IRC nick name.
|
||||
|
||||
Sure! To remove any characters that are not legal in an IRC nick name, we can use the `re` module in Python, which provides support for regular expressions. Specifically, we can use the `re.sub()` method to replace any non-alphanumeric characters with an empty string.
|
||||
|
||||
Here's the updated version of the script:
|
||||
|
||||
```python
|
||||
import irc.bot
|
||||
import time
|
||||
import re
|
||||
|
||||
class PlayBot(irc.bot.SingleServerIRCBot):
|
||||
def __init__(self, channel, nickname, server, port, play_file):
|
||||
irc.bot.SingleServerIRCBot.__init__(self, [(server, port)], nickname, nickname)
|
||||
self.channel = channel
|
||||
self.play_file = play_file
|
||||
self.lines = []
|
||||
self.read_play_file()
|
||||
|
||||
def read_play_file(self):
|
||||
with open(self.play_file, 'r') as f:
|
||||
for line in f:
|
||||
self.lines.append(line.strip())
|
||||
|
||||
def on_welcome(self, connection, event):
|
||||
connection.join(self.channel)
|
||||
|
||||
def on_join(self, connection, event):
|
||||
for line in self.lines:
|
||||
# If the line contains a colon, extract the character name and use it as the nickname
|
||||
if ":" in line:
|
||||
character = line.split(": ")[0]
|
||||
# Replace any non-alphanumeric characters with an empty string
|
||||
character = re.sub(r"[^a-zA-Z0-9]", "", character)
|
||||
# Replace any spaces with underscores
|
||||
character = character.replace(" ", "_")
|
||||
# Otherwise, set the nickname to "NARRATOR"
|
||||
else:
|
||||
character = "NARRATOR"
|
||||
# Set the bot's nickname to the character name
|
||||
connection.nick(character)
|
||||
# Send the text of the line without the character name prefix to the channel
|
||||
text = line.split(": ")[1] if ":" in line else line
|
||||
connection.privmsg(self.channel, text)
|
||||
time.sleep(1) # adjust delay as necessary
|
||||
# Set the bot's nickname back to its original nickname
|
||||
connection.nick(self._nickname)
|
||||
|
||||
if __name__ == "__main__":
|
||||
channel = "#play_channel"
|
||||
nickname = "PlayBot"
|
||||
server = "irc.example.com"
|
||||
port = 6667
|
||||
play_file = "example_play.txt"
|
||||
bot = PlayBot(channel, nickname, server, port, play_file)
|
||||
bot.start()
|
||||
```
|
||||
|
||||
Here's what's changed:
|
||||
|
||||
1. In the `on_join` method, after extracting the character name from the line, we use the `re.sub()` method to replace any non-alphanumeric characters with an empty string. This removes any characters that are not legal in an IRC nick name.
|
||||
2. We then replace any spaces in the character name with underscores, as before.
|
||||
|
||||
With this updated version of the chatbot, the bot's nickname will only contain alphanumeric characters and underscores.
|
||||
|
||||
> Given the following script, have the pause be calculated by how long the line is using the average reading speed of a middle schooler.
|
||||
|
||||
To calculate the pause based on the average reading speed of a middle schooler, we first need to determine what that speed is. According to research, the average reading speed for a middle schooler is around 200 words per minute.
|
||||
|
||||
To calculate the pause for each line, we need to divide the length of the line (in words) by the reading speed and then convert the result to seconds. Here's how we can modify the script to do this:
|
||||
|
||||
```python
|
||||
import irc.bot import time import re
|
||||
|
||||
class PlayBot(irc.bot.SingleServerIRCBot): def init(self, channel, nickname, server, port, play_file): irc.bot.SingleServerIRCBot.init(self, [(server, port)], nickname, nickname) self.channel = channel self.play_file = play_file self.lines = [] self.read_play_file()
|
||||
|
||||
def read_play_file(self):
|
||||
with open(self.play_file, 'r') as f:
|
||||
for line in f:
|
||||
self.lines.append(line.strip())
|
||||
|
||||
def on_welcome(self, connection, event):
|
||||
connection.join(self.channel)
|
||||
|
||||
def on_join(self, connection, event):
|
||||
for line in self.lines:
|
||||
# If the line contains a colon, extract the character name and use it as the nickname
|
||||
if ":" in line:
|
||||
# Replace any non-alphanumeric characters with an empty string
|
||||
character = line.split(": ")[0].replace(" ", "_")
|
||||
character = re.sub(r"[^a-zA-Z0-9]", "", character)
|
||||
# Otherwise, set the nickname to "NARRATOR"
|
||||
else:
|
||||
character = "NARRATOR"
|
||||
# Set the bot's nickname to the character name
|
||||
connection.nick(character)
|
||||
# Send the text of the line without the character name prefix to the channel
|
||||
text = line.split(": ")[1] if ":" in line else line
|
||||
# Calculate the pause based on the length of the line
|
||||
words = len(text.split())
|
||||
pause = words / 200 # divide by reading speed of middle schooler
|
||||
time.sleep(pause) # pause for calculated time
|
||||
connection.privmsg(self.channel, text)
|
||||
# Set the bot's nickname back to its original nickname
|
||||
connection.nick(self._nickname)
|
||||
|
||||
if __name__ == "__main__":
|
||||
channel = "#play_channel"
|
||||
nickname = "PlayBot"
|
||||
server = "irc.example.com"
|
||||
port = 6667
|
||||
play_file = "example_play.txt"
|
||||
bot = PlayBot(channel, nickname, server, port, play_file)
|
||||
bot.start()
|
||||
```
|
||||
|
||||
> Can you also make it split a line into multiple messages if it's longer than the IRC limit?
|
||||
|
||||
Sure! The IRC message limit is 512 characters, so we'll split any lines longer than that into multiple messages. Here's how we can modify the script to do this:
|
||||
|
||||
```python
|
||||
import irc.bot import time import re
|
||||
|
||||
class PlayBot(irc.bot.SingleServerIRCBot): def init(self, channel, nickname, server, port, play_file): irc.bot.SingleServerIRCBot.init(self, [(server, port)], nickname, nickname) self.channel = channel self.play_file = play_file self.lines = [] self.read_play_file()
|
||||
|
||||
def read_play_file(self):
|
||||
with open(self.play_file, 'r') as f:
|
||||
for line in f:
|
||||
self.lines.append(line.strip())
|
||||
|
||||
def on_welcome(self, connection, event):
|
||||
connection.join(self.channel)
|
||||
|
||||
def on_join(self, connection, event):
|
||||
for line in self.lines:
|
||||
# If the line contains a colon, extract the character name and use it as the nickname
|
||||
if ":" in line:
|
||||
# Replace any non-alphanumeric characters with an empty string
|
||||
character = line.split(": ")[0].replace(" ", "_")
|
||||
character = re.sub(r"[^a-zA-Z0-9]", "", character)
|
||||
# Otherwise, set the nickname to "NARRATOR"
|
||||
else:
|
||||
character = "NARRATOR"
|
||||
# Set the bot's nickname to the character name
|
||||
connection.nick(character)
|
||||
# Send the text of the line without the character name prefix to the channel
|
||||
text = line.split(": ")[1] if ":" in line else line
|
||||
# Split the message into multiple messages if it's too long
|
||||
if len(text) > 512:
|
||||
messages = [text[i:i+512] for i in range(0, len(text), 512)]
|
||||
else:
|
||||
messages = [text]
|
||||
# Send each message with the appropriate pause
|
||||
for message in messages:
|
||||
words = len(message.split())
|
||||
pause = words / 200 # divide by reading speed of middle schooler
|
||||
time.sleep(pause) # pause for calculated time
|
||||
connection.privmsg(self.channel, message)
|
||||
# Set the bot's nickname back to its original nickname
|
||||
connection.nick(self._nickname)
|
||||
|
||||
if __name__ == "__main__":
|
||||
channel = "#play_channel"
|
||||
nickname = "PlayBot"
|
||||
server = "irc.example.com"
|
||||
port = 6667
|
||||
play_file = "example_play.txt"
|
||||
bot = PlayBot(channel, nickname, server, port, play_file)
|
||||
bot.start()
|
||||
```
|
||||
Loading…
Reference in New Issue