multiple instances of odoo_ls each time VIM is opened and correct configuration

[Cerebellum-ITM]

Sorry for opening an issue, but I didn't know how to contact you. I wanted to see if there was a way to initialize the language only if a configuration file is detected, or if it's done via a command. I'm very new to VIM, and this is my first time using a LS. Since every time I open an instance of Vim I see that an instance of the language is generated that quickly ends up using up my server's RAM, having to kill the Odools processes manually every time I exit an instance of Vim.

I'd also like to know the correct way to configure it. I've theoretically configured the addon as described in the readme, but I don't see the code imports disappearing until I export it: export PYTHONPATH=${PYTHONPATH}:/home/odoo_ce_17.

I understood that the purpose of configuring the addon routes was so that the imports would be resolved correctly. But I see that neither the stubs nor the addons work. It's worth noting that I'm working with a Dockerized system, but I understand that as long as I have access to the codebase, the LS should work. Or am I mistaken?

Again, sorry for opening this issue, but I'm very interested in properly configuring my work environment for Odoo.

[fda-odoo]

I will let @Whenrow answer for the Vim part, but I can explain to you how OdooLS is designed regarding your issue.
First, I want to let you know that you are asking this at the right time, as we released yesterday a total refactoring of configuration files in our version 0.8.0 of OdooLS. Be sure to use the 0.8.0 (or rather 0.8.1) build with your plugin. However, Vim plugin has not been yet updated to 0.8.0, so as many changes will come, I would suggest you to wait for this update for Vim.

So: regarding the configurations, you can follow the guide on our wiki: https://github.com/odoo/odoo-ls/wiki/Configuration-files
It will let you create configuration files for you different projects. If you open a project that is not an odoo one and does not have any configuration file, OdooLS will start, but should only consume around 10Mo in memory as it is launched in "not-odoo" mode. This mode make it works like a classical python linter (autocompletion, hover, gotodefinition), but only for on-the-fly python stuff.

The new configuration system allows the usage of profiles, and "default" and "disabled" profiles are always available. Setting your profile to "disabled" will make OdooLS work as explained earlier, in on-the-fly mode.
However, as the Vim plugin doesn't implement yet the new configuration files and profiles, I can't help you on setting up profiles with the 0.8.0 right now.

Let me know if you have any question, I would be happy to help you configure your setup :)

[Cerebellum-ITM]

Thank you for your response. I'll check out the link you sent me and wait for that version for VIM. I really have some questions, whether they're related to using OdooLS or to VIM configuration.

For example, before I discovered OdooLS, it worked like this: I would download the Odoo code and use "stow" to create symbolic links for the Odoo CE, EE, and my custom plugins, then export that path to PTYTHONPATH so I could use the import structure:

from odoo.addons.base.models.res_partner import Partner

With that, VIM now recognizes the functions that the class has, but there are things that are inherited from the base models, for example: the id and pyright give me an attribute error that it does not exist. After some searching, I found OdooLS and thought that using it would prevent me from having to export to PYTHONPATH, but I'm still seeing import errors. I don't know if I have something configured wrong.

Now I'm developing using the technique I used and the OdooLS configuration. I thought the combination of the two would allow me to work. I also saw the stub configuration. I thought using stubs would solve that problem since it detects those attributes. I even managed to create a basic stub to add my own fields or functions, but I don't know how to tell pyright that it's not an error. Or maybe the problem is that I shouldn't use that tool for code review.

Sorry if I'm not clear on this or if it's something too obvious, but I honestly think this is the first time I've worked with LS in VIM. I usually just stuck to basic configurations. Once again, I thank you for taking the time to answer me and if you can help me better understand how I should use OdooLS for my development environment, I would be very grateful.

[fda-odoo]

