Extend

From PyMOLWiki
Revision as of 14:31, 17 November 2009 by Inchoate (talk | contribs)
Jump to: navigation, search

Extend is an API-only function which binds a new external function as a command into the PyMOL scripting language. In other words, when you write a function and want PyMOL to recognize the new command, you extend the command into PyMOL. Once extended, the function name is recognized like other function names (example below). Typically, extend is the last line of a PyMOL script.

PYMOL API

cmd.extend(string name,function function)

PYTHON EXAMPLE

def foo(moo=2): print moo
cmd.extend('foo',foo)

The following would now work within PyMOL:

PyMOL>foo
2
PyMOL>foo 3
3
PyMOL>foo moo=5
5
PyMOL>foo ?

Usage: foo [ moo ]

NOTES

For security reasons, new PyMOL commands created using "extend" are not saved or restored in sessions.

SEE ALSO