.. _ref-annotations:

Annotations
===========

In this section we describe each of the annotations that can be used in
specification files.

Annotations can either be :ref:`argument annotations <ref-arg-annos>`,
:ref:`class annotations <ref-class-annos>`, :ref:`mapped type annotations
<ref-mapped-type-annos>`, :ref:`enum annotations <ref-enum-annos>`,
:ref:`exception annotations <ref-exception-annos>`, :ref:`function annotations
<ref-function-annos>`, :ref:`typedef annotations <ref-typedef-annos>` or
:ref:`variable annotations <ref-variable-annos>` depending on the context in
which they can be used.

Annotations are placed between forward slashes (``/``).  Multiple annotations
are comma separated within the slashes.

Annotations have a type and, possibly, a value.  The type determines the
format of the value.  The name of an annotation and its value are separated by
``=``.

Annotations can have one of the following types:

*boolean*
    This type of annotation has no value and is implicitly true.

*integer*
    This type of annotation is an integer.  In some cases the value is
    optional.

*name*
    The value is a name that is compatible with a C/C++ identifier.  In some
    cases the value is optional.

*dotted name*
    The value is a name that is compatible with an identifier preceded by a
    Python scope.

*string*
    The value is a double quoted string.  The value is interpreted as a
    sequence of ``;``-separated fields.  Each field may contain a
    ``:``-separated selector:value pair.  The selector is the name of either a
    platform (defined by the :directive:`%Platforms` directive) or a feature
    (defined by the :directive:`%Feature` directive).  If the selector refers
    to the current platform or to an enabled feature then the corresponding
    value is used as the value of the annotation.  The selector may be preceded
    by ``!`` to invert the selection.  The selector of each field is
    evaluated in turn until a value is found to be selected.  ``;`` and ``:``
    may be escaped using a leading ``\\``.  Normally a string annotation is a
    simple string.

The following example shows argument and function annotations::

    void exec(QWidget * /Transfer/) /ReleaseGIL/;


.. _ref-arg-annos:

Argument Annotations
--------------------

.. argument-annotation:: AllowNone

    This boolean annotation specifies that the value of the corresponding
    argument (which should be either :stype:`SIP_PYBUFFER`,
    :stype:`SIP_PYCALLABLE`, :stype:`SIP_PYDICT`, :stype:`SIP_PYLIST`,
    :stype:`SIP_PYSLICE`, :stype:`SIP_PYTUPLE` or :stype:`SIP_PYTYPE`) may be
    ``None``.


.. argument-annotation:: Array

    This boolean annotation specifies that the corresponding argument refers
    to an array.
    
    The argument should be either a pointer to a wrapped type, a ``char *`` or
    a ``unsigned char *``.  If the argument is a character array then the
    annotation also implies the :aanno:`Encoding` annotation with an encoding
    of ``"None"``.

    There must be a corresponding argument with the :aanno:`ArraySize`
    annotation specified.  The annotation may only be specified once in a list
    of arguments.


.. argument-annotation:: ArraySize

    This boolean annotation specifies that the corresponding argument (which
    should be either ``short``, ``unsigned short``, ``int``, ``unsigned``,
    ``long`` or ``unsigned long``) refers to the size of an array.  There must
    be a corresponding argument with the :aanno:`Array` annotation specified.
    The annotation may only be specified once in a list of arguments.


.. argument-annotation:: Constrained

    Python will automatically convert between certain compatible types.  For
    example, if a floating pointer number is expected and an integer supplied,
    then the integer will be converted appropriately.  This can cause problems
    when wrapping C or C++ functions with similar signatures.  For example::

        // The wrapper for this function will also accept an integer argument
        // which Python will automatically convert to a floating point number.
        void foo(double);

        // The wrapper for this function will never get used.
        void foo(int);

    This boolean annotation specifies that the corresponding argument (which
    should be either ``bool``, ``int``, ``float``, ``double``, ``enum`` or a
    wrapped class) must match the type without any automatic conversions.  In
    the context of a wrapped class the invocation of any
    :directive:`%ConvertToTypeCode` is suppressed.

    The following example gets around the above problem::

        // The wrapper for this function will only accept floating point
        // numbers.
        void foo(double /Constrained/);

        // The wrapper for this function will be used for anything that Python
        // can convert to an integer, except for floating point numbers.
        void foo(int);

    Any type hint for the argument will be ignored.


.. argument-annotation:: DisallowNone

    This boolean annotation specifies that the value of the corresponding
    argument (which should be a pointer to either a C++ class or a mapped type)
    must not be ``None``.


