/usr/share/doc/python-sip-doc/html/_sources/incompatibilities.txt is in python-sip-doc 4.15.5-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 | Potential Incompatibilities with Earlier Versions
=================================================
This section describes incompatibilities introduced by particular versions of
SIP. Normally these are the removal of previously deprecated features.
SIP v4.14.4
-----------
Prior to this version, the handwritten code defined by the
:directive:`%VirtualErrorHandler` directive was called without the Python
Global Interpreter Lock (GIL) being held and from an arbitrary thread.
Starting with this version the code is called with the GIL being held and from
the thread that raised the error. In addition the code is provided a value
called ``sipGILState`` that may be passed to :c:func:`SIP_RELEASE_GIL` in order
to release the GIL. This must be done if the code changes the execution path
(e.g. by throwing a C++ exception).
SIP v4.12.3
-----------
Prior to this version, when SIP searches a class hierachy to see if there is a
Python reimplementation of a virtual C++ method, it ignored any objects that
were not Python functions or methods.
Starting with this version such an object is not ignored and will be called.
If it is not callable then a Python exception will be raised. For example,
the following code will now raise an excepton because the ``Mixin.event``
attribute will now be called as it is assumed to be a valid reimplementation of
``QObject.event()``::
class Mixin:
event = False
class MyObject(QObject, Mixin):
pass
SIP v4.12
---------
Prior to this version several directives ignored any enclosing :directive:`%If`
directive. Starting with this version all directives are affected by the
:directive:`%If` directive.
SIP v4.10.1
-----------
Newly Deprecated Features
*************************
The following parts of the :ref:`C API <ref-c-api>` are now deprecated (but
still supported).
- The ``D`` format character of :c:func:`sipParseResult()`.
SIP v4.8
--------
__truediv__
***********
Prior to this version the :meth:`__div__` special method implicitly defined the
:meth:`__truediv__` special method. From this version the :meth:`__truediv__`
special method must be explicitly defined.
sipWrapper user Member
**********************
Prior to this version the :c:type:`sipWrapper` structure had a member called
:c:type:`user` which is available for handwritten code to use. From this
version :c:type:`user` is a member of the :c:type:`sipSimpleWrapper` structure.
:c:type:`sipWrapper` pointers can be safely cast to :c:type:`sipSimpleWrapper`
pointers, so if your code does something like::
((sipWrapper *)obj)->user = an_object_reference;
then you just need to change it to::
((sipSimpleWrapper *)obj)->user = an_object_reference;
Removal of Previously Deprecated Features
*****************************************
The following parts of the :ref:`C API <ref-c-api>` have been removed.
- The ``a``, ``A``, ``M``, ``N``, ``O``, ``P`` and ``T`` format characters
from :c:func:`sipBuildResult()` and :c:func:`sipCallMethod()`.
- The ``a``, ``A``, ``L`` and ``M`` format characters from
:c:func:`sipParseResult()`.
- :c:func:`sipConvertToCpp()`
- :c:func:`sipIsSubClassInstance()`
- :c:func:`sipTransfer()`
- The :func:`transfer` function of the :mod:`sip` module.
- The old-style generated type convertors.
In addition the :option:`-a` command line option to :file:`configure.py` has
been removed.
Removal of PyQt-specific Features
*********************************
The following PyQt-specific support functions have been removed.
- :c:func:`sipConnectRx()`
- :c:func:`sipDisconnectRx()`
- :c:func:`sipEmitSlot()`
- :c:func:`sipGetSender()`
Newly Deprecated Features
*************************
The following parts of the :ref:`C API <ref-c-api>` are now deprecated (but
still supported).
- The :ref:`ref-type-objects`.
- The :ref:`ref-enum-type-objects`.
- :c:func:`sipConvertFromInstance()`
- :c:func:`sipConvertFromMappedType()`
- :c:func:`sipConvertFromNamedEnum()`
- :c:func:`sipConvertFromNewInstance()`
- :c:func:`sipCanConvertToInstance()`
- :c:func:`sipCanConvertToMappedType()`
- :c:func:`sipConvertToInstance()`
- :c:func:`sipConvertToMappedType()`
- :c:func:`sipForceConvertToInstance()`
- :c:func:`sipForceConvertToMappedType()`
- :c:func:`sipClassName()`
- :c:func:`sipFindClass()`
- :c:func:`sipFindNamedEnum()`
- :c:func:`sipFindMappedType()`
- :c:func:`sipGetWrapper()`
- :c:func:`sipReleaseInstance()`
- :c:func:`sipReleaseMappedType()`
- :c:func:`sipWrapper_Check()`
- The ``B``, ``C`` and ``E`` format characters of :c:func:`sipBuildResult()`
and :c:func:`sipCallMethod()`.
- The ``s``, ``C`` and ``E`` format characters of :c:func:`sipParseResult()`.
SIP v4.7.8
----------
Automatic int to Enum Conversions
*********************************
This version allows a Python ``int`` object to be passed whenever an enum is
expected. This can mean that two signatures that were different with prior
versions are now the same as far as Python is concerned.
The :aanno:`Constrained` argument annotation can now be applied to an enum
argument to revert to the earlier behaviour.
SIP v4.7.3
----------
Complementary Comparison Operators
**********************************
Prior to this version SIP did not automatically generate missing complementary
comparison operators. Typically this was worked around by adding them
explicitly to the .sip files, even though they weren't implemented in C++ and
relied on the C++ compiler calling the complementary operator that was
implemented.
A necessary change to the code generator meant that this not longer worked and
so SIP was changed to automatically generate any missing complementary
operators. If you have added such operators explicitly then you should remove
them or make them dependent on the particular version of SIP.
SIP v4.4
--------
%ConvertFromTypeCode and %ConvertToTypeCode
*******************************************
Handwritten :directive:`%ConvertFromTypeCode` and
:directive:`%ConvertToTypeCode` now have the responsibility for implementing
the :aanno:`Transfer` and :aanno:`TransferBack` annotations.
SIP_BUILD
*********
The :c:macro:`SIP_BUILD` C preprocessor symbol has been removed.
Newly Deprecated Features
*************************
The following parts of the :ref:`C API <ref-c-api>` are now deprecated (but
still supported).
- The old-style generated type convertors.
- :c:func:`sipConvertToCpp()`
- :c:func:`sipIsSubClassInstance()`
|