CLOC tools using ODOO CLI

This text offers an outline of how we are able to work with the CLOC instrument in Odoo as a developer.

Earlier than beginning this tutorial, you must have a primary thought of CLI in Odoo. Should you don’t have primary information of Odoo CLI, learn a newbie information to Odoo CLI.

Why do we want CLOC Software in Odoo CLI?

• CLOC Software in Odoo helps to rely the variety of related strains written in Python, Javascript, CSS, SCSS, or XML.
• Counting strains of code may also help you estimate the hassle required for upkeep, debugging, and additional improvement of your Odoo customization.
• It helps in understanding the scale and complexity of a codebase.

Earlier than transferring forward, try our Odoo improvement providers & an intensive vary of high quality Odoo Apps.

The way to use the CLOC Software in Odoo CLI?

1.) Counting the strains of code with addons path

It should rely the strains of code for all of the modules or directories which can be current within the add-ons path.

Syntax

odoo-bin cloc --addons-path=addons -d my_database

Right here is the command for counting the strains of code with addons path.

./choose/odoo/odoo-bin cloc --addons-path=/choose/odoo-custom-addons -d extra-fee-check --db_host=localhost --db_user=odoo --db_password=odoo

The place, “.” denotes the present listing. “-d” or “–database” denotes the database title, and in addition if we use “-d” or “–database” then it can rely the strains of code just for put in modules.

Notice:- If we use an add-ons path for counting the strains of code. Then, we have to use db_user, db_password, db_host, and many others.. if out there in your Odoo config file.

Output for higher command

Right here is the command for counting the strains of code with addons path and -v or –verbose.

./choose/odoo/odoo-bin cloc --addons-path=/choose/odoo-custom-addons -d extra-fee-check --db_host=localhost --db_user=odoo --db_password=odoo -v

or

./choose/odoo/odoo-bin cloc --addons-path=/choose/odoo-custom-addons -d extra-fee-check --db_host=localhost --db_user=odoo --db_password=odoo --verbose

The place, “-v” or “–verbose” is used to point out the main points of strains counted for every file.

Output similar to this

2.) Counting the strains of code with the config file

It should rely the strains of code for all of the modules or directories which can be current within the add-ons path.

Learn to carry out database operations utilizing Odoo CLI.

Syntax

odoo-bin cloc -c config.conf -d my_database

Right here is the command for counting the strains of code with the config file.

./choose/odoo/odoo-bin cloc -c /and many others/odoo/odoo-server.conf -d extra-fee-check

Right here we’ve handed our {custom} config file path utilizing “-c”.

Output

Notice:- We are able to additionally use the “-v” or “–verbose” within the higher instructions.

3.) Counting the strains of code with the path of the module or listing

It should rely the strains of code for explicit modules or directories which can be current within the add-ons path.

Syntax

odoo-bin cloc -p addons/account

Right here is the command for counting the strains of code for a single module.

./choose/odoo/odoo-bin cloc -p /choose/odoo-custom-addons/variant_price_extra

The place, “-p” or “–path” denotes the add-ons path.

Output

Right here is one other command for counting the strains of code for a number of modules.

Syntax

odoo-bin cloc -p addons/account -p addons/sale

Right here is the code

./choose/odoo/odoo-bin cloc -p /choose/odoo-custom-addons/variant_price_extra -p /choose/odoo-custom-addons/odoo_magento_connect

Output

Notice:- We are able to additionally use the “-v” or “–verbose” within the higher instructions.

Some information are excluded from the rely by default:

• The manifest (__manifest__.py or __openerp__.py).
• The contents of the folder static/lib.
• The assessments outlined within the folder assessments and static/assessments.
• The migration scripts outlined within the folder migrations and upgrades.
• The XML information declared within the demo or demo_xml sections of the manifest.

The way to exclude the {custom} information and directories(modules) from the rely:

This may be executed by the cloc_exclude entry within the manifest file.

Right here is the syntax of cloc_exclude:

"cloc_exclude": [
    "lib/common.py", # exclude a single file
    "data/*.xml",    # exclude all XML files in a specific folder
    "example/**/*",  # exclude all files in a folder hierarchy recursively
    "**/*.scss",     # exclude all scss file from the module
]

The sample "**/*” can be utilized to disregard a complete module. This may be helpful to exclude a module from upkeep service prices. Like as,

"cloc_exclude": [
    "**/*",     # exclude a module
]

NEED HELP?

Hope you discover the information useful! Please be at liberty to share your suggestions within the feedback beneath.

Should you nonetheless have any points/queries relating to the identical, please increase a ticket on the UV Desk.

For any doubt, contact us at our help mail.

ajay sharma
2 Badges

20 October 2023