Skip to content

Commit a71f5a8

Browse files
Removed singleReturnLibrary function in favor of library
1 parent ae25f07 commit a71f5a8

1 file changed

Lines changed: 4 additions & 13 deletions

File tree

src/openspace/src/api.py

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,8 @@ def disconnect(self):
7474
def startTopic(self, type: str, payload) -> Topic:
7575
""" Initialize a new channel of communication. \n
7676
77-
:param `type` - A string specifying the type of topic to construct. \n
78-
See OpenSpace's server module for available topic types.
77+
:param `type` - A string specifying the type of topic to construct.
78+
See OpenSpace's server module for available topic types. \n
7979
:param `payload` - An object representing the topic \n
8080
:return - A Topic object. """
8181

@@ -338,7 +338,7 @@ async def executeLuaFunction(self, function: str, args, getReturnValue = True):
338338
else:
339339
topic.cancel()
340340

341-
async def library(self, wrapper: None|Callable = None) -> dict:
341+
async def library(self, wrapper: None | Callable = None) -> NamedTuple:
342342
""" Get an object representing the OpenSpace lua libarary. \n
343343
:param wrapper: if set, wraps all API calls (may be used to make them synchronous)
344344
:return - The lua library, mapped to async python functions. """
@@ -374,13 +374,4 @@ async def async_lua_call(functionName, *args):
374374
lua_call = partial(wrapper, lua_call)
375375
subPyLibrary[func['name']] = lua_call
376376

377-
return toNamedTuple(pyLibrary, libraryName)
378-
379-
async def singleReturnLibrary(self, wrapper=None):
380-
""" Get an object representing the OpenSpace lua library. \n
381-
(deprecated. Use library() instead)
382-
:param wrapper: if set, wraps all API calls (may be used to make them synchronous)
383-
:return - The lua library, mapped to async python functions. This method only
384-
returns the first return value. """
385-
386-
return await self.library(wrapper)
377+
return toNamedTuple(pyLibrary, libraryName)

0 commit comments

Comments
 (0)