plover.oslayer – Platform layer

This is an umbrella package for platform-specific functionality:

• plover.oslayer.config – Platform-specific configuration
• plover.oslayer.controller – Process management
• plover.oslayer.i18n – System languages
• plover.oslayer.keyboardcontrol – Keyboard input and output
• plover.oslayer.log – User-facing notifications
• plover.oslayer.wmctrl – Window management

plover.oslayer.PLATFORM_PACKAGE: Dict[str, str]

A mapping from platforms to platform layer packages.

The keys are platform names, the same as in PLATFORM, and the values are names of subpackages within plover.oslayer. For example, logic specific to macOS systems (for which PLATFORM is mac) can be found in plover.oslayer.osx, and this is defined as follows:

PLATFORM_PACKAGE = {
  "mac": "osx",
}

By adding a platform definition to this mapping, the platform layer logic can be imported automatically without using the platform name, for example plover.oslayer.osx.wmctrl is imported as plover.oslayer.wmctrl, and the same for every other platform.