.. argument-annotation:: Encoding

    This string annotation specifies that the corresponding argument (which
    should be either ``char``, ``const char``, ``char *`` or ``const char *``)
    refers to an encoded character or ``'\0'`` terminated encoded string with
    the specified encoding.  The encoding can be either ``"ASCII"``,
    ``"Latin-1"``, ``"UTF-8"`` or ``"None"``.  An encoding of ``"None"`` means
    that the corresponding argument refers to an unencoded character or string.

    The default encoding is specified by the :directive:`%DefaultEncoding`
    directive.  If the directive is not specified then ``None`` is used.

    The ``bytes`` type is used to represent the argument if the encoding is
    ``"None"`` and the ``str`` type otherwise.


.. argument-annotation:: GetWrapper

    This boolean annotation is only ever used in conjunction with handwritten
    code specified with the :directive:`%MethodCode` directive.  It causes an
    extra variable to be generated for the corresponding argument which is a
    pointer to the Python object that wraps the argument.

    See the :directive:`%MethodCode` directive for more detail.


.. argument-annotation:: In

    This boolean annotation is used to specify that the corresponding argument
    (which should be a pointer type) is used to pass a value to the function.

    For pointers to wrapped C structures or C++ class instances, ``char *`` and
    ``unsigned char *`` then this annotation is assumed unless the :aanno:`Out`
    annotation is specified.

    For pointers to other types then this annotation must be explicitly
    specified if required.  The argument will be dereferenced to obtain the
    actual value.

    Both :aanno:`In` and :aanno:`Out` may be specified for the same argument.


.. argument-annotation:: KeepReference

    This optional integer annotation is used to specify that a reference to the
    corresponding argument should be kept to ensure that the object is not
    garbage collected.  If the method is called again with a new argument then
    the reference to the previous argument is discarded.  Note that ownership
    of the argument is not changed.

    If the function is a method then the reference is kept by the instance,
    i.e. ``self``.  Therefore the extra reference is released when the instance
    is garbage collected.

    If the function is a class method or an ordinary function and it is
    annotated using the :fanno:`Factory` annotation, then the reference is
    kept by the object created by the function.  Therefore the extra reference
    is released when that object is garbage collected.

    Otherwise the reference is not kept by any specific object and will never
    be released.

    If a value is specified then it defines the argument's key.  Arguments of
    different constructors or methods that have the same key are assumed to
    refer to the same value.


.. argument-annotation:: NoCopy

    This boolean annotation is used with arguments of virtual methods that are
    a ``const`` reference to a class.  Normally, if the class defines a copy
    constructor then a copy of the returned reference is automatically created
    and wrapped before being passed to a Python reimplementation of the method.
    The copy will be owned by Python.  This means that the reimplementation may
    take a reference to the argument without having to make an explicit copy.
    
    If the annotation is specified then the copy is not made and the original
    reference is wrapped instead and will be owned by C++.


.. argument-annotation:: Out

    This boolean annotation is used to specify that the corresponding argument
    (which should be a pointer type) is used by the function to return a value
    as an element of a tuple.

    For pointers to wrapped C structures or C++ class instances, ``char *`` and
    ``unsigned char *`` then this annotation must be explicitly specified if
    required.

    For pointers to other types then this annotation is assumed unless the
    :aanno:`In` annotation is specified.

    Both :aanno:`In` and :aanno:`Out` may be specified for the same argument.


.. argument-annotation:: PyInt

    This boolean annotation is used with ``char``, ``signed char`` and
    ``unsigned char`` arguments to specify that they should be interpreted as
    integers rather than strings of one character.


.. argument-annotation:: ResultSize

    This boolean annotation is used with functions or methods that return a
    ``void *`` or ``const void *``.  It identifies an argument that defines the
    size of the block of memory whose address is being returned.  This allows
    the :class:`sip.voidptr` object that wraps the address to support the
    Python buffer protocol.


.. argument-annotation:: ScopesStripped

    This integer annotation is only used with Qt signal arguments.  Normally
    the fully scoped type of the argument is used but this annotation specifies
    that the given number of scopes should be removed.


.. argument-annotation:: Transfer

    This boolean annotation is used to specify that ownership of the
    corresponding argument (which should be a wrapped C structure or C++ class
    instance) is transferred from Python to C++.  In addition, if the argument
    is of a class method, then it is associated with the class instance with
    regard to the cyclic garbage collector.

    If the annotation is used with the :aanno:`Array` annotation then the
    array of pointers to the sequence of C structures or C++ class instances
    that is created on the heap is not automatically freed.

    See :ref:`ref-object-ownership` for more detail.


.. argument-annotation:: TransferBack

    This boolean annotation is used to specify that ownership of the
    corresponding argument (which should be a wrapped C structure or C++ class
    instance) is transferred back to Python from C++.  In addition, any
    association of the argument with regard to the cyclic garbage collector
    with another instance is removed.

    See :ref:`ref-object-ownership` for more detail.


