# -*- coding: utf-8 -*- """KiCad Python Shell. This module provides the python shell for KiCad. Currently the shell is only available inside PCBNEW. PCBNEW starts the shell once, by calling makePcbnewShellWindow() the first time it is opened, subsequently the shell window is just hidden or shown, as per user requirements. IF makePcbnewShellWindow() is called again, a second/third shell window can be created. PCBNEW does not do this, but a user may call this from the first shell if they require. """ import wx import sys import os from wx.py import crust, editor, version, dispatcher from wx.py.editor import EditorNotebook import pcbnew INTRO = "KiCAD:PCBNEW - Python Shell - PyAlaMode %s" % version.VERSION class PcbnewPyShell(editor.EditorNotebookFrame): """The Pythonshell of PCBNEW.""" def _setup_startup(self): """Initialise the startup script.""" # Create filename for startup script. self.startup_file = os.path.join(self.config_dir, "PyShell_pcbnew_startup.py") self.execStartupScript = True # Check if startup script exists if not os.path.isfile(self.startup_file): # Not, so create a default. default_startup = open(self.startup_file, 'w') # provide the content for the default startup file. default_startup.write( "### DEFAULT STARTUP FILE FOR KiCad:PCBNEW Python Shell\n" + "# Enter any Python code you would like to execute when" + " the PCBNEW python shell first runs.\n" + "\n" + "# Eg:\n" + "\n" + "# import pcbnew\n" + "# board = pcbnew.GetBoard()\n") default_startup.close() def _setup(self): """ Setup prior to first buffer creation. Called automatically by base class during init. """ self.notebook = EditorNotebook(parent=self) intro = 'Py %s' % version.VERSION import imp module = imp.new_module('__main__') if sys.version_info >= (3,): import builtins module.__dict__['__builtins__'] = builtins else: import __builtin__ module.__dict__['__builtins__'] = __builtin__ namespace = module.__dict__.copy() self.config_dir = pcbnew.GetKicadConfigPath() self.dataDir = self.config_dir self._setup_startup() self.history_file = os.path.join(self.config_dir, "PyShell_pcbnew.history") self.config_file = os.path.join(self.config_dir, "PyShell_pcbnew.cfg") self.config = wx.FileConfig(localFilename=self.config_file) self.config.SetRecordDefaults(True) self.autoSaveSettings = False self.autoSaveHistory = False self.LoadSettings() # in case of wxPhoenix we need to create a wxApp first and store it # to prevent removal by gabage collector if 'phoenix' in wx.PlatformInfo: self.theApp = wx.App() self.crust = crust.Crust(parent=self.notebook, intro=intro, locals=namespace, rootLabel="locals()", startupScript=self.startup_file, execStartupScript=self.execStartupScript) self.shell = self.crust.shell # Override the filling so that status messages go to the status bar. self.crust.filling.tree.setStatusText = self.SetStatusText # Override the shell so that status messages go to the status bar. self.shell.setStatusText = self.SetStatusText # Fix a problem with the sash shrinking to nothing. self.crust.filling.SetSashPosition(200) self.notebook.AddPage(page=self.crust, text='*Shell*', select=True) self.setEditor(self.crust.editor) self.crust.editor.SetFocus() """Keep pydoc output on stdout instead of pager and place the stdout into the editor window """ import pydoc self._keep_stdin = sys.stdin pydoc.pager = pydoc.plainpager self.LoadHistory() def OnAbout(self, event): """Display an About window.""" title = 'About : KiCad:PCBNEW - Python Shell' text = "Enhanced Python Shell for KiCad:PCBNEW\n\n" + \ "This KiCad Python Shell is based on wxPython PyAlaMode.\n\n" + \ "see: http://wiki.wxpython.org/PyAlaMode\n\n" + \ "KiCad Revision: %s\n" % "??.??" + \ "PyAlaMode Revision : %s\n" % version.VERSION + \ "Platform: %s\n" % sys.platform + \ "Python Version: %s\n" % sys.version.split()[0] + \ "wxPython Version: %s\n" % wx.VERSION_STRING + \ ("\t(%s)\n" % ", ".join(wx.PlatformInfo[1:])) dialog = wx.MessageDialog(self, text, title, wx.OK | wx.ICON_INFORMATION) dialog.ShowModal() dialog.Destroy() def EditStartupScript(self): """Open a Edit buffer of the startup script file.""" self.bufferCreate(filename=self.startup_file) def LoadSettings(self): """Load settings for the shell.""" if self.config is not None: editor.EditorNotebookFrame.LoadSettings(self, self.config) self.autoSaveSettings = \ self.config.ReadBool('Options/AutoSaveSettings', False) self.execStartupScript = \ self.config.ReadBool('Options/ExecStartupScript', True) self.autoSaveHistory = \ self.config.ReadBool('Options/AutoSaveHistory', False) self.hideFoldingMargin = \ self.config.ReadBool('Options/HideFoldingMargin', True) def SaveSettings(self, force=False): """ Save settings for the shell. Arguments: force -- False - Autosaving. True - Manual Saving. """ if self.config is not None: # always save these self.config.WriteBool('Options/AutoSaveSettings', self.autoSaveSettings) if self.autoSaveSettings or force: editor.EditorNotebookFrame.SaveSettings(self, self.config) self.config.WriteBool('Options/AutoSaveHistory', self.autoSaveHistory) self.config.WriteBool('Options/ExecStartupScript', self.execStartupScript) self.config.WriteBool('Options/HideFoldingMargin', self.hideFoldingMargin) if self.autoSaveHistory: self.SaveHistory() def DoSaveSettings(self): """Menu function to trigger saving the shells settings.""" if self.config is not None: self.SaveSettings(force=True) self.config.Flush() def SaveHistory(self): """Save shell history to the shell history file.""" if self.dataDir: try: name = self.history_file f = file(name, 'w') hist = [] enc = wx.GetDefaultPyEncoding() for h in self.shell.history: if isinstance(h, unicode): h = h.encode(enc) hist.append(h) hist = '\x00\n'.join(hist) f.write(hist) f.close() except: d = wx.MessageDialog(self, "Error saving history file.", "Error", wx.ICON_EXCLAMATION | wx.OK) d.ShowModal() d.Destroy() raise def LoadHistory(self): """Load shell history from the shell history file.""" if self.dataDir: name = self.history_file if os.path.exists(name): try: f = file(name, 'U') hist = f.read() f.close() self.shell.history = hist.split('\x00\n') dispatcher.send(signal="Shell.loadHistory", history=self.shell.history) except: d = wx.MessageDialog(self, "Error loading history file!", "Error", wx.ICON_EXCLAMATION | wx.OK) d.ShowModal() d.Destroy() def makePcbnewShellWindow(parent=None): """ Create a new Shell Window and return its handle. Arguments: parent -- The parent window to attach to. Returns: The handle to the new window. """ pyshell = PcbnewPyShell(parent, id=-1, title=INTRO) pyshell.Show() return pyshell