Merge branch 'OCA:main' into modoolar

Author: agajic-modoolar

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 9.0.6
+current_version = 9.1.2
 commit = True
 tag = True
 sign_tags = True

.github/workflows/test.yml

@@ -8,24 +8,29 @@ on:
   pull_request:
     branches:
       - main
+
+env:
+  CACHE_VERSION: 1
+  PRE_COMMIT_CACHE: ~/.cache/pre-commit
+
 jobs:
   test:
     runs-on: ${{ matrix.os }}
     timeout-minutes: 30
     strategy:
       fail-fast: false
       matrix:
-        python: ['3.8', '3.9', '3.10', '3.11']
+        python: ['3.8', '3.9', '3.10', '3.11', '3.12']
         os: [ubuntu-latest, windows-latest, macos-latest]
         tox_env: [py]
         include:
-          - python: '3.10'
+          - python: '3.12'
             os: ubuntu-latest
             tox_env: 'lint'
-          - python: '3.10'
+          - python: '3.12'
             os: ubuntu-latest
             tox_env: 'update-readme'
-          - python: '3.10'
+          - python: '3.12'
             os: ubuntu-latest
             tox_env: 'build'
     steps:
@@ -35,14 +40,14 @@ jobs:
         git config --global core.autocrlf false
     - name: Cache pre-commit packages
       id: cache-pre-commit
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
-        path: ~/.cache/pre-commit
+        path: ${{ env.PRE_COMMIT_CACHE }}
         key: ${{ runner.os }}-py${{ matrix.python }}-pre-commit
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4.1.2
       with:
         fetch-depth: 0
-    - uses: actions/setup-python@v4
+    - uses: actions/setup-python@v5.0.0
       with:
         python-version: ${{ matrix.python }}
         architecture: 'x64'
@@ -63,7 +68,7 @@ jobs:
     #TODO: Add GITHUB_RUN_ID.GITHUB_RUN_ATTEMPT.GITHUB_RUN_NUMBER to bumpversion to avoid duplicating upload versions or even the git sha
     - name: codecov
       if: startsWith(matrix.tox_env, 'py')  # only coveralls in python tests
-      uses: codecov/codecov-action@v3
+      uses: codecov/codecov-action@v4
       with:
         fail_ci_if_error: false  # TODO: Set true after fix token for win&macosx
         verbose: true

README.md

@@ -1,3 +1,3 @@
-pylint-plugin-utils==0.7
-pylint==3.0.*
-validators==0.22.*
+pylint-plugin-utils==0.8.*
+pylint==3.1.*
+validators==0.24.*

requirements.txt

@@ -1,6 +1,6 @@
 [metadata]
 name = pylint-odoo
-version = 9.0.6
+version = 9.1.2
 author = Odoo Community Association (OCA)
 author_email = [email protected]
 summary = Pylint plugin for Odoo
@@ -22,6 +22,7 @@ classifier =
     Programming Language :: Python :: 3.9
     Programming Language :: Python :: 3.10
     Programming Language :: Python :: 3.11
+    Programming Language :: Python :: 3.12
     Topic :: Software Development :: Debuggers
     Topic :: Software Development :: Quality Assurance
     Topic :: Software Development :: Testing

setup.cfg

@@ -1,3 +1,3 @@
-__version__ = "9.0.6"
+__version__ = "9.1.2"
 
 from .plugin import register

src/pylint_odoo/__init__.py

@@ -204,6 +204,7 @@
     "W8103": ('Translation method _("string") in fields is not necessary.', "translation-field", CHECK_DESCRIPTION),
     "W8105": ('attribute "%s" deprecated', "attribute-deprecated", CHECK_DESCRIPTION),
     "W8106": ('Missing `super` call in "%s" method.', "method-required-super", CHECK_DESCRIPTION),
+    "W8107": ('Prohibited override of "%s" method.', "prohibited-method-override", CHECK_DESCRIPTION),
     "W8110": ("Missing `return` (`super` is used) in method %s.", "missing-return", CHECK_DESCRIPTION),
     "W8111": (
         'Field parameter "%s" is no longer supported. Use "%s" instead.',
@@ -303,6 +304,7 @@
     "unlink",
     "write",
 ]
+DFTL_PROHIBITED_OVERRIDE_METHODS = []
 DFTL_CURSOR_EXPR = [
     "cr",  # old api
     "self._cr",  # new api
@@ -495,6 +497,15 @@ class OdooAddons(OdooBaseChecker, BaseChecker):
                 "help": "List of methods where call to `super` is required.separated by a comma.",
             },
         ),
+        (
+            "prohibited-method-override",
+            {
+                "type": "csv",
+                "metavar": "<comma separated values>",
+                "default": DFTL_PROHIBITED_OVERRIDE_METHODS,
+                "help": "List of methods that have been marked as prohibited to override.",
+            },
+        ),
         (
             "no-missing-return",
             {
@@ -1188,7 +1199,9 @@ def check_deprecated_odoo_method(self, node: NodeNG) -> bool:
 
         return node.name in self._deprecated_odoo_methods
 
-    @utils.only_required_for_messages("method-required-super", "missing-return", "deprecated-odoo-model-method")
+    @utils.only_required_for_messages(
+        "method-required-super", "prohibited-method-override", "missing-return", "deprecated-odoo-model-method"
+    )
     def visit_functiondef(self, node):
         """Check that `api.one` and `api.multi` decorators not exists together
         Check that method `copy` exists `api.one` decorator
@@ -1216,6 +1229,22 @@ def visit_functiondef(self, node):
                 there_is_super = True
                 break
 
+        # Verify if super attributes are prohibited methods to override
+        if there_is_super and self.linter.config.prohibited_method_override or DFTL_PROHIBITED_OVERRIDE_METHODS:
+            for attr in node.nodes_of_class(nodes.Attribute):
+                if attr.attrname != node.name:
+                    continue
+                func = attr.expr.func
+                if (
+                    isinstance(func, nodes.Name)
+                    and func.name == "super"
+                    and (
+                        attr.attrname in self.linter.config.prohibited_method_override
+                        or attr.attrname in DFTL_PROHIBITED_OVERRIDE_METHODS
+                    )
+                ):
+                    self.add_message("prohibited-method-override", node=node, args=(attr.attrname,))
+
         there_is_return = any(node.nodes_of_class(nodes.Return, skip_klass=(nodes.FunctionDef, nodes.ClassDef)))
         if (
             there_is_super

src/pylint_odoo/checkers/odoo_addons.py

@@ -11,3 +11,25 @@ def method1(self, example_var):
     def test_1(self):
         self.partner.message_post(body="Test", subtype="mail.mt_comment")
         self.partner.message_post("Test", subtype="mail.mt_comment")
+
+    def test_base_method_1(self):
+        # Override prohibited, should fail
+        super().test_base_method_1()
+        # No override applied, should not fail
+        super().test_base_method_2()
+        return super().test_base_method_3()
+
+    def test_base_method_2(self):
+        # No override applied, should not fail
+        super(TestModel, self).test_base_method_1()
+        # Override allowed, should not fail
+        super(TestModel, self).test_base_method_2()
+        # No override applied, should not fail
+        return super(TestModel, self).test_base_method_3()
+
+    def test_base_method_3(self):
+        # No override applied, should not fail
+        super(TestModel, self).test_base_method_1()
+        super(TestModel, self).test_base_method_2()
+        # Override prohibited, should fail
+        return super(TestModel, self).test_base_method_3()

testing/resources/test_repo/broken_module/tests/test_model.py

@@ -410,6 +410,20 @@ def test_option_odoo_deprecated_model_method(self):
             pylint_res.linter.stats.by_msg["deprecated-odoo-model-method"],
         )
 
+    def test_175_prohibited_method_override(self):
+        """Test --prohibited_override_methods parameter"""
+        extra_params = [
+            "--disable=all",
+            "--enable=prohibited-method-override",
+            "--prohibited-method-override=test_base_method_1,test_base_method_3",
+        ]
+        pylint_res = self.run_pylint(self.paths_modules, extra_params, verbose=True)
+        real_errors = pylint_res.linter.stats.by_msg
+        expected_errors = {
+            "prohibited-method-override": 2,
+        }
+        self.assertDictEqual(real_errors, expected_errors)
+
     @staticmethod
     def re_replace(sub_start, sub_end, substitution, content):
         re_sub = re.compile(rf"^{re.escape(sub_start)}$.*^{re.escape(sub_end)}$", re.M | re.S)

tests/test_main.py

@@ -7,6 +7,7 @@ envlist =
     py39,
     py310,
     py311,
+    py312
 
 [testenv]
 parallel_show_output=true