Why do we need CLOC Tool in Odoo CLI?<\/strong><\/h2>\n\n\n\n\n- CLOC Tool in Odoo helps to count the number of relevant lines written in Python, Javascript, CSS, SCSS, or XML.<\/li>\n\n\n\n
- Counting lines of code can help you estimate the effort required for maintenance, debugging, and further development of your Odoo customization.<\/li>\n\n\n\n
- It helps in understanding the size and complexity of a codebase.<\/li>\n<\/ul>\n\n\n\n
Before moving ahead, check out our Odoo development<\/a> services & an extensive range of quality Odoo Apps<\/a>.<\/em><\/p>\n\n\n\nHow to use the CLOC Tool in Odoo CLI?<\/strong><\/h2>\n\n\n\n1.) Counting the lines of code with addons path<\/strong><\/h4>\n\n\n\nIt will count the lines of code for all the modules or directories that are present in the add-ons path.<\/p>\n\n\n\n
Syntax<\/strong><\/p>\n\n\n\nodoo-bin cloc --addons-path=addons -d my_database<\/pre>\n\n\n\nHere is the command for counting the lines of code with addons path. <\/p>\n\n\n\n
.\/opt\/odoo\/odoo-bin cloc --addons-path=\/opt\/odoo-custom-addons -d extra-fee-check --db_host=localhost --db_user=odoo --db_password=odoo<\/pre>\n\n\n\nWhere, “.”<\/strong> denotes the current directory. “-d”<\/strong> or “–database”<\/strong> denotes the database name, and also if we use “-d” or “–database”<\/strong><\/strong> then it will count the lines of code only for installed modules.<\/p>\n\n\n\nNote<\/strong>:- If we use an add-ons path for counting the lines of code. Then, we need to use db_user, db_password, db_host, etc.. if available in your Odoo config file.<\/p>\n\n\n\nOutput for upper command<\/strong><\/p>\n\n\n\n![\"counting-line-of-code-in-cloc-tool-in-odoo-1\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/10\/image-181.png\")
<\/a><\/figure>\n\n\n\nHere is the command for counting the lines of code with addons path and -v<\/strong> or –verbose<\/strong>.<\/p>\n\n\n\n.\/opt\/odoo\/odoo-bin cloc --addons-path=\/opt\/odoo-custom-addons -d extra-fee-check --db_host=localhost --db_user=odoo --db_password=odoo -v\n\nor\n\n.\/opt\/odoo\/odoo-bin cloc --addons-path=\/opt\/odoo-custom-addons -d extra-fee-check --db_host=localhost --db_user=odoo --db_password=odoo --verbose<\/pre>\n\n\n\nWhere, “-v” or “–verbose”<\/strong> is used to show the details of lines counted for each file.<\/p>\n\n\n\nOutput<\/strong> just like this<\/p>\n\n\n\n![\"counting-line-of-code-in-cloc-tool-in-odoo-2\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/10\/image-182.png\")
<\/a><\/figure>\n\n\n\n2.) Counting the lines of code with<\/strong> the<\/strong> config file<\/strong><\/h4>\n\n\n\nIt will count the lines of code for all the modules or directories that are present in the add-ons path.<\/p>\n\n\n\n
Learn how to perform database operations using Odoo CLI<\/a>.<\/p>\n\n\n\nSyntax<\/strong><\/p>\n\n\n\nodoo-bin cloc -c config.conf -d my_database<\/pre>\n\n\n\nHere is the command for counting the lines of code with the config file<\/strong>.<\/p>\n\n\n\n.\/opt\/odoo\/odoo-bin cloc -c \/etc\/odoo\/odoo-server.conf -d extra-fee-check<\/pre>\n\n\n\nHere we have passed our custom config file path using “-c”<\/strong>.<\/p>\n\n\n\nOutput<\/strong><\/p>\n\n\n\n![\"counting-line-of-code-in-cloc-tool-in-odoo-usinf-config-files\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/10\/image-183.png\")
<\/a><\/figure>\n\n\n\nNote:-<\/strong> We can also use the “-v”<\/strong> or “–verbose”<\/strong> in the upper commands.<\/p>\n\n\n\n3.) Counting the lines of code with<\/strong> the<\/strong> path of the module or directory<\/strong><\/h4>\n\n\n\nIt will count the lines of code for particular modules or directories that are present in the add-ons path.<\/p>\n\n\n\n
Syntax<\/strong><\/p>\n\n\n\nodoo-bin cloc -p addons\/account<\/pre>\n\n\n\nHere is the command for counting the lines of code for a single<\/strong> module<\/strong>.<\/p>\n\n\n\n.\/opt\/odoo\/odoo-bin cloc -p \/opt\/odoo-custom-addons\/variant_price_extra<\/pre>\n\n\n\nWhere, “-p”<\/strong> or “–path”<\/strong> denotes the add-ons path.<\/p>\n\n\n\nOutput<\/strong><\/p>\n\n\n\n![\"counting-line-of-code-for-partiular-directory\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/10\/image-185.png\")
<\/figure>\n\n\n\nHere is another command for counting the lines of code for multiple modules<\/strong>.<\/p>\n\n\n\nSyntax<\/strong><\/p>\n\n\n\nodoo-bin cloc -p addons\/account -p addons\/sale<\/pre>\n\n\n\nHere is the code<\/p>\n\n\n\n
.\/opt\/odoo\/odoo-bin cloc -p \/opt\/odoo-custom-addons\/variant_price_extra -p \/opt\/odoo-custom-addons\/odoo_magento_connect<\/pre>\n\n\n\nOutput<\/strong><\/p>\n\n\n\n![\"counting-line-of-code-in-for-multiple-directories\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/10\/image-187.png\")
<\/a><\/figure>\n\n\n\nNote:-<\/strong> We can also use the “-v”<\/strong> or “–verbose”<\/strong> in the upper commands.<\/p>\n\n\n\nSome files are excluded from the count by default:<\/h2>\n\n\n\n\n- The manifest (
__manifest__.py<\/strong><\/code> or __openerp__.py<\/strong><\/code>).<\/li>\n\n\n\n- The contents of the folder
static\/lib<\/strong><\/code>.<\/li>\n\n\n\n- The tests defined in the folder
tests<\/strong><\/code> and static\/tests<\/strong><\/code>.<\/li>\n\n\n\n- The migration scripts defined in the folder
migrations<\/strong><\/code> and upgrades<\/strong><\/code>.<\/li>\n\n\n\n- The XML files declared in the
demo<\/strong><\/code> or demo_xml<\/strong><\/code> sections of the manifest.<\/li>\n<\/ul>\n\n\n\nHow to exclude the custom files and directories(modules) from the count:<\/h2>\n\n\n\n
This can be done by the cloc_exclude<\/strong><\/code> entry in the manifest file<\/strong>.<\/p>\n\n\n\nHere is the syntax of cloc_exclude<\/strong>:<\/p>\n\n\n\n"cloc_exclude": [\n "lib\/common.py", # exclude a single file\n "data\/*.xml", # exclude all XML files in a specific folder\n "example\/**\/*", # exclude all files in a folder hierarchy recursively\n "**\/*.scss", # exclude all scss file from the module\n]<\/pre>\n\n\n\nThe pattern \"**\/*<\/strong><\/code>” can be used to ignore an entire module. This can be useful to exclude a module from maintenance service costs. Like as,<\/p>\n\n\n\n"cloc_exclude": [\n "**\/*", # exclude a module\n]<\/pre>\n\n\n\nNEED HELP?<\/strong><\/h2>\n\n\n\nHope you find the guide helpful! Please feel free to share your feedback in the comments below.<\/p>\n\n\n\n
If you still have any issues\/queries regarding the same, please raise a ticket at the UV Desk<\/a>.<\/p>\n\n\n\nFor any doubt, contact us at our support mail<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"
Before moving ahead, check out our Odoo development<\/a> services & an extensive range of quality Odoo Apps<\/a>.<\/em><\/p>\n\n\n\n It will count the lines of code for all the modules or directories that are present in the add-ons path.<\/p>\n\n\n\n Syntax<\/strong><\/p>\n\n\n\n Here is the command for counting the lines of code with addons path. <\/p>\n\n\n\n Where, “.”<\/strong> denotes the current directory. “-d”<\/strong> or “–database”<\/strong> denotes the database name, and also if we use “-d” or “–database”<\/strong><\/strong> then it will count the lines of code only for installed modules.<\/p>\n\n\n\n Note<\/strong>:- If we use an add-ons path for counting the lines of code. Then, we need to use db_user, db_password, db_host, etc.. if available in your Odoo config file.<\/p>\n\n\n\n Output for upper command<\/strong><\/p>\n\n\n\n Here is the command for counting the lines of code with addons path and -v<\/strong> or –verbose<\/strong>.<\/p>\n\n\n\n Where, “-v” or “–verbose”<\/strong> is used to show the details of lines counted for each file.<\/p>\n\n\n\n Output<\/strong> just like this<\/p>\n\n\n\n It will count the lines of code for all the modules or directories that are present in the add-ons path.<\/p>\n\n\n\n Learn how to perform database operations using Odoo CLI<\/a>.<\/p>\n\n\n\n Syntax<\/strong><\/p>\n\n\n\n Here is the command for counting the lines of code with the config file<\/strong>.<\/p>\n\n\n\n Here we have passed our custom config file path using “-c”<\/strong>.<\/p>\n\n\n\n Output<\/strong><\/p>\n\n\n\n Note:-<\/strong> We can also use the “-v”<\/strong> or “–verbose”<\/strong> in the upper commands.<\/p>\n\n\n\n It will count the lines of code for particular modules or directories that are present in the add-ons path.<\/p>\n\n\n\n Syntax<\/strong><\/p>\n\n\n\n Here is the command for counting the lines of code for a single<\/strong> module<\/strong>.<\/p>\n\n\n\n Where, “-p”<\/strong> or “–path”<\/strong> denotes the add-ons path.<\/p>\n\n\n\n Output<\/strong><\/p>\n\n\n\n Here is another command for counting the lines of code for multiple modules<\/strong>.<\/p>\n\n\n\n Syntax<\/strong><\/p>\n\n\n\n Here is the code<\/p>\n\n\n\n Output<\/strong><\/p>\n\n\n\n Note:-<\/strong> We can also use the “-v”<\/strong> or “–verbose”<\/strong> in the upper commands.<\/p>\n\n\n\n This can be done by the Here is the syntax of cloc_exclude<\/strong>:<\/p>\n\n\n\n The pattern Hope you find the guide helpful! Please feel free to share your feedback in the comments below.<\/p>\n\n\n\n If you still have any issues\/queries regarding the same, please raise a ticket at the UV Desk<\/a>.<\/p>\n\n\n\n For any doubt, contact us at our support mail<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"How to use the CLOC Tool in Odoo CLI?<\/strong><\/h2>\n\n\n\n
1.) Counting the lines of code with addons path<\/strong><\/h4>\n\n\n\n
odoo-bin cloc --addons-path=addons -d my_database<\/pre>\n\n\n\n
.\/opt\/odoo\/odoo-bin cloc --addons-path=\/opt\/odoo-custom-addons -d extra-fee-check --db_host=localhost --db_user=odoo --db_password=odoo<\/pre>\n\n\n\n
<\/a><\/figure>\n\n\n\n.\/opt\/odoo\/odoo-bin cloc --addons-path=\/opt\/odoo-custom-addons -d extra-fee-check --db_host=localhost --db_user=odoo --db_password=odoo -v\n\nor\n\n.\/opt\/odoo\/odoo-bin cloc --addons-path=\/opt\/odoo-custom-addons -d extra-fee-check --db_host=localhost --db_user=odoo --db_password=odoo --verbose<\/pre>\n\n\n\n
<\/a><\/figure>\n\n\n\n2.) Counting the lines of code with<\/strong> the<\/strong> config file<\/strong><\/h4>\n\n\n\n
odoo-bin cloc -c config.conf -d my_database<\/pre>\n\n\n\n
.\/opt\/odoo\/odoo-bin cloc -c \/etc\/odoo\/odoo-server.conf -d extra-fee-check<\/pre>\n\n\n\n
<\/a><\/figure>\n\n\n\n3.) Counting the lines of code with<\/strong> the<\/strong> path of the module or directory<\/strong><\/h4>\n\n\n\n
odoo-bin cloc -p addons\/account<\/pre>\n\n\n\n
.\/opt\/odoo\/odoo-bin cloc -p \/opt\/odoo-custom-addons\/variant_price_extra<\/pre>\n\n\n\n
<\/figure>\n\n\n\nodoo-bin cloc -p addons\/account -p addons\/sale<\/pre>\n\n\n\n
.\/opt\/odoo\/odoo-bin cloc -p \/opt\/odoo-custom-addons\/variant_price_extra -p \/opt\/odoo-custom-addons\/odoo_magento_connect<\/pre>\n\n\n\n
<\/a><\/figure>\n\n\n\nSome files are excluded from the count by default:<\/h2>\n\n\n\n
\n
__manifest__.py<\/strong><\/code> or __openerp__.py<\/strong><\/code>).<\/li>\n\n\n\nstatic\/lib<\/strong><\/code>.<\/li>\n\n\n\ntests<\/strong><\/code> and static\/tests<\/strong><\/code>.<\/li>\n\n\n\nmigrations<\/strong><\/code> and upgrades<\/strong><\/code>.<\/li>\n\n\n\ndemo<\/strong><\/code> or demo_xml<\/strong><\/code> sections of the manifest.<\/li>\n<\/ul>\n\n\n\nHow to exclude the custom files and directories(modules) from the count:<\/h2>\n\n\n\n
cloc_exclude<\/strong><\/code> entry in the manifest file<\/strong>.<\/p>\n\n\n\n"cloc_exclude": [\n "lib\/common.py", # exclude a single file\n "data\/*.xml", # exclude all XML files in a specific folder\n "example\/**\/*", # exclude all files in a folder hierarchy recursively\n "**\/*.scss", # exclude all scss file from the module\n]<\/pre>\n\n\n\n
\"**\/*<\/strong><\/code>” can be used to ignore an entire module. This can be useful to exclude a module from maintenance service costs. Like as,<\/p>\n\n\n\n"cloc_exclude": [\n "**\/*", # exclude a module\n]<\/pre>\n\n\n\n
NEED HELP?<\/strong><\/h2>\n\n\n\n