The interface.py module

Summary

Classes

DataclassProtocol	Protocol for objects generated with dataclasses.dataclass().
LauncherProtocol	Provides the interface for managing a local product instance.

Enums

ServerType

Defines which protocols the server supports.

Constants

METADATA_KEY_DOC	Key used in the dataclasses.Field metadata for the option description.
METADATA_KEY_NOPROMPT	Key used in the dataclasses.Field metadata to skip prompting for
FALLBACK_LAUNCH_MODE_NAME
LAUNCHER_CONFIG_T

Description

Interface definitions for implementing a local product launcher.

A plugin for the local product launcher must implement the LauncherProtocol class and register it.

Module detail

interface.METADATA_KEY_DOC = 'launcher_doc'

Key used in the dataclasses.Field metadata for the option description.

interface.METADATA_KEY_NOPROMPT = 'launcher_noprompt'

Key used in the dataclasses.Field metadata to skip prompting for the option by default.

interface.FALLBACK_LAUNCH_MODE_NAME = '__fallback__'

interface.LAUNCHER_CONFIG_T