odoo-pre-commit-hooks to use in pre-commit-config.yml files

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for moylop260 from gravatar.com moylop260 Avatar for vauxoo from gravatar.com vauxoo

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU Lesser General Public License v3 or later (LGPLv3+) (LGPL-3.0-or-later)
  • Author: Odoo Community Association (OCA)
  • Tags pre-commit, OCA, Odoo Community Association, pre-commit-hook
  • Requires: Python >=3.7
Classifiers

Project description

Build Status codecov version wheel supported-versions commits-since code-style-black

odoo-pre-commit-hooks

OCA's custom pre-commit hooks for Odoo modules

Installation

You don't need to install it directly only configure your ".pre-commit-config.yaml" file

You even can install it directly:

  • Installing from pypi:

    • pip install -U oca-odoo-pre-commit-hooks

  • Installing from github:

    • pip install --force-reinstall -U git+https://github.com/OCA/odoo-pre-commit-hooks.git@main

Usage pre-commit-config.yaml

Add to your ".pre-commit-config.yaml" configuration file the following input

    - repo: https://github.com/OCA/odoo-pre-commit-hooks
        rev: v0.0.34
        hooks:
        - id: oca-checks-odoo-module
        - id: oca-checks-po
          args: ["--fix"]

Usage directly the entry points

If you install directly the package use the entry point:

oca-checks-odoo-module --help
oca-checks-po --help

Skip one xml-check for only one file

If you need to skip one check in one particular XML file you can use the follow comment

<?xml version="1.0" encoding="utf-8"?>
<!-- oca-hooks:disable=xml-check-to-skip -->
<odoo>
...
</odoo>

<?xml version="1.0" encoding="utf-8"?>
<!-- oca-hooks:disable=xml-check-to-skip,
                       xml-check-to-skip2 -->
<odoo>
...
</odoo>

The position of the comment it is not relative to the line that throw the check

It disable the entire file

Configuration

Behavior can be configured through several methods and as of now only consists of enabling/disabling checks.

Enabling or Disabling Checks

Each available hook consists of multiple checks which can be enabled/disabled using any of the following methods (ordered by priority):

  1. As an argument e.g., oca-checks-odoo --enable=check-to-enable --disable=check-to-disable1,check-to-disable2
  2. Using environment variables OCA_HOOKS_ENABLE or OCA_HOOKS_DISABLE e.g., export OCA_HOOKS_ENABLE=check1,check2
  3. A configuration file. The path to it can be specified with the argument --config. Alternatively a file named .oca_hooks.cfg will be looked for (by default) in the following locations (in order):
    1. Current working directory
    2. Repo's root
    3. User's home

Using a Configuration File

To enable or disable checks using a configuration file, add a disable or enable key under the MESSAGES_CONTROL section. For example:

[MESSAGES_CONTROL]
enable=check-enable1,check-enable2
disable=check-to-disable

As stated before, each source has a certain priority. This means that if the environment variable OCA_HOOKS_ENABLE=check1 exists, the configuration file above would not have any effect when it comes to enabling checks, and the only enabled check will be check1.

However, if OCA_HOOKS_DISABLE is not set, the configuration file will still have an effect and check-to-disable will be disabled.

