Giovanni Allegri giohappy

Debugging QGIS 3.x python plugins on Ubuntu 24.04 using VS Code

My setup uses Ubuntu 22.04 running on Windows WSL2, which suppots executing GUI applications.

Setting up VS Code

NOTE: I'm using VS Code Python Debugger extension version v2024.12.0 (ms-python.debugpy), which uses debugpy.

QGIS

In my setup I'm running QGIS built from source, following the official instructions but using the internal libspatialindex (since the one shipped with Ubuntu 26 has the ABI breaking changes introduced after version 2.1, and which QGIS doesn't support. I have also disabled PDAL. The build command is cmake . -B build -DWITH_PDAL=0 -D WITH_INTERNAL_SPATIALINDEX=TRUE My build is under /home/giohappy/dev/qgis/QGIS/build.

A generic version built on top of https://gist.github.com/giohappy/8a30f14678aa7e446f9b694c632d7089

Debugging QGIS 3.x python plugins on Windows 11 using VS Code

Setting up VS Code

NOTE: I'm using VS Code Python Debugger extension version v2024.10.0 (ms-python.debugpy), which uses debugpy.

Start VS Code

For simplicity I start VS Code directly from the plugin folder. We could symlink to avoid polluting the folder with out configurations...

A debugpy version inspired by this gist: https://gist.github.com/NicolaiMogensen/acfd8723720c4761aefef3cdfc2aa55a

Debugging QGIS 3.x python plugins on Windows 11 using VS Code

Setting up VS Code

NOTE: I'm using VS Code Python extension version 2022.20.2, which has PyLance as language server. The most recent versions of the extension use debugpy debugger.

Start VS Code

For simplicity I start VS Code directly from the plugin folder.

tmux cheatsheet

As configured in my dotfiles.

start new:

tmux

start new with session name:

	<!DOCTYPE html>
	<html lang="en">
	<head>
	<meta charset="UTF-8">
	<title>Advanced Physical Modeling Membrane Synthesizer</title>
	<style>
	body {
	background-color: #0b0f19;
	color: #f1f5f9;
	font-family: system-ui, -apple-system, sans-serif;

	import requests
	import json

	REQ_TEMPLATE = '''<?xml version="1.0" encoding="UTF-8"?>
	<GeoServerLayer>
	<enabled>true</enabled>
	<inMemoryCached>true</inMemoryCached>
	<name>{}</name>
	<metaWidthHeight>
	<int>2</int>

	# Install GeoServer on cloud server
	________________

	## 1. Install Java JDK

	apt install openjdk-11-jdk

	You can check the installation using `$ java -version`. Now you can see something like this:

	openjdk version "11.0.7" 2020-04-14

	#source ./export_env_file.sh ./.env
	set -o allexport
	. $1
	set +o allexport

	========================================== ==========================================
	TMUX COMMAND WINDOW (TAB)
	========================================== ==========================================

	List tmux ls List ^b w
	New -s <session> Create ^b c
	Attach att -t <session> Rename ^b , <name>
	Rename rename-session -t <old> <new> Last ^b l (lower-L)
	Kill kill-session -t <session> Close ^b &

	# data test for PostGIS BRIN Indexes
	# a small dataset ( ~400K rows for roads)

	wget http://download.geofabrik.de/europe/france/bretagne-latest.shp.zip
	unzip bretagne-latest.shp.zip

	shp2pgsql -s 4326:2154 -I landuse.shp landuse \| psql -h localhost -p 32770 -U pggis -d pggis
	shp2pgsql -s 4326:2154 -I natural.shp natural \| psql -h localhost -p 32770 -U pggis -d pggis
	shp2pgsql -s 4326:2154 -I places.shp places \| psql -h localhost -p 32770 -U pggis -d pggis
	shp2pgsql -s 4326:2154 -I points.shp points \| psql -h localhost -p 32770 -U pggis -d pggis