Previous page

Next page

Locate page in Contents

Package and Modules

The following table lists packages and modules comprising the Parallels Python API.

prlsdkapi

This is the main package containing the majority of the classes.

prlsdkapi.prlsdk

This is an internal module. Do not use it in your applications.

prlsdkapi.prlsdk.consts

This module contains constants that are used throughout the API. Most of the constants are combined into groups which are used as pseudo enumerations. Constants that belong to the same group have the same prefix in their names.  For example, constants with a PDE_ prefix identify device types: PDE_GENERIC_DEVICE, PDE_HARD_DISK, PDE_GENERIC_NETWORK_ADAPTER, etc.

In this guide, and in the Parallels Python API Reference guide, we identify individual groups of constants using these prefixes. For example, we might say, "for the complete list of device types, see the PDE_xxx constants".

prlsdkapi.prlsdk.errors

This module contains error code constants. There's a very large amount of error codes but the majority of them are used internally. The error code constant are also grouped using prefixes in their names.

The Parallels Python package is installed automatically during the Parallels Virtualization SDK installation and is placed into the default directory for Python site-packages.