Best practice for button and workflow decorators

albert · November 29, 2020, 9:41pm

Say I develop a module that inherits method that has the button and/or workflow.transition decorators.

Should the inheriting method also add those decorators?

I’ve always added them and I could find examples in core modules that add the decorators (I think they’re added in most cases):

github.com

tryton/commission/blob/develop/invoice.py#L31


        'invisible': Eval('type') == 'in',
        'readonly': Eval('state', '') != 'draft',
        },
    depends=['type', 'company', 'state'],
    help="The agent who receives a commission for the invoice.")

@classmethod
def _journal_types(cls, invoice_type):
    return super()._journal_types(invoice_type) + ['commission']

@classmethod
@ModelView.button
@Workflow.transition('posted')
def post(cls, invoices):
    # Create commission only the first time the invoice is posted
    to_commission = [i for i in invoices
        if i.state not in ['posted', 'paid']]
    super(Invoice, cls).post(invoices)
    cls.create_commissions(to_commission)

@classmethod

But also examples that don’t:

github.com

tryton/purchase/blob/develop/invoice.py#L99


    @classmethod
    @process_purchase
    def post(cls, invoices):
        super(Invoice, cls).post(invoices)

    @classmethod
    @process_purchase
    def paid(cls, invoices):
        super(Invoice, cls).paid(invoices)

    @classmethod
    @process_purchase
    def cancel(cls, invoices):
        super(Invoice, cls).cancel(invoices)


class InvoiceLine(metaclass=PoolMeta):
    __name__ = 'account.invoice.line'

    @fields.depends('origin')
    def on_change_with_product_uom_category(self, name=None):

github.com

tryton/sale/blob/develop/invoice.py#L93


    def paid(cls, invoices):
        super(Invoice, cls).paid(invoices)

    @classmethod
    @process_sale
    def cancel(cls, invoices):
        super(Invoice, cls).cancel(invoices)

    @classmethod
    @Workflow.transition('draft')
    def draft(cls, invoices):
        for invoice in invoices:
            if invoice.sales and invoice.state == 'cancelled':
                raise AccessError(
                    gettext('sale.msg_sale_invoice_reset_draft',
                        invoice=invoice.rec_name))

        return super(Invoice, cls).draft(invoices)


class Line(metaclass=PoolMeta):

ced · November 29, 2020, 10:28pm

It just depend if you need or not the filtering of workflow or the access check of button.

albert · November 29, 2020, 10:30pm

But that is always “needed” and both are going to be checked when calling super(), isn’t it?

ced · November 29, 2020, 10:31pm

It is not always needed as for the two examples you give.
The check on super may not be enough.