Fonctions
Documentation Fonctionnelle
Ce module contient des fonctions pour manipuler les données de document et effectuer diverses opérations liées aux champs de document.
Fonctions
set_field_value(document_data, field_name, value)
Description: Définit la valeur d'un champ dans les données du document.
Paramètres:
document_data (dict): Les données du document contenant des informations sur les champs.
field_name (str): Le nom du champ à définir.
value: La valeur à définir pour le champ.
set_date_value(document_data, field_name, value, add_days=0, skip_weekend=False)
Description: Définit la valeur d'un champ de date dans les données du document.
Paramètres:
document_data (dict): Les données du document contenant des informations sur les champs.
field_name (str): Le nom du champ de date à définir.
value: La valeur de date à définir au format ISO (par exemple, "2020-12-31").
add_days (int): Ajoute des jours supplémentaires à la date donnée.
skip_weekend (bool): Ignore la date si elle tombe le week-end.
set_amount_value(document_data, field_name, value)
Description: Définit la valeur d'un champ de montant dans les données du document.
Paramètres:
document_data (dict): Les données du document contenant des informations sur les champs.
field_name (str): Le nom du champ à définir.
value: La valeur à définir pour le champ.
get_field_value(document_data, field_name, default_value=None, is_clean=False)
Description: Obtient la valeur d'un champ à partir des données du document.
Paramètres:
document_data (dict): Les données du document contenant des informations sur les champs.
field_name (str): Le nom du champ à définir.
default_value (optionnel): Renvoie default_value si aucune valeur de champ n'est trouvée.
is_clean (optionnel): Met la valeur en majuscules et la nettoie des espaces vides.
Renvoie:
Valeur du champ.
create_new_field(field_name, value="")
Description: Crée un nouveau champ avec le nom et la valeur spécifiés.
Paramètres:
field_name (str): Le nom du champ à créer.
value: La valeur initiale pour le champ (par défaut, une chaîne vide).
Renvoie:
Dictionnaire du nouveau champ créé.
delete_field(document_data, field_name)
Description: Supprime un champ des données du document.
Paramètres:
document_data (dict): Les données du document contenant des informations sur les champs.
field_name (str): Le nom du champ à définir.
Renvoie:
Document_data au format json et au format dict après la suppression du champ.
set_is_required(document_data, field_name, value)
Description: Définit l'attribut 'is_required' d'un champ dans les données du document.
Paramètres:
document_data (dict): Les données du document contenant des informations sur les champs.
field_name (str): Le nom du champ à définir.
value: La valeur à définir pour le champ.
set_force_validation(document_data, field_name, value)
Description: Définit l'attribut 'force_validation' d'un champ dans les données du document.
Paramètres:
document_data (dict): Les données du document contenant des informations sur les champs.
field_name (str): Le nom du champ à définir.
value (bool): La valeur à définir pour le champ.
set_field_as_invalid(document_data, field_name, message, code=None)
Description: Marque un champ comme invalide dans les données du document.
Paramètres:
document_data (dict): Les données du document contenant des informations sur les champs.
field_name (str): Le nom du champ à marquer comme invalide.
message (str): Le message de validation pour le champ.
code (optionnel): Code d'erreur pour la validation (par défaut, None).
set_field_attribute(document_data, field_name, attribute_name, value)
Description: Définit un attribut personnalisé d'un champ dans les données du document.
Paramètres:
document_data (str): Les données du document contenant des informations sur les champs.
field_name (str): Le nom du champ à définir.
attribute_name (str): Le nom de l'attribut à définir.
value (bool): La valeur à définir pour l'attribut.
is_supplier_valid(use: UserAuthentication, filter_data_json, sub_org_id=None)
Description: Vérifie si un fournisseur est valide en fonction des critères fournis.
Paramètres:
user (UserAuthentication): L'utilisateur authentifié.
filter_data_json: Critères de filtrage pour valider le fournisseur.
sub_org_id (optionnel): ID de sous-organisation optionnel pour le filtrage.
Renvoie:
True, si l'utilisateur est valide.
False si l'utilisateur n'est pas valide.
get_document_content(document_data)
Description: Renvoie le contenu du document basé sur les données du document.
Paramètres:
document_data (str): Les données du document contenant des informations sur les champs.
Renvoie:
Contenu du document des données du document.
update_document_status_with_doc_id(doc_id, user, org_id, status, message=None, doc_classification_class=None)
Description: Met à jour le statut d'un document avec l'ID spécifié.
Paramètres:
doc_id (str): L'ID du document à mettre à jour.
user: L'utilisateur effectuant la mise à jour (soit l'ID de l'utilisateur, soit l'objet UserAuthentication).
org_id: L'ID de l'organisation à laquelle appartient le document.
status (str): Le nouveau statut du document.
message: Message optionnel associé à la mise à jour du statut.
doc_classification_class: Classe de classification de document optionnelle.
get_lov_values(org_id, key, return_type="list_of_objects", sub_org_id=None)
Description: Obtient les valeurs LOV à partir d'un org_id spécifique.
Paramètres:
org_id: L'ID de l'organisation à laquelle appartient le document.
return_type (optionnel): Le type dans lequel les données doivent être renvoyées.
sub_org_id (optionnel): ID de sous-organisation optionnel pour le filtrage.
Renvoie:
Valeurs LOV sous forme de liste d'objets ou sous forme de liste.
format_decimal_to_locale(value, to_locale="en_US.UTF-8", max_decimal_places=4, min_decimal_places=2)
Description: Formate une valeur décimale au format en_US.UTF-8.
Paramètres:
value: La valeur qui doit être formatée.
to_locale (optionnel): Le format dans lequel la valeur doit être transformée.
max_decimal_places (optionnel): Le maximum de décimales à considérer.
min_decimal_places (optionnel): Le minimum de décimales à considérer.
Renvoie:
La valeur formatée.
compare_values(value1, value2)
Description: Compare deux valeurs pour l'égalité, en gérant divers types de données.
Paramètres:
value1: La première valeur à comparer.
value2: La deuxième valeur à comparer.
Renvoie:
True si les valeurs sont égales et False si elles diffèrent.
create_document_task( user, document_data, title, description, priority, assigned_to_user_id, assigned_to_group_id, send_emai: bool)
Description: Crée une tâche de document.
Paramètres:
user: L'utilisateur effectuant la mise à jour (soit l'ID de l'utilisateur, soit l'objet UserAuthentication).
document_data: Les données du document contenant des informations sur les champs.
title (str): Le titre de la tâche.
description (str): La description de la tâche.
priority: La priorité de la tâche.
assigned_to_user_id: L'ID de l'utilisateur auquel la tâche doit être assignée.
assigned_to_group_id: L'ID du groupe auquel la tâche doit être assignée.
send_email (bool): Détermine si un email doit être envoyé ou non.
Renvoie:
Dict indiquant si le processus a été réussi ou non.
set_document_sub_org_id(document_data, sub_org_id)
Description: Définit le sub_org_id des données de document spécifiées.
Paramètres:
document_data: Les données du document contenant des informations sur les champs.
sub_org_id (str): ID de sous-organisation optionnel pour le filtrage.
get_user_by_id(user_id)
Description: Obtient l'utilisateur avec l'ID utilisateur correspondant.
Paramètres:
user_id (str): L'ID de l'utilisateur.
Renvoie:
L'utilisateur avec l'ID utilisateur correspondant.
get_group_by_id(group_id)
Description: Obtient le groupe avec l'ID de groupe correspondant.
Paramètres:
group_id (str): L'ID du groupe.
Renvoie:
Le groupe avec l'ID de groupe correspondant.
add_table_column(table, col_name, default_value=None)
Description: Ajoute une colonne à la table correspondante.
Paramètres:
table: La table où la colonne doit être ajoutée.
col_name: Le nom de la colonne.
default_value (optionnel): La valeur initiale pour le champ (par défaut, une chaîne vide).
get_column_value(row, column_name, default_value=None, is_clean=False)
Description: Obtient une valeur d'une colonne spécifiée.
Paramètres:
row: La ligne où la valeur est située.
col_name: Le nom de la colonne.
default_value (optionnel): Renvoie default_value si aucune valeur de champ n'est trouvée.
is_clean (optionnel): Met la valeur en majuscules et la nettoie des espaces vides.
set_column_value(row, column_name, value)
Description: Définit une valeur d'une colonne spécifiée.
Paramètres:
row: La ligne où la valeur est située.
col_name: Le nom de la colonne.
value: La valeur qui sera définie à l'emplacement spécifié.
Renvoie:
True si le changement a été réussi.
set_column_date_value(document_data, row, column_name, value, add_days=0)
Description: Définit une valeur d'une colonne spécifiée.
Paramètres:
document_data: Les données du document contenant des informations sur les champs.
row: La ligne où la valeur est située.
col_name: Le nom de la colonne.
value: La valeur de date à définir au format ISO (par exemple, "2020-12-31").
add_days (int): Ajoute des jours supplémentaires à la date donnée.
set_column_amount_value(document_data, row, column_name, value)
Description: Effectue les actions suivantes:
Convertit la valeur en chaîne et définit la valeur pour la colonne.
Définit le contenu de la colonne sur la valeur.
Formate la valeur selon la locale.
Paramètres:
document_data (dict): Les données du document contenant des informations sur les champs.
row: Ligne de la table.
column_name: Nom de la colonne.
value: Valeur à définir.
remove_rows_from_table(document_data, table_name, count, start)
Description: Supprime des lignes de la table spécifiée.
Paramètres:
document_data (dict): Les données du document contenant des informations sur les champs.
table_name: Le nom de la table.
count: Combien de lignes doivent être supprimées.
start: Le point de départ.
remove_all_rows_except_one_from_table(document_data, line_number)
Description: Supprime toutes les lignes sauf une de la table spécifiée.
Paramètres:
document_data (dict): Les données du document contenant des informations sur les champs.
line_number: Le numéro de la ligne qui ne doit pas être supprimée.
Fonctions intégrées de Python
Vous pouvez également utiliser certaines des fonctions intégrées de Python:
abs(): Renvoie la valeur absolue d'un nombre.
len(): Renvoie la longueur (nombre d'éléments) d'un objet, comme une liste ou une chaîne.
isinstance(): Vérifie si un objet est une instance d'une classe ou d'un type particulier.
print(): Imprime la sortie sur la console.
round(): Arrondit un nombre à virgule flottante à un nombre spécifié de décimales.
str_to_bool(): Convertit une chaîne en une valeur booléenne (True ou False).
type(): Renvoie le type d'un objet.
dict(): Crée un objet dictionnaire.
list(): Crée un objet liste.
str(): Convertit une valeur en chaîne.
float(): Convertit une valeur en nombre à virgule flottante.
int(): Convertit une valeur en entier.
Pour plus de détails, consultez la documentation officielle de Python: Fonctions intégrées.
Fonctions de la classe String
Vous pouvez également utiliser ces fonctions spécifiquement pour travailler avec des chaînes:
lower(): Convertit tous les caractères d'une chaîne en minuscules.
upper(): Convertit tous les caractères d'une chaîne en majuscules.
split(): Divise une chaîne en une liste en fonction d'un délimiteur (par exemple, espace ou virgule).
startswith(): Vérifie si une chaîne commence par un préfixe spécifié.
endswith(): Vérifie si une chaîne se termine par un suffixe spécifié.
strip(): Supprime les espaces vides au début ou à la fin d'une chaîne.
Fonctions du module Math de Python
Ces fonctions font partie du module math et sont utiles pour les opérations mathématiques:
floor(): Renvoie le plus grand entier inférieur ou égal à un nombre donné.
ceil(): Renvoie le plus petit entier supérieur ou égal à un nombre donné.
Pour plus d'informations, consultez la documentation officielle de Python: Fonctions du module Math.
Fonction d'expression régulière
re.search(): Recherche un motif dans une chaîne et renvoie la première correspondance.
Voir plus de détails ici: Documentation re.search.
Fonctions externes
Voici quelques fonctions utiles provenant de bibliothèques externes:
deepcopy(): Crée une copie d'un objet, y compris des objets imbriqués (du module copy). Documentation Deepcopy.
levenshtein_distance(): Calcule le nombre d'éditions (insertions, suppressions, substitutions) nécessaires pour transformer une chaîne en une autre. Cette fonction est disponible dans la bibliothèque Jellyfish.
Fonctions de date et d'heure
Vous pouvez utiliser les fonctions suivantes pour travailler avec des dates et des heures:
strptime(): Convertit une chaîne en un objet datetime basé sur un format spécifié.
strftime(): Formate un objet datetime en une chaîne basée sur un format spécifié.
Pour plus d'informations, consultez la documentation officielle: Fonctions de date et d'heure.
Scripts d'exemple
Last updated