Checks

  • Check manifest-syntax-error Check if the manifest file has syntax error

  • Check csv-duplicate-record-id duplicate CSV "id" AKA xmlid but for CSV files

  • Check csv-syntax-error Check syntax error for CSV files declared in the manifest

  • Check xml-deprecated-data-node Deprecated node inside xml node

  • Check xml-deprecated-openerp-node deprecated xml node

  • Check xml-deprecated-qweb-directive for use of deprecated QWeb directives t-*-options

  • Check xml-not-valid-char-link The resource in in src/href contains a not valid character.

  • Check xml-oe-structure-missing-id

      Ensure all tags with class 'oe_structure' have an ID. For more information on the rationale, see:
  https://github.com/OCA/odoo-pre-commit-hooks/issues/27

  • Check xml-redundant-module-name

      If the module is called "module_a" and the xmlid is
  `<record id="module_a.xmlid_name1" ...`

  The "module_a." is redundant it could be replaced to only
  `<record id="xmlid_name1" ...`

  • Check xml-dangerous-filter-wo-user Check dangerous filter without a user assigned.

  • Check xml-create-user-wo-reset-password records of user without context="{'no_reset_password': True}" This context avoid send email and mail log warning

  • Check xml-view-dangerous-replace-low-priority in ir.ui.view

          <field name="priority" eval="10"/>
      ...
          <field name="name" position="replace"/>

  • Check xml-deprecated-tree-attribute The tree-view declaration is using a deprecated attribute.

  • Check xml-record-missing-id Generated when a tag has no id.

  • Check xml-duplicate-record-id

      If a module has duplicated record_id AKA xml_ids
  file1.xml
      <record id="xmlid_name1"
  file2.xml
      <record id="xmlid_name1"

  • Check xml-duplicate-fields in all record nodes <record id="xmlid_name1"... <field name="field_name1"... <field name="field_name1"...

  • Check xml-syntax-error Check syntax of XML files declared in the Odoo manifest

  • Check xml-dangerous-qweb-replace-low-priority Dangerous qweb view defined with low priority

  • Check xml-duplicate-template-id Triggered when two templates share the same ID

  • Check xml-xpath-translatable-item check xpath nodes using contains(text(), 'Text translatable') Since that the text could be translated so it is a mutable value. It could raise ValueError exception if the language is changed.

Checks PO

  • Check po-requires-module Translation entry requires comment #. module: MODULE

  • Check po-python-parse-printf Check if msgid is using str variables like %s So translation msgstr must be the same number of variables too

  • Check po-python-parse-format Check if msgid is using str variables like {} So translation msgstr must be the same number of variables too

  • Check po-duplicate-message-definition (message-id) in all entries of PO files

  • Check po-duplicate-model-definition Verify that no entries share the same 'model:' tag

  • Check po-pretty-format Check the following: 1. Entries sorted alphabetically 2. Lines are wrapped at 78 columns (same as Odoo) 3. Clear msgstr when it is the same as msgid

  • Check po-syntax-error Check syntax of PO files from i18n* folders

Help

usage: oca-checks-odoo-module [-h] [--no-verbose] [--no-exit] [--disable DISABLE] [--enable ENABLE] [--config CONFIG] [--list-msgs] [--fix] [files_or_modules ...]

positional arguments:
 files_or_modules Odoo __manifest__.py paths or Odoo module paths.

options:
 -h, --help show this help message and exit
 --no-verbose If enabled so disable verbose mode.
 --no-exit If enabled so it will not call exit.
 --disable DISABLE, -d DISABLE Disable the checker with the given 'check-name', separated by commas.
 --enable ENABLE, -e ENABLE Enable the checker with the given 'check-name', separated by commas. Default: All checks are enabled by default
 --config CONFIG, -c CONFIG Path to a configuration file (default: .oca_hooks.cfg)
 --list-msgs List all currently enabled messages.
 --fix Automatically fix files when possible

Help PO

usage: oca-checks-po [-h] [--no-verbose] [--no-exit] [--disable DISABLE] [--enable ENABLE] [--config CONFIG] [--list-msgs] [--fix] [po_files ...]

positional arguments:
 po_files PO files.

options:
 -h, --help show this help message and exit
 --no-verbose If enabled so disable verbose mode.
 --no-exit If enabled so it will not call exit.
 --disable DISABLE, -d DISABLE Disable the checker with the given 'check-name', separated by commas.
 --enable ENABLE, -e ENABLE Enable the checker with the given 'check-name', separated by commas. Default: All checks are enabled by default
 --config CONFIG, -c CONFIG Path to a configuration file (default: .oca_hooks.cfg)
 --list-msgs List all currently enabled messages.
 --fix Automatically fix files when possible

Examples

Examples PO

Licenses

This repository is licensed under AGPL-3.0.

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

CHANGES

