What is Monkey Patching & How It Can Be Applied in Odoo 17

What is Monkey Patching &
How It Can Be Applied in Odoo
17
Enterprise

Introduction
Enterprise
This slide explores the concept of "monkey patching," a
technique used to augment existing functionality in Odoo 17.
Let's delve into what monkey patching entails and how it can be
implemented within the Odoo 17 environment.

Enterprise
What is Monkey Patching?
Monkey patching is a technique that allows for the modification
or extension of the behavior of existing code at runtime. This
approach facilitates changes to the code without modifying the
source code itself. It is particularly useful for introducing new
features, fixing bugs, or overriding existing code without directly
altering the source code.

Enterprise
A typical monkey patching implementation follows a
structured approach:
# Original class
class MyClass:
def original_method(self):
print("This is the original method")
# Monkey patching the class with a new method
def new_method(self):
print("This is the new method")
MyClass.original_method = new_method

Enterprise
By assigning new_method to MyClass.original_method, the
original method is replaced with the new method. Consequently,
whenever the original method is called, the new method is
executed, allowing changes without modifying the original
method itself.

Enterprise
Example: Splitting Deliveries in Sale Orders
Let's explore a scenario where we need to split deliveries for
each product listed in a sales order. Typically, a single delivery,
referred to as stock picking, is generated for the entire sales
order, including all products. To achieve this, we need to
introduce a field in the order line to specify the delivery date for
each product and modify the _assign_picking method within the
stock.move model to create a pick for each move.

Enterprise
Adding a Field in the Order Line
First, we need to add a delivery date field within the sales order line:
class SaleOrderline(models.Model):
"""Inheriting sale order line to add delivery date field"""
_inherit = 'sale.order.line'
delivery_date = fields.Date("Delivery Date")

Enterprise
Next, we incorporate the field into the views:
<odoo>
<record id="view_order_form" model="ir.ui.view">
<field name="name">sale.order.inherit.monkey.patching</field>
<field name="inherit_id" ref="sale.view_order_form"/>
<field name="model">sale.order</field>
<field name="arch" type="xml">
<xpath
expr="//field[@name='order_line']/tree/field[@name='price_unit']"
position="before">
<field name="delivery_date"/>
</xpath>
</field>
</record>
</odoo>

Enterprise
Modifying the _prepare_procurement_values Method
To split deliveries based on the delivery date, we need to
monkey patch the _prepare_procurement_values method of
the sale order line model:

Enterprise
def _prepare_procurement_values(self, group_id=False):
order_date = self.date_order
order_id = self.order_id
deadline_date = self.delivery_date or (order_id.date_order + timedelta(days=self.customer_lead or
0.0))
planned_date = deadline_date - timedelta(days=self.order_id.company_id.security_lead)
values = {
'group_id': group_id,
'sale_line_id': self.id,
'date_planned': planned_date,
'date_deadline': deadline_date,
'route_ids': self.route_id,
'warehouse_id': order_id.warehouse_id or False,
'product_description_variants':
self.with_context(lang=order_id.partner_id.lang)._get_sale_order_line_multiline_description_variants(),
'company_id': order_id.company_id,
'product_packaging_id': self.product_packaging_id,
'sequence': self.sequence,
}
return values
SaleOrderLine._prepare_procurement_values = _prepare_procurement_values

Enterprise
In this instance, we adjust the date_deadline value to match
the delivery date specified in the corresponding order line. If
the delivery date is not specified, we set it to the order date
plus the customer lead time of the product.

Enterprise
Inheriting the stock.move Model
Next, we extend the functionality of the stock.move model by
inheriting it:
class StockMoveInherits(models.Model):
"""Inheriting the stock move model"""
_inherit = 'stock.move'

Enterprise
Adjusting the _assign_picking Method
Finally, we modify the _assign_picking method to accomplish
the splitting of deliveries:

Enterprise
def _assign_picking(self):
pickings = self.env['stock.picking']
grouped_moves = groupby(self, key=lambda m: m._key_assign_picking())
for group, moves in grouped_moves:
moves = self.env['stock.move'].concat(*moves)
new_picking = False
pickings = moves[0]._search_picking_for_assignation()
if pickings:
vals = {}
if any(pickings.partner_id.id != m.partner_id.id for m in moves):
vals['partner_id'] = False
if any(pickings.origin != m.origin for m in moves):
vals['origin'] = False
if vals:
pickings.write(vals)

Enterprise
else:
moves = moves.filtered(lambda m: float_compare(m.product_uom_qty, 0.0,
precision_rounding=m.product_uom.rounding) >= 0)
if not moves:
continue
new_picking = True
pick_values = moves._get_new_picking_values()
sale_order = self.env['sale.order'].search([('name', '=',
pick_values['origin'])])
for move in moves:
picking = pickings.create(move._get_new_picking_values())
move.write({'picking_id': picking.id})
move._assign_picking_post_process(new=new_picking)
return True
StockMove._assign_picking = _assign_picking

Enterprise
In this implementation:
● We initialize pickings as an empty record of the
stock.picking model.
● We group the moves based on a key derived from the
_key_assign_picking method.
● We search for a picking using the
_search_picking_for_assignation method.
● If a picking is found, we update its fields; otherwise, we
create a new picking for each move.

Enterprise
Through these applied monkey patches, we have successfully
implemented the functionality to split deliveries within the
sales order. While monkey patching is a powerful tool, it's
advisable to explore alternative approaches when appropriate.

For More Info.
Check our company website for related blogs
and Odoo book.
Check our YouTube channel for
functional and technical videos in Odoo.
Enterprise
www.cybrosys.com

What is Monkey Patching & How It Can Be Applied in Odoo 17

Recommended

More Related Content

Similar to What is Monkey Patching & How It Can Be Applied in Odoo 17 (20)

More from Celine George (20)

Recently uploaded (20)

What is Monkey Patching & How It Can Be Applied in Odoo 17