Dataset Viewer
Auto-converted to Parquet Duplicate
instruction
stringlengths
12
98
input
stringlengths
2
49
output
stringlengths
18
1.56k
Crée une méthode server-side qui récupère le nom du client à partir d'un champ Link.
DocType: Sales Invoice, Field: customer (Link)
def get_customer_name(self): return frappe.db.get_value('Customer', self.customer, 'customer_name')
Écris une validation pour empêcher la soumission si le champ total est zéro.
DocType: Purchase Order
def validate(self): if self.total <= 0: frappe.throw('Le montant total doit être supérieur à zéro pour soumettre.')
Comment créer une fonction whitelistée pour être appelée depuis le client JS ?
Python controller
@frappe.whitelist() def get_item_details(item_code): return frappe.get_doc('Item', item_code).as_dict()
Récupère tous les projets en cours pour un client spécifique.
DocType: Project, Status: Open
projects = frappe.get_all('Project', filters={'customer': customer_name, 'status': 'Open'}, fields=['name', 'project_name'])
Envoie une notification par email depuis un script Python.
Frappe Framework
frappe.sendmail(recipients=['admin@halfware.com'], subject='Alerte ERPNext', message='Le document a été mis à jour.')
Ajoute un log dans le système lors de la création d'un document.
DocType hook
def after_insert(self): frappe.log_error(f'Document {self.name} créé par {frappe.session.user}', 'App Audit')
Comment faire une jointure simple avec frappe.db.get_all ?
Frappe ORM
data = frappe.get_all('Sales Invoice', filters={'docstatus': 1}, fields=['name', 'customer', 'grand_total'], order_by='creation desc')
Initialise une valeur par défaut dans le on_update d'un DocType.
DocType: Task
def on_update(self): if not self.assigned_to: self.assigned_to = frappe.session.user
Comment lancer un job en arrière-plan (Background Job) ?
Frappe Background Jobs
frappe.enqueue('my_app.tasks.process_heavy_data', queue='long', timeout=3000, data=self.name)
Vérifie si l'utilisateur actuel a un rôle spécifique.
Frappe Permissions
if 'System Manager' in frappe.get_roles(frappe.session.user): # Action réservée
Supprime des enregistrements liés lors de la suppression d'un parent.
DocType: Parent
def on_trash(self): frappe.db.delete('Child DocType', {'parent': self.name})
Comment formater une date en format ISO dans un script ?
Frappe Utils
from frappe.utils import format_date formatted = format_date(self.posting_date, 'yyyy-mm-dd')
Crée un nouveau document via le code.
DocType: Communication
doc = frappe.get_doc({'doctype': 'Communication', 'subject': 'Hello', 'content': 'Test'}) doc.insert(ignore_permissions=True)
Comment utiliser une requête SQL brute sécurisée ?
Frappe DB API
frappe.db.sql('SELECT name FROM `tabItem` WHERE item_group = %s', (item_group), as_dict=True)
Récupère les settings d'un DocType Single.
DocType: App Settings
settings = frappe.get_single('App Settings') print(settings.api_key)
Déclenche une erreur personnalisée avec une action spécifique.
Frappe Exceptions
frappe.throw('Erreur critique', title='Validation échouée', is_minimizable=True)
Comment itérer sur une table enfant (Child Table) ?
DocType: Sales Invoice (Items)
for item in self.items: print(f'Article: {item.item_code}, Quantité: {item.qty}')
Appelle une fonction Python depuis un script JS.
Frappe Client Script
frappe.call({'method': 'my_app.api.get_data', 'args': {'id': frm.doc.name}, 'callback': function(r) { console.log(r.message); }});
Change la valeur d'un champ via JS.
Frappe Client Side
frm.set_value('status', 'Completed'); frm.refresh_field('status');
Utilise les hooks pour surcharger une méthode core.
hooks.py
override_whitelisted_methods = { 'frappe.desk.doctype.event.event.get_events': 'my_app.overrides.get_events' }
Calculer la somme d'un champ d'une table enfant lors de la sauvegarde.
DocType: Order, Child Table: items, Field: amount
def validate(self): self.total_amount = sum(item.amount for item in self.items) self.db_set('total_amount', self.total_amount)
Vérifier si un document a des dépendances avant suppression.
DocType: Customer
def on_trash(self): if frappe.db.exists('Sales Invoice', {'customer': self.name}): frappe.throw('Impossible de supprimer un client lié à des factures.')
Utiliser frappe.get_list pour des performances optimales.
Filtrage avancé sur Sales Order
orders = frappe.get_list('Sales Order', filters={'docstatus': 1, 'grand_total': ['>', 1000]}, fields=['name', 'grand_total'])
Créer une fonction qui génère un numéro de série unique.
DocType: Serial No
def generate_serial(prefix): last = frappe.db.get_value('Serial No', {'name': ['like', f'{prefix}%']}, 'name', order_by='creation desc') return f'{prefix}-001' if not last else f'{prefix}-{int(last.split('-')[-1])+1:03d}'
Mettre à jour un champ spécifique sans redéclencher tout le cycle de vie.
DocType: Item
frappe.db.set_value('Item', self.item_code, 'last_purchase_date', frappe.utils.today())
Récupérer la configuration d'un module personnalisé.
DocType: App Settings (Single)
settings = frappe.get_cached_doc('App Settings') mode = settings.get('debug_mode')
Ajouter un bouton d'action dans le Desk (JS).
frappe.ui.form.on('Sales Order', 'refresh', ...)
frappe.ui.form.on('Sales Order', { refresh: function(frm) { frm.add_custom_button('Generer PDF', () => frm.print_doc()); } });
Filtrer une table enfant dynamiquement.
JS, Field: item_code
frm.set_query('item_code', 'items', () => { return { filters: { 'is_stock_item': 1 } }; });
Exécuter une requête SQL brute avec paramètres nommés.
Database access
frappe.db.sql('UPDATE `tabItem` SET status = %(status)s WHERE item_group = %(group)s', {'status': 'Active', 'group': 'Raw Material'})
Gestion des permissions personnalisées.
frappe.has_permission
if not frappe.has_permission('Project', 'write', doc=self): frappe.throw('Permission refusée', frappe.PermissionError)
Utiliser un hook pour modifier le comportement de soumission.
hooks.py
before_submit = ['my_app.utils.validate_before_submit']
Récupérer des données via une API whitelistée.
Python Controller
@frappe.whitelist() def get_user_stats(user): return {'docs_count': frappe.db.count('ToDo', {'owner': user})}
Calculer la différence en jours entre deux dates.
frappe.utils.date_diff
from frappe.utils import date_diff days = date_diff(self.end_date, self.start_date)
Créer une entrée dans le journal système.
Activity Log
frappe.get_doc({'doctype': 'Activity Log', 'subject': 'Action réussie', 'user': frappe.session.user}).insert()
Ajouter un champ dynamiquement via le code.
DocType Setup
frappe.get_doc({'doctype': 'DocField', 'fieldname': 'new_field', 'fieldtype': 'Data', 'parent': 'Task'}).insert()
Gérer les fichiers joints dans un document.
File Manager
frappe.attach_print('Sales Order', self.name, 'Sales Order Print', 'pdf')
Surcharger une méthode existante du framework.
hooks.py
override_whitelisted_methods = {'frappe.client.get_list': 'my_app.overrides.get_list'}
Envoyer une réponse JSON standard depuis une API.
API response
return {'status': 'success', 'data': result}
Récupérer la liste des utilisateurs ayant un rôle précis.
User roles
users = frappe.get_all('Has Role', filters={'role': 'HR Manager'}, fields=['parent'])
Vérifier la validité d'un numéro de TVA.
DocType: Customer
from frappe.utils import validate_email_address if not self.vat_number or len(self.vat_number) < 5: frappe.throw('Numéro de TVA invalide.')
Calculer la taxe globale sur un document.
DocType: Invoice
self.total_tax = sum(tax.tax_amount for tax in self.taxes)
Récupérer la valeur d'un champ d'un DocType Single.
Frappe settings
value = frappe.db.get_single_value('System Settings', 'enable_email_notifications')
Ajouter un message d'information dans le formulaire.
Client Script
frappe.msgprint('Opération terminée avec succès.', title='Info', indicator='green')
Masquer un champ selon une condition utilisateur.
Client Script
if (frappe.user.has_role('Employee')) { cur_frm.set_df_property('salary', 'hidden', 1); }
Gérer les doublons lors de l'insertion.
Python
if frappe.db.exists('Item', self.item_code): frappe.throw('Item existe déjà.')
Utiliser un filtre complexe sur un champ Date.
ORM Query
frappe.get_all('Task', filters={'due_date': ['<=', frappe.utils.today()]})
Surcharger une fonction Python via hooks.
hooks.py
override_whitelisted_methods = {'frappe.auth.get_logged_user': 'my_app.auth.get_user'}
Valider que le champ quantité est positif.
DocType: Stock
if self.qty < 0: frappe.throw('La quantité ne peut être négative.')
Changer le statut d'un document via l'API.
frappe.client.set_value
frappe.db.set_value('ToDo', self.name, 'status', 'Closed')
Envoyer une réponse JSON d'erreur.
API Controller
return {'status': 'error', 'message': 'Données manquantes'}
Récupérer tous les noms de colonnes d'un DocType.
Metadata
meta = frappe.get_meta('Sales Order') fields = [df.fieldname for df in meta.fields]
Créer un lien de téléchargement PDF.
Frappe Print
file_url = frappe.utils.get_url('/api/method/frappe.utils.print_format.download_pdf?doctype=Invoice&name=INV-001')
Exécuter une tâche planifiée chaque nuit.
hooks.py
scheduler_events = {'daily': ['my_app.tasks.cleanup_logs']}
Vérifier si un fichier est attaché.
DocType: Communication
if not self.has_attachments(): frappe.throw('Veuillez joindre un fichier.')
Initialiser un champ avec la date actuelle.
DocType hook
def before_insert(self): self.creation_date = frappe.utils.nowdate()
Filtrer les résultats par utilisateur actuel.
frappe.session.user
frappe.get_all('Task', filters={'assigned_to': frappe.session.user})
Faire une somme agrégée via SQL.
SQL Query
total = frappe.db.sql('SELECT SUM(grand_total) FROM `tabSales Invoice` WHERE docstatus=1')[0][0]
Verrouiller un document contre les modifications.
DocType
if self.is_locked: frappe.throw('Ce document est verrouillé.')
Renommer un document proprement.
frappe.rename_doc
frappe.rename_doc('Customer', old_name, new_name)
Obtenir la version actuelle du framework.
frappe.utils
version = frappe.utils.get_bench_version()
Appliquer un style CSS conditionnel via JS.
Client Script
cur_frm.fields_dict['status'].$input.css('color', 'red')
Utiliser frappe.db.commit.
Transaction
frappe.db.set_value('Task', name, 'status', 'Done'); frappe.db.commit()
Vérifier la présence d'un module installé.
frappe.get_installed_apps
if 'erpnext' in frappe.get_installed_apps(): pass
Récupérer la configuration globale d'un site.
frappe.get_conf
db_name = frappe.get_conf().db_name
Calculer la taxe sur une table enfant.
validate
self.total = sum(d.amount for d in self.get('items'))
Ajouter un rôle à un utilisateur.
frappe.get_doc
user = frappe.get_doc('User', 'test@user.com'); user.add_roles('HR Manager')
Vider le cache d'un DocType.
frappe.clear_cache
frappe.clear_cache(doctype='Item')
Gestion des exceptions personnalisées.
frappe.ValidationError
raise frappe.ValidationError('Action non autorisée')
Forcer le rechargement d'un formulaire.
JS API
cur_frm.reload_doc()
Récupérer la liste des doctypes standards.
frappe.get_all
doctypes = frappe.get_all('DocType', filters={'istable': 0})
Calculer la différence en heures.
frappe.utils
diff = frappe.utils.time_diff_in_seconds(end, start) / 3600
Vérifier si le mode debug est activé.
frappe.conf
if frappe.conf.developer_mode: print('Mode dev actif')
Appeler une méthode JS après la sauvegarde.
Client Script
frappe.ui.form.on('Sales Invoice', 'after_save', (frm) => { ... })
Nettoyer les inputs avant enregistrement.
DocType
self.name = self.name.strip().upper()
Récupérer les logs d'erreurs.
Error Log
logs = frappe.get_all('Error Log', limit=10)
Vérifier les droits d'accès au DocType.
frappe.has_permission
if frappe.has_permission('Task', 'read'): pass
Créer un lien permanent.
URL management
link = frappe.utils.get_url_to_form('Task', self.name)
Utiliser frappe.db.get_list avec le mode 'or'.
Filtres
frappe.get_list('Item', filters={'item_group': ['in', ['A', 'B']]})
Ajouter une note système dans un document.
Activity Log
frappe.get_doc({'doctype': 'Comment', 'comment_by': frappe.session.user, 'comment': 'Note test'}).insert()
How to fetch a single value from the database using the Frappe ORM?
Field: rate, DocType: Item
rate = frappe.db.get_value('Item', {'item_code': self.item_code}, 'rate')
Write a validate method to ensure a date is not in the past.
DocType: Event
def validate(self): if self.event_date < frappe.utils.today(): frappe.throw('Event date cannot be in the past.')
How to whitelist a Python method to be accessible via API?
Controller method
@frappe.whitelist() def get_report_data(): return frappe.get_all('Task', fields=['name', 'status'])
Create a new document programmatically ignoring permissions.
DocType: Note
doc = frappe.get_doc({'doctype': 'Note', 'title': 'Reminder', 'content': 'Meeting at 10 AM'}) doc.insert(ignore_permissions=True)
How to iterate over a child table in a DocType?
DocType: Sales Invoice
for item in self.get('items'): print(f'Item: {item.item_code}, Qty: {item.qty}')
Update a document field without triggering hooks.
frappe.db.set_value
frappe.db.set_value('Task', self.name, 'status', 'Completed', update_modified=False)
How to format a date to a specific string format?
frappe.utils
from frappe.utils import format_date formatted_date = format_date(self.date, 'yyyy-MM-dd')
Send a system notification to a specific user.
frappe.notify
frappe.notify(recipients=['user@example.com'], subject='System Alert', message='Your task is overdue.')
How to run a raw SQL query safely?
Database access
data = frappe.db.sql('SELECT name FROM `tabCustomer` WHERE customer_group = %s', ('Service'), as_dict=True)
Check if a document exists before processing.
frappe.db.exists
if frappe.db.exists('Item', {'item_code': 'ITEM-001'}): # proceed with logic
Calculate the difference between two timestamps in hours.
frappe.utils
from frappe.utils import time_diff_in_seconds hours = time_diff_in_seconds(end_time, start_time) / 3600
How to add a custom button to a form in JS?
Client Script
cur_frm.add_custom_button('Process', () => { frappe.call('my_app.api.process_data', {name: cur_frm.doc.name}); });
Use frappe.get_list for better performance than get_all.
DocType: Lead
leads = frappe.get_list('Lead', filters={'status': 'Open'}, fields=['name', 'lead_name'], limit=10)
How to perform an aggregate sum via ORM?
frappe.db.count
total_tasks = frappe.db.count('Task', {'status': 'Open'})
Change a field property dynamically in JS.
Client Script
cur_frm.set_df_property('target_field', 'read_only', 1);
How to enqueue a background job?
frappe.enqueue
frappe.enqueue('my_app.tasks.send_bulk_emails', queue='long', timeout=5000)
Retrieve system settings configuration.
frappe.get_conf
conf = frappe.get_conf() if conf.developer_mode: print('Developer mode is ON')
Clear the cache for a specific DocType.
frappe.clear_cache
frappe.clear_cache(doctype='Sales Invoice')
How to throw a specific Frappe exception?
frappe.ValidationError
raise frappe.ValidationError('This action is restricted.')
Get a list of installed apps on the site.
frappe.get_installed_apps
apps = frappe.get_installed_apps() if 'erpnext' in apps: # ERPNext is installed
Override a standard whitelisted method in hooks.
hooks.py
override_whitelisted_methods = {'frappe.client.get_value': 'my_app.api.get_value_override'}
End of preview. Expand in Data Studio
README.md exists but content is empty.
Downloads last month
11