dips package#

Submodules#

Module contents#

Dips Python API

Public API for interacting with Dips application via gRPC.

class dips.DipsApp(port)#

Bases: object

static AttachToExisting(port)#
Close()#
GetModel() → ProjStubRef#
Hide()#
static LaunchApp(port, overridePathToExecutable: str = None, timeout: float = 120, headless: bool = False, fileToOpen: str = None)#
Ping()#
Show()#
static startApplication(port: int, overridePathToExecutable: str = None, timeout: float = 120, headless: bool = False, fileToOpen: str = None) → None#

Opens the most recently installed Dips application. Starts the Python server and binds it to the given port.

Parameters:

  • port (int) – the port to bind the Python server to.

  • overridePathToExecutable (str, optional) – full path to the desired executable to be opened. If not provided, the latest installation of Dips is used

  • timeout (float, optional) – the maximum amount of time to wait for the application and server to start.

Raises:

  • ValueError – Port range must be between 49152 and 65535, otherwise ValueError is raised

  • TimeoutError – if timeout is provided, raises TimeoutError if not able to connect to the server within that time.