Add sip5/sip6 sip-build support

[manisandro]

No description provided.

[lbartoletti]

Thanks @manisandro

Let us have time to test on our different systems.

[manisandro]

Yes please, testing welcome

[lbartoletti]

@manisandro On FreeBSD, and maybe other unix system, it doesn't build unless the WS_X11 tag is set. I'll send you a patch.

But after the fix, I get this sip error:

auto_generated/raster/qgsrasterinterface.sip:498:13: error: no member named 'sipProtect_initHistogram' in 'QgsRasterInterface'
    sipCpp->sipProtect_initHistogram( *a0, a1, a2, minimum, maximum, *a5, a6, a7 );
    ~~~~~~  ^
1 error generated.

tested with sip 5.5.0 and PyQt 5.15.4

[landryb]

@manisandro On FreeBSD, and maybe other unix system, it doesn't build unless the WS_X11 tag is set. I'll send you a patch.

But after the fix, I get this sip error:

auto_generated/raster/qgsrasterinterface.sip:498:13: error: no member named 'sipProtect_initHistogram' in 'QgsRasterInterface'
    sipCpp->sipProtect_initHistogram( *a0, a1, a2, minimum, maximum, *a5, a6, a7 );
    ~~~~~~  ^
1 error generated.

tested with sip 5.5.0 and PyQt 5.15.4

same thing when testing the PR on OpenBSD (same versions of sip & pyqt), backported on top of 3.20.3. Note that it seems i dont need the WS_X11 thing on OpenBSD.

auto_generated/raster/qgsrasterinterface.sip:498:13: error: no member named 'sipProtect_initHistogram' in 'QgsRasterInterface'                                                                                                                                                    
    sipCpp->sipProtect_initHistogram( *a0, a1, a2, minimum, maximum, *a5, a6, a7 );                                                                                                                                                                                                   ~~~~~~  ^                                                                                                                                                                                                                                                                     1 error generated.  

thanks @manisandro for your work, much appreciated !

[manisandro]

Regarding initHistogram: Can you try playing with the code here [1] and see whether tweaking the #if in some way fixes the issue?

[1]

QGIS/python/core/auto_generated/raster/qgsrasterinterface.sip.in

Line 495 in 708ec53

#if defined(SIP_PROTECTED_IS_PUBLIC) or SIP_VERSION >= 0x060000

[landryb]

Regarding initHistogram: Can you try playing with the code here [1] and see whether tweaking the #if in some way fixes the issue?

[1]

QGIS/python/core/auto_generated/raster/qgsrasterinterface.sip.in

Line 495 in 708ec53

#if defined(SIP_PROTECTED_IS_PUBLIC) or SIP_VERSION >= 0x060000

you mean, should that codepath be used with sip 5.5 when using sip-build ?

[manisandro]

Yes, try SIP_VERSION >= 0x050000

[landryb]

Yes, try SIP_VERSION >= 0x050000

my build isnt finished yet, but with SIP_VERSION >= 0x050500 in build-amd64/python/core/auto_generated/raster/qgsrasterinterface.sip it seems all the python stuff has been built so far.. will confirm in a few. That might mean the #if test should be on using sip-build rather than checking the version ?

edit build succeeded. will test runtime now.

[landryb]

afaict, qgis 3.20.3 built from this PR and the SIP_VERSION check relaxed starts fine on OpenBSD. yay!

[manisandro]

Thanks, commit updated. Checking for sip-build rather than SIP_VERSION should be identical, as sip-build will always be used with SIP 5+ with this PR.

[lbartoletti]

Yes, try SIP_VERSION >= 0x050000

tested & confirmed.

[lbartoletti]

ok FreeBSD@

cc @rhurlin

[rhurlin]

ok FreeBSD@

cc @rhurlin

Hi @lbartoletti,
The patches apply and work fine here on my FreeBSD box with recent QGIS devel (c2243a7).

Thanks for notification and congrats for nomination :)

[nyalldawson]

As with all changes of this nature we're never going to identify any issues upfront. Let's merge and see what build systems break...!

[nyalldawson]

@manisandro @lbartoletti @jef-n
This has broken PyQGIS in fundamental ways -- specifically the new sip-build based method does NOT correct set the old "-g" flag to indicate that methods should release the GIL by default.

That's required by QGIS to avoid deadlocks in threaded code and code which raises exceptions, such as Processing. It's the underlying cause behind #45766 and #45685

We need to fix this ASAP, I cannot overstate how bad this regression is.

[nyalldawson]

Seems like the solution is to set the flag in some pyproject.toml file -- see https://www.riverbankcomputing.com/static/Docs/sip/pyproject_toml.html . But like usual, the sip docs give no clear indication on how to do this or on how pyproject.toml can be used during the build. 😠

[manisandro]

#45829 should address this...

[stoecker]

Will the SIP6 support be backported to 3.22? We have lot's of trouble in openSUSE packaging because of missing SIP6 support...

[manisandro]

It is in master and 3.22

[bnavigator]

Please also add #45829 to 3.22

Sorry for the noise. It's in there. Not familiar enough with your release branch setup.
c47fc8a