Odoo

https://www.odoo.com/documentation/17.0
Admin
Odoo is a comprehensive suite of open-source business management software tools, including CRM, ERP,...
Tokens:1,533,947
Snippets:12,822
Trust Score:10
Update:6 hours ago
Show doc for...
Tokens:
Raw
### Use onMounted hook in setup

Source: https://www.odoo.com/documentation/17.0/developer/tutorials/discover_js_framework/01_owl_components.html

Example of an Owl hook that executes code when the component is mounted. All hooks must be called in the setup method.

```javascript
setup() {
  onMounted(() => {
    // do something here
  });
}
```

--------------------------------

### Install and start PostgreSQL on Fedora

Source: https://www.odoo.com/documentation/17.0/administration/on_premise/packages.html

Installs and initializes PostgreSQL on Fedora, then enables and starts the service. Requires sudo to be available and configured.

```bash
$ sudo dnf install -y postgresql-server
$ sudo postgresql-setup --initdb --unit postgresql
$ sudo systemctl enable postgresql
$ sudo systemctl start postgresql
```

--------------------------------

### Launch Odoo with odoo-bin

Source: https://www.odoo.com/documentation/17.0/developer/tutorials/setup_guide.html

Starts the Odoo server using the odoo-bin command-line interface. Requires the addons path and database name; the -d flag specifies the database to use.

```bash
$ cd $HOME/src/odoo/
$ ./odoo-bin --addons-path="addons/,../enterprise/,../tutorials" -d rd-demo
```

--------------------------------

### Example values for ensure_xmlid_match_record

Source: https://www.odoo.com/documentation/17.0/developer/reference/upgrades/upgrade_utils.html

Shows two example values dictionaries for the ensure_xmlid_match_record function. The first maps id to 123, the second maps name and company_id.

```python
values = {"id": 123}
```

```python
values = {"name": "INV/2024/0001", "company_id": 1}
```

--------------------------------

### once as boolean example

Source: https://www.odoo.com/documentation/17.0/developer/reference/upgrades/upgrade_utils.html

Runs a migration only during the first upgrade step that reaches the specified version interval. Useful for multi-step upgrades.

```python
def migrate(cr, version):
    if util.once("17.0", "18.0"):
        util.rename_field(cr, "sale.order", "old_name", "new_name")
```

--------------------------------

### Google Fonts configuration example (Poppins)

Source: https://www.odoo.com/documentation/17.0/developer/howtos/website_themes/theming.html

Example of embedding the Google Font 'Poppins' with a URL and base font-size property.

```scss
$o-theme-font-configs: (
   'Poppins': (
      'family':                         ('Poppins', sans-serif),
      'url':                            'Poppins:400,500',
      'properties' : (
         'base': (
            'font-size-base':           1rem,
         ),
      ),
   ),
);
```

--------------------------------

### Implementing a service (OrmService) and registering it

Source: https://www.odoo.com/documentation/17.0/developer/reference/frontend/javascript_reference.html

Shows how to create a service by defining an object with a start() method that returns the service API, then registering it in the 'services' category. The example uses the orm service, which interacts with business objects on the server.

```javascript
import { registry } from "@web/core/registry";
export const OrmService = {
    start() {
        return {
            read(...) { ... },
            write(...) { ... },
            unlink(...) { ... },
            ...
        }
    },
};
registry.category("services").add("orm", OrmService);
```

--------------------------------

### report_with_list example

Source: https://www.odoo.com/documentation/17.0/developer/reference/upgrades/upgrade_utils.html

Appends an upgrade report entry with a list of records. The example uses a SQL cursor to fetch rows and calls report_with_list with a summary, columns, row format, links, total, and category. If the list is empty, nothing is posted.

```python
total = cr.rowcount
data = cr.fetchmany(20)
util.report_with_list(
    summary="The following records were altered.",
    data=data,
    columns=("id", "name", "city", "comment", "company_id", "company_name"),
    row_format="Partner with id {partner_link} works at company {company_link} in {city}, ({comment})",
    links={"company_link": ("res.company", "company_id", "company_name"), "partner_link": ("res.partner", "id", "name")},
    total=total,
    category="Accounting"
)
```

--------------------------------

### Example directory structure for upgrade tests

Source: https://www.odoo.com/documentation/17.0/developer/reference/upgrades/upgrade_utils.html

Shows the required layout for upgrade test files: a tests module with an __init__.py and a test_ prefixed script inside the module folder.

```text
myupgrades/
└── mymodule1/
    ├── 18.0.1.1.2/
    │   └── pre-myupgrade.py
    └── tests/
        ├── __init__.py
        └── test_myupgrade.py
```

--------------------------------

### Clone the odoo/tutorials repository

Source: https://www.odoo.com/documentation/17.0/developer/tutorials/setup_guide.html

Clone the odoo/tutorials repository to use as an addons directory for tutorials. This is the first step in preparing the environment.

```bash
$ git clone git@github.com:odoo/tutorials.git
```

--------------------------------

### parallel_execute example

Source: https://www.odoo.com/documentation/17.0/developer/reference/upgrades/upgrade_utils.html

Example of using util.parallel_execute to run multiple queries concurrently. It takes a list of queries and executes them in parallel, returning the sum of rowcounts.

```python
util.parallel_execute(cr, [util.format_query(cr, "REINDEX TABLE {}", t) for t in tables])
```

--------------------------------

### Install ipdb Python debugger

Source: https://www.odoo.com/documentation/17.0/developer/tutorials/setup_guide.html

Install the ipdb library using pip. This is the first step to use the Python debugger in the examples.

```bash
pip install ipdb
```

--------------------------------

### once as decorator example

Source: https://www.odoo.com/documentation/17.0/developer/reference/upgrades/upgrade_utils.html

Same effect as the boolean usage, but wraps the entire function body. Only runs during the first step that reaches the interval.

```python
@util.once("17.0", "18.0")
def migrate(cr, version):
    util.rename_field(cr, "sale.order", "old_name", "new_name")
```

