odoo-development

Odoo Development Guidelines

Module Structure

Naming Conventions

• Module names: Use lowercase with underscores (e.g., sale_extended, inventory_custom)
• Technical name: Same as module directory name
• Display name: Human-readable with spaces (e.g., "Sales Extended")
• Never use hyphens in module names

Directory Structure

module_name/
├── __init__.py              # Import submodules
├── __manifest__.py          # Module metadata
├── models/                  # Python models
│   ├── __init__.py
│   └── model_name.py
├── views/                   # XML views
│   └── model_views.xml
├── security/                # Access rights and rules
│   ├── ir.model.access.csv  # Odoo 17-19
│   ├── ir.access.csv        # Odoo 20
│   └── module_security.xml
├── data/                    # Data files
├── wizard/                  # Transient models
├── report/                  # Report definitions
├── static/                  # Static assets
│   ├── description/
│   │   └── icon.png        # 128x128 PNG
│   └── src/
└── i18n/                    # Translations

Python Coding Standards

Model Naming

• Model name: Use dot notation (e.g., sale.order.line)
• Class name: CamelCase matching model (e.g., SaleOrderLine)
• Inherit: Use _inherit for extension, _inherits for delegation
• Never use underscore in model names (use dots)

Field Naming

• Field names: lowercase_with_underscores
• Boolean fields: Start with is_, has_, or can_ (e.g., is_active)
• Many2one fields: End with _id (e.g., partner_id)
• One2many/Many2many fields: End with _ids (e.g., line_ids)
• Computed fields: Descriptive names, add compute parameter

Field Types and Parameters

# Char fields
name = fields.Char(string='Name', required=True, index=True)

# Many2one with domain and context
partner_id = fields.Many2one(
    'res.partner',
    string='Customer',
    required=True,
    domain="[('customer_rank', '>', 0)]",
    context="{'default_customer_rank': 1}"
)

# Selection field
state = fields.Selection([
    ('draft', 'Draft'),
    ('confirmed', 'Confirmed'),
    ('done', 'Done'),
], string='Status', default='draft', required=True)

# Computed field
total_amount = fields.Float(
    string='Total',
    compute='_compute_total_amount',
    store=True
)