Relative path to the plugin folder for SVG file in QGIS3 .SLD file

Question

I'm trying to update an old plugin to QGIS3 where we use default svg files (in the plugin folder) as markers. It is important that it is the plugin folder since I just to have the entire plugin in one location.

In QGIS2.18 I could specify the path to the svg marker as: :/PLUGIN_NAME/IMAGE_FOLDER/FILENAME.svg

Update: I use an .sld file to specify the .svg path (and other attributes like name etc.) The <se:OnlineResource xlink:type="simple" xlink:href=":/PLUGIN_NAME/IMAGE_FOLDER/FILENAME.svg"/>

When I try it now in QGIS3 I just gets ? instead of the svg symbol, unless I use absolute paths to the plugin and the image folder :(

Update: I tried to add %AppData%/QGIS/QGIS3/profiles/default/python/plugins in front of PLUGIN_NAME, hence without success.

The .qgs file is used in multiple computers, so I want to specify a relative path in the .sld files to the svg file.

Any suggestions how to write it in QGIS3?

Answer 1

In QGIS2.18 I could specify the path to the svg marker as: :/PLUGIN_NAME/IMAGE_FOLDER/FILENAME.svg

Paths that start with :/ (and qrc:///) are paths to Qt resources. I assume there is a .qrc file which has been compiled/packaged to a resources.py file. The file from QGIS 2 is not compatible with QGIS 3 and you need to recreate the file to be able to continue to use resources (and therefore also paths that start with :/)

Alternatively you can also specify the full path to the svg file (as you post yourself as an answer).

This can also be automated, the following snippet can be used to determine the plugin path:

import os 
plugin_path = os.path.dirname(os.path.realpath(__file__)) # Potentially fix subdirectories

Then check if this path is already configured and add it if missing

svg_paths = QgsSettings().value('svg/searchPathsForSVG')
if plugin_path not in svg_paths:
    QgsSettings().setValue('svg/searchPathsForSVG', svg_paths + [plugin_path])

Answer 2

When you use relative path in SLD file, that path is relative to the current working directory (CWD), not relative to SLD file. If you change CWD into your plugin folder, relative path in SLD file works.

Sample plugin folder structure:

SLD File:

<se:OnlineResource xlink:href="./SVG/FILENAME.SVG" xlink:type="simple"/>

In your plugin file plugin_main.py, add below codes to related lines:

import os
.
os.chdir(os.path.dirname(__file__))
.
layer.loadSldStyle("./Styles.sld")
layer.triggerRepaint()

But If you change CWD into another folder later, you get '?' again.

In my QGIS Python console, os.getcwd() returns 'C:\\OSGEO4~1\\bin' and in this case QGIS searchs a file with relative path within that folder.

Answer 3

Well the solution was to add the folder to the SVG paths

And then use .qml files to store the layer in instead of .sld files and in the .qml file specify the path relative to plugin_folder.

prop v="SVG_folder/SVG_name.svg" k="name"/>

I tried to make it relative to ..QGIS3\profiles\default/svg/ which is added by default, with ../python/plugins/plugin_name/image_folder/svg_name.svg in the .qml file. Which worked locally, hence in the .qgs was the absolute path stored..

Answer 4

Assuming you have IMAGE_FOLDER in your working directory you can do something like this".IMAGE_FOLDER/FILENAME.svg" to specify relative path in python3 or if its present one directory above your working directory you can do "..IMAGE_FOLDER/FILENAME.svg".