paraview Package

paraview Package

The paraview package provides modules used to script ParaView. Generally, users should import the modules of interest directly e.g.:

from paraview.simple import *

However, one may want to import paraview package before importing any of the ParaView modules to force backwards compatibility to an older version:

# To run scripts written for ParaView 4.0 in newer versions, you can use the
# following.
import paraview
paraview.compatibility.major = 4
paraview.compatibility.minor = 0

# Now, import the modules of interest.
from paraview.simple import *
exception paraview.__init__.NotSupportedException(msg)[source]

Bases: Exception

Exception that is fired when obsolete API is used in a script.

class paraview.__init__.compatibility[source]

Bases: object

Class used to check version number and compatibility. Users should only set the compatibility explicitly to force backwards compatibility to and older versions.

classmethod GetVersion()[source]
major = None
minor = None

Make a string into a valid Python variable name.

class paraview.__init__.options[source]

Bases: object

Values set here have any effect, only when importing the paraview module in python interpretor directly i.e. not through pvpython or pvbatch. In that case, one should use command line arguments for the two executables

batch = False

When True, acts like pvbatch –symmetric. Requires that batch is set to True to have any effect.

print_debug_messages = False

When True, This mean the current process is a satellite and should not try to connect or do anything else.

satelite = False
symmetric = False

When True, paraview.print_debug_info() will result in printing the debug messages to stdout. Default is False, hence all debug messages will be suppressed.