[Qgis-developer] Console API auto-completion prepared file (.pap)

[Salvatore Larosa]

ok Larry, your last commit works fine only I was wonder might be a problem
to edit the source tree file pyqgis.pap by running the qsci-pap-src target
? just curiosity!

Tonight I'll push the updated API files (GDAL/OGR-1.10.0,QScintilla-2.7.2
and GEOS-3.4.2 ) and will add the GEOS-3.4.2 APIs to the default .pap file.

Thanks for the clarification !




2013/8/31 Larry Shaffer <larrys at dakotacarto.com>

> Hi Salvatore,
>
> On Sat, Aug 31, 2013 at 4:50 AM, Salvatore Larosa <lrssvtml at gmail.com>wrote:
>
>> Hi Larry,
>>
>> 2013/8/31 Larry Shaffer <larrys at dakotacarto.com>
>>
>>> Hi Salvatore,
>>>
>>> On Fri, Aug 30, 2013 at 2:52 PM, Salvatore Larosa <lrssvtml at gmail.com>wrote:
>>>
>>>> Hi Larry,
>>>>
>>>> 2013/8/30 Larry Shaffer <larrys at dakotacarto.com>
>>>>
>>>>> Hi,
>>>>>
>>>> snip --------8<------
>
>>
>>>>> Should GDAL-OGR-1.9.1 be updated to 1.10 for QGIS 2.0 release?
>>>>>
>>>>
>>>> I would like update to the 1.10.0 version and add the GEOS-3.4.2, I
>>>> have prepared those api files so if there are not objections here I could
>>>> push they to master in order to add the new APIs to the pyqgis.pap file.
>>>>
>>>
>>> Sounds good to me. I'm done mucking about with the setup, so please make
>>> the changes you see fit. Looks like the default pyqgis.pap I committed is
>>> missing the new 'qgis.core.NULL' attribute. Must of missed that somehow.
>>> Shows up fine when making qsci-pap-master, though. Please test for its
>>> completion tip in console before uploading another +1 MB .pap file (thanks).
>>>
>>
>> the pyqgis.pap file seems not to have the PyQGIS.api file, I done some
>> adjustment to the cmake file [0] in order to point the generates_api script
>> to the right directory. Please could you verify that it is working for you
>> as well?
>>>
>>>
> The point of the qsci-pap-src target is to update the default pyqgis.pap,
> in the source tree. Once that is updated, then the regular CMakelists.txt
> [0] takes care of installing it. This update could be done every once in a
> while, but should always be done right before a release (i.e. like now).
> The target is not part of ALL, otherwise building would take that much
> longer. So, keeping a fairly recent version of pyqgis.pap updated in the
> source tree is a good idea.
>
> The qsci-pap-master target helps developers when they are testing out new
> bindings and want the console to show them right away. Ideally, once a new
> binding is committed, the qsci-pap-src would be run to update the default
> pyqgis.pap. However, I do not expect this to happen very often; and, it
> seems rather excessive to upload a new pyqgis.pap (> 1MB) so often. It
> should be done a regular basis, though.
>
> It may be possible to just remove the qsci-pap-master target. But, my
> feeling is that if many developers are updating the default pyqgis.pap, it
> will lead to problems with it.
>
> In other words, your edits should not be committed. But, you did find a
> bug.  :^)  Indeed, the PyQGIS.api file was not being picked up when making
> qsci-pap-src. I have adjusted the custom commands and the script. GitHub is
> offline right now for maintenance, but I'll commit it ASAP, along with a
> fixed default pyqgis.pap.
>
> Missing is the QScintilla2 API file, but I think that will just bloat the
>>> default completions with items most users will not need. IMO, we should
>>> keep the default .pap as slim as possible, for the same reasons, i.e. just
>>> core PyQGIS, OSGeo and Python/PyQt modules. That is, until there is
>>> on-the-fly object inspection support, which would auto-filter the results.
>>>
>>
>> ok, we can leave out the QScintilla APIs, but what about to add the
>> updated file (QScintilla-2.7.2) into qsci_apis dir ? or should we drop all
>> the old versions (GDAL-OGR-1.10 will replace GDAL-OGR-1.9.1 and so on) ?
>>
>
> I think the .api files in QGIS source/install should reflect the 'base and
> most likely' versions available on supported platforms. It is common to
> have a much older QScintilla installed, which is why the older 2.4.5 api is
> in there. Since QGIS is working with much newer OSGeo libs (e.g. gdal-1.10)
> in core, I think it would be better to have more up-to-date .api version
> for those.
>
> IMO, the idea here is to ensure new users and plugin developers don't get
> used to using a newer API for something that might not be available for all
> users. However, your custom API loader in console should take care of those
> users who do want to use the latest.
>
>
> Regards,
>
> Larry
>
>
>
>> Thanks,
>>
>> -SL
>>
>> [0] - https://gist.github.com/slarosa/6397516
>>
>>
>>>
>>> Regards,
>>>
>>> Larry
>>>
>>>
>>>
>>>>  I am going to test your cool commit....:-)
>>>>
>>>> Thanks a lot!
>>>>
>>>> Best Regards,
>>>>
>>>> -SL
>>>>
>>>>
>>>>>
>>>>>
>>>>> [0] https://github.com/qgis/Quantum-GIS/commit/dc462859
>>>>>
>>>>> Regards,
>>>>>
>>>>> Larry
>>>>>
>>>>>


-- 
Salvatore Larosa
linkedIn: http://linkedin.com/in/larosasalvatore
twitter: @lrssvt
skype: s.larosa
IRC: lrssvt on freenode
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-developer/attachments/20130831/0e7936c4/attachment-0001.html>