[Qgis-developer] automatic sip files generation

[Tim Sutton]

Hi


> On 30 Mar 2017, at 5:02 PM, Denis Rouzaud <denis.rouzaud at gmail.com> wrote:
> 
> 
> 
> Le jeu. 30 mars 2017 à 16:56, Tim Sutton <tim at kartoza.com <mailto:tim at kartoza.com>> a écrit :
> Hi
> 
>> On 30 Mar 2017, at 3:18 PM, Denis Rouzaud <denis.rouzaud at gmail.com <mailto:denis.rouzaud at gmail.com>> wrote:
>> 
>> Dear all,
>> 
>> I'd like to raise the attention on a new workflow I just merged to automatically generate SIP files using the header as source only.
>> 
>> A PR is pending for the documentation, but you can read it here
>> https://github.com/3nids/QGIS-Documentation/blob/6e3a9fb6f98a2869aef27c01b7ab70eb0a4c7556/source/docs/developers_guide/codingstandards.rst#sip-bindings <https://github.com/3nids/QGIS-Documentation/blob/6e3a9fb6f98a2869aef27c01b7ab70eb0a4c7556/source/docs/developers_guide/codingstandards.rst#sip-bindings>
>> (waiting to be merged).
>> 
>> For the moment, only 3 files are generated (qgsattributes, qgsfeature and qgsvectorlayer). One can starts adding new files to the process by adapting their header and removing them from python/auto_sip.blacklist.
> 
> This is really great! A couple of questions:
> 
> 1) the blacklist implies that any new .h files added to the source tree will automatically have sip bindings generated unless you explicitly blacklist them?
> 
> As soon as you add the include in python/core/core.sip (or gui, analysis), the SIP is considered as automatically generated from header except if you blacklist it.
>  
> 2) are you thinking to maintain the sip files in Git still or remove the from revision in favour of having them as build time artifacts only? I ask this because I often direct people to use the sip files as a reference guide for the python API if they want to dig under the hood a bit more.
> 
> The goal is to remove the SIP files and have them created on build time.
> But:
> 1) I except a few errors in the script to arise (so better to have an easy access to the SIP files)
> 2) it needs to reach a significant point of ported headers.
>  
> So, in a somehow close or far future, yes they'll be removed from source (hence no blacklist anymore only manual files such as core/conversions.sip).


Ok thanks for the clarifications!

Regards

Tim


> <KartozaNewLogoThumbnail.jpg>

—










Tim Sutton

Co-founder: Kartoza
Project chair: QGIS.org

Visit http://kartoza.com <http://kartoza.com/> to find out about open source:

Desktop GIS programming services
Geospatial web development
GIS Training
Consulting Services

Skype: timlinux 
IRC: timlinux on #qgis at freenode.net

Kartoza is a merger between Linfiniti and Afrispatial

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-developer/attachments/20170330/ff14eb43/attachment-0001.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: KartozaNewLogoThumbnail.jpg
Type: image/jpeg
Size: 6122 bytes
Desc: not available
URL: <http://lists.osgeo.org/pipermail/qgis-developer/attachments/20170330/ff14eb43/attachment-0001.jpg>