.. argument-annotation:: TransferThis

    This boolean annotation is only used in C++ constructors or methods.  In
    the context of a constructor or factory method it specifies that ownership
    of the instance being created is transferred from Python to C++ if the
    corresponding argument (which should be a wrapped C structure or C++ class
    instance) is not ``None``.  In addition, the newly created instance is
    associated with the argument with regard to the cyclic garbage collector.

    In the context of a non-factory method it specifies that ownership of
    ``this`` is transferred from Python to C++ if the corresponding argument is
    not ``None``.  If it is ``None`` then ownership is transferred to Python.

    The annotation may be used more that once, in which case ownership is
    transferred to last instance that is not ``None``.

    See :ref:`ref-object-ownership` for more detail.


.. argument-annotation:: TypeHint

    This string annotation specifies the type of the argument as it will appear
    in any generated docstrings and PEP 484 type hints.  It is the equivalent
    of specifying :aanno:`TypeHintIn` and :aanno:`TypeHintOut` with the same
    value.  It is usually used with arguments of type :stype:`SIP_PYOBJECT` to
    provide a more specific type.


.. argument-annotation:: TypeHintIn

    This string annotation specifies the type of the argument as it will appear
    in any generated docstrings and PEP 484 type hints when the argument is
    used to pass a value to a function (rather than being used to return a
    value from a function).  It is usually used with arguments of type
    :stype:`SIP_PYOBJECT` to provide a more specific type.


.. argument-annotation:: TypeHintOut

    This string annotation specifies the type of the argument as it will appear
    in any generated docstrings and PEP 484 type hints when the argument is
    used to return a value from a function (rather than being used to pass a
    value to a function).  It is usually used with arguments of type
    :stype:`SIP_PYOBJECT` to provide a more specific type.


.. argument-annotation:: TypeHintValue

    This string annotation specifies the default value of the argument as it
    will appear in any generated docstrings.


.. _ref-class-annos:

Class Annotations
-----------------

.. class-annotation:: Abstract

    This boolean annotation is used to specify that the class has additional
    pure virtual methods that have not been specified and so it cannot be
    instantiated or sub-classed from Python.  It should not be specified if all
    pure virtual methods have been specified.


.. class-annotation:: AllowNone

    Normally when a Python object is converted to a C/C++ instance ``None``
    is handled automatically before the class's
    :directive:`%ConvertToTypeCode` is called.  This boolean annotation
    specifies that the handling of ``None`` will be left to the
    :directive:`%ConvertToTypeCode`.  The annotation is ignored if the class
    does not have any :directive:`%ConvertToTypeCode`.


.. class-annotation:: DelayDtor

    This boolean annotation is used to specify that the class's destructor
    should not be called until the Python interpreter exits.  It would normally
    only be applied to singleton classes.

    When the Python interpreter exits the order in which any wrapped instances
    are garbage collected is unpredictable.  However, the underlying C or C++
    instances may need to be destroyed in a certain order.  If this annotation
    is specified then when the wrapped instance is garbage collected the C or
    C++ instance is not destroyed but instead added to a list of delayed
    instances.  When the interpreter exits then the function
    :c:func:`sipDelayedDtors()` is called with the list of delayed instances.
    :c:func:`sipDelayedDtors()` can then choose to call (or ignore) the
    destructors in any desired order.

    The :c:func:`sipDelayedDtors()` function must be specified using the
    :directive:`%ModuleCode` directive.

.. c:function:: void sipDelayedDtors(const sipDelayedDtor *dd_list)

    :param dd_list:
        the linked list of delayed instances.

.. c:type:: sipDelayedDtor

    This structure describes a particular delayed destructor.

    .. c:member:: const char* dd_name

        This is the name of the class excluding any package or module name.

    .. c:member:: void* dd_ptr

        This is the address of the C or C++ instance to be destroyed.  It's
        exact type depends on the value of :c:member:`dd_isderived`.

    .. c:member:: int dd_isderived

        This is non-zero if the type of :c:member:`dd_ptr` is actually the
        generated derived class.  This allows the correct destructor to be
        called.  See :ref:`ref-derived-classes`.

    .. c:member:: sipDelayedDtor* dd_next

        This is the address of the next entry in the list or zero if this is
        the last one.

    Note that the above applies only to C and C++ instances that are owned by
    Python.


.. class-annotation:: Deprecated

    This optional string annotation is used to specify that the class is
    deprecated.  Any string is appended to the deprecation warning and is
    usually used to suggest an appropriate alternative.  It is the equivalent
    of annotating all the class's constructors, function and methods as being
    deprecated.

    .. versionchanged:: 6.10

        If the target ABI does not support the optional string value then the
        value is ignored.  In earlier versions an error was raised.


.. class-annotation:: FileExtension

    This string annotation is used to specify the filename extension to be used
    for the file containing the generated code for this class.


