pymel.core.system.loadPlugin¶

loadPlugin(*args, **kwargs)¶

Load plug-ins into Maya. The parameter(s) to this command are either the names or pathnames of plug-in files. The convention for naming plug-ins is to use a .so extension on Linux, a .mll extension on Windows and .bundle extension on Mac OS X. If no extension is provided then the default extension for the platform will be used. To load a Python plugin you must explicitly supply the ‘.py’ extension. If the plugin was specified with a pathname then that is where the plugin will be searched for. If no pathname was provided then the current working directory (i.e. the one returned by Maya’s ‘pwd’ command) will be searched, followed by the directories in the MAYA_PLUG_IN_PATH environment variable. When the plug-in is loaded, the name used in Maya’s internal plug-in registry for the plug-in information will be the file name with the extension removed. For example, if you load the plug-in newNode.mllthe name used in the Maya’s registry will be newNode. This value as well as that value with either a .so, .mllor .bundleextension can be used as valid arguments to either the unloadPlugin or pluginInfo commands.

Flags:

Long Name / Short Name		Argument Types	Properties
addCallback / ac		script
	Add a MEL or Python callback script to be called after a plug-in is loaded. For MEL, the procedure should have the following signature: global proc procedureName(string $pluginName). For Python, you may specify either a script as a string, or a Python callable object such as a function. If you specify a string, then put the formatting specifier %swhere you want the name of the plug-in to be inserted. If you specify a callable such as a function, then the name of the plug-in will be passed as an argument.
allPlugins / a		bool
	Cause all plug-ins in the search path specified in MAYA_PLUG_IN_PATH to be loaded.
name / n		unicode
	Set a user defined name for the plug-ins that are loaded. If the name is already taken, then a number will be added to the end of the name to make it unique.
qObsolete / q		bool
quiet / qt		bool
	Don’t print a warning if you attempt to load a plug-in that is already loaded.
removeCallback / rc		script
	Removes a procedure which was previously added with -addCallback. Flag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.loadPlugin

Example:

import pymel.core as pm

# Load the plug-in named "newNode" into Maya.
#
pm.loadPlugin( 'newNode.py' )

# Load all the plug-ins found in all the directories that are
# included in MAYA_PLUG_IN_PATH.
#
pm.loadPlugin( allPlugins=True )