sip.pyi

# Copyright (c) 2022, Riverbank Computing Limited
# All rights reserved.
#
# This copy of SIP is licensed for use under the terms of the SIP License
# Agreement. See the file LICENSE for more details.
#
# This copy of SIP may also used under the terms of the GNU General Public
# License v2 or v3 as published by the Free Software Foundation which can be
# found in the files LICENSE-GPL2 and LICENSE-GPL3 included in this package.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.


fromtypingimportAny, Generic, Iterable, overload, Sequence, TypeVar, Union


# PEP 484 has no explicit support for the buffer protocol so we just name types
# we know that implement it.
Buffer=Union[bytes, bytearray, memoryview, 'array', 'voidptr']


# Constants.
SIP_VERSION= ... # type: int
SIP_VERSION_STR= ... # type: str


# The bases for SIP generated types.
classwrappertype:
def__init__(self, *args, **kwargs) ->None: ...

classsimplewrapper:
def__init__(self, *args, **kwargs) ->None: ...

classwrapper(simplewrapper): ...


# The array type.
_T=TypeVar('_T')

classarray(Sequence[_T], Generic[_T]):

@overload
def__getitem__(self, key: int) ->_T: ...
@overload
def__getitem__(self, key: slice) ->'array[_T]': ...

@overload
def__setitem__(self, key: int, value: _T) ->None: ...
@overload
def__setitem__(self, key: slice, value: Iterable[_T]) ->None: ...

@overload
def__delitem__(self, key: int) ->None: ...
@overload
def__delitem__(self, key: slice) ->None: ...

def__len__(self) ->int: ...


# The voidptr type.
classvoidptr:

def__init__(self, addr: Union[int, Buffer], size: int=-1, writeable: bool=True) ->None: ...

def__int__(self) ->int: ...

@overload
def__getitem__(self, i: int) ->bytes: ...

@overload
def__getitem__(self, s: slice) ->'voidptr': ...

def__len__(self) ->int: ...

def__setitem__(self, i: Union[int, slice], v: Buffer) ->None: ...

defasarray(self, size: int=-1) ->array[int]: ...

# Python doesn't expose the capsule type.
defascapsule(self) ->Any: ...

defasstring(self, size: int=-1) ->bytes: ...

defgetsize(self) ->int: ...

defgetwriteable(self) ->bool: ...

defsetsize(self, size: int) ->None: ...

defsetwriteable(self, writeable: bool) ->None: ...


# Remaining functions.
defassign(obj: simplewrapper, other: simplewrapper) ->None: ...
defcast(obj: simplewrapper, type: wrappertype) ->simplewrapper: ...
defdelete(obj: simplewrapper) ->None: ...
defdump(obj: simplewrapper) ->None: ...
defenableautoconversion(type: wrappertype, enable: bool) ->bool: ...
defisdeleted(obj: simplewrapper) ->bool: ...
defispycreated(obj: simplewrapper) ->bool: ...
defispyowned(obj: simplewrapper) ->bool: ...
defsetdeleted(obj: simplewrapper) ->None: ...
defsettracemask(mask: int) ->None: ...
deftransferback(obj: wrapper) ->None: ...
deftransferto(obj: wrapper, owner: wrapper) ->None: ...
defunwrapinstance(obj: simplewrapper) ->None: ...
defwrapinstance(addr: int, type: wrappertype) ->simplewrapper: ...