Erpnext Errors Serverscripts

What it does

This skill provides guidance on handling errors within ERPNext server scripts. It focuses specifically on error handling patterns, acknowledging limitations imposed by the RestrictedPython environment used in ERPNext sandboxes. The skill emphasizes using appropriate methods like frappe.throw(), frappe.log_error(), and conditional checks to manage errors effectively while adhering to sandbox restrictions. This helps ensure smoother operations and prevents downtime related to server script issues.

When to use it

• When developing or debugging ERPNext server scripts where error handling is required.
• To understand how to appropriately respond to validation errors that should prevent a save or submission.
• When needing to log errors for later review and troubleshooting using frappe.log_error().
• If you are encountering issues with standard Python error handling constructs (like try/except or raise) within ERPNext server scripts.

Key capabilities

• Provides guidance on error handling patterns in ERPNext Server Scripts.
• Details limitations of the RestrictedPython environment, specifically prohibiting try/except, raise, and import traceback.
• Explains how to use frappe.throw() for stopping execution and displaying errors.
• Covers using frappe.log_error() for logging errors to the Error Log doctype.
• Describes using frappe.msgprint() to display messages while continuing script execution.

Example prompts

• "How should I handle a validation error in an ERPNext server script?"
• "What's the correct way to log an error within an ERPNext server script?"
• "I need to stop the execution of my ERPNext server script and show an error message. What do I use?"

Tips & gotchas

• Sandbox Restrictions: Be aware that try/except blocks, raise statements, and importing the traceback module are not allowed within ERPNext sandboxes due to RestrictedPython limitations.
• Use frappe.throw(): For errors requiring script termination and error display, use frappe.throw() instead of Python's built-in exception handling.
• Consult Related Skills: Refer to the erpnext-syntax-serverscripts skill for syntax guidance and the erpnext-impl-serverscripts skill for implementation workflows.