Skip to content

cmem_client.models.python_install¤

Result models for Python package installation and plugin management operations.

Installing a Python package into DataIntegration runs pip inside the deployment and then registers the plugins the package ships. Both steps can fail on their own, so the operations of client.python_packages report the outcome with these models rather than raising: a package can install cleanly and still contribute a plugin which does not load.

Classes:

PluginError¤

Bases: Model

An error reported during plugin registration.

Attributes:

  • package_name (str) – Name of the package whose plugin failed to register.
  • error_message (str) – Message of the error.
  • error_type (str) – Type of the error, as named by DataIntegration.
  • stack_trace (str | None) – Stack trace of the error, if the deployment reports one.

error_message¤

error_message: str = Field(alias='errorMessage', default='')

error_type¤

error_type: str = Field(alias='errorType', default='')

model_config¤

model_config = ConfigDict(extra='allow', populate_by_name=True)

package_name¤

package_name: str = Field(alias='packageName', default='')

stack_trace¤

stack_trace: str | None = Field(alias='stackTrace', default=None)

PluginReloadResult¤

Bases: Model

Result of a plugin reload operation.

Attributes:

  • errors (list[PluginError]) – Plugins which failed to register during the reload. An empty list means every plugin loaded.

errors¤

errors: list[PluginError] = Field(default_factory=list)

model_config¤

model_config = ConfigDict(extra='allow', populate_by_name=True)

PythonInstallResult¤

Bases: Model

Result of a Python package installation (by name or by file).

Attributes:

  • success (bool) – Whether the installation itself succeeded. Plugins which failed to register afterwards are reported in plugin_errors and do not clear this flag.
  • output (str) – Combined output of the installation.
  • standard_output (str) – What the installation wrote to stdout.
  • error_output (str) – What the installation wrote to stderr.
  • plugin_errors (list[PluginError]) – Plugins of the installed package which failed to register.

error_output¤

error_output: str = Field(alias='errorOutput', default='')

model_config¤

model_config = ConfigDict(extra='allow', populate_by_name=True)

output¤

output: str = ''

plugin_errors¤

plugin_errors: list[PluginError] = Field(default_factory=list)

standard_output¤

standard_output: str = Field(alias='standardOutput', default='')

success¤

success: bool = False

Comments