Telegram Bot to Shuffle Lines from a TXT File

This document outlines a Python function to create a Telegram bot that shuffles the lines from a specified TXT file. The bot will respond to messages with the shuffled lines.

Required Libraries

To implement the bot, you'll need the following libraries:

• python-telegram-bot: To interact with the Telegram Bot API.
• random: To shuffle the lines.

Necessary Code

import random
from telegram import Update
from telegram.ext import Updater, CommandHandler, MessageHandler, Filters, CallbackContext

# Define the path to your text file
FILE_PATH = 'your_file.txt'

def load_lines_from_file(file_path: str) -> list:
    """
    Load lines from a specified TXT file.

    Parameters:
    file_path (str): The path to the TXT file.

    Returns:
    list: A list of lines from the file.
    
    Raises:
    FileNotFoundError: If the file does not exist.
    """
    try:
        with open(file_path, 'r', encoding='utf-8') as file:
            lines = file.readlines()
        return [line.strip() for line in lines if line.strip()]
    except FileNotFoundError:
        raise FileNotFoundError(f"The file '{file_path}' does not exist.")

def shuffle_lines(update: Update, context: CallbackContext) -> None:
    """
    Shuffle lines from the TXT file and send them back to the user.

    Parameters:
    update (Update): Incoming update object.
    context (CallbackContext): Context for the command.
    """
    # Load lines from the file
    lines = load_lines_from_file(FILE_PATH)
    
    # Shuffle the lines
    random.shuffle(lines)
    
    # Send the shuffled lines as a response
    update.message.reply_text('\n'.join(lines))

def start_bot(token: str) -> None:
    """
    Start the Telegram bot.

    Parameters:
    token (str): The bot token provided by the BotFather.
    """
    updater = Updater(token, use_context=True)
    
    # Register command handlers
    updater.dispatcher.add_handler(CommandHandler('start', shuffle_lines))
    updater.dispatcher.add_handler(MessageHandler(Filters.text & ~Filters.command, shuffle_lines))

    # Start the bot
    updater.start_polling()
    updater.idle()

if __name__ == "__main__":
    # Replace 'YOUR_BOT_TOKEN' with your actual Telegram bot token
    start_bot('YOUR_BOT_TOKEN')

Code Breakdown

1. Imports: Necessary libraries for processing Telegram messages and handling randomness.

2. load_lines_from_file:

   • Loads lines from a TXT file into a list, stripping whitespace.
   • Raises a FileNotFoundError if the specified file does not exist.

3. shuffle_lines:

   • Retrieves lines from the file, shuffles them, and sends them back to the user via Telegram.

4. start_bot:

   • Initializes the Telegram bot and sets up command handlers.
   • Starts polling for updates from Telegram.

Usage Example

1. Create a TXT File: Prepare a text file named your_file.txt containing some sample lines.

2. Run the Bot:

   • Replace 'YOUR_BOT_TOKEN' with your actual bot token from the BotFather.
   • Run the script. The bot will start listening for updates.

3. Interact with the Bot:

   • Send a message to the bot, and it will respond with shuffled lines from the TXT file.

Conclusion

This code snippet provides a straightforward way to utilize a Telegram bot for shuffling lines from a text file. For further learning and practice, consider exploring more courses on the Enterprise DNA Platform.