MasterBot

Langue

Français

English

Description

Le MasterBot se charge de gérer et d'orchestrer les bots de wikipast. D'une part, il permet de lancer les bots de manière individuelle, en entrant des paramètres depuis un tableau de bord. D'autre part, il permet personaliser des séquences de lancement de bots, en spécifiant les paramètres (i.e. la fréquence le lancement, l'ordre, etc) de chaque bot.

Implémentation et fonctionnalités

L'idée est d'avoir le code de chaque bot sur une page (ou section d'une page) spécifique. Cela permet de lancer les bots à partir du code disponible sur la page de chacun (ou même depuis Github). Une simple API créée avec flask se charge de gérer les requêtes reçues. Tous les bots et leurs informations pertinentes (nom, adresse du code, ...) sont stockés dans un dictionnaire. L'API est dotée d'une interface web graphique qui facilite l'interaction avec le bot.

Dictionnaire des bots

Le dictionnaire des bots contient le nom du bot, l'adresse où son code se trouve, le nom d'une fonction main à appeler (si nécessaire), et une brève description du bot. Si le code du bot se trouve sur la page wiki de ce dernier, l'adresse est donc l'adresse de la page wiki du bot. Si le code se trouve sur GitHub, l'adresse stockée dans le dictionnaire est le lien direct vers le fichier python du code.

Lancer un bot

Pour lancer un bot, il suffit d'effectuer une requête GET de la manière suivante, sur un navigateur web. Il faut passer en paramètre le nom du bot, et éventuellement, les paramètres requis.

http://localhost:5000/api/v1/bots/run?name=SummarizingBot

Ceci va appeller la fonction run_bot(), qui va parser et formatter les paramètres de la requête (dans l'exemple, le nom), récupérer le code du bot à l'aide d'une function auxiliaire, et puis executer le code correspondant. Dans certains cas, il faut appeler une certaine fonction et lui donner quelques paramètres. Un message de succès s'affiche lors de la fin d'execution du bot, ainsi que tout les messages print du bot (changement du stdout). Si le bot est introuvable, un message d'erreur s'affiche. L'affichage est formaté à l'aide d'un simple template html.

Récupérer le code d'un bot

La fonction vérifie si l'adresse où se trouve le code (dans le dictionnaire des bots) contient le mot clé "GitHub" ou "wikipast". Si le code se trouve sur wikipast, la fonction assume qu'il est dans une seule section "Code" et entouré des tags "nowiki". Si le code se trouve sur GitHub, la fonction assume que le code est disponible dans un seul et unique fichier (et donc ne dépend pas de fichier externes) -

Obtenir de l'information sur les différents bots

Pour obtenir une brève description du bot il suffit d'effectuer la requête suivante (en passant le nom du bot en paramètre)

http://localhost:5000/api/v1/bots/info?name=SummarizingBot

Pour avoir une vue d'ensemble sur tous les bots disponibles:

http://localhost:5000/api/v1/bots/all

Limitations

Le code des bots est soit sur gitub, soit directement sur la page wiki du bot. Cependant, la structure des bots n'est pas homogène. Certains bots sont programmés pour agir sur des pages spécifiques, ou sur toutes les pages des biographies: il n'y a aucun moyen de spécifier une page précise. D'autre part, le code de certains bots est éparpillé sur plusieurs fichiers python: cela n'est plus en accord avec les assomptions de la fonction qui récupère le code des bots.

Code

def debug(*arg):
	print("I was called with", len(arg), "arguments:", arg)