Welcome to rubelp’s documentation!

A Python module implemented in Rust.

class rubelp.Node

Classe représentant le noeud d’un arbre, avec pour valeur une chaîne de caractères.

Parameters:
  • txt (str) – la valeur du noeud

  • lvl (int) – le niveau de l’arbre (coordonnée x)

  • i (int) – la position du noeud (coordonnée y)

children
data
index
level
class rubelp.Tree

Classe représentant une arborescence, les noeuds ayant pour seule valeur une chaîne de caractère. Le package utilise cette dernière pour garder une trace de chaque étape de transformation.

Parameters:

leaves (list[str]) – les feuilles de l’arbre

concat(self, lvl: int, i: int, sep: str)

Méthode permettant de récupérer le texte des feuilles auquel le noeud a accès, avec possibilité d’un séparateur entre chaque.

Parameters:
  • lvl (int) – le niveau de l’arbre (coordonnée x)

  • i (int) – la position du noeud (coordonnée y)

  • sep (str) – le séparateur à utiliser

Returns:

la chaîne résultante

Return type:

str

data
decapsulate(self, lvl: int, i: int)

Méthode permettant de récupérer les feuilles auquel a accès le noeud spécifié (sous la forme d’une liste de noeuds). :param lvl: le niveau de l’arbre (coordonnée x) :type lvl: int :param i: index du noeud dans le niveau :type i: int :return: la liste des feuilles :rtype: list[Node]

get_children(self, lvl: int, i: int)

Méthode permettant de récupérer les enfants du noeud.

Parameters:
  • lvl (int) – le niveau de l’arbre (coordonnée x)

  • i (int) – la position du noeud (coordonnée y)

Returns:

la liste des noeuds enfants

Return type:

list[Node]

subtree(self, lvl: int, i: int)

Permet de récupérer un sous-arbre sous la forme d’un objet Tree. :param lvl: le niveau de l’arbre (coordonnée x) :type lvl: int :param i: la position du nouveau noeud racine (coordonnée y) :type i: int :return: le sous arbre partant du noeud spécifié :rtype: Tree

to_xml(self)

Méthode fournissant une chaîne de caractère décrivant l’arbre au format XML. Format d’export à privilégier.

Returns:

l’arbre structuré en XML

Return type:

str

rubelp.engine(tokens: list[str], ruleset: dict)

Fonction faisant tourner le moteur à base de règles, à partir de tokens et d’un ensemble de règles.

Parameters:
  • tokens (list[str]) – la liste des tokens à traiter

  • ruleset (dict) – la base de règles

Returns:

l’arbre résultant

Return type:

Tree

rubelp.tokenize(txt: str)

Fonction de tokenisation utilisant un transducteur à états finis.

Parameters:

txt (str) – la chaîne de caractères à tokeniser

Indices and tables