pymel.mayahook

Low-level maya and pymel utilities. Functions in this module are used by both pymel.api and pymel.core, and are able to be defined before maya.standalone is initialized.

Functions

decorator Decorator for decorators.
deprecated the decorator can either receive parameters or the function directly.
encodeFix
executableOutput Will return the text output of running the given executable with the given arguments.
executeDeferred This is a wrap for maya.utils.executeDeferred. Maya’s version does not execute at all when in batch mode, so this
formatwarning Redefined format warning for maya.
getConfigFile
getLogger Return a logger with the specified name, creating it if necessary.
getMayaAppDir
getMayaExecutable Returns the path string to the maya executable for the given version; if version is None, then returns the path
getMayaLocation Remember to pass the FULL version (with extension if any) to this function!
getMayaVersion Returns the maya version (ie 2008),
getRunningMayaVersionString Returns the version string (from ‘about(version=True)’ ) of the currently running version of maya, or None
initMEL
loadCache
mayaDocsLocation
mayaInit Try to init Maya standalone module, use when running pymel from an external Python inerpreter,
mayaIsRunning Returns True if a version of maya is running / initialized, False otherwise.
moduleDir Returns the base pymel directory.
parseMayaenv parse the Maya.env file and set the environement variablas and python path accordingly.
parsePymelConfig
parseVersionStr
>>> from pymel import *
recurseMayaScriptPath Given a path or list of paths, recurses through directories appending to the MAYA_SCRIPT_PATH
refreshEnviron copy the shell environment into python’s environment, as stored in os.environ
resetwarnings Clear the list of warning filters, so that no filters are active.
shellOutput Will return the text output of running a given shell command.
showwarning
simplefilter Insert a simple entry into the list of warnings filters (at the front).
source Looks for a python script in the specified path (uses system path if no path is specified)
warn Default Maya warn which uses ExecutionWarning as the default warning class.
writeCache

Classes

Version Class for storing apiVersions, which are the best method for comparing versions.

Exceptions

class ExecutionWarning

Bases: exceptions.UserWarning

Simple Warning class that doesn’t print any information besides warning message

args
message
exception message