Debugging - odoo-ps/pshk-process GitHub Wiki

Debugging

Debugging is a very important skill in order to learn odoo program in depth.

Process of debugging is to understand the flow of program and understanding how your interaction with the software triggers the code that is running in the backend.
Code debugging is separated for python and javascript. For Python, we usually use pudb or vscode's own debugger.

For Javascript, we usually load all assets and use chrome's own debugging tools.

Python VSCode Debugging

Internally, the default python debugger on VSCode is using debugpy.

Before doing debugging, here are some checklists you need to fulfill before starting:

  • Setting up odoo-bin and python virtual environment (refer to Installation)
  • General understanding of using odoo-bin to run locally (w/ terminal)

Follow these steps:

  1. Open your VSCode on the upper level folder. Which means that in your file explorer you should be seeing this sort of structure:
/home/odoo
|__ Github/
	  |__ odoo/ # Odoo Community
	  |__ enterprise/  # Odoo Enterprise
	  |__ envs/  # Virtual environments
	  |__ psbe-ps-tech-tools/ # ps tool
	  |__ support-tools/ # support tool
  1. Find/Open any python file, Go to Debug section on VSCode and create launch.json file. An initial configuration is created, we will create new configurations. Image Image
  2. Inside the configurations list add
        {
            "name": "SMB",
            "type": "python",
            "request": "launch",
            "program": "/home/odoo/Github/odoo/odoo-bin",
            "python": "${workspaceFolder}/envs/v14/bin/python3",
            "args": [
                "--addons-path",
                "${workspaceFolder}/odoo/addons,${workspaceFolder}/enterprise,${workspaceFolder}/design-themes/",
                "-d",
                "smb_test", // database
            ],
            "console": "externalTerminal"
        },
  • name: Name of config
  • program: root file to run program: path to odoo-bin
  • python: which python interpreter to run. Use the one stored on your virtual environment file
  • args: all arguments to be supplied to odoo-bin
  1. Try running Image3
  2. Put breakpoints on the code.Hover of the line number and red circle should appear. VSCode 4
  3. When you run your code, it will stop the line you have chosen as your breakpoint. VSCode 5

Python PUDB

PUDB is a very helpful debugger to put debugging capability in ANY python code. Although the VSCode debugging is powerful and user-friendly, some developments we are going to do may not be able to be covered by it. More example of this will explained later.

  1. Install pudb using your virtual environment
pip3 install pudb
  1. Modify the code. Only do this locally.

Modif 1 Modif 2 Modif 3 Modif 4 Modif 5

  1. Debugging with pudb. If you are in python file, don't forget to import pudb on the beginning of the file. Put breakpoint by inserting:
pudb.set_trace()

Modif 5 Modif 5 which when you run the code will pop open and show the console for debugging. You can learn more about commands on the pudb link

Javascript Debug

You can only debug javascript when it is loaded. I hope you are using chrome to do this.

Install this chrome extension first.

  1. Run odoo-bin first. Double-click to make mode asset debugging Modif 5
  2. Open chrome debug (F12 Key). Go to Sources and find the javascript file using (Ctrl+P) Modif 5
  3. Put breakpoint inside your javascript file. Modif 5