pre-commit-vauxoo 8.3.0__tar.gz → 8.3.2__tar.gz

{pre_commit_vauxoo-8.3.0 → pre_commit_vauxoo-8.3.2}/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 8.3.0
+current_version = 8.3.2
 commit = True
 tag = True
 sign_tags = True

{pre_commit_vauxoo-8.3.0 → pre_commit_vauxoo-8.3.2}/.coveragerc

@@ -5,6 +5,9 @@ source = src
 source = src
 parallel = true
 context = ${{COVERAGE_CONTEXT}}
+# "sysmon" is the default core since python3.14 but it does not support the dynamic
+# contexts set by "pytest --cov-context=test" raising a CoverageWarning for each test
+core = ctrace
 
 [report]
 show_missing = true

{pre_commit_vauxoo-8.3.0 → pre_commit_vauxoo-8.3.2}/ChangeLog

@@ -1,6 +1,20 @@
 CHANGES
 =======
 
+v8.3.2
+------
+
+* Bump version: 8.3.1 → 8.3.2
+* [IMP] cfg: Migrate to ruff the flake8/pylint checks already implemented in it (#250)
+* [IMP] cfg: Enable pylint --jobs=3 using pylint-odoo v10.0.9 (#251)
+
+v8.3.1
+------
+
+* Bump version: 8.3.0 → 8.3.1
+* [FIX] coveragerc: Set "core=ctrace" to support dynamic contexts
+* [IMP] bandit-optional: Allow html\_sanitize calls for markupsafe B704
+
 v8.3.0
 ------
 

{pre_commit_vauxoo-8.3.0 → pre_commit_vauxoo-8.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pre-commit-vauxoo
-Version: 8.3.0
+Version: 8.3.2
 Summary: pre-commit script to run automatically the configuration and variables custom from Vauxoo
 Home-page: https://github.com/Vauxoo/pre-commit-vauxoo
 Author: Vauxoo
@@ -215,9 +215,13 @@ Full --help command result:
                                     README.rst,      change py _('translation')
                                     to self.env._('translation'), rm manifest
                                     superfluous keys, rm field-string-redundant)
-                                    🟢 3. ESLint 🟢 4. Black / Autoflake 🟢 5. pre-
-                                    commit framework 🟢 6. Pylint/pylint-odoo 🟢
-                                    7. flake8
+                                    🟢 3. ESLint 🟢 4. Black / Autoflake (30 →
+                                    Use ruff instead. It also migrates to ruff
+                                    the mandatory and optional pylint/flake8
+                                    checks already implemented in ruff,
+                                    disabling them from the original tool) 🟢 5.
+                                    pre-commit framework 🟢 6. Pylint/pylint-
+                                    odoo 🟢 7. flake8
 
                                     ⚠️ Higher values or empty valuesmay
                                     introduce formatting changes, stricter
@@ -295,6 +299,20 @@ Note, to combine the coverage data from all the tox environments run:
 CHANGES
 =======
 
+v8.3.2
+------
+
+* Bump version: 8.3.1 → 8.3.2
+* [IMP] cfg: Migrate to ruff the flake8/pylint checks already implemented in it (#250)
+* [IMP] cfg: Enable pylint --jobs=3 using pylint-odoo v10.0.9 (#251)
+
+v8.3.1
+------
+
+* Bump version: 8.3.0 → 8.3.1
+* [FIX] coveragerc: Set "core=ctrace" to support dynamic contexts
+* [IMP] bandit-optional: Allow html\_sanitize calls for markupsafe B704
+
 v8.3.0
 ------
 

{pre_commit_vauxoo-8.3.0 → pre_commit_vauxoo-8.3.2}/README.rst

@@ -50,9 +50,9 @@ Overview
     :alt: Supported versions
     :target: https://pypi.org/project/pre-commit-vauxoo
 
-.. |commits-since| image:: https://img.shields.io/github/commits-since/Vauxoo/pre-commit-vauxoo/v8.3.0.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/Vauxoo/pre-commit-vauxoo/v8.3.2.svg
     :alt: Commits since latest release
-    :target: https://github.com/Vauxoo/pre-commit-vauxoo/compare/v8.3.0...main
+    :target: https://github.com/Vauxoo/pre-commit-vauxoo/compare/v8.3.2...main
 
 
 
@@ -216,9 +216,13 @@ Full --help command result:
                                     README.rst,      change py _('translation')
                                     to self.env._('translation'), rm manifest
                                     superfluous keys, rm field-string-redundant)
-                                    🟢 3. ESLint 🟢 4. Black / Autoflake 🟢 5. pre-
-                                    commit framework 🟢 6. Pylint/pylint-odoo 🟢
-                                    7. flake8
+                                    🟢 3. ESLint 🟢 4. Black / Autoflake (30 →
+                                    Use ruff instead. It also migrates to ruff
+                                    the mandatory and optional pylint/flake8
+                                    checks already implemented in ruff,
+                                    disabling them from the original tool) 🟢 5.
+                                    pre-commit framework 🟢 6. Pylint/pylint-
+                                    odoo 🟢 7. flake8
 
                                     ⚠️ Higher values or empty valuesmay
                                     introduce formatting changes, stricter

{pre_commit_vauxoo-8.3.0 → pre_commit_vauxoo-8.3.2}/docs/conf.py

@@ -18,7 +18,7 @@ project = "pre-commit-vauxoo"
 year = "2022"
 author = "Vauxoo"
 copyright = f"{year}, {author}"
-version = release = "8.3.0"
+version = release = "8.3.2"
 
 pygments_style = "trac"
 templates_path = ["."]

pre_commit_vauxoo-8.3.2/resources/module_example1/models/__init__.py

@@ -0,0 +1,2 @@
+from . import models
+from . import markupsafe_sanitized

pre_commit_vauxoo-8.3.2/resources/module_example1/models/markupsafe_sanitized.py

@@ -0,0 +1,12 @@
+from markupsafe import Markup
+
+from odoo.tools import html_sanitize
+
+
+def body2markup(body):
+    """Build a HTML body for 'message_post' without raising bandit B704
+
+    Markup() is mandatory since 'message_post' escapes anything that is not a
+    Markup object, so the value is sanitized instead of escaped
+    """
+    return Markup(html_sanitize(body))

pre_commit_vauxoo-8.3.2/resources/module_warnings1/tests/data/ruff_optional_use_cases.py

@@ -0,0 +1,108 @@
+"""Use cases of the optional checks migrated from pylint/flake8+bugbear to ruff.
+
+Each case must be reported:
+ - before the ruff migration: by "pylint optional checks" or "flake8 + bugbear optional checks"
+ - after the ruff migration: by "ruff optional checks" (see .config/.ruff-optional.toml)
+
+It is stored under "tests/data/" since that path is excluded from the autofixes
+so the use cases are not autofixed before being reported by the linters.
+The cases must not be reported by any mandatory check.
+"""
+
+import datetime
+
+# implicit-str-concat (pylint) -> single-line-implicit-string-concatenation (ruff ISC001)
+IMPLICIT_CONCAT = "implicit" "concatenation"
+
+# redundant-u-string-prefix (pylint) -> unicode-kind-prefix (ruff UP025)
+UNICODE_PREFIX = u"unicode prefix"
+
+# E242 tab after ',' (flake8) -> tab-after-comma (ruff E242)
+TAB_AFTER_COMMA = ("first",	"second")
+
+
+def bad_docstring_quotes_use_case(value):
+    'bad-docstring-quotes (pylint) -> triple-single-quotes (ruff D300)'
+    return value
+
+
+def dict_literal_use_case():
+    # use-dict-literal (pylint) -> unnecessary-collection-call (ruff C408)
+    return dict(one=1)
+
+
+def print_use_case(value):
+    # print-used (pylint) -> print (ruff T201)
+    print(value)
+
+
+def except_pass_use_case(value):
+    # except-pass (pylint) -> try-except-pass (ruff S110)
+    try:
+        value = int(value)
+    except ValueError:
+        pass
+    return value
+
+
+def compare_empty_string_use_case(name):
+    # use-implicit-booleaness-not-comparison-to-string (pylint) -> compare-to-empty-string (ruff PLC1901)
+    if name == "":
+        return "empty"
+    return name
+
+
+def ambiguous_variable_use_case(items):
+    # E741 ambiguous variable name (flake8) -> ambiguous-variable-name (ruff E741)
+    total = 0
+    for l in items:  # pylint: disable=invalid-name
+        total += l
+    return total
+
+
+def function_call_default_use_case(when=datetime.datetime.now()):
+    # B008 (flake8-bugbear) -> function-call-in-default-argument (ruff B008)
+    return when
+
+
+def assert_false_use_case():
+    # B011 (flake8-bugbear) -> assert-false (ruff B011)
+    assert False, "assert False use case"
+
+
+def too_complex_use_case(number):
+    # too-complex (pylint mccabe max-complexity=15) -> complex-structure (ruff C901)
+    total = 0
+    if number % 2:
+        total += 2
+    if number % 3:
+        total += 3
+    if number % 5:
+        total += 5
+    if number % 7:
+        total += 7
+    if number % 11:
+        total += 11
+    if number % 13:
+        total += 13
+    if number % 17:
+        total += 17
+    if number % 19:
+        total += 19
+    if number % 23:
+        total += 23
+    if number % 29:
+        total += 29
+    if number % 31:
+        total += 31
+    if number % 37:
+        total += 37
+    if number % 41:
+        total += 41
+    if number % 43:
+        total += 43
+    if number % 47:
+        total += 47
+    if number % 53:
+        total += 53
+    return total

{pre_commit_vauxoo-8.3.0 → pre_commit_vauxoo-8.3.2}/setup.py

@@ -37,7 +37,7 @@ def read(*names, **kwargs):
 
 setup(
     name="pre-commit-vauxoo",
-    version="8.3.0",
+    version="8.3.2",
     license="LGPL-3.0-or-later",
     description="pre-commit script to run automatically the configuration and variables custom from Vauxoo",
     long_description_content_type="text/x-rst",

pre_commit_vauxoo-8.3.2/src/pre_commit_vauxoo/__init__.py

@@ -0,0 +1 @@
+__version__ = "8.3.2"

pre_commit_vauxoo-8.3.0/src/pre_commit_vauxoo/cfg/.bandit-experimental → pre_commit_vauxoo-8.3.2/src/pre_commit_vauxoo/cfg/.bandit-experimental.yml

@@ -1,11 +1,22 @@
-[bandit]
-exclude = tests
+exclude_dirs:
+  - tests
 
 # B608: hardcoded_sql_expressions they are considered from pylint-odoo
 # B313,B314,B315,B316,B317,B318,B319,B405,B406,B407,B408,B409: defusedxml checks
 #   Odoo's team via inbox twitter is not convinced to repair them and the entire Odoo is raising these checks
-# B704: It is already enabled from .bandit-optional
-skips = B608,B313,B314,B315,B316,B317,B318,B319,B405,B406,B407,B408,B409,B704
-format = custom
-msg-template={relpath}:{line}:{col} {msg} - [{test_id}] - ({severity})
-quiet=True
+# B704: It is already enabled from .bandit-optional.yml
+skips:
+  - B608
+  - B313
+  - B314
+  - B315
+  - B316
+  - B317
+  - B318
+  - B319
+  - B405
+  - B406
+  - B407
+  - B408
+  - B409
+  - B704

pre_commit_vauxoo-8.3.2/src/pre_commit_vauxoo/cfg/.bandit-optional.yml

@@ -0,0 +1,15 @@
+exclude_dirs:
+  - tests
+
+# B704:markupsafe_markup_xss more info https://github.com/OCA/pylint-odoo/pull/578
+tests:
+  - B704
+
+# Markup() is required to post HTML in Odoo (mail_thread.message_post() runs
+# escape(body) and keeps it as is only for Markup objects), so the value can not
+# simply be escaped. Wrapping the value with html_sanitize() is the safe way to
+# build it, so it is whitelisted instead of forcing "# nosec" comments.
+markupsafe_xss:
+  allowed_calls:
+    - odoo.tools.html_sanitize
+    - odoo.tools.mail.html_sanitize

pre_commit_vauxoo-8.3.0/src/pre_commit_vauxoo/cfg/.flake8-optional → pre_commit_vauxoo-8.3.2/src/pre_commit_vauxoo/cfg/.flake8-optional.jinja

@@ -1,6 +1,20 @@
 [flake8]
 max-line-length = 119
 jobs = 0
+{% if use_ruff -%}
+# The E,W,F and most of the bugbear (B) checks were migrated to ruff
+# (.config/.ruff.toml for the mandatory ones and .config/.ruff-optional.toml for the optional ones)
+# Only the bugbear checks without a ruff implementation keep running here: B906, B908,
+# B950 (line length with +10% tolerance) and any future bugbear check
+# B = bugbear
+# B9 = bugbear opinionated (incl line length +10% tolerance)
+select = B,B9
+# - B001 is covered by ruff E722 and B902 by ruff N804/N805 (both mandatory .config/.ruff.toml)
+# - B912: map(strict=True) only works in python >= 3.14 (same reason as B905)
+# - B023,B024,B036,B904,B905,B907 were already ignored before the ruff migration (see comments below)
+# - The remaining B0xx/B9xx checks are implemented in ruff (.config/.ruff-optional.toml)
+ignore = B001,B002,B003,B004,B005,B006,B007,B008,B009,B010,B011,B012,B013,B014,B015,B016,B017,B018,B019,B020,B021,B022,B023,B024,B025,B026,B027,B028,B029,B030,B031,B032,B033,B034,B035,B036,B039,B901,B902,B903,B904,B905,B907,B909,B911,B912
+{%- else -%}
 # B = bugbear
 # B9 = bugbear opinionated (incl line length +10% tolerance)
 select = C,E,F,W,B,B9
@@ -23,3 +37,4 @@ ignore = B024,B036,E203,E501,W503,W504,E241,B023,E226,B904,B905,B907,E123,E275
 per-file-ignores =
     __init__.py:F401
     __manifest__.py:B018
+{%- endif %}

pre_commit_vauxoo-8.3.0/src/pre_commit_vauxoo/cfg/.flake8 → pre_commit_vauxoo-8.3.2/src/pre_commit_vauxoo/cfg/.flake8.jinja

@@ -1,4 +1,12 @@
 [flake8]
+{% if use_ruff -%}
+# The pyflakes (F) and most of the pycodestyle (E,W) checks were migrated to ruff (.config/.ruff.toml)
+# Only the continuation-line indentation rules (E12x/E13x) and E704 keep running here
+# since ruff does not implement them https://github.com/astral-sh/ruff/issues/2402
+select = E12,E13,E704
+# E123,E133 keep being ignored (same as before the ruff migration)
+ignore = E123,E133
+{%- else -%}
 # B024: Odoo is not common to use ABC Classes not big deal to ignore it.
 # B036: Don't except `BaseException` unless you plan to re-raise it. (covered by pylint)
 # E123,E133,E226,E241,E242 are ignored by default by pep8 and flake8
@@ -10,7 +18,8 @@
 # E741 do not use variables named ‘l’, ‘O’, or ‘I’
 # chunk = records[index : index + chunk_size]
 ignore = B024,B036,E123,E133,E203,E226,E241,E242,E501,E741,F811,F601,W503,W504
-max-line-length = 119
 per-file-ignores=
     __init__.py:F401
+{%- endif %}
+max-line-length = 119
 jobs = 0

{pre_commit_vauxoo-8.3.0 → pre_commit_vauxoo-8.3.2}/src/pre_commit_vauxoo/cfg/.pre-commit-config-optional.yaml.jinja

@@ -29,7 +29,7 @@ default_language_version:
 repos:
   - repo: https://github.com/OCA/pylint-odoo
 {%- if pylint_matrix_value >= 20 %}
-    rev: v10.0.8
+    rev: v10.0.9
 {%- else %}
     rev: v9.3.24
 {%- endif %}
@@ -39,8 +39,9 @@ repos:
         args:
           - --rcfile=.config/.pylintrc-optional
           - --disable={{ pylint_disable_checks | join(",") if pylint_disable_checks else "R0000" }}
-          # uncomment after fix https://github.com/OCA/pylint-odoo/pull/512
-          # - --jobs=0  # 0 will auto-detect the number of processors available to use
+{%- if pylint_matrix_value >= 20 %}
+          - --jobs=3
+{%- endif %}
   - repo: https://github.com/OCA/odoo-pre-commit-hooks
 {%- if oca_hooks_matrix_value >= 20 %}
     rev: v0.2.24
@@ -66,6 +67,15 @@ repos:
         language: python
         pass_filenames: false
         always_run: true
+{%- if use_ruff %}
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.16.0
+    hooks:
+      - id: ruff-check
+        name: ruff optional checks
+        args:
+          - --config=.config/.ruff-optional.toml
+{%- endif %}
   - repo: https://github.com/PyCQA/flake8
 {%- if flake8_matrix_value >= 20 %}
     rev: 7.3.0
@@ -89,7 +99,12 @@ repos:
         name: bandit optional
         verbose: True
         args:
-          - --ini=.config/.bandit-optional
+          # The YAML format is used instead of the INI one since it is the only
+          # one supporting per-plugin options, e.g. "markupsafe_xss"
+          - --configfile=.config/.bandit-optional.yml
+          - --format=custom
+          - "--msg-template={relpath}:{line}:{col} {msg} - [{test_id}] - ({severity})"
+          - --quiet
         # reduce the INFO logger
         require_serial: true
   - repo: https://github.com/PyCQA/bandit
@@ -100,12 +115,15 @@ repos:
         verbose: True
         args:
           - --exit-zero
-          - --ini=.config/.bandit-experimental
+          - --configfile=.config/.bandit-experimental.yml
+          - --format=custom
+          - "--msg-template={relpath}:{line}:{col} {msg} - [{test_id}] - ({severity})"
+          - --quiet
         # reduce the INFO logger
         require_serial: true
   - repo: https://github.com/OCA/pylint-odoo
 {%- if pylint_matrix_value >= 20 %}
-    rev: v10.0.8
+    rev: v10.0.9
 {%- else %}
     rev: v9.3.24
 {%- endif %}
@@ -116,3 +134,6 @@ repos:
         args:
           - --rcfile=.config/.pylintrc-experimental
           - --exit-zero
+{%- if pylint_matrix_value >= 20 %}
+          - --jobs=3
+{%- endif %}

{pre_commit_vauxoo-8.3.0 → pre_commit_vauxoo-8.3.2}/src/pre_commit_vauxoo/cfg/.pre-commit-config.yaml.jinja

@@ -27,6 +27,15 @@ default_language_version:
   python: python3
   node: "24.13.0"
 repos:
+{%- if use_ruff %}
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.16.0
+    hooks:
+      - id: ruff-check
+        name: ruff mandatory checks
+        args:
+          - --config=.config/.ruff.toml
+{%- endif %}
   - repo: https://github.com/PyCQA/flake8
 {%- if flake8_matrix_value >= 20 %}
     rev: 7.3.0
@@ -40,7 +49,7 @@ repos:
           - --config=.config/.flake8
   - repo: https://github.com/OCA/pylint-odoo
 {%- if pylint_matrix_value >= 20 %}
-    rev: v10.0.8
+    rev: v10.0.9
 {%- else %}
     rev: v9.3.24
 {%- endif %}
@@ -50,8 +59,9 @@ repos:
         args:
           - --rcfile=.config/.pylintrc
           - --disable={{ pylint_disable_checks | join(",") if pylint_disable_checks else "R0000" }}
-          # uncomment after fix https://github.com/OCA/pylint-odoo/pull/512
-          # - --jobs=0  # 0 will auto-detect the number of processors available to use
+{%- if pylint_matrix_value >= 20 %}
+          - --jobs=3
+{%- endif %}
   - repo: https://github.com/pre-commit/mirrors-eslint
     rev: v9.39.1
     hooks:

{pre_commit_vauxoo-8.3.0 → pre_commit_vauxoo-8.3.2}/src/pre_commit_vauxoo/cfg/.pylintrc-optional.jinja

@@ -29,18 +29,12 @@ disable=all,unknown-option-value
 enable=attribute-deprecated,
   attribute-string-redundant,
   bad-builtin-groupby,
-  bad-docstring-quotes,
   consider-merging-classes-inherited,
-  consider-using-generator,
   context-overridden,
   deprecated-method,
   deprecated-odoo-model-method,
   deprecated-pragma,
-  docstring-first-line-empty,
-  eval-used,
-  except-pass,
   external-request-timeout,
-  implicit-str-concat,
   invalid-commit,
   license-allowed,
   manifest-author-string,
@@ -58,12 +52,9 @@ enable=attribute-deprecated,
   missing-return,
   odoo-addons-relative-import,
   odoo-exception-warning,
-  print-used,
-  redundant-u-string-prefix,
   renamed-field-parameter,
   resource-not-exist,
   sql-injection,
-  too-complex,
   translation-contains-variable,
   translation-field,
   translation-required,
@@ -74,13 +65,26 @@ enable=attribute-deprecated,
   translation-too-few-args,
   translation-too-many-args,
   translation-unsupported-format,
-  use-dict-literal,
-  use-implicit-booleaness-not-comparison-to-string,
   use-implicit-booleaness-not-comparison-to-zero,
   use-symbolic-message-instead,
   use-vim-comment,
   useless-parent-delegation,
   website-manifest-key-not-valid-uri
+  {%- if not use_ruff %},
+  # The following checks are migrated to ruff when it is enabled
+  # (see .config/.ruff.toml for eval-used and .config/.ruff-optional.toml for the rest)
+  bad-docstring-quotes,  # ruff D300
+  consider-using-generator,  # ruff C419 with preview (mandatory .ruff.toml)
+  docstring-first-line-empty,  # ruff D212
+  eval-used,  # ruff S307
+  except-pass,  # ruff S110
+  implicit-str-concat,  # ruff ISC001
+  print-used,  # ruff T201
+  redundant-u-string-prefix,  # ruff UP025
+  too-complex,  # ruff C901
+  use-dict-literal,  # ruff C408
+  use-implicit-booleaness-not-comparison-to-string  # ruff PLC1901
+  {%- endif %}
 
 [REPORTS]
 msg-template={path}:{line}:{column}: ({symbol}) {msg}