detail.pythonalgorithm Module

paraview.detail.pythonalgorithm.get_plugin_name(module_or_package)

helper function called by vtkPVPythonAlgorithmPlugin to discover ParaView plugin name, if any.

paraview.detail.pythonalgorithm.get_plugin_version(module_or_package)

helper function called by vtkPVPythonAlgorithmPlugin to discover ParaView plugin version, if any.

paraview.detail.pythonalgorithm.get_plugin_xmls(module_or_package)

helper function called by vtkPVPythonAlgorithmPlugin to discover all “proxy” decorated classes in the module or package. We don’t recurse into the package, on simply needs to export all classes that form the ParaView plugin in the __init__.py for the package.

paraview.detail.pythonalgorithm.get_qualified_classname(classobj)

paraview.detail.pythonalgorithm.load_plugin(filepath, default_modulename=None)

helper function called by vtkPVPythonAlgorithmPlugin to load a python file.

paraview.detail.pythonalgorithm.reload_plugin_module(module)

helper function to reload a plugin module previously loaded via load_plugin

class paraview.detail.pythonalgorithm.smdomain

Bases: object

Provides decorators that add domains to properties.

static datatype(dataTypes, **kwargs)

static doublerange(**kwargs)

static filelist(**kwargs)

static intrange(**kwargs)

static xml(xmlstr)

class paraview.detail.pythonalgorithm.smhint

Bases: object

Provides decorators that add hints to proxies and properties.

static filechooser(extensions, file_description)

static xml(xmlstr)

class paraview.detail.pythonalgorithm.smproperty

Bases: object

Provides decorators for class methods that are to be exposed as server-manager properties in ParaView. Only methods that are decorated using one of the available decorators will be exposed be accessible to ParaView UI or client-side Python scripting API.

static dataarrayselection(name=None)

static doublevector(**kwargs)

static idtypevector(**kwargs)

static input(**kwargs)

static intvector(**kwargs)

static proxy(**kwargs)

static stringvector(**kwargs)

static xml(xmlstr)

Decorator that be used to directly add a ServerManager property XML for a method.

class paraview.detail.pythonalgorithm.smproxy

Bases: object

Provides decorators for class objects that should be exposed to ParaView.

static filter(**kwargs)

static reader(file_description, extensions=None, filename_patterns=None, is_directory=False, **kwargs)

Decorates a reader. Either filename_patterns or extensions must be provided.

static source(**kwargs)

static writer(file_description, extensions, **kwargs)

Decorates a writer.