--------------------------------

### format_query example

Source: https://www.odoo.com/documentation/17.0/developer/reference/upgrades/upgrade_utils.html

Shows how to use util.format_query to safely format a SQL query with parameters. The query uses {} placeholders and keyword arguments for table names, producing quoted identifiers.

```python
>>> util.format_query(cr, "SELECT {0} FROM {table}", "id", table="res_users")
SELECT "id" FROM "res_users"
```

--------------------------------

### Example theme.scss using Odoo variables

Source: https://www.odoo.com/documentation/17.0/developer/howtos/website_themes/theming.html

Example SCSS file that reuses Bootstrap and Odoo variables (e.g., $rounded-pill, o-color, o-website-value) to style blockquotes. Place in /website_airproof/static/src/scss/theme.scss.

```scss
 blockquote {
   border-radius: $rounded-pill;
   color: o-color('o-color-3');
   font-family: o-website-value('headings-font');
 }
```

--------------------------------

### Install Make on Linux

Source: https://www.odoo.com/documentation/17.0/contributing/documentation.html

Install Make using apt on Linux.

```bash
$ sudo apt install make -y
```

--------------------------------

### Install web_enterprise module from source

Source: https://www.odoo.com/documentation/17.0/administration/on_premise/community_to_enterprise.html

Installs the web_enterprise module when using the source code. Replace <database_name> with your database name. The command may take time depending on database size.

```bash
$ -d <database_name> -i web_enterprise --stop-after-init
```

--------------------------------

### Custom font configuration example (Proxima Nova)

Source: https://www.odoo.com/documentation/17.0/developer/howtos/website_themes/theming.html

Example of declaring a custom font 'Proxima Nova' without a Google Fonts URL, only family and properties.

```scss
$o-theme-font-configs: (
   'Proxima Nova': (
      'family':                         ('Proxima Nova', sans-serif),
      'properties' : (
         'base': (
            'font-size-base':           1rem,
         ),
      ),
   ),
);
```

--------------------------------

### import_script return value example

Source: https://www.odoo.com/documentation/17.0/developer/reference/upgrades/upgrade_utils.html

Shows the module object returned by import_script when a name is provided.

```python
>>> util.import_script("base/0.0.0/end-moved0.py", name="my-moved0")
<module 'my-moved0' from '/home/odoo/src/upgrade-util/src/base/0.0.0/end-moved0.py'>
```

--------------------------------

### Link Git with your fork (odoo/tutorials)

Source: https://www.odoo.com/documentation/17.0/developer/tutorials/setup_guide.html

Add a remote named 'dev' pointing to your fork of odoo/tutorials. Replace <your_github_account> with your GitHub account name.

```bash
$ cd /TutorialsPath
$ git remote add dev git@github.com:<your_github_account>/tutorials.git
```

--------------------------------

### Use a service in a component with useService

Source: https://www.odoo.com/documentation/17.0/developer/tutorials/discover_js_framework/02_build_a_dashboard.html

Shows how a component can import and use the 'shared_state' service via useService. The example retrieves a value with getValue and comments that you can do something with it. This snippet is part of the component's setup method.

```javascript
import { useService } from "@web/core/utils/hooks";

setup() {
   this.sharedState = useService("shared_state");
   const value = this.sharedState.getValue("somekey");
   // do something with value
}
```

--------------------------------

### parametrize example: test_double

Source: https://www.odoo.com/documentation/17.0/developer/reference/upgrades/upgrade_utils.html

Uses the parametrize decorator to generate four test methods from a list of argument tuples. Each tuple is unpacked and passed to the test function.

```python
@parametrize([(1, 2), (2, 4), (-1, -2), (0, 0)])
def test_double(self, input, expected):
    self.assertEqual(input * 2, expected)
```

--------------------------------

### Install the enterprise .deb package on Linux

Source: https://www.odoo.com/documentation/17.0/administration/on_premise/community_to_enterprise.html

Installs the enterprise .deb package over the community package using dpkg. Replace <path_to_enterprise_deb> with the actual path to the downloaded .deb file.

```bash
$ sudo dpkg -i <path_to_enterprise_deb>
```

--------------------------------

### Using environment to get empty recordset and search

Source: https://www.odoo.com/documentation/17.0/developer/reference/backend/orm.html

Demonstrates using the environment to get an empty recordset for a model and perform a search.

```python
>>> self.env['res.partner']
res.partner()
>>> self.env['res.partner'].search([('is_company', '=', True), ('customer', '=', True)])
res.partner(7, 18, 12, 14, 17, 19, 8, 31, 26, 16, 13, 20, 30, 22, 29, 15, 23, 28, 74)
```

--------------------------------

### import_script usage example

Source: https://www.odoo.com/documentation/17.0/developer/reference/upgrades/upgrade_utils.html

Imports functions from another upgrade script into the current one. The script must be available in the upgrade path.

```python
def my_util(cr):
    # do stuff
```

```python
from odoo.upgrade import util

script = util.import_script("mymodule/15.0.1.0/pre-migrate.py")

def migrate(cr, version):
    script.my_util(cr)  # reuse the function
```

--------------------------------

### Run Odoo with upgrade-util src directory

Source: https://www.odoo.com/documentation/17.0/developer/reference/upgrades/upgrade_utils.html

Starts Odoo with the upgrade-util src directory prepended to the --upgrade-path option. Replace /path/to/upgrade-util/src and /path/to/other/upgrade/script/directory with actual paths.

```bash
$ ./odoo-bin --upgrade-path=/path/to/upgrade-util/src,/path/to/other/upgrade/script/directory [...]
```

--------------------------------

### Install Command Line Tools on Mac OS

Source: https://www.odoo.com/documentation/17.0/administration/on_premise/source.html

Download and install the Command Line Tools before installing non-Python dependencies with a package manager.

```bash
$ xcode-select --install
```

--------------------------------

### CSS syntax and formatting example

Source: https://www.odoo.com/documentation/17.0/contributing/development/coding_guidelines.html

