Erpnext Errors Hooks

What it does

This skill provides error handling guidance and patterns specifically for ERPNext hooks (hooks.py configurations). It focuses on how to manage errors within different hook types, emphasizing the unique characteristics of each. The skill highlights critical considerations such as transaction behavior, logging requirements, and potential impacts of silent failures, ultimately aiming to improve system stability and enable rapid issue resolution in ERPNext environments.

When to use it

• When developing custom hooks for ERPNext (e.g., doc_events, scheduler_events).
• When troubleshooting errors occurring within existing ERPNext hooks.
• To ensure proper error logging, especially for scheduler hooks where user feedback is unavailable.
• When implementing permission-related hooks to avoid breaking list views.

Key capabilities

• Provides guidance on error handling strategies for various hook types (doc_events, scheduler_events, permission_query_conditions, etc.).
• Explains the unique transaction behavior associated with different event hooks (e.g., validate, on_update).
• Highlights the importance of logging errors, particularly within scheduler hooks.
• Details specific error handling requirements for permission-related hooks (has_permission).
• Covers best practices for extending doctypes and bootinfo.

Example prompts

• "How should I handle errors in an ERPNext scheduler_events hook?"
• "What's the correct way to log errors within a doc_events validate hook?"
• "What are the error handling considerations for permission_query_conditions hooks?"

Tips & gotchas

• Scheduler hooks require manual database commits (frappe.db.commit()) and rely heavily on frappe.log_error() for debugging as there's no user feedback.
• Permission hooks should never throw errors; instead, return a safe fallback value (empty string or False).
• Be aware that multiple handlers can be registered in doc_events, and the first error encountered will halt the chain.