.. class-annotation:: ExportDerived

    In many cases SIP generates a derived class for each class being wrapped
    (see :ref:`ref-derived-classes`).  Normally this is used internally.  This
    boolean annotation specifies that the declaration of the class is exported
    and able to be used by handwritten code of any module.


.. class-annotation:: ExportDerivedLocally

    .. versionadded:: 6.13

    This boolean annotation is similar to the :canno:`ExportDerived` class
    annotation except that the declaration of the derived class is only
    exported to handwritten code in the same module that the class is defined.


.. class-annotation:: External

    This boolean annotation is used to specify that the class is defined in
    another module.  Declarations of external classes are private to the module
    in which they appear.


.. class-annotation:: Metatype

    This dotted name annotation specifies the name of the Python type object
    (i.e. the value of the ``tp_name`` field) used as the meta-type used when
    creating the type object for this C structure or C++ type.

    See the section :ref:`ref-types-metatypes` for more details.


.. class-annotation:: Mixin

    This boolean annotation specifies that the class can be used as a mixin
    with other wrapped classes.
    
    Normally a Python application cannot define a new class that is derived
    from more than one wrapped class.  In C++ this would create a new C++
    class.  This cannot be done from Python.  At best a C++ instance of each of
    the wrapped classes can be created and wrapped as separate Python objects.
    However some C++ classes may function perfectly well with this restriction.
    Such classes are often intended to be used as mixins.

    If this annotation is specified then a separate instance of the class is
    created.  The main instance automatically delegates to the instance of the
    mixin when required.  A mixin class should have the following
    characteristics:

    - Any constructor arguments should be able to be specified using keyword
      arguments.

    - The class should not have any virtual methods.


.. class-annotation:: NoDefaultCtors

    This boolean annotation is used to suppress the automatic generation of
    default constructors for the class.


.. class-annotation:: NoTypeHint

    This boolean annotation is used to suppress the generation of the PEP 484
    type hint for the class and its contents.


.. class-annotation:: PyName

    This name annotation specifies an alternative name for the class being
    wrapped which is used when it is referred to from Python.

    .. seealso:: :directive:`%AutoPyName`


.. class-annotation:: Supertype

    This dotted name annotation specifies the name of the Python type object
    (i.e. the value of the ``tp_name`` field) used as the super-type used when
    creating the type object for this C structure or C++ type.

    See the section :ref:`ref-types-metatypes` for more details.


.. class-annotation:: TypeHint

    This string annotation specifies the type of the class as it will appear
    in any generated docstrings and PEP 484 type hints.  It is the equivalent
    of specifying :canno:`TypeHintIn` and :canno:`TypeHintOut` with the same
    value.


.. class-annotation:: TypeHintIn

    This string annotation specifies the type of the class as it will appear
    in any generated docstrings and PEP 484 type hints when an instance of the
    class is passed as an argument to a function (rather than being returned
    from a function).  It is usually used with classes that implement
    :directive:`%ConvertToTypeCode` to allow additional types to be used
    whenever an instance of the class is expected.


.. class-annotation:: TypeHintOut

    This string annotation specifies the type of the class as it will appear
    in any generated docstrings and PEP 484 type hints when an instance of the
    class is returned from a function (rather than being used to pass a
    value to a function).


.. class-annotation:: TypeHintValue

    This string annotation specifies the default value of the class as it will
    appear in any generated docstrings.


.. class-annotation:: VirtualErrorHandler

    This name annotation specifies the handler (defined by the
    :directive:`%VirtualErrorHandler` directive) that is called when a Python
    re-implementation of any of the class's virtual C++ functions raises a
    Python exception.  If not specified then the handler specified by the
    ``default_VirtualErrorHandler`` argument of the :directive:`%Module`
    directive is used.

    .. seealso:: :fanno:`NoVirtualErrorHandler`, :fanno:`VirtualErrorHandler`, :directive:`%VirtualErrorHandler`


.. _ref-mapped-type-annos:

Mapped Type Annotations
-----------------------

.. mapped-type-annotation:: AllowNone

    Normally when a Python object is converted to a C/C++ instance ``None``
    is handled automatically before the mapped type's
    :directive:`%ConvertToTypeCode` is called.  This boolean annotation
    specifies that the handling of ``None`` will be left to the
    :directive:`%ConvertToTypeCode`.

.. mapped-type-annotation:: Movable

    .. versionadded:: 6.11

    If a C++ instance is passed by value as an argument to a function then the
    class's assignment operator is normally used under the covers.  If the
    class's assignment operator has been deleted then the generated code will
    not compile.  This annotation says that the C++ instances of this type
    should be moved instead, ie. the argument should be wrapped in a called to
    `std::move()`.  Because the C++ instance is unusable after being passed to
    `std::move()`, SIP automatically transfers ownership of the instance to C++
    so that Python doesn't try to call its destructor.

    .. note::
        SIP does not automatically generate the declaration of `std::move()`
        so the :directive:`%TypeHeaderCode` for the mapped type should include
        `#include <utility>`.


