Home » Support » Index of All Documentation » Wing IDE Reference Manual » Scripting and Extending Wing IDE »

Scripting API

Wing's formal scripting API consists of several parts:

  • The contents of the wingapi.py file in bin inside the Wing IDE installation (this file is located in src when working from the source distribution). Please refer to the file itself for details of the API.
  • The portions of the wingutils.datatype and guiutils.formbuilder modules that are documented in the preceding section.
  • All of the documented commands which can be invoked using the ExecuteCommand() method on wingapi.gApplication. Note keyword arguments can be passed to commands that take them, for example ExecuteCommand('replace-string', search_string="tset", replace_string="test")
  • All of the documented preferences which can be obtained and altered using GetPreference and SetPreference on wingapi.gApplication.

Scripts can, of course, also import and use standard library modules from Python, although Wing ships with a pruned subset of the standard library that includes only those modules that are used by the IDE's internals.

Advanced scripts may also "reach through" the API into Wing internals, however this requires reading Wing's souce code and no guarantee is made that these will remain unchanged or will change only in a backward compatible manner.

Scripting API