Hooks doc_events on a dynamic list of doctypes

Frappe Framework
1

I have a list of DocTypes for which I need to configure common behavior via doc_events (after_insert, on_submit, …).

The list of DocTypes is not static, it is dynamic and may contains some user added custom doctypes.

Right now I configured the events on “*” within the hooks.py, and I validate within each events if the current DocType is part of the list of DocTypes to process.

This is working, but I don’t like having “*” events being triggered for ALL doctypes.

So instead of using hooks.py, I would like to manually update the dictionnary map of doc_events that frappe is holding in memory/cache.

Any insights how to do this ?
Thanks.

1 Like
2

Hi @guimorin,

Particular doctype doc_event method call for apply it like:

# Syntax
doc_events = {
  "Your DocType": {
      "on_update": "your_method_with_proper_path"
  }
}

# Example
doc_events = {
  "Lead": {
      "on_update": "method.testcall"
  }
}

Thank You!

3

The doctypes are known only at runtime, they come from a database query.

4

I kind of assumed I couldn’t code much in the hooks.py file, but it turns out I could do the following right after the assignation of doc_events variable, which perfectly solve my situation.

try:
    def _set_doctype_event(doctype_dict, event, value):
        doctype_dict.setdefault(event,[])
        if not isinstance(doctype_dict[event], list):
            doctype_dict[event] = [doctype_dict[event]]
        doctype_dict[event].append(value)

    doctypes = frappe.db.sql("<some select returning the doctypes>",pluck=True)
    for doctype in doctypes:
        doctype_dict = doc_events.setdefault(doctype,{})
        _set_doctype_event(doctype_dict, "after_insert", "...my_events.after_insert")
        _set_doctype_event(doctype_dict, "on_submit", "...my_events.on_submit")
        _set_doctype_event(doctype_dict, "on_cancel", "...my_events.on_cancel")
        _set_doctype_event(doctype_dict, "on_trash", "...my_events.on_trash")
except:
    pass
2 Likes
5

Hi @guimorin
If I update the list at runtime like creating new documents that updates the doctypes list that are needed to be added to the doc_events. Does this handle that also ( without having to restart the server )

6

Hi @guimorin,

If u have add multiple doctype for same logic so u can use doc_event for multiple doctype as a one time it like:

doc_events = {
  ("Lead", "Customer", "Sales Order", "Quotation"): {
      "on_update": "method.testcall"
  }
}