v0.0.34

  • [IMP] *: Display the duplicated lines (#111)
  • [REF] tox.ini: Add compatibility with new pyttest (#112)
  • [IMP] csv-duplicate-record-id: show the actual record id
  • [IMP] xml-duplicate-record-id: show the actual record id

v0.0.33

  • [IMP] check_odoo_module_po: extract line number from error message (#108)
  • [IMP] Better error output (#106)

v0.0.32

v0.0.31

  • [REF] setup: Add py3.12 support info (#98)
  • [REF] .github: Update actions version, fix cache and update lints (#97)
  • [REF] tests: Fixing windows po autofix unitest (#96)

v0.0.30

  • CI improvements (#93)
  • [REF] setup: Enable py311 classifier (#87)

v0.0.29

  • IMP] add xml-duplicate-template-id message (#82)
  • [FIX] lints (#86)
  • [ADD] po-duplicate-model-definition check (#85)
  • [REF] Don't filter out messages, move is_message_enabled (#83)
  • [IMP] add xml-record-missing-id (#84)

v0.0.28

  • [FIX] oe-structure-missing-id: change constraints, add docs (#81)

v0.0.27

  • [REF] improve xpath expressions (#80)

v0.0.26

  • [IMP] Improve XPath expressions, compile them only once, fix false negative, add profiling tests (#79)
  • [ADD] pretty-format-po check (#76)
  • [IMP] add xml-oe-structure-missing-id check (#78)
  • [REF] tests: Generate immutable readme (without extra spaces)
  • [IMP] README: Added a section on configuration

v0.0.25

  • [REF] requirements.txt: Update polib to fix issues and improves (#72)

v0.0.24

  • [FIX] pre-commit: Fix isort hook - RuntimeError The Poetry configuration is invalid (#71)

v0.0.23

  • [FIX] Correct documentation (#69)

v0.0.22

  • [IMP] Help msg for "xml-view-dangerous-replace-low-priority" (#68)
  • Wrote documentation for proposed refactoring (#66)
  • [FIX] ci: update flake8 repo URL, tox.ini and gh actions .yml (#65)
  • [REF] hooks: Add support for `` (#62)

v0.0.21

  • [REF] duplicate-xml-fields: Only applies to direct record's children (#58)

v0.0.20

  • [FIX] xml-xpath-translatable-item: Fix false negative calling a method o.amount_to_text() (#57)

v0.0.19

  • [FIX] setup: Add missing "requirements.txt" file to package (#441) (#55)

v0.0.18

  • [FIX] checks_odoo_module: Support glob expression for "qweb" manifest data section (#54)
  • [IMP] oca_pre_commit_hooks: Add --list-msgs option (#53)
  • [REF] oca_pre_commit_hooks: Silent subprocess git error (#52)

v0.0.17

  • [IMP] oca_pre_commit_hooks: Support enable/disable from ENV (#38) (#49)

v0.0.16

  • [ADD] xml-xpath-translatable-item: Add new check to identify mutable item used from xpath (#50)

v0.0.15

  • [FIX] oca_pre_commit_hooks: Fix exit_status false error (#48)

v0.0.14

  • [IMP] oca_pre_commit_hooks: Support for config file (#41)

v0.0.13

  • [REF] pylint_odoo: Remove TODO comments (#47)
  • [REF] requirements: Remove unused libraries and pre-commit hooks (#45)
  • [REF] xml-deprecated-data-node: Use the data node sourceline instead of odoo node (#43)
  • [IMP] oca_pre_commit_hooks: Support disable XML checks from disable comments (#42)
  • [REF] README: Fix name of pypi package (#35)
  • [REF] oca_pre_commit_hooks: cli_po, cli: Add cli_po and cli global (#36)
  • [REF] setup: Match requires-python = ">=3.7" from pre-commit
  • [REF] CI: Enable py3.11

v0.0.12

  • [REF] checks_odoo_module_xml: Allow duplicated fields with 'groups' (#32)
  • [REF] CI: Enable tox with parallels + codecov compatibility (#33)

v0.0.11

  • [REF] codecov: Enable codecov again
  • [REM] missing-readme: Check add to pylint-odoo
  • [REF] TOX: Strip names, remove no-cover, compatible with parallels option (#24)
  • [REF] lint: Adapt lints for py packages instead of odoo module (#23)

v0.0.10

  • [REF] README: Update README and fix mutable results auto-generating it (#22)
  • [REF] checks_odoo_module_po: Run on modified PO files only (#21)
  • [REF] manifest: Skip duplicated data files (#20)

v0.0.9

  • [FIX] README: Fix regex to replace autogenerated content (#18)
  • [REF] README: Detect from CI if README needs to be updated (#17)

v0.0.8

  • [REF] README: Add examples of checks section and script to auto-generate it (#16)
  • [REF] README: Add help section and script to auto-generate it (#15)

v0.0.7

  • [REF] checks: name_checks changed to name-checks (#14)
  • [REF] oca_pre_commit_hooks: Use shorter path in messages (#13)
  • [FIX] pre-commit-hooks.yaml: Run checks even if the manifest was not changed
  • [REF] test: Remove TODO comments already fixed

v0.0.6

  • [FIX] oca_pre_commit_hooks: Fix checks if it has syntax error (#8)

v0.0.5

  • [REF] oca_pre_commit_hooks: Small improvements (#7)

v0.0.4

  • [IMP] oca_pre_commit_hooks: Enable feature to 'enable' checks (#6)
  • [IMP] oca_pre_commit_hooks: Add entrypoint arguments to disable checks (#5)

v0.0.3

  • [REF] README: Remove deprecated CI build

v0.0.2

  • [REF] CI: Re-use tox to run pre-commit in the CI with same caches and packages
  • [ADD] .pre-commit-hooks.yaml: Compatible with pre-commit-hooks to use as hook id directly

v0.0.1

  • [ADD] Migrate pylint-odoo checks (not related to python) to pre-commit hooks (#2)
  • Initialize

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for moylop260 from gravatar.com moylop260 Avatar for vauxoo from gravatar.com vauxoo

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU Lesser General Public License v3 or later (LGPLv3+) (LGPL-3.0-or-later)
  • Author: Odoo Community Association (OCA)
  • Tags pre-commit, OCA, Odoo Community Association, pre-commit-hook
  • Requires: Python >=3.7
Classifiers

Release history Release notifications | RSS feed

This version

0.0.34

0.0.33

0.0.32

0.0.31

0.0.30

0.0.29

0.0.28

0.0.27

0.0.26

0.0.25

0.0.24

0.0.23

0.0.22

0.0.21

0.0.20

0.0.19

0.0.18

0.0.17

0.0.16

0.0.15

0.0.14

0.0.13

0.0.12

0.0.11

0.0.10

0.0.9

0.0.8

0.0.7

0.0.6

0.0.5

0.0.4

0.0.3

0.0.2

0.0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

oca_odoo_pre_commit_hooks-0.0.34.tar.gz (51.9 kB view details)

Uploaded Source

Built Distribution

oca_odoo_pre_commit_hooks-0.0.34-py3-none-any.whl (41.6 kB view details)

Uploaded Python 3

File details

Details for the file oca_odoo_pre_commit_hooks-0.0.34.tar.gz.

File metadata

File hashes

Hashes for oca_odoo_pre_commit_hooks-0.0.34.tar.gz
Algorithm Hash digest
SHA256 d1b7979a1241718da78e70a00cd42c0c6cd47187169f464dbd9910b1553ca072
MD5 7402b411c9e921e1870a5e935c17f93f
BLAKE2b-256 9915e1723fbd5c3fdfeda5ded3e076104d5c1f3f7d395c0ad3a2c2133dc2444f

See more details on using hashes here.

File details

Details for the file oca_odoo_pre_commit_hooks-0.0.34-py3-none-any.whl.

File metadata

File hashes

Hashes for oca_odoo_pre_commit_hooks-0.0.34-py3-none-any.whl
Algorithm Hash digest
SHA256 19f4bc2db4cb351cf1689a611f94ac6d196da27ec4f89bd87a4cd305e9fe74ae
MD5 6a2adbfb7b65281eaa6655f0fc727ca6
BLAKE2b-256 9655ecf2f4e613126ff4dbb08a6056c77efe3fd5e48c23996df2e51d3460fba5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page