Shows the equivalent CSS formatting with hard-coded values (32px, 16px, #EAEAEA) instead of SCSS variables. Use the same indentation and brace conventions as the SCSS example.

```CSS
.o_foo, .o_foo_bar, .o_baz {
   height: 32px;
}

.o_foo .o_quux, .o_foo_bar .o_quux, .o_baz .o_qux {
   height: 16px;
}

.o_corge {
   background: #EAEAEA;
}

```

--------------------------------

### Install Debian/Ubuntu dependencies via setup/debinstall.sh

Source: https://www.odoo.com/documentation/17.0/administration/on_premise/source.html

Run from the Odoo Community directory to install required packages on Debian/Ubuntu. The script parses the debian/control file and installs the found packages.

```bash
$ cd odoo #CommunityPath
$ sudo ./setup/debinstall.sh
```

--------------------------------

### Install upgrade-util via pip

Source: https://www.odoo.com/documentation/17.0/developer/reference/upgrades/upgrade_utils.html

Installs the upgrade-util library from GitHub using pip on platforms where Odoo is not managed manually.

```bash
$ python3 -m pip install git+https://github.com/odoo/upgrade-util@master
```

--------------------------------

### Register a service that shows notifications every 5 seconds

Source: https://www.odoo.com/documentation/17.0/developer/reference/frontend/framework_overview.html

Create a service with a dependency on the 'notification' service. The service's start method runs when the service is started and sets an interval to display notifications.

```javascript
import { registry } from "./core/registry";

const serviceRegistry = registry.category("services");

const myService = {
    dependencies: ["notification"],
    start(env, { notification }) {
        let counter = 1;
        setInterval(() => {
            notification.add(`Tick Tock ${counter++}`);
        }, 5000);
    }
};

serviceRegistry.add("myService", myService);
```

--------------------------------

### Extending the gallery view with a custom renderer (my_gallery)

Source: https://www.odoo.com/documentation/17.0/developer/tutorials/master_odoo_web_framework/02_create_gallery_view.html

Shows how to extend the gallery view by subclassing GalleryRenderer and registering a new view with a custom Renderer. The example logs a message in setup() and uses the my_module.MyExtendedGalleryRenderer template. This is the only code block displayed in the source; the other sections describe steps without showing code.

```javascript
/** @odoo-module */

import { registry } from '@web/core/registry';
import { galleryView } from '@awesome_gallery/gallery_view';
import { GalleryRenderer } from '@awesome_gallery/gallery_renderer';

export class MyExtendedGalleryRenderer extends GalleryRenderer {
   static template = "my_module.MyExtendedGalleryRenderer";
   setup() {
      super.setup();
      console.log("my gallery renderer extension");
   }
}

registry.category("views").add("my_gallery", {
   ...galleryView,
   Renderer: MyExtendedGalleryRenderer,
});
```

--------------------------------

### RST menuselection markup for menu paths

Source: https://www.odoo.com/documentation/17.0/contributing/documentation/rst_guidelines.html

Use the :menuselection: role to guide users through a sequence of menus, starting with the app's name. Only include actual menu items.

```RST
To review sales performance, go to :menuselection:`Sales --> Reporting --> Dashboard`.
```

--------------------------------

### Run Odoo on Linux

Source: https://www.odoo.com/documentation/17.0/administration/on_premise/source.html

Launch Odoo server on Linux with custom addons path and database name. Replace CommunityPath with the Odoo installation path and mydb with the PostgreSQL database name.

```bash
$ cd /CommunityPath
$ python3 odoo-bin --addons-path=addons -d mydb
```

--------------------------------

### Install PostgreSQL on Linux

Source: https://www.odoo.com/documentation/17.0/administration/on_premise/source.html

Install PostgreSQL 12.0 or later on Linux using the package manager. The command installs both the server and client packages.

```bash
$ sudo apt install postgresql postgresql-client
```

--------------------------------

### Example of using ipdb in a copy method

Source: https://www.odoo.com/documentation/17.0/developer/tutorials/setup_guide.html

Example of placing an ipdb breakpoint inside a method. The debugger stops at the breakpoint, allowing inspection of variables and execution flow.

```python
def copy(self, default=None):
    import ipdb; ipdb.set_trace()
    self.ensure_one()
    chosen_name = default.get('name') if default else ''
    new_name = chosen_name or _('%s (copy)') % self.name
    default = dict(default or {}, name=new_name)
    return super(Partner, self).copy(default)
```

--------------------------------

### Access ref with useRef and onMounted

Source: https://www.odoo.com/documentation/17.0/developer/tutorials/discover_js_framework/01_owl_components.html

Uses the useRef hook in the setup method to get a reference object. The el property is only defined after the component is mounted, so it is accessed inside onMounted.

```javascript
setup() {
   this.myRef = useRef('some_name');
   onMounted(() => {
      console.log(this.myRef.el);
   });
}
```

--------------------------------

### Odoo option variable declaration example (we-button)

Source: https://www.odoo.com/documentation/17.0/developer/howtos/website_themes/theming.html

Shows the structure of an Odoo option declaration using data-customize-website-variable to expose a variable for customization.

```xml
<we-button title="..."
   data-name="..."
   data-customize-website-views="..."
   data-customize-website-variable="'Sidebar'"
   data-img="..."/>
```

--------------------------------

### Install pdf417gen library for PDF fiscal elements

Source: https://www.odoo.com/documentation/17.0/applications/finance/fiscal_localizations/chile.html

Required for Odoo SH or On-Premise hosting to generate PDFs with fiscal elements. Run this command manually to install the library.

```bash
pip install pdf417gen
```

--------------------------------

### Clone Odoo and Enterprise repositories with SSH on Linux

Source: https://www.odoo.com/documentation/17.0/administration/on_premise/source.html

Clones the Odoo 17.0 Community and Enterprise repositories using SSH. Recommended when contributing to Odoo source code or following the Getting Started developer tutorial.

```bash
$ git clone --branch 17.0 --single-branch git@github.com:odoo/odoo.git
$ git clone --branch 17.0 --single-branch git@github.com:odoo/enterprise.git
```

--------------------------------

### Create Owl component template in your_component.xml

Source: https://www.odoo.com/documentation/17.0/developer/howtos/frontend_owl_components.html

XML template for the Owl component that renders 'Hello, World!'. Place this file in /your_module/static/src/portal_component/your_component.xml.

```XML
<?xml version="1.0" encoding="UTF-8"?>
<templates xml:space="preserve">
    <t t-name="your_module.YourComponent">
        Hello, World!
    </t>
</templates>
```

--------------------------------

### Clone Odoo and Enterprise repositories with SSH on Windows

Source: https://www.odoo.com/documentation/17.0/administration/on_premise/source.html

Clones the Odoo 17.0 Community and Enterprise repositories using SSH on Windows. Recommended when contributing to Odoo source code or following the Getting Started developer tutorial.

```bash
C:\> git clone --branch 17.0 --single-branch git@github.com:odoo/odoo.git
C:\> git clone --branch 17.0 --single-branch git@github.com:odoo/enterprise.git
```

--------------------------------

### header example with statusbar widget

Source: https://www.odoo.com/documentation/17.0/developer/reference/user_interface/view_architectures.html

Example header containing a workflow button and a statusbar field widget with statusbar_visible and options attributes.

```XML
<header>
    <button string="Reset" type="object" name="set_draft" invisible="state != 'done'"/>
    <field name="state" widget="statusbar" statusbar_visible="draft,posted" options="{'clickable': 1}"/>
</header>
```

--------------------------------

### Subscribe to env.bus event (e.g., WEB_CLIENT_READY)

Source: https://www.odoo.com/documentation/17.0/developer/reference/frontend/framework_overview.html

Use env.bus.on to listen for global events on the web client's event bus. The example subscribes to the WEB_CLIENT_READY event, which is triggered when the web client has been mounted.

```javascript
// for example, in some service code:
env.bus.on("WEB_CLIENT_READY", null, doSomething);
```

--------------------------------

### Install Odoo rpm package on Fedora

Source: https://www.odoo.com/documentation/17.0/administration/on_premise/packages.html

Installs the downloaded Odoo 'rpm' package using dnf localinstall, then enables and starts the odoo service.

```bash
$ sudo dnf localinstall odoo_17.0.latest.noarch.rpm
$ sudo systemctl enable odoo
$ sudo systemctl start odoo
```

--------------------------------

### Multi-level Dropdown with t-call Example

Source: https://www.odoo.com/documentation/17.0/developer/reference/frontend/owl_components.html

Shows how to build a File dropdown with submenus (New, Save as...) by defining separate templates and calling them with t-call. The templates addon.Dropdown.File, addon.Dropdown.File.New, and addon.Dropdown.File.Save.As are defined together to form the complete example.

```XML
<t t-name="addon.Dropdown.File">
  <Dropdown>
    <t t-set-slot="toggler">File</t>
    <DropdownItem onSelected="() => this.onItemSelected('file-open')">Open</DropdownItem>
    <t t-call="addon.Dropdown.File.New"/>
    <DropdownItem onSelected="() => this.onItemSelected('file-save')">Save</DropdownItem>
    <t t-call="addon.Dropdown.File.Save.As"/>
  </Dropdown>
</t>

<t t-name="addon.Dropdown.File.New">
  <Dropdown>
    <t t-set-slot="toggler">New</t>
    <DropdownItem onSelected="() => this.onItemSelected('file-new-document')">Document</DropdownItem>
    <DropdownItem onSelected="() => this.onItemSelected('file-new-spreadsheet')">Spreadsheet</DropdownItem>
  </Dropdown>
</t>

<t t-name="addon.Dropdown.File.Save.As">
  <Dropdown>
    <t t-set-slot="toggler">Save as...</t>
    <DropdownItem onSelected="() => this.onItemSelected('file-save-as-csv')">CSV</DropdownItem>
    <DropdownItem onSelected="() => this.onItemSelected('file-save-as-pdf')">PDF</DropdownItem>
  </Dropdown>
</t>
```

--------------------------------

### Cards directive example

Source: https://www.odoo.com/documentation/17.0/contributing/documentation/rst_guidelines.html

Shows how to use the `cards` directive to create a grid of cards with optional target, tag, large, image, and alt options. The example includes four cards: Documentation, Content guidelines, RST guidelines, and Card with image.

```rst
.. cards::

   .. card:: Documentation
      :target: ../documentation
      :tag: Step-by-step guide
      :large:

      Use this guide to acquire the tools and knowledge you need to write documentation.

   .. card:: Content guidelines
      :target: content_guidelines

      List of guidelines, tips, and tricks to help you create clear and effective content.

   .. card:: RST guidelines
      :target: rst_guidelines

      List of technical guidelines to observe when writing with reStructuredText.

   .. card:: Card with image
      :target: ../documentation
      :large:
      :image: placeholder-image.png
      :alt: Placeholder card image

      Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
```

```rst
.. toctree::
   :titlesonly:

   website/web_design
   website/pages
   website/configuration
   website/reporting
   website/mail_groups
```

--------------------------------

### Install Odoo Python requirements with pip on Windows

Source: https://www.odoo.com/documentation/17.0/administration/on_premise/source.html

Run in a terminal with Administrator privileges after installing Build Tools for Visual Studio. Installs setuptools and wheel before the requirements.

```batch
C:\> cd \CommunityPath
C:\> pip install setuptools wheel
C:\> pip install -r requirements.txt
```

--------------------------------

### Install system libraries for pip on Debian/Ubuntu

Source: https://www.odoo.com/documentation/17.0/administration/on_premise/source.html

Required before installing Python dependencies with pip, as some packages need a compilation step. Installs python3-pip, libldap2-dev, libpq-dev, and libsasl2-dev.

```bash
$ sudo apt install python3-pip libldap2-dev libpq-dev libsasl2-dev
```

--------------------------------

### Tag test to run after all modules installed with @tagged('-at_install', 'post_install')

Source: https://www.odoo.com/documentation/17.0/developer/reference/backend/testing.html

Use this decorator to configure a test class to run after all modules have been installed instead of right after its own module installation. The tags are inherited by subclasses, and a '-' prefix removes a tag. The example shows a HttpCase subclass that will only execute after all modules are installed.

```python
# coding: utf-8
from odoo.tests import HttpCase, tagged

# This test should only be executed after all modules have been installed.
@tagged('-at_install', 'post_install')
class WebsiteVisitorTests(HttpCase):
  def test_create_visitor_on_tracked_page(self):
      Page = self.env['website.page']
```

--------------------------------

### footer example with dialog buttons

Source: https://www.odoo.com/documentation/17.0/developer/reference/user_interface/view_architectures.html

Example footer containing Save, Feature action, and Discard buttons with special and type attributes.

```XML
<footer>
    <button string="Save" special="save"/>
    <button string="Feature action" type="object" name="my_action" class="btn-primary"/>
    <button string="Discard" special="cancel"/>
</footer>
```

--------------------------------

### odoo.fields.Datetime.start_of(value, granularity)

Source: https://www.odoo.com/documentation/17.0/developer/reference/backend/orm.html

Static method to get the start of a time period from a date or datetime. Accepts a value and a granularity string (year, quarter, month, week, day, hour) and returns the start of that period.

```APIDOC
## [STATIC] odoo.fields.Datetime.start_of(value, granularity)

### Description
Get start of a time period from a date or a datetime.

### Method
Static method

### Parameters
- **value** - initial date or datetime.
- **granularity** - type of period in string, can be year, quarter, month, week, day or hour.

### Returns
A date/datetime object corresponding to the start of the specified period.
```

--------------------------------

### odoo.fields.Date.start_of(value, granularity)

Source: https://www.odoo.com/documentation/17.0/developer/reference/backend/orm.html

Static method to get the start of a time period from a date or datetime. Accepts a value and a granularity string (year, quarter, month, week, day, hour) and returns the start of that period.

```APIDOC
## [STATIC] odoo.fields.Date.start_of(value, granularity)

### Description
Get start of a time period from a date or a datetime.

### Method
Static method

### Parameters
- **value** - initial date or datetime.
- **granularity** - type of period in string, can be year, quarter, month, week, day or hour.

### Returns
A date/datetime object corresponding to the start of the specified period.
```

--------------------------------

### modules_installed(cr, *modules)

Source: https://www.odoo.com/documentation/17.0/developer/reference/upgrades/upgrade_utils.html

Returns whether all given modules are installed. Accepts a variadic list of module names.

```APIDOC
## modules_installed(cr, *modules)

### Description
Return whether _all_ given modules are installed.

### Parameters
- **modules** (str) - Required - One or more module names to check (variadic)

### Returns
- **bool** - Whether all given modules are installed

### Notes
In the context of upgrades a module is considered as installed if it is marked for upgrade, or for installation; even if they are not yet fully installed.
```

--------------------------------

### UpgradeCase example: DeactivateBobUsers

Source: https://www.odoo.com/documentation/17.0/developer/reference/upgrades/upgrade_utils.html

Shows an UpgradeCase with prepare and check methods. prepare returns a JSON-serializable value (user id) that is passed to check. The check method executes SQL to verify the user is inactive. This test type is for development only, not for production upgrades.

```python
from odoo.upgrade.testing import UpgradeCase, change_version


class DeactivateBobUsers(UpgradeCase):

    def prepare(self):
        u = self.env["res.users"].create({"login": "bob", "name": "Bob"})
        return u.id  # will be passed to check

    def check(self, uid):  # uid is the value returned by prepare
        self.env.cr.execute(
            "SELECT * FROM res_users WHERE id=%s AND NOT active", [uid]
        )
        self.assertEqual(self.env.cr.rowcount, 1)
```

--------------------------------

### force_install_module(cr, module, if_installed=None, reason='it has been explicitly asked for')

Source: https://www.odoo.com/documentation/17.0/developer/reference/upgrades/upgrade_utils.html

Forces the ORM to install a module. Optionally only forces installation if certain modules are already installed.

```APIDOC
## force_install_module(cr, module, if_installed=None, reason='it has been explicitly asked for')

### Description
Force the ORM to install a module.

### Parameters
- **module** (str) - Required - Name of the module to install
- **if_installed** (list of str or None) - Optional - Only force the install when these modules are already installed
- **reason** (str) - Optional - Reason for forcing the install (default: 'it has been explicitly asked for')

### Returns
- **str** - The _new_ state of the module
```

--------------------------------

### Add Odoo Community nightly repository on Fedora

Source: https://www.odoo.com/documentation/17.0/administration/on_premise/packages.html

Adds the Odoo nightly repository for Community edition on Fedora and installs, enables, and starts the odoo service.

```bash
$ sudo dnf config-manager --add-repo=https://nightly.odoo.com/17.0/nightly/rpm/odoo.repo
$ sudo dnf install -y odoo
$ sudo systemctl enable odoo
$ sudo systemctl start odoo
```

--------------------------------

### Run Odoo on Windows

Source: https://www.odoo.com/documentation/17.0/administration/on_premise/source.html

Launch Odoo server on Windows with PostgreSQL user and password, custom addons path, and database name. Replace CommunityPath, dbuser, dbpassword, and mydb accordingly.

```batch
C:\> cd CommunityPath/
C:\> python odoo-bin -r dbuser -w dbpassword --addons-path=addons -d mydb
```

--------------------------------

### Install Odoo Python requirements with pip on Linux

Source: https://www.odoo.com/documentation/17.0/administration/on_premise/source.html

Navigate to the Odoo Community installation path and run pip on the requirements.txt file to install dependencies for the current user. Using pip may lead to security issues and broken dependencies.

```bash
$ cd /CommunityPath
$ pip install -r requirements.txt
```

--------------------------------

### Import SQL dump with psql

Source: https://www.odoo.com/documentation/17.0/developer/howtos/website_themes/setup.html

Imports the SQL dump file into the newly created database. Replace <database_name> with your database name and ensure dump.sql is in the current directory.

```bash
psql <database_name> < dump.sql
```

--------------------------------

### Todo object example

Source: https://www.odoo.com/documentation/17.0/developer/tutorials/discover_js_framework/01_owl_components.html

Shows the structure of a todo object used in the tutorial: an id (number), a description (string), and a flag isCompleted (boolean).

```javascript
{ id: 3, description: "buy milk", isCompleted: false }
```

--------------------------------

### UpgradeCase

Source: https://www.odoo.com/documentation/17.0/developer/reference/upgrades/upgrade_utils.html

Test case to verify the upgrade flow. Override prepare to set up data and check to assert expectations after the upgrade. The return value of prepare is persisted and passed to check.

```APIDOC
## UpgradeCase

### Description
Test case to verify the upgrade flow. Override `prepare` to set up data and `check` to assert expectations after the upgrade. The ORM can be used in these methods. The return value of `prepare` is persisted and passed as an argument to `check`; it must be JSON-serializable.

### Method
Class definition

### Usage
Inherit from `UpgradeCase` and override `prepare` and `check` methods.

### Parameters
- **methodName** (str) - Optional - The name of the test method (default: 'runTest').

### Example
```python
from odoo.upgrade.testing import UpgradeCase, change_version

class DeactivateBobUsers(UpgradeCase):
    def prepare(self):
        u = self.env["res.users"].create({"login": "bob", "name": "Bob"})
        return u.id  # will be passed to check

    def check(self, uid):  # uid is the value returned by prepare
        self.env.cr.execute(
            "SELECT * FROM res_users WHERE id=%s AND NOT active", [uid]
        )
        self.assertEqual(self.env.cr.rowcount, 1)
```
```

--------------------------------

### explode_execute parallel query example

Source: https://www.odoo.com/documentation/17.0/developer/reference/upgrades/upgrade_utils.html

Shows how to call util.explode_execute() to run a query in parallel, splitting by buckets of ids. The query must include the {parallel_filter} placeholder, which is added to the last WHERE clause if missing. Avoid using this for DELETE queries on self-referencing tables due to ON DELETE effects.

```python
util.explode_execute(
    cr,
    '''
    UPDATE res_users u
       SET active = False
     WHERE (u.login LIKE 'dummy' OR u.login = 'bob')
       AND {parallel_filter}
    ''',
    table="res_users"
    alias="u",
)
```

--------------------------------

### HTTP Service: get and post requests

Source: https://www.odoo.com/documentation/17.0/developer/reference/frontend/services.html

Use the http service to send GET and POST requests. The get method accepts a route and an optional readMethod (default 'json'); post accepts route, params, and readMethod. The example shows fetching a post and then updating it with a POST request.

```javascript
const httpService = useService("http");
const data = await httpService.get("https://something.com/posts/1");
// ...
await httpService.post("https://something.com/posts/1", { title: "new title", content: "new content" });
```

--------------------------------

### PO file example

Source: https://www.odoo.com/documentation/17.0/developer/howtos/website_themes/translations.html

Example of a .po file for translations, showing the module and model_terms reference. Used for manual translation or creating translation files.

```PO
#. module: website_airproof
#: model_terms:ir.ui.view,arch_db:website_airproof.s_custom_snippet
msgid "..."
msgstr "..."
```

--------------------------------

### get_inherit_model_names

Source: https://www.odoo.com/documentation/17.0/developer/reference/upgrades/upgrade_utils.html

Gets the names of the models the model directly or indirectly `_inherit`. If `model._name` is not in the returned set, the model is defined once.

```APIDOC
## get_inherit_model_names

### Description
Gets the names of the models the model directly or indirectly `_inherit`. If `model._name` is not in the returned set, the model is defined once. `base` is always in the returned set for non-`base` models.

### Parameters
- **model** (recordset) - Required - The model recordset.

### Returns
- **list[str]** - The names of the models the model directly or indirectly `_inherit`.
```

--------------------------------

### Verbose Utility Classes in QWeb

Source: https://www.odoo.com/documentation/17.0/developer/howtos/scss_tips.html

Example of a QWeb template with verbose utility classes, which is hard to read and maintain.

```XML
<myComponent t-attf-class="d-flex border px-lg-2 card
{{props.readonly ? 'o_myComponent_disabled' : ''}}
card d-lg-block position-absolute {{props.active ?
'o_myComponent_active' : ''}}  myComponent px-3"/>
```

--------------------------------

### Install ipdb temporarily

Source: https://www.odoo.com/documentation/17.0/administration/odoo_sh/advanced.html

Installs the ipdb debugger temporarily in the current build using pip with the --user flag.

```bash
pip install ipdb --user
```

--------------------------------

### Start profiler with custom collectors

Source: https://www.odoo.com/documentation/17.0/developer/reference/backend/performance.html

Specify collectors via the `collectors` parameter. Here, SQL and a `PeriodicCollector` with a 0.1-second interval are used.

```python
with Profiler(collectors=['sql', PeriodicCollector(interval=0.1)]):
    do_stuff()
```

--------------------------------

### Create an empty database with createdb

Source: https://www.odoo.com/documentation/17.0/developer/howtos/website_themes/setup.html

Creates an empty PostgreSQL database with the given name. Run this before importing the SQL dump.

```bash
createdb <database_name>
```

--------------------------------

### Import memoize with @web prefix

Source: https://www.odoo.com/documentation/17.0/developer/reference/frontend/framework_overview.html

Shows how to import a module from the web/static/src root folder using the @web prefix. The web/static/src folder is the root for all web/ JavaScript code, and everything inside can be imported with this prefix.

```javascript
import { memoize } from "@web/core/utils/functions";
```

--------------------------------

### Search defaults action context example

Source: https://www.odoo.com/documentation/17.0/developer/reference/user_interface/view_architectures.html

Example action context using search_default_ keys to set a field value and enable a filter by default.

```python
{
    'search_default_foo': 'acro',
    'search_default_bar': 1
}
```

--------------------------------

### is_changed

Source: https://www.odoo.com/documentation/17.0/developer/reference/upgrades/upgrade_utils.html

Returns whether a record was changed before the current upgrade start time. Returns `None` if the xmlid doesn't exist in the DB.

```APIDOC
## is_changed

### Description
Returns whether a record was changed before the current upgrade start time. Returns `None` if the xmlid doesn't exist in the DB.

### Parameters
- **xmlid** (str) - Required - xml_id of the record to check
- **interval** (str) - Optional - Interval after `create_date` on which a record is considered as changed

### Returns
bool or None - Whether the record was changed, or `None` if the xmlid doesn't exist

```

--------------------------------

### Switch Git branches for odoo and enterprise repositories

Source: https://www.odoo.com/documentation/17.0/developer/tutorials/setup_guide.html

Switch both the odoo and enterprise repositories to the 17.0 branch. Both repositories must be synchronized and on the same branch.

```bash
$ cd $HOME/src/odoo
$ git switch 17.0

$ cd $HOME/src/enterprise
$ git switch 17.0
```

--------------------------------

### Warnings during startup

Source: https://www.odoo.com/documentation/17.0/developer/tutorials/server_framework_101/03_basicmodel.html

Expected warnings when the model lacks a _description and access rules. These appear during server startup after adding the model.

```text
...
WARNING rd-demo odoo.models: The model estate.property has no _description
...
WARNING rd-demo odoo.modules.loading: The model estate.property has no access rules, consider adding one...
...
```

--------------------------------

### Link Git with odoo-dev (odoo/tutorials)

Source: https://www.odoo.com/documentation/17.0/developer/tutorials/setup_guide.html

For Odoo employees, configure the 'dev' remote to the shared odoo-dev fork and prevent pushing to the origin repository.

```bash
$ cd /tutorials
$ git remote add dev git@github.com:odoo-dev/tutorials.git
$ git remote set-url --push origin you_should_not_push_on_this_repository
```

--------------------------------

### SCSS syntax and formatting example

Source: https://www.odoo.com/documentation/17.0/contributing/development/coding_guidelines.html

Shows the recommended SCSS formatting: four-space indentation, one declaration per line, and use of SCSS variables like $o-statusbar-height. Follow the listed style rules (80-character columns, brace placement, whitespace).

```SCSS
.o_foo, .o_foo_bar, .o_baz {
   height: $o-statusbar-height;

   .o_qux {
      height: $o-statusbar-height * 0.5;
   }
}

.o_corge {
   background: $o-list-footer-bg-color;
}

```

--------------------------------

### Install pudb temporarily

Source: https://www.odoo.com/documentation/17.0/administration/odoo_sh/advanced.html

Installs the pudb debugger temporarily in the current build using pip with the --user flag.

```bash
pip install pudb --user
```

--------------------------------

### Place a breakpoint with ipdb

Source: https://www.odoo.com/documentation/17.0/developer/tutorials/setup_guide.html

Insert this line in your code to trigger the ipdb debugger at that point. The process is similar with other Python debuggers like pdb or pudb.

```python
import ipdb; ipdb.set_trace()
```

--------------------------------

### Root component template (root.xml)

Source: https://www.odoo.com/documentation/17.0/developer/howtos/standalone_owl_application.html

Defines the Owl template for the root component, rendering 'Hello, World!'. Place this file in /your_module/static/src/standalone_app/root.xml.

```XML
<?xml version="1.0" encoding="UTF-8"?>
<templates xml:space="preserve">
    <t t-name="your_module.Root">
        Hello, World!
    </t>
</templates>
```

--------------------------------

### NGINX root and try_files for Git sources installation

Source: https://www.odoo.com/documentation/17.0/administration/on_premise/deploy.html

Use these directives when Odoo is installed from sources with Community and Enterprise repos cloned in /opt/odoo/community and /opt/odoo/enterprise, and --addons-path '/opt/odoo/community/odoo/addons,/opt/odoo/community/addons,/opt/odoo/enterprise'.

```nginx
root /opt/odoo;
try_files /community/odoo/addons$uri /community/addons$uri /enterprise$uri @odoo;
```

--------------------------------

### Settings view example with app, block, and setting elements

Source: https://www.odoo.com/documentation/17.0/developer/reference/user_interface/view_architectures.html

Shows a complete settings view structure with an app element, header setting, blocks with settings, and various attributes like help, documentation, and company_specific.

```XML
<app string="CRM" name="crm">
    <setting type="header" string="Foo">
        <field name="foo" title="Foo?."/>
        <button name="nameAction" type="object" string="Button"/>
    </setting>
    <block title="Title of group Bar">
        <setting help="this is bar" documentation="/applications/technical/web/settings/this_is_a_test.html">
            <field name="bar"/>
        </setting>
        <setting string="This is Big BAR" company_specific="1">
            <field name="bar"/>
        </setting>
    </block>
    <block title="Title of group Foo">
        <setting string="Personalize setting" help="this is full personalize setting">
            <div>This is a different setting</div>
        </setting>
    </block>
</app>
```

--------------------------------

### chunks function example

Source: https://www.odoo.com/documentation/17.0/developer/reference/upgrades/upgrade_utils.html

Splits an iterable into chunks of a given size and applies a formatting function. Useful for processing large data in smaller pieces.

```python
>>> list(chunks(range(10), 4, fmt=tuple))
[(0, 1, 2, 3), (4, 5, 6, 7), (8, 9)]
>>> ' '.join(chunks('abcdefghijklm', 3))
'abc def ghi jkl m'
```

--------------------------------

### expand_braces function example

Source: https://www.odoo.com/documentation/17.0/developer/reference/upgrades/upgrade_utils.html

Expands a string containing exactly one pair of braces into a list of strings. The input must have precisely one pair of braces.

```python
>>> util.expand_braces("a_{this,that}_b")
['a_this_b', 'a_that_b']
```

--------------------------------

### Preset view activation record

Source: https://www.odoo.com/documentation/17.0/developer/howtos/website_themes/theming.html

Generic example of activating or deactivating a view as a preset by setting the active field on an ir.ui.view record in presets.xml.

```XML
<record id="module.view" model="ir.ui.view">
      <field name="active" eval="False"/>
</record>
```

--------------------------------

### Define the client action template (my_client_action.xml)

Source: https://www.odoo.com/documentation/17.0/developer/howtos/javascript_client_action.html

Provides the QWeb template for the client action component. The template name must match the one set in the JavaScript component.

```xml
<?xml version="1.0" encoding="UTF-8" ?>
<templates xml:space="preserve">
    <t t-name="awesome_tshirt.clientaction">
        Hello world
    </t>
</templates>
```

--------------------------------

### Translator-friendly string formatting examples

Source: https://www.odoo.com/documentation/17.0/contributing/development/coding_guidelines.html

Shows how to format strings passed to `_()` to keep translations clear. Avoid concatenation and prefer `%(varname)` placeholders for readability.

```python
# Bad: makes the translations hard to work with
error = "'" + question + _("' \nPlease enter an integer value ")

# Ok (pay attention to position of the brackets too!)
error = _("Answer to question %s is not valid.\n" \
          "Please enter an integer value.", question)

# Better
error = _("Answer to question %(title)s is not valid.\n" \
          "Please enter an integer value.", title=question)
```

--------------------------------

### Prepare test data command

Source: https://www.odoo.com/documentation/17.0/developer/reference/upgrades/upgrade_utils.html

Runs the prepare phase of upgrade tests using the --test-tags=$prepare_test_tag flag. The tag must be set to 'upgrade.test_prepare' for UpgradeCase or 'integrity_case.test_prepare' for IntegrityCase.

```bash
$ ~/odoo/$version/odoo-bin -d DB --test-tags=$prepare_test_tag \
  --upgrade-path=~/upgrade-util/src,~/myupgrades \
  --addons=~/odoo/$version/addons,~/enterprise/$version,~/mymodules --stop
```

--------------------------------

### Clear Python cache to fix AttributeError

Source: https://www.odoo.com/documentation/17.0/developer/tutorials/setup_guide.html

Deletes all .pyc files in the Python site-packages directory to resolve AttributeError issues. Run after re-installing modules if errors persist.

```bash
$ cd $HOME/.local/lib/python3.8/site-packages/
$ find -name '*.pyc' -type f -delete
```

--------------------------------

### execute_kw - search with pagination

Source: https://www.odoo.com/documentation/17.0/developer/reference/external_api.html

Demonstrates using `offset` and `limit` parameters with `search()` to retrieve a subset of records. This example retrieves 5 records starting from offset 10.

```APIDOC
## [POST] /xmlrpc/2/object

### Description
Calls the `execute_kw` RPC function to invoke the `search` method with pagination parameters. This example retrieves a subset of records using `offset` and `limit`.

### Method
POST

### Endpoint
/xmlrpc/2/object

### Parameters
#### Request Body
- **db** (string) - Required - The database to use.
- **uid** (integer) - Required - The user id (retrieved through `authenticate`).
- **password** (string) - Required - The user's password.
- **model** (string) - Required - The model name (e.g., 'res.partner').
- **method** (string) - Required - The method name (e.g., 'search').
- **args** (array) - Required - Parameters passed by position. For search, this is a list containing a domain filter (e.g., [[['is_company', '=', true]]]).
- **kwargs** (object) - Optional - Parameters passed by keyword. For pagination, include 'offset' and 'limit'.

### Request Example
```json
{
  "db": "database_name",
  "uid": 1,
  "password": "password",
  "model": "res.partner",
  "method": "search",
  "args": [[["is_company", "=", true]]],
  "kwargs": {"offset": 10, "limit": 5}
}
```

### Response
#### Success Response (200)
- **result** (array of integers) - List of record IDs matching the filter, limited by offset and limit.

#### Response Example
```json
{
  "result": [13, 20, 30, 22, 29]
}
```
```

--------------------------------

### Example TransactionCase test with setUpClass and assertions

Source: https://www.odoo.com/documentation/17.0/developer/tutorials/unit_tests.html

Illustrates a typical Odoo test class extending TransactionCase. Use setUpClass to create shared data, and test methods to verify business logic. The example shows using assertRecordValues and assertRaises to check computed fields and state transitions.

```python
from odoo.tests.common import TransactionCase
from odoo.exceptions import UserError
from odoo.tests import tagged

# The CI will run these tests after all the modules are installed,
# not right after installing the one defining it.
@tagged('post_install', '-at_install')
class EstateTestCase(TransactionCase):

    @classmethod
    def setUpClass(cls):
        # add env on cls and many other things
        super(EstateTestCase, cls).setUpClass()

        # create the data for each tests. By doing it in the setUpClass instead
        # of in a setUp or in each test case, we reduce the testing time and
        # the duplication of code.
        cls.properties = cls.env['estate.property'].create([...])

    def test_creation_area(self):
        """Test that the total_area is computed like it should."""
        self.properties.living_area = 20
        self.assertRecordValues(self.properties, [
           {'name': ..., 'total_area': ...},
           {'name': ..., 'total_area': ...},
        ])


    def test_action_sell(self):
        """Test that everything behaves like it should when selling a property."""
        self.properties.action_sold()
        self.assertRecordValues(self.properties, [
           {'name': ..., 'state': ...},
           {'name': ..., 'state': ...},
        ])

        with self.assertRaises(UserError):
            self.properties.forbidden_action_on_sold_property()
```

--------------------------------

### Start profiler with default collectors

Source: https://www.odoo.com/documentation/17.0/developer/reference/backend/performance.html

Use as a context manager to record SQL and async stack traces by default. Call it around the code you want to profile, such as a method or test.

```python
with Profiler():
    do_stuff()
```
Tokens:
Raw