class WorkingDirectory(QToolBar, SMPluginMixin):
"""
Working directory changer widget
"""
CONF_SECTION = 'workingdir'
CONFIGWIDGET_CLASS = WorkingDirectoryConfigPage
LOG_PATH = get_conf_path('.workingdir')
sig_option_changed = pyqtSignal(str, object)
def __init__(self, parent, workdir=None):
QToolBar.__init__(self, parent)
SMPluginMixin.__init__(self, parent)
# Initialize plugin
self.initialize_plugin()
# Setting default values for editor-related options
self.get_option('editor/open/browse_scriptdir', True)
self.get_option('editor/open/browse_workdir', False)
self.get_option('editor/new/browse_scriptdir', False)
self.get_option('editor/new/browse_workdir', True)
self.get_option('editor/open/auto_set_to_basedir', False)
self.get_option('editor/save/auto_set_to_basedir', False)
self.setWindowTitle(self.get_plugin_title()) # Toolbar title
self.setObjectName(self.get_plugin_title()) # Used to save Window state
# Previous dir action
self.history = []
self.histindex = None
self.previous_action = create_action(self, "previous", None,
get_icon('previous.png'), _('Back'),
triggered=self.previous_directory)
self.addAction(self.previous_action)
# Next dir action
self.history = []
self.histindex = None
self.next_action = create_action(self, "next", None,
get_icon('next.png'), _('Next'),
triggered=self.next_directory)
self.addAction(self.next_action)
# Enable/disable previous/next actions
self.connect(self, SIGNAL("set_previous_enabled(bool)"),
self.previous_action.setEnabled)
self.connect(self, SIGNAL("set_next_enabled(bool)"),
self.next_action.setEnabled)
# Path combo box
adjust = self.get_option('working_dir_adjusttocontents', False)
self.pathedit = PathComboBox(self, adjust_to_contents=adjust)
self.pathedit.setToolTip(_("This is the working directory for newly\n"
"opened consoles (Python interpreters and\n"
"terminals), for the file explorer, for the\n"
"find in files plugin and for new files\n"
"created in the editor"))
self.connect(self.pathedit, SIGNAL("open_dir(QString)"), self.chdir)
self.pathedit.setMaxCount(self.get_option('working_dir_history', 20))
wdhistory = self.load_wdhistory( workdir )
if workdir is None:
if self.get_option('startup/use_last_directory', True):
if wdhistory:
workdir = wdhistory[0]
else:
workdir = "."
else:
workdir = self.get_option('startup/fixed_directory', ".")
if not osp.isdir(workdir):
workdir = "."
self.chdir(workdir)
self.pathedit.addItems( wdhistory )
self.refresh_plugin()
self.addWidget(self.pathedit)
# Browse action
browse_action = create_action(self, "browse", None,
get_std_icon('DirOpenIcon'),
_('Browse a working directory'),
triggered=self.select_directory)
self.addAction(browse_action)
# Set current console working directory action
setwd_action = create_action(self, icon=get_icon('set_workdir.png'),
text=_("Set as current console's "
"working directory"),
triggered=self.set_as_current_console_wd)
self.addAction(setwd_action)
# Parent dir action
parent_action = create_action(self, "parent", None,
get_icon('up.png'),
_('Change to parent directory'),
triggered=self.parent_directory)
self.addAction(parent_action)
#------ SpyderPluginWidget API ---------------------------------------------
def get_plugin_title(self):
"""Return widget title"""
return _('Global working directory')
def get_plugin_icon(self):
"""Return widget icon"""
return get_std_icon('DirOpenIcon')
def get_plugin_actions(self):
"""Setup actions"""
return (None, None)
def register_plugin(self):
"""Register plugin in Spyder's main window"""
self.connect(self, SIGNAL('redirect_stdio(bool)'),
self.main.redirect_internalshell_stdio)
self.connect(self.main.console.shell, SIGNAL("refresh()"),
self.refresh_plugin)
self.main.addToolBar(self)
def refresh_plugin(self):
"""Refresh widget"""
curdir = os.getcwdu()
self.pathedit.add_text(curdir)
self.save_wdhistory()
self.emit(SIGNAL("set_previous_enabled(bool)"),
self.histindex is not None and self.histindex > 0)
self.emit(SIGNAL("set_next_enabled(bool)"),
self.histindex is not None and \
self.histindex < len(self.history)-1)
def apply_plugin_settings(self, options):
"""Apply configuration file's plugin settings"""
pass
def closing_plugin(self, cancelable=False):
"""Perform actions before parent main window is closed"""
return True
#------ Public API ---------------------------------------------------------
def load_wdhistory(self, workdir=None):
"""Load history from a text file in user home directory"""
if osp.isfile(self.LOG_PATH):
wdhistory, _ = encoding.readlines(self.LOG_PATH)
wdhistory = [name for name in wdhistory if os.path.isdir(name)]
else:
if workdir is None:
workdir = os.getcwdu()
wdhistory = [ workdir ]
return wdhistory
def save_wdhistory(self):
"""Save history to a text file in user home directory"""
text = [ unicode( self.pathedit.itemText(index) ) \
for index in range(self.pathedit.count()) ]
encoding.writelines(text, self.LOG_PATH)
def select_directory(self):
"""Select directory"""
self.emit(SIGNAL('redirect_stdio(bool)'), False)
directory = getexistingdirectory(self.main, _("Select directory"),
os.getcwdu())
if directory:
self.chdir(directory)
self.emit(SIGNAL('redirect_stdio(bool)'), True)
def previous_directory(self):
"""Back to previous directory"""
self.histindex -= 1
self.chdir(browsing_history=True)
def next_directory(self):
"""Return to next directory"""
self.histindex += 1
self.chdir(browsing_history=True)
def parent_directory(self):
"""Change working directory to parent directory"""
self.chdir(os.path.join(os.getcwdu(), os.path.pardir))
def chdir(self, directory=None, browsing_history=False,
refresh_explorer=True):
"""Set directory as working directory"""
# Working directory history management
if directory is not None:
directory = osp.abspath(unicode(directory))
if browsing_history:
directory = self.history[self.histindex]
elif directory in self.history:
self.histindex = self.history.index(directory)
else:
if self.histindex is None:
self.history = []
else:
self.history = self.history[:self.histindex+1]
self.history.append(directory)
self.histindex = len(self.history)-1
# Changing working directory
os.chdir( unicode(directory) )
self.refresh_plugin()
if refresh_explorer:
self.emit(SIGNAL("set_explorer_cwd(QString)"), directory)
self.emit(SIGNAL("refresh_findinfiles()"))
def set_as_current_console_wd(self):
"""Set as current console working directory"""
self.emit(SIGNAL("set_current_console_wd(QString)"), os.getcwdu())
class WorkingDirectory(QToolBar, SMPluginMixin):
"""
Working directory changer widget
"""
CONF_SECTION = 'workingdir'
CONFIGWIDGET_CLASS = WorkingDirectoryConfigPage
LOG_PATH = get_conf_path('.workingdir')
sig_option_changed = pyqtSignal(str, object)
def __init__(self, parent, workdir=None):
QToolBar.__init__(self, parent)
SMPluginMixin.__init__(self, parent)
# Initialize plugin
self.initialize_plugin()
# Setting default values for editor-related options
self.get_option('editor/open/browse_scriptdir', True)
self.get_option('editor/open/browse_workdir', False)
self.get_option('editor/new/browse_scriptdir', False)
self.get_option('editor/new/browse_workdir', True)
self.get_option('editor/open/auto_set_to_basedir', False)
self.get_option('editor/save/auto_set_to_basedir', False)
self.setWindowTitle(self.get_plugin_title()) # Toolbar title
self.setObjectName(
self.get_plugin_title()) # Used to save Window state
# Previous dir action
self.history = []
self.histindex = None
self.previous_action = create_action(self,
"previous",
None,
get_icon('previous.png'),
_('Back'),
triggered=self.previous_directory)
self.addAction(self.previous_action)
# Next dir action
self.history = []
self.histindex = None
self.next_action = create_action(self,
"next",
None,
get_icon('next.png'),
_('Next'),
triggered=self.next_directory)
self.addAction(self.next_action)
# Enable/disable previous/next actions
self.connect(self, SIGNAL("set_previous_enabled(bool)"),
self.previous_action.setEnabled)
self.connect(self, SIGNAL("set_next_enabled(bool)"),
self.next_action.setEnabled)
# Path combo box
adjust = self.get_option('working_dir_adjusttocontents', False)
self.pathedit = PathComboBox(self, adjust_to_contents=adjust)
self.pathedit.setToolTip(
_("This is the working directory for newly\n"
"opened consoles (Python interpreters and\n"
"terminals), for the file explorer, for the\n"
"find in files plugin and for new files\n"
"created in the editor"))
self.connect(self.pathedit, SIGNAL("open_dir(QString)"), self.chdir)
self.pathedit.setMaxCount(self.get_option('working_dir_history', 20))
wdhistory = self.load_wdhistory(workdir)
if workdir is None:
if self.get_option('startup/use_last_directory', True):
if wdhistory:
workdir = wdhistory[0]
else:
workdir = "."
else:
workdir = self.get_option('startup/fixed_directory', ".")
if not osp.isdir(workdir):
workdir = "."
self.chdir(workdir)
self.pathedit.addItems(wdhistory)
self.refresh_plugin()
self.addWidget(self.pathedit)
# Browse action
browse_action = create_action(self,
"browse",
None,
get_std_icon('DirOpenIcon'),
_('Browse a working directory'),
triggered=self.select_directory)
self.addAction(browse_action)
# Set current console working directory action
setwd_action = create_action(self,
icon=get_icon('set_workdir.png'),
text=_("Set as current console's "
"working directory"),
triggered=self.set_as_current_console_wd)
self.addAction(setwd_action)
# Parent dir action
parent_action = create_action(self,
"parent",
None,
get_icon('up.png'),
_('Change to parent directory'),
triggered=self.parent_directory)
self.addAction(parent_action)
#------ SpyderPluginWidget API ---------------------------------------------
def get_plugin_title(self):
"""Return widget title"""
return _('Global working directory')
def get_plugin_icon(self):
"""Return widget icon"""
return get_std_icon('DirOpenIcon')
def get_plugin_actions(self):
"""Setup actions"""
return (None, None)
def register_plugin(self):
"""Register plugin in Spyder's main window"""
self.connect(self, SIGNAL('redirect_stdio(bool)'),
self.main.redirect_internalshell_stdio)
self.connect(self.main.console.shell, SIGNAL("refresh()"),
self.refresh_plugin)
self.main.addToolBar(self)
def refresh_plugin(self):
"""Refresh widget"""
curdir = os.getcwdu()
self.pathedit.add_text(curdir)
self.save_wdhistory()
self.emit(SIGNAL("set_previous_enabled(bool)"),
self.histindex is not None and self.histindex > 0)
self.emit(SIGNAL("set_next_enabled(bool)"),
self.histindex is not None and \
self.histindex < len(self.history)-1)
def apply_plugin_settings(self, options):
"""Apply configuration file's plugin settings"""
pass
def closing_plugin(self, cancelable=False):
"""Perform actions before parent main window is closed"""
return True
#------ Public API ---------------------------------------------------------
def load_wdhistory(self, workdir=None):
"""Load history from a text file in user home directory"""
if osp.isfile(self.LOG_PATH):
wdhistory, _ = encoding.readlines(self.LOG_PATH)
wdhistory = [name for name in wdhistory if os.path.isdir(name)]
else:
if workdir is None:
workdir = os.getcwdu()
wdhistory = [workdir]
return wdhistory
def save_wdhistory(self):
"""Save history to a text file in user home directory"""
text = [ unicode( self.pathedit.itemText(index) ) \
for index in range(self.pathedit.count()) ]
encoding.writelines(text, self.LOG_PATH)
def select_directory(self):
"""Select directory"""
self.emit(SIGNAL('redirect_stdio(bool)'), False)
directory = getexistingdirectory(self.main, _("Select directory"),
os.getcwdu())
if directory:
self.chdir(directory)
self.emit(SIGNAL('redirect_stdio(bool)'), True)
def previous_directory(self):
"""Back to previous directory"""
self.histindex -= 1
self.chdir(browsing_history=True)
def next_directory(self):
"""Return to next directory"""
self.histindex += 1
self.chdir(browsing_history=True)
def parent_directory(self):
"""Change working directory to parent directory"""
self.chdir(os.path.join(os.getcwdu(), os.path.pardir))
def chdir(self,
directory=None,
browsing_history=False,
refresh_explorer=True):
"""Set directory as working directory"""
# Working directory history management
if directory is not None:
directory = osp.abspath(unicode(directory))
if browsing_history:
directory = self.history[self.histindex]
elif directory in self.history:
self.histindex = self.history.index(directory)
else:
if self.histindex is None:
self.history = []
else:
self.history = self.history[:self.histindex + 1]
self.history.append(directory)
self.histindex = len(self.history) - 1
# Changing working directory
os.chdir(unicode(directory))
self.refresh_plugin()
if refresh_explorer:
self.emit(SIGNAL("set_explorer_cwd(QString)"), directory)
self.emit(SIGNAL("refresh_findinfiles()"))
def set_as_current_console_wd(self):
"""Set as current console working directory"""
self.emit(SIGNAL("set_current_console_wd(QString)"), os.getcwdu())
