Installation

Be sure to have the "pydevd-pycharm" package installed in your Odoo environment. It is recommended to use the version recommended by PyCharm itself when configuring the debug server.

Configuration in Odoo

• Using environment variables:
  • PYCHARM_DEBUG_SERVER_ENABLED: Set to True to enable the debug server. (Default: False)
  • PYCHARM_DEBUG_SERVER_HOST: Set the host to use for the debug server. (Default: localhost)
  • PYCHARM_DEBUG_SERVER_PORT: Set the port to use for the debug server. (Default: 6899)
  • PYCHARM_DEBUG_SERVER_STDOUT: Set to False to avoid redirect the standard output to the debug server. (Default: True)
  • PYCHARM_DEBUG_SERVER_STDERR: Set to False to avoid redirect the standard error to the debug server. (Default: True)
• Using the Odoo configuration file:

                          [options]
                          (...)
                          workers = 2
                          server_wide_modules = web
  
                          (...)
                          [pycharm_debug_server]
                          enabled = True
                          host = host.docker.internal
                          port = 6899
                          stdout = True
                          stderr = True
                      

• Environment variables have priority over the configuration file.
• Confirm the debug is running correctly by checking the logs.

                          ...INFO odoo odoo.addons.pycharm_debug_server.hooks: Initializing PyCharm Debug Server
                      

Configuration in PyCharm

• Go to Run > Edit Configurations.
• Add a new Python Debug Server configuration and set the name, check the Allow multiple instances option, and set the host and port.
• Add path mapping in the Path Mappings. Example in docker including the custom addons path and the Odoo source code.
• Save the changes, check the module is installed in Odoo and configured correctly, start the debug server in PyCharm, and restart the Odoo server. If everything is correct, you should break in the hook and then you can skip to the next breakpoint.
• Enjoy debugging!! 🐞

Common issues

• Initializing log not appearing: Check the enabled option is set to True.
• Connection refused: Check that the configuration is correct, the pydevd_pycharm package is installed, and the debug server is running.
• Mappings not working: Check the path mappings in PyCharm are correct and enter the absolute path.
• Server memory limit (...) reached: Increase the memory limit in the Odoo configuration file.