[IMP] server: add deprecation warning on odoo.tests.common.Form

Author: fda-odoo

server/core/python_arch_builder_odoo_hooks.py

@@ -48,6 +48,7 @@ def on_file_declaration(symbol):
                         return #TODO should never happen
                     form_var.start_pos = getattr_sym.start_pos
                     form_var.end_pos = getattr_sym.end_pos
+                    form_var.deprecated_reason = "Use odoo.tests.Form instead of odoo.tests.common.Form"
                     symbol.add_symbol(form_var)
 
     @staticmethod

server/core/python_arch_eval_odoo_hooks.py

@@ -130,3 +130,8 @@ def on_form_eval(symbol):
             return
         fileSymbol = symbol.get_in_parents([SymType.FILE])
         symbols = resolve_import_stmt(OdooLanguageServer.get(), fileSymbol, fileSymbol, "form", [ast.alias("Form", "")], 1, symbol.start_pos, symbol.end_pos)
+        _, form_symbol, _ = symbols[0]
+        symbol.eval = Evaluation(
+            symbol = RegisteredRef(form_symbol),
+            instance=True
+        )

server/core/symbol.py

@@ -46,7 +46,7 @@ class Symbol(RegisterableObject):
     __slots__ = ("name", "type", "eval", "ast_node", "value", "symbols", "moduleSymbols",
         "localSymbols",  "dependencies", "dependents", "parent",
         "modelData", "external", "start_pos", "end_pos", "archStatus", "odooStatus", "validationStatus",
-        "not_found_paths", "i_ext", "doc")
+        "not_found_paths", "i_ext", "doc", "deprecated_reason")
 
     def __init__(self, name, type):
         super().__init__()
@@ -112,6 +112,7 @@ def __init__(self, name, type):
         self.odooStatus = 0 #0: not loaded, 1: building, 2: loaded
         self.validationStatus = 0 #0: not validated, 1: in validation, 2: validated
         self.not_found_paths = []
+        self.deprecated_reason: str = None #if not None, the symbol is deprecated and the reason is given
         self.doc = None
 
     def __str__(self):

server/features/validation/python_validator.py

@@ -7,7 +7,7 @@
 from ...python_utils import PythonUtils
 from ...core.file_mgr import FileMgr
 from ...core.import_resolver import resolve_import_stmt
-from lsprotocol.types import (Diagnostic,Position, Range)
+from lsprotocol.types import (Diagnostic,DiagnosticTag,Position, Range)
 
 class ClassContentCacheValidator():
 
@@ -275,6 +275,19 @@ def create_symbol(name, type, lineno):
 
     def validate_structure(self):
         for symbol in self.symStack[0].get_ordered_symbols():
+            if symbol.eval and symbol.eval.get_symbol() and symbol.eval.get_symbol().deprecated_reason: #not follow_ref because we only want to raise on first ref
+                position = (symbol.start_pos, symbol.end_pos)
+                self.diagnostics.append(Diagnostic(
+                    range = Range(
+                        start=Position(line=position[0][0]-1, character=position[0][1]),
+                        end=Position(line=position[0][0]-1, character=1) if sys.version_info < (3, 8) else \
+                            Position(line=position[0][0]-1, character=position[1][0])
+                    ),
+                    message = symbol.eval.get_symbol().name + " is deprecated: " + symbol.eval.get_symbol().deprecated_reason,
+                    source = EXTENSION_NAME,
+                    tags=[DiagnosticTag.Deprecated],
+                    severity = 3
+                ))
             if symbol.type == SymType.CLASS:
                 if symbol.modelData:
                     position = (symbol.start_pos, symbol.end_pos)