P3: Somewhat important Description
When certain changes to the XML of generated classes are made, these changes are performed internally, but the change is not visible in the generated code comments and, more importantly, not in the generated .pyi files.
Example:
We modify a function from QFile like so:
<object-type name="QFile"> <!-- PYSIDE-1499: Replace QString by pathlib.Path (qfile.h) --> <modify-function signature="QFile(const QString &)" return-type="PyObject*"> <modify-argument index="1"><replace-type modified-type="PyPathLike"/></modify-argument> <inject-code class="target" position="beginning" file="../glue/qtcore.cpp" snippet="qfile-path-1"/> </modify-function>
This has the desired effect to use PyPathLike instead of QString, but we can see the effect of this change nowhere.
As a workaround, we also added the function, giving
<object-type name="QFile"> <!-- PYSIDE-1499: Replace QString by pathlib.Path (qfile.h) --> <modify-function signature="QFile(const QString &)" return-type="PyObject*"> <modify-argument index="1"><replace-type modified-type="PyPathLike"/></modify-argument> <inject-code class="target" position="beginning" file="../glue/qtcore.cpp" snippet="qfile-path-1"/> </modify-function> <add-function signature="QFile(const PyPathLike &@name@)"/>
This has the effect that additionally a new type is added, with the only purpose to show up in the signature, because the functionality is already covered by the modify-function.
It would be very nice to avoid this hackish workaround.
Attachments
| For Gerrit Dashboard: PYSIDE-1588 | ||||||
|---|---|---|---|---|---|---|
| # | Subject | Branch | Project | Status | CR | V |
| 353205,11 | Use replaced types in functions signatures | dev | pyside/pyside-setup | Status: MERGED | +2 | 0 |
| 353450,2 | Use replaced types in functions signatures | 6.1 | pyside/pyside-setup | Status: MERGED | +2 | 0 |
| 353580,3 | shiboken6: Use replaced types in functions signatures in generated code | dev | pyside/pyside-setup | Status: MERGED | +2 | 0 |
| 353668,2 | shiboken6: Use replaced types in functions signatures in generated code | 6.1 | pyside/pyside-setup | Status: MERGED | +2 | 0 |
| 354207,6 | shiboken6: Add a modification for PYI types | dev | pyside/pyside-setup | Status: MERGED | +2 | 0 |
| 355884,1 | shiboken6: Fix "::" in signature strings with replaced types | dev | pyside/pyside-setup | Status: ABANDONED | 0 | 0 |