autogram 3.3.2

An extensible telegram API wrapper

0x00 An efficient asyncronous Telegram bot API wrapper!

Autogram is an easily extensible telegram BOT API wrapper. You can get to work quickly by simply cloning this repository and adding custom callbacks to launch.py in root directory!

import os
from autogram import Autogram, onStart
from autogram.updates import Message, callbackQuery

@callbackQuery.addHandler
def callBackHandler(cb :callbackQuery):
    cb.answerCallbackQuery(text='Updated')
    cb.delete()

# bot commands        
@Message.onCommand('start')
def startCommand(msg: Message):
    msg.delete()
    msg.sendText(
        f"*Defined Commands*\n```python\n{msg.getCommands()}```",
        parse_mode='MarkdownV2',
        reply_markup = msg.autogram.getInlineKeyboardMarkup(
            [
                [{'text': 'Confirm', 'callback_data': 'confirmed'}]
            ],
            params = {
                'one_time_keyboard': True
            }
        )
    )

@Message.onCommand('shutdown')
def shutdownCommand(msg: Message):
    msg.delete()
    msg.sendText('Shutting down...')
    def exit_func():
        print("Custom clean-up function!")
    msg.autogram.shutdown(exit_func) # arg to shutdown is optional

@Message.onMessageType('text')
def messageHandler(msg: Message):
    msg.textBack(msg.text)

@Message.onMessageType('voice')
@Message.onMessageType('audio')
@Message.onMessageType('photo')
@Message.onMessageType('video')
@Message.onMessageType('document')
@Message.onMessageType('video_note')
def fileHandler(msg: Message):
    temp_dir = 'Downloads'
    if not os.path.exists(temp_dir):
        os.mkdir(temp_dir)
    file_path = f"{temp_dir}/{msg.file['name']}"
    with open(file_path, 'wb') as file:
        file.write(msg.file['bytes'])
    msg.delete()

@onStart('autogram.json')
def startBot(config: dict):
    bot = Autogram(config=config)
    bot_thread = bot.send_online()
    bot_thread.join()

The above implementation assumes you want to control your bot through telegram messages only, as calling join on bot.send_online(...) which returns a thread object will block. If you intend to use the bot alongside other code, call bot.send_online(...) and leave it at that. The bot thread will terminate when your program finishes execution.

1. You can use the bot handle returned by bot = Autogram(config=config) to terminate the telegram bot. Just call bot.shutdown() from your thread to set the termination flag.
2. The bot has implicit chat actions. i.e typing, sending photo, etc which are invoked when you call reply functions on update objects.

0x02 Why AutoGram?

I needed a bot framework that was easy to control remotely.

AutoGram has a built-in webhook endpoint written using Bottle Framework. Therefore, if you have a public IP, or can get an external service to comminicate with localhost through a service like ngrok (I use it too!), then add that IP or publicly visible address to your environment variables. If the public addr is not found, the program will use polling to fetch updates from telegram servers. You add functionality to Autogram bot py implementing and adding callback functions. The bot will therefore work with available callbacks, and will continue to work even if none is specified! This allows the bot to work with available features, despite of missing handlers for specific types of messages.

The basic idea is that you can have a running bot without handlers. To be able to handle a normal user message, you'll need to import the Message module, and add a handler to it. When a normal user message is received, the Message object will parse the message, parse some of the content and set attributes on itself, then pass itself down to your handler. While creating the handler, you can tell the Message object whether you want to download message attachments too. If you don't, they will be downloaded when you attempt to access them. Below is a list of Update Objects you can (or will be able to) add callbacks to.

0x03 Currently implemented update types

• Message
• callbackQuery

0x04 Upcoming features

• Add onNotification handlers
• Plans to cover the entire telegram API
• Add live-reload, customizable through config

0x05 toThread(*args, **kwargs) usage

• toThread() available in Autogram instances allow optional priority for tasks. You can:

toThread(func, args).result() # which returns the function result, or raises exception

# Using custom callback functions
def customFunction(result):
    print(result)

def customErrHandler(err):
    raise err

toThread(func, args, callback=customFunction, errHandler=customErrHandler)

ChangeLog

• Update to use ngrok version available in path.
• Added support for callbackQueries.
• Added onStart(*args) handler which can be used to start the bot.
• Autogram has a reusable ThreadPoolExecutor using a bot.toThread(*args)

Utilities functions

• onStart calls load_config implicitly, and passes it to decorated function. Bot can be instantiated here.
• load_config loads and checks config file for correctness.

Deprecated features / can be done in higher level

• Admin and deputy functionalities
• Default behaviour is to forward messages to admin.
• Admin and assistant admin functionality. You can implement in the higher leve admin functionality.

footnotes

• short-polling and ngrok servers are available for testing.
• Don't run multiple bots with the same TOKEN as this will cause update problems
• Sending unescaped special characters when using MarkdownV2 will return HTTP400
• Have fun with whatever you're building ;)