Skip to content

add and install interface file to help IDE usage #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,6 @@ include scripts/dump_osc.1
include scripts/send_osc.1
include test/*.py
include examples/*.py
include liblo/*.pyi
graft doc
prune doc/build
86 changes: 86 additions & 0 deletions liblo/__init__.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@


from typing import Callable, Union, overload

UDP: int
UNIX: int
TCP: int


class Message:
def __init__(self, path: str, *args: tuple) -> None: ...
def add(self, *args: tuple): ...


class Bundle:
@overload
def __init__(self, timetag: float, *messages: tuple[Message]) -> None: ...
@overload
def __init__(self, *messages: tuple[Message]): ...

@overload
def add(self, path: str, *messages: tuple[Message]): ...
@overload
def add(self, *args: tuple): ...


class Address:
url: str
hostname: str
port: Union[int, str]
protocol: int

@overload
def __init__(self, hostname: str, port: Union[int, str], proto: int =UDP): ...
@overload
def __init__(self, port: Union[int, str]): ...
@overload
def __init__(self, url: str): ...


class __AbstractServer:
url: str
port: Union[int, str]
protocol: int

def __init__(self, port: Union[int, str], proto: int =UDP, reg_methods=True): ...
def recv(self, timeout: int =None) -> bool: ...
def add_method(self, path: str, typespec: str, func: Callable, user_data=None): ...
def del_method(self, path: str, typespec: str): ...
def register_methods(self, obj=None): ...
def add_bundle_handlers(start_handler: Callable, end_handler: Callable, user_data=None): ...

@overload
def send(address: Address, path: str, *args: tuple): ...
@overload
def send(address: Address, messages: list[Message]): ...

def fileno(self) -> int: ...
def free(self): ...


class Server(__AbstractServer):
def recv(self, timeout: int =None) -> bool: ...


class ServerThread(__AbstractServer):
def start(self): ...
def stop(self): ...


class ServerError(BaseException): ...


class AddressError(BaseException): ...


@overload
def send(target: Union[Address, int, tuple[str, int], str],
path: str,
*args: tuple): ...
@overload
def send(target: Union[Address, int, tuple[str, int], str],
*messages: tuple[Message]): ...

def time() -> float: ...
def make_method(path: str, typespec: str, user_data=None): ...
4 changes: 3 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ def copy_scripts(self):
url = 'http://das.nasophon.de/pyliblo/',
description = 'Python bindings for the liblo OSC library',
license = 'LGPL',
include_package_data = True,
packages = ['liblo'],
scripts = [
'scripts/send_osc.py',
'scripts/dump_osc.py',
Expand All @@ -67,7 +69,7 @@ def copy_scripts(self):
('share/man/man1', [
'scripts/send_osc.1',
'scripts/dump_osc.1',
]),
])
],
cmdclass = cmdclass,
ext_modules = ext_modules,
Expand Down