I'm not a vim user and I don't really know how the plugin implementation works, so I can't really help with the technical questions, but indeed, OdooLS is designed to provide autocompletion, hover definition, gotodefinition and diagnostics features mainly.
So it is designed to check your imports if it is set up correctly, as well as the id variable on models.
Small disclaimer: if you are working on the source of Odoo that is >= 18.1, there is still probably some issues with OdooLS as the orm has been refactored in this version, OdooLS do not include everything yet.

Seeing your way of organizing your filesystem, I would want to precise that OdooLS does NOT support symlink right now. So you have to use complete and valid path in your configuration files. If you think symlink is mandatory in your setup, I would be happy to learn more about it to see if it has some value to implement it in future versions.

Regarding stubs, only typeshed should be needed to work. It should placed next to your OdooLS executable. You don't need to specify any stub to the CLI, except if you want to provide stubs of libraries that are not part of Odoo and typeshed.

[Cerebellum-ITM]

Thank you for taking the time to answer me. I think I confused you a bit with my previous answer, I use the stow part for Pyright (I think it's the part that checks library imports) To ensure that the all the addons folders are located in one path: odoo/addons. But besides that the OdooLS configuration is as follows:

return {
  {
    "whenrow/odoo-ls.nvim",
    dependencies = { "neovim/nvim-lspconfig" },
    config = function()
      local odools = require("odools")
      local h = os.getenv("HOME")
      odools.setup({
        -- mandatory
        odoo_path = h .. "/odoo_base_code/odoo_ce_17",
        python_path = "/usr/bin/python3",

        -- optional
        server_path = h .. "/.local/share/nvim/odoo/odoo_ls_server",
        addons = {
          h .. "/odoo_base_code/odoo_ce_17/addons",
          h .. "/odoo_develop/addons",
        },
        additional_stubs = { h .. "/odoo_develop_data/odoo-stubs", h .. "/odoo_develop_data/custom_studs" },
        root_dir = h .. "/odoo_develop/addons",
        settings = {
          autoRefresh = true,
          autoRefreshDelay = nil,
          diagMissingImportLevel = "none",
        },
      })
    end,
  },
}

Where odoo-stubs is a clone of https://github.com/odoo-ide/odoo-stubs and custom_studs is a recreation of the plugins created for the project I'm working on following the structure: "odoo/addons/custom_addon"

Although I understood that using the Odoo-ide repository is not necessary, right?
One question: When you work with OdooLS in your editor, is OdooLS selected as the only Python reviewer? Does OdooLS also review basic Python content?

If you have any other advice, it would be greatly appreciated, as I'm still looking for the best way to develop for Odoo.

[fda-odoo]

In your configuration, you should not have to specify the path to community addons, except if you move them elsewhere than from the repository.
You don't need any stubs to work with OdooLS. OdooLS is able to parse Odoo code and external code. Stubs are only useful if you don't have that code but still want code completion on it. Actually OdooLS only support stubs of classical python code, not Odoo code. Full code of Odoo is required for OdooLS to work.

If by Odoo-ide you mean https://odoo-ide.com/, no, you don't need it. This is a community project we don't own and have no relation with at all.
On VsCode I continue to use the "Python" extension alongside OdooLS, because it help me manage my python environment and provide some colorization, and nice-to-have features to vscode. But I turn the language server of this extension to None to let OdooLS handle diagnostics and completion features.
Actually OdooLS is less powerful on pure Python code, as we focus actually on implementing Odoo diagnostics, but it should improve in the future. On Python stuff, you can expect syntax validation right now, as well as some basic checks that we need for Odoo (base class validation, things like that)

I hope that OdooLS will be part of the "best way to develop for Odoo", but as we are still in Beta, I can't give you a perfect setup including it right now, as some features are still missing in this project.

[Cerebellum-ITM]

Thank you again for your response. I'm going to check out the integration in VScode to see how it works and better understand how it should behave, but you've really helped me understand how OdooLS works. Of course, it will continue to be part of my development workflow. I just want to understand it and see how to configure it correctly because I was working completely without autocomplete for Odoo, and these days I've really enjoyed that feature.