.. mapped-type-annotation:: NoAssignmentOperator

    This boolean annotation is used to specify that the C++ type does not have
    a public assignment operator.


.. mapped-type-annotation:: NoCopyCtor

    This boolean annotation is used to specify that the C++ type does not have
    a public copy constructor.


.. mapped-type-annotation:: NoDefaultCtor

    This boolean annotation is used to specify that the C++ type does not have
    a public default constructor.


.. mapped-type-annotation:: NoRelease

    This boolean annotation is used to specify that the mapped type does not
    support the :c:func:`sipReleaseType()` function.  Any
    :directive:`%ConvertToTypeCode` should not create temporary instances of
    the mapped type, i.e. it should not return :c:macro:`SIP_TEMPORARY`.


.. mapped-type-annotation:: PyName

    This name annotation specifies an alternative name for the mapped type
    being wrapped which is used when it is referred to from Python.  The only
    time a Python type is created for a mapped type is when it is used as a
    scope for static methods or enums.
    
    It should not be used with mapped type templates.

    .. seealso:: :directive:`%AutoPyName`


.. mapped-type-annotation:: TypeHint

    This string annotation specifies the type of the mapped type as it will
    appear in any generated docstrings and PEP 484 type hints.  It is the
    equivalent of specifying :manno:`TypeHintIn` and :manno:`TypeHintOut` with
    the same value.


.. mapped-type-annotation:: TypeHintIn

    This string annotation specifies the type of the mapped type as it will
    appear in any generated docstrings and PEP 484 type hints when it is passed
    to a function (rather than being returned from a function).


.. mapped-type-annotation:: TypeHintOut

    This string annotation specifies the type of the mapped type as it will
    appear in any generated docstrings and PEP 484 type hints when it is
    returned from a function (rather than being passed to a function).

.. mapped-type-annotation:: TypeHintValue

    This string annotation specifies the default value of the mapped type as it
    will appear in any generated docstrings.


.. _ref-enum-annos:

Enum Annotations
----------------

.. enum-annotation:: BaseType

    This name annotation specifies the type from the :mod:`enum` module
    that will be used as the base type of the enum.  The possible values are
    ``Enum`` (corresponding to :class:`~enum.Enum`), ``Flag`` (corresponding to
    :class:`~enum.Flag`), ``IntEnum`` (corresponding to
    :class:`~enum.IntEnum`), ``UIntEnum`` (also corresponding to
    :class:`~enum.IntEnum` but with unsigned members) and ``IntFlag``
    (corresponding to :class:`~enum.IntFlag`).  The default value is ``Enum``.
    The members of ``Flag`` and ``IntFlag`` enums are implicitly unsigned.

    This annotation is only available when ABI v13 or later is specified.

.. enum-annotation:: NoScope

    This boolean annotation specifies the that scope of an enum's members
    should be omitted in the generated code.  Normally this would mean that the
    generated code will not compile.  However it is useful when defining
    pseudo-enums, for example, to wrap global values so that they are defined
    (in Python) within the scope of a class.


.. enum-annotation:: NoTypeHint

    This boolean annotation is used to suppress the generation of the PEP 484
    type hint for the enum or enum member.


.. enum-annotation:: PyName

    This name annotation specifies an alternative name for the enum or enum
    member being wrapped which is used when it is referred to from Python.

    .. seealso:: :directive:`%AutoPyName`


.. _ref-exception-annos:

Exception Annotations
---------------------

.. exception-annotation:: Default

    This boolean annotation specifies that the exception being defined will be
    used as the default exception to be caught if a function or constructor
    does not have a ``throw`` clause.

    This annotaion is ignored when using ABI v13.1 or later and v12.9 or later.

.. exception-annotation:: PyName

    This name annotation specifies an alternative name for the exception being
    defined which is used when it is referred to from Python.

    .. seealso:: :directive:`%AutoPyName`


.. _ref-function-annos:

Function Annotations
--------------------

.. function-annotation:: AbortOnException

    This boolean annotation specifies that when a Python re-implementation of a
    virtual C++ function raises a Python exception then ``abort()`` is
    called after the error handler returns.


.. function-annotation:: AllowNone

    This boolean annotation is used to specify that the value returned by the
    function (which should be either :stype:`SIP_PYBUFFER`,
    :stype:`SIP_PYCALLABLE`, :stype:`SIP_PYDICT`, :stype:`SIP_PYLIST`,
    :stype:`SIP_PYSLICE`, :stype:`SIP_PYTUPLE` or :stype:`SIP_PYTYPE`) may be
    ``None``.


.. function-annotation:: AutoGen

    This optional name annotation is used with class methods to specify that
    the method be automatically included in all sub-classes.  The value is the
    name of a feature (specified using the :directive:`%Feature` directive)
    which must be enabled for the method to be generated.


.. function-annotation:: Default

    This boolean annotation is only used with C++ constructors.  Sometimes SIP
    needs to create a class instance.  By default it uses a constructor with no
    compulsory arguments if one is specified.  (SIP will automatically generate
    a constructor with no arguments if no constructors are specified.)  This
    annotation is used to explicitly specify which constructor to use.  Zero is
    passed as the value of any arguments to the constructor.  This annotation
    is ignored if the class defines :directive:`%InstanceCode`.


.. function-annotation:: Deprecated

    This optional string annotation is used to specify that the constructor or
    function is deprecated.  Any string is appended to the deprecation warning
    and is usually used to suggest an appropriate alternative.

    .. versionchanged:: 6.10

        If the target ABI does not support the optional string value then the
        value is ignored.  In earlier versions an error was raised.


.. function-annotation:: DisallowNone

    This boolean annotation is used to specify that the value returned by the
    function (which should be a pointer to either a C++ class or a mapped type)
    must not be ``None``.


.. function-annotation:: Encoding

    This string annotation serves the same purpose as the :aanno:`Encoding`
    argument annotation when applied to the type of the value returned by the
    function.


.. function-annotation:: Factory

    This boolean annotation specifies that the value returned by the function
    (which should be a wrapped C structure or C++ class instance) is a newly
    created instance and is owned by Python.

    See :ref:`ref-object-ownership` for more detail.


.. function-annotation:: HoldGIL

    This boolean annotation specifies that the Python Global Interpreter Lock
    (GIL) is not released before the call to the underlying C or C++ function.
    See :ref:`ref-gil` and the :fanno:`ReleaseGIL` annotation.


.. function-annotation:: __imatmul__

    This boolean annotation specifies that a ``__imatmul__()`` method should be
    automatically generated that will use the method being annotated to compute
    the value that the ``__imatmul__()`` method will return.


.. function-annotation:: KeepReference

    This optional integer annotation serves the same purpose as the
    :aanno:`KeepReference` argument annotation when applied to the type of the
    value returned by the function.

    If the function is a class method or an ordinary function then the
    reference is not kept by any other object and so the returned value will
    never be garbage collected.


.. function-annotation:: KeywordArgs

    This string annotation specifies the level of support the argument parser
    generated for this function will provide for passing the parameters using
    Python's keyword argument syntax.  The value of the annotation can be
    either ``"None"`` meaning that keyword arguments are not supported,
    ``"All"`` meaning that all named arguments can be passed as keyword
    arguments, or ``"Optional"`` meaning that all named optional arguments
    (i.e. those with a default value) can be passed as keyword arguments.

    If the annotation is not used then the value specified by the
    ``keyword_arguments`` argument of the :directive:`%Module` directive is
    used.

    Keyword arguments cannot be used for functions that use an ellipsis to
    designate that the function has a variable number of arguments.


.. function-annotation:: __len__

    This boolean annotation specifies that a ``__len__()`` method should be
    automatically generated that will use the method being annotated to compute
    the value that the ``__len__()`` method will return.

    If the class has a ``__getitem__()`` method or an ``operator[]`` operator
    with an integer argument then those will raise an ``IndexError`` exception
    if the argument is out of range.  This means that the class will
    automatically support being iterated over.


.. function-annotation:: __matmul__

    This boolean annotation specifies that a ``__matmul__()`` method should be
    automatically generated that will use the method being annotated to compute
    the value that the ``__matmul__()`` method will return.


.. function-annotation:: NewThread

    This boolean annotation specifies that the function (which must be a
    virtual) will be executed in a new thread.


.. function-annotation:: NoArgParser

    This boolean annotation is used with methods and global functions to
    specify that the supplied :directive:`%MethodCode` will handle the parsing
    of the arguments.


.. function-annotation:: NoCopy

    This boolean annotation is used with methods and global functions that
    return a ``const`` reference to a class.  Normally, if the class defines a
    copy constructor then a copy of the returned reference is automatically
    created and wrapped.  The copy will be owned by Python.
    
    If the annotation is specified then the copy is not made and the original
    reference is wrapped instead and will be owned by C++.


.. function-annotation:: NoDerived

    This boolean annotation is only used with C++ constructors.  In many cases
    SIP generates a derived class for each class being wrapped (see
    :ref:`ref-derived-classes`).  This derived class contains constructors with
    the same C++ signatures as the class being wrapped.  Sometimes you may want
    to define a Python constructor that has no corresponding C++ constructor.
    This annotation is used to suppress the generation of the constructor in
    the derived class.


.. function-annotation:: NoRaisesPyException

    This boolean annotation specifies that the function or constructor does not
    raise a Python exception to indicate that an error occurred.

    .. seealso:: :fanno:`RaisesPyException`


.. function-annotation:: NoTypeHint

    This boolean annotation is used to suppress the generation of the PEP 484
    type hint for the function or constructor.


.. function-annotation:: NoVirtualErrorHandler

    This boolean annotation specifies that when a Python re-implementation of a
    virtual C++ function raises a Python exception then ``PyErr_Print()`` is
    always called.  Any error handler specified by either the
    :fanno:`VirtualErrorHandler` function annotation, the
    :canno:`VirtualErrorHandler` class annotation or the
    ``default_VirtualErrorHandler`` argument of the :directive:`%Module`
    directive is ignored.

    .. seealso:: :fanno:`VirtualErrorHandler`, :canno:`VirtualErrorHandler`, :directive:`%VirtualErrorHandler`


.. function-annotation:: Numeric

    This boolean annotation specifies that the operator should be interpreted
    as a numeric operator rather than a sequence operator.
    
    Python uses the ``+`` operator for adding numbers and concatanating
    sequences, and the ``*`` operator for multiplying numbers and repeating
    sequences.  Unless this or the :fanno:`Sequence` annotation is specified,
    SIP tries to work out which is meant by looking at other operators that
    have been defined for the type.  If it finds either ``-``, ``-=``, ``/``,
    ``/=``, ``%`` or ``%=`` defined then it assumes that ``+``, ``+=``, ``*``
    and ``*=`` should be numeric operators.  Otherwise, if it finds either
    ``[]``, :meth:`__getitem__`, :meth:`__setitem__` or :meth:`__delitem__`
    defined then it assumes that they should be sequence operators.


.. function-annotation:: PostHook

    This name annotation is used to specify the name of a Python builtin that
    is called immediately after the call to the underlying C or C++ function or
    any handwritten code.  The builtin is not called if an error occurred.  It
    is primarily used to integrate with debuggers.


.. function-annotation:: PreHook

    This name annotation is used to specify the name of a Python builtin that
    is called immediately after the function's arguments have been successfully
    parsed and before the call to the underlying C or C++ function or any
    handwritten code.  It is primarily used to integrate with debuggers.


.. function-annotation:: PyName

    This name annotation specifies an alternative name for the function being
    wrapped which is used when it is referred to from Python.

    .. seealso:: :directive:`%AutoPyName`


.. function-annotation:: PyInt

    This boolean annotation serves the same purpose as the :aanno:`PyInt`
    argument annotation when applied to the type of the value returned by the
    function.


.. function-annotation:: RaisesPyException

    This boolean annotation specifies that the function or constructor raises a
    Python exception to indicate that an error occurred.  Any current exception
    is cleared before the function or constructor is called.  It is ignored if
    the :directive:`%MethodCode` directive is used.

    .. seealso:: :fanno:`NoRaisesPyException`


.. function-annotation:: ReleaseGIL

    This boolean annotation specifies that the Python Global Interpreter Lock
    (GIL) is released before the call to the underlying C or C++ function and
    reacquired afterwards.  It should be used for functions that might block or
    take a significant amount of time to execute.  See :ref:`ref-gil` and the
    :fanno:`HoldGIL` annotation.


.. function-annotation:: Sequence

    This boolean annotation specifies that the operator should be interpreted
    as a sequence operator rather than a numeric operator.

    Python uses the ``+`` operator for adding numbers and concatanating
    sequences, and the ``*`` operator for multiplying numbers and repeating
    sequences.  Unless this or the :fanno:`Numeric` annotation is specified,
    SIP tries to work out which is meant by looking at other operators that
    have been defined for the type.  If it finds either ``-``, ``-=``, ``/``,
    ``/=``, ``%`` or ``%=`` defined then it assumes that ``+``, ``+=``, ``*``
    and ``*=`` should be numeric operators.  Otherwise, if it finds either
    ``[]``, :meth:`__getitem__`, :meth:`__setitem__` or :meth:`__delitem__`
    defined then it assumes that they should be sequence operators.


.. function-annotation:: Transfer

    This boolean annotation specifies that ownership of the value returned by
    the function (which should be a wrapped C structure or C++ class instance)
    is transferred to C++.  It is only used in the context of a class
    constructor or a method.

    In the case of methods returned values (unless they are new references to
    already wrapped values) are normally owned by C++ anyway.  However, in
    addition, an association between the returned value and the instance
    containing the method is created with regard to the cyclic garbage
    collector.

    See :ref:`ref-object-ownership` for more detail.


.. function-annotation:: TransferBack

    This boolean annotation specifies that ownership of the value returned by
    the function (which should be a wrapped C structure or C++ class instance)
    is transferred back to Python from C++.  Normally returned values (unless
    they are new references to already wrapped values) are owned by C++.  In
    addition, any association of the returned value with regard to the cyclic
    garbage collector with another instance is removed.

    See :ref:`ref-object-ownership` for more detail.


.. function-annotation:: TransferThis

    This boolean annotation specifies that ownership of ``this`` is transferred
    from Python to C++.

    See :ref:`ref-object-ownership` for more detail.


.. function-annotation:: TypeHint

    This string annotation specifies the type of the value returned by the
    function as it will appear in any generated docstrings and PEP 484 type
    hints.  It is usually used with results of type :stype:`SIP_PYOBJECT` to
    provide a more specific type.


.. function-annotation:: VirtualErrorHandler

    This name annotation specifies the handler (defined by the
    :directive:`%VirtualErrorHandler` directive) that is called when a Python
    re-implementation of the virtual C++ function raises a Python exception.
    If not specified then the handler specified by the class's
    :canno:`VirtualErrorHandler` is used.

    .. seealso:: :fanno:`NoVirtualErrorHandler`, :canno:`VirtualErrorHandler`, :directive:`%VirtualErrorHandler`


.. _ref-typedef-annos:

Typedef Annotations
-------------------

.. typedef-annotation:: Capsule

    This boolean annotation may only be used when the base type is ``void *``
    and specifies that a Python capsule object is used to wrap the value rather
    than a :class:`sip.voidptr`.  The advantage of using a capsule is that name
    based type checking is performed using the name of the type being defined.

    For versions of Python that do not support capules :class:`sip.voidptr` is
    used instead and name based type checking is not performed.


.. typedef-annotation:: Encoding

    This string annotation serves the same purpose as the :aanno:`Encoding`
    argument annotation when applied to the mapped type being defined.


.. typedef-annotation:: NoTypeName

    This boolean annotation specifies that the definition of the type rather
    than the name of the type being defined should be used in the generated
    code.

    Normally a typedef would be defined as follows::

        typedef bool MyBool;

    This would result in ``MyBool`` being used in the generated code.

    Specifying the annotation means that ``bool`` will be used in the generated
    code instead.


.. typedef-annotation:: PyInt

    This boolean annotation serves the same purpose as the :aanno:`PyInt`
    argument annotation when applied to the type being defined.


.. typedef-annotation:: PyName

    This name annotation only applies when the typedef is being used to create
    the wrapping for a class defined using a template and specifies an
    alternative name for the class when it is referred to from Python.

    .. seealso:: :directive:`%AutoPyName`


.. typedef-annotation:: TypeHint

    This string annotation specifies the type as it will appear in any
    generated docstrings and PEP 484 type hints.  It is the equivalent of
    specifying :tanno:`TypeHintIn` and :tanno:`TypeHintOut` with the same
    value.


.. typedef-annotation:: TypeHintIn

    This string annotation specifies the type as it will appear in any
    generated docstrings and PEP 484 type hints when it is passed to a function
    (rather than being returned from a function).  It is usually used with
    arguments of type :stype:`SIP_PYOBJECT` to provide a more specific type.


.. typedef-annotation:: TypeHintOut

    This string annotation specifies the type as it will appear in any
    generated docstrings and PEP 484 type hints when it is returned from a
    function (rather than being passed to a function).  It is usually used with
    arguments of type :stype:`SIP_PYOBJECT` to provide a more specific type.


.. _ref-variable-annos:

Variable Annotations
--------------------

.. variable-annotation:: Encoding

    This string annotation serves the same purpose as the :aanno:`Encoding`
    argument annotation when applied to the type of the variable being defined.


.. variable-annotation:: NoSetter

    This boolean annotation specifies that the variable will have no setter and
    will be read-only.  Because SIP does not fully understand C/C++ types
    (particularly ``const`` arrays) it is sometimes necessary to explicitly
    annotate a variable as being read-only.


.. variable-annotation:: NoTypeHint

    This boolean annotation is used to suppress the generation of the PEP 484
    type hint for the variable.


.. variable-annotation:: PyInt

    This boolean annotation serves the same purpose as the :aanno:`PyInt`
    argument annotation when applied to the type of the variable being defined.


.. variable-annotation:: PyName

    This name annotation specifies an alternative name for the variable being
    wrapped which is used when it is referred to from Python.

    .. seealso:: :directive:`%AutoPyName`


.. variable-annotation:: TypeHint

    This string annotation specifies the type of the variable as it will appear
    in any generated docstrings and PEP 484 type hints.  It is usually used
    with arguments of type :stype:`SIP_PYOBJECT` to provide a more specific
    type.
