vassili/seitime-frappe
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

chore: Update raise_error_on_no_output documentation and example

Browse source
This commit is contained in:
Abdeali Chharchhodawala 2025-01-22 13:42:08 +05:30 • committed by GitHub
parent b9479e21e1
commit bebc40087c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 16 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
frappe/utils/error.py
View file

@ -100,8 +100,6 @@ def get_default_args(func):
def raise_error_on_no_output(error_message, error_type=None, keep_quiet=None):
"""Decorate any function to throw error incase of missing output.
TODO: Remove keep_quiet flag after testing and fixing sendmail flow.
:param error_message: error message to raise
:param error_type: type of error to raise
:param keep_quiet: control error raising with external factor.
@ -109,11 +107,22 @@ def raise_error_on_no_output(error_message, error_type=None, keep_quiet=None):
:type error_type: Exception Class
:type keep_quiet: function
>>> @raise_error_on_no_output("Ingradients missing")
... def get_indradients(_raise_error=1):
... return
>>> get_ingradients()
`Exception Name`: Ingradients missing
---
Example:
```py
@raise_error_on_no_output("Ingredients are missing")
def get_ingredients(_raise_error=1):
return
# this will raise an Exception with message "Ingredients are missing"
ingredients = get_ingredients()
```
---
TODO: Remove keep_quiet flag after testing and fixing sendmail flow.
"""
def decorator_raise_error_on_no_output(func):