Error Handling and Logging in Odoo Custom Code: Production-Ready Techniques

from odoo.exceptions import UserError

def action_ship(self):
    for order in self:
        if not order.partner_shipping_id:
            raise UserError(f"Cannot ship Order {order.name}: No shipping address defined.")

from odoo.exceptions import ValidationError

@api.constrains('price')
def _check_price(self):
    if self.price < 0:
        raise ValidationError("Price cannot be negative.")

import logging
_logger = logging.getLogger(__name__)  # Sets logger name to current module

try:
    api.push_order(order.id)
except Exception as e:
    # BAD: _logger.error("It failed")
    
    # GOOD: Include ID, Name, and the Stack Trace
    _logger.error(
        "Failed to push Order %s (%s) to 3PL. Error: %s", 
        order.name, order.id, str(e), exc_info=True
    )
    # exc_info=True adds the python traceback to the log

def action_batch_sync(self):
    orders = self.search([('state', '=', 'sale'), ('is_synced', '=', False)])
    
    for order in orders:
        # Create a "savepoint" before processing each record
        try:
            with self.env.cr.savepoint():
                self._sync_single_order(order)
                # If successful, this commits locally within the transaction
        except UserError as e:
            # Logic error: Log warning, don't crash batch
            _logger.warning("Skipping order %s: %s", order.name, str(e))
        except Exception as e:
            # System error: Log error, don't crash batch
            _logger.error("Crash on order %s: %s", order.name, str(e), exc_info=True)

def action_capture_payment(self):
    self.ensure_one()
    
    # 1. Validation (Pre-Check)
    if not self.payment_token_id:
        raise UserError("No payment method selected.")
    
    # 2. External API Call (Outside of critical DB locks if possible)
    try:
        response = payment_gateway.charge(self.amount_total, self.payment_token_id)
    except GatewayTimeout:
        _logger.error("Gateway Timeout for Order %s", self.name)
        raise UserError("Payment gateway did not respond. Please try again.")
    except Exception as e:
        _logger.error("Payment Error %s: %s", self.name, str(e), exc_info=True)
        raise UserError("An error occurred during payment processing.")
    
    # 3. Process Response
    if response['status'] == 'success':
        # API succeeded, now update Odoo
        try:
            self.write({
                'state': 'sale',
                'transaction_id': response['id'],
                'payment_date': fields.Datetime.now()
            })
            _logger.info("Payment captured for Order %s, Trans ID: %s", self.name, response['id'])
        except Exception as e:
            # CRITICAL: Money taken, DB failed. LOG LOUDLY.
            _logger.critical(
                "MONEY TAKEN BUT ODOO FAILED. Order: %s, Trans ID: %s. Error: %s",
                self.name, response['id'], str(e)
            )
    else:
        # API declined
        _logger.info("Payment declined for Order %s: %s", self.name, response['message'])
        raise UserError(f"Payment Declined: {response['message']}")

except Exception as e:
    _logger.error("Sync Failed %s", order.name, exc_info=True)
    
    # Create a To-Do activity for the IT Manager
    order.activity_schedule(
        'mail.mail_activity_data_warning',
        user_id=self.env.ref('base.user_admin').id,
        summary=f'Sync Failed: {str(e)}',
        note='Check system logs for traceback.'
    )