def __init__(self):
super().__init__()
self.setWindowTitle(__namever__)
self.setWindowIcon(get_icon('master'))
self.setContextMenuPolicy(Qt.NoContextMenu)
if platform.system() == 'Windows':
import ctypes
myappid = 'climate_data_preprocessing_tool' # arbitrary string
ctypes.windll.shell32.SetCurrentProcessExplicitAppUserModelID(
myappid)
self.data_downloader = None
# Setup the toolbar.
self.show_data_downloader_btn = QToolButton()
self.show_data_downloader_btn.setIcon(get_icon('search_weather_data'))
self.show_data_downloader_btn.setAutoRaise(True)
self.show_data_downloader_btn.setToolTip("Download Data")
self.show_data_downloader_btn.clicked.connect(
self.show_data_downloader)
toolbar = QToolBar('Main')
toolbar.setObjectName('main_toolbar')
toolbar.setFloatable(False)
toolbar.setMovable(False)
toolbar.setIconSize(get_iconsize('normal'))
self.addToolBar(Qt.TopToolBarArea, toolbar)
toolbar.addWidget(self.show_data_downloader_btn)
toolbar.addWidget(create_toolbar_stretcher())
toolbar.addWidget(self._create_workdir_manager())
# Setup the main widget.
self.gapfiller = WeatherDataGapfiller()
self.setCentralWidget(self.gapfiller)
self._restore_window_geometry()
self._restore_window_state()
self.set_workdir(CONF.get('main', 'working_dir', get_home_dir()))
class WorkingDirectory(SpyderPluginWidget):
"""Working directory changer plugin."""
CONF_SECTION = 'workingdir'
CONFIGWIDGET_CLASS = WorkingDirectoryConfigPage
LOG_PATH = get_conf_path(CONF_SECTION)
sig_option_changed = Signal(str, object)
set_previous_enabled = Signal(bool)
set_next_enabled = Signal(bool)
redirect_stdio = Signal(bool)
set_explorer_cwd = Signal(str)
refresh_findinfiles = Signal()
set_current_console_wd = Signal(str)
def __init__(self, parent, workdir=None, **kwds):
SpyderPluginWidget.__init__(self, parent)
self.toolbar = QToolBar(self)
# Initialize plugin
self.initialize_plugin()
self.toolbar.setWindowTitle(self.get_plugin_title())
# Used to save Window state
self.toolbar.setObjectName(self.get_plugin_title())
# Previous dir action
self.history = []
self.histindex = None
self.previous_action = create_action(self,
"previous",
None,
ima.icon('previous'),
_('Back'),
triggered=self.previous_directory)
self.toolbar.addAction(self.previous_action)
# Next dir action
self.history = []
self.histindex = None
self.next_action = create_action(self,
"next",
None,
ima.icon('next'),
_('Next'),
triggered=self.next_directory)
self.toolbar.addAction(self.next_action)
# Enable/disable previous/next actions
self.set_previous_enabled.connect(self.previous_action.setEnabled)
self.set_next_enabled.connect(self.next_action.setEnabled)
# Path combo box
adjust = self.get_option('working_dir_adjusttocontents')
self.pathedit = PathComboBox(self, adjust_to_contents=adjust)
self.pathedit.setToolTip(
_("This is the working directory for newly\n"
"opened consoles (Python/IPython consoles and\n"
"terminals), for the file explorer, for the\n"
"find in files plugin and for new files\n"
"created in the editor"))
self.pathedit.open_dir.connect(self.chdir)
self.pathedit.activated[str].connect(self.chdir)
self.pathedit.setMaxCount(self.get_option('working_dir_history'))
wdhistory = self.load_wdhistory(workdir)
if workdir is None:
if self.get_option('startup/use_last_directory'):
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.pathedit.selected_text = self.pathedit.currentText()
self.refresh_plugin()
self.toolbar.addWidget(self.pathedit)
# Browse action
browse_action = create_action(self,
"browse",
None,
ima.icon('DirOpenIcon'),
_('Browse a working directory'),
triggered=self.select_directory)
self.toolbar.addAction(browse_action)
# Parent dir action
parent_action = create_action(self,
"parent",
None,
ima.icon('up'),
_('Change to parent directory'),
triggered=self.parent_directory)
self.toolbar.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 ima.icon('DirOpenIcon')
def get_plugin_actions(self):
"""Setup actions"""
return (None, None)
def register_plugin(self):
"""Register plugin in Spyder's main window"""
self.redirect_stdio.connect(self.main.redirect_internalshell_stdio)
self.main.console.shell.refresh.connect(self.refresh_plugin)
iconsize = 24
self.toolbar.setIconSize(QSize(iconsize, iconsize))
self.main.addToolBar(self.toolbar)
def refresh_plugin(self):
"""Refresh widget"""
curdir = getcwd()
self.pathedit.add_text(curdir)
self.save_wdhistory()
self.set_previous_enabled.emit(self.histindex is not None
and self.histindex > 0)
self.set_next_enabled.emit(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 = get_home_dir()
wdhistory = [workdir]
return wdhistory
def save_wdhistory(self):
"""Save history to a text file in user home directory"""
text = [ to_text_string( self.pathedit.itemText(index) ) \
for index in range(self.pathedit.count()) ]
encoding.writelines(text, self.LOG_PATH)
@Slot()
def select_directory(self):
"""Select directory"""
self.redirect_stdio.emit(False)
directory = getexistingdirectory(self.main, _("Select directory"),
getcwd())
if directory:
self.chdir(directory)
self.redirect_stdio.emit(True)
@Slot()
def previous_directory(self):
"""Back to previous directory"""
self.histindex -= 1
self.chdir(directory='', browsing_history=True)
@Slot()
def next_directory(self):
"""Return to next directory"""
self.histindex += 1
self.chdir(directory='', browsing_history=True)
@Slot()
def parent_directory(self):
"""Change working directory to parent directory"""
self.chdir(os.path.join(getcwd(), os.path.pardir))
@Slot(str)
@Slot(str, bool)
@Slot(str, bool, bool)
def chdir(self, directory, browsing_history=False, refresh_explorer=True):
"""Set directory as working directory"""
if directory:
directory = osp.abspath(to_text_string(directory))
# Working directory history management
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(to_text_string(directory))
self.refresh_plugin()
if refresh_explorer:
self.set_explorer_cwd.emit(directory)
self.set_as_current_console_wd()
self.refresh_findinfiles.emit()
def set_as_current_console_wd(self):
"""Set as current console working directory"""
self.set_current_console_wd.emit(getcwd())
class WorkingDirectory(SpyderPluginWidget):
"""Working directory changer plugin."""
CONF_SECTION = 'workingdir'
CONFIGWIDGET_CLASS = WorkingDirectoryConfigPage
LOG_PATH = get_conf_path(CONF_SECTION)
set_previous_enabled = Signal(bool)
set_next_enabled = Signal(bool)
redirect_stdio = Signal(bool)
set_explorer_cwd = Signal(str)
refresh_findinfiles = Signal()
set_current_console_wd = Signal(str)
def __init__(self, parent, workdir=None, **kwds):
SpyderPluginWidget.__init__(self, parent)
self.hide()
self.toolbar = QToolBar(self)
# Initialize plugin
self.initialize_plugin()
self.options_button.hide()
self.toolbar.setWindowTitle(self.get_plugin_title())
# Used to save Window state
self.toolbar.setObjectName(self.get_plugin_title())
# Previous dir action
self.history = []
self.histindex = None
self.previous_action = create_action(self, "previous", None,
ima.icon('previous'), _('Back'),
triggered=self.previous_directory)
self.toolbar.addAction(self.previous_action)
# Next dir action
self.next_action = create_action(self, "next", None,
ima.icon('next'), _('Next'),
triggered=self.next_directory)
self.toolbar.addAction(self.next_action)
# Enable/disable previous/next actions
self.set_previous_enabled.connect(self.previous_action.setEnabled)
self.set_next_enabled.connect(self.next_action.setEnabled)
# Path combo box
adjust = self.get_option('working_dir_adjusttocontents')
self.pathedit = PathComboBox(self, adjust_to_contents=adjust)
self.pathedit.setToolTip(_("This is the working directory for newly\n"
"opened consoles (Python/IPython consoles and\n"
"terminals), for the file explorer, for the\n"
"find in files plugin and for new files\n"
"created in the editor"))
self.pathedit.open_dir.connect(self.chdir)
self.pathedit.activated[str].connect(self.chdir)
self.pathedit.setMaxCount(self.get_option('working_dir_history'))
wdhistory = self.load_wdhistory(workdir)
if workdir is None:
if self.get_option('console/use_project_or_home_directory'):
workdir = get_home_dir()
else:
workdir = self.get_option('console/fixed_directory', default='')
if not osp.isdir(workdir):
workdir = get_home_dir()
self.chdir(workdir)
self.pathedit.addItems(wdhistory)
self.pathedit.selected_text = self.pathedit.currentText()
self.refresh_plugin()
self.toolbar.addWidget(self.pathedit)
# Browse action
browse_action = create_action(self, "browse", None,
ima.icon('DirOpenIcon'),
_('Browse a working directory'),
triggered=self.select_directory)
self.toolbar.addAction(browse_action)
# Parent dir action
parent_action = create_action(self, "parent", None,
ima.icon('up'),
_('Change to parent directory'),
triggered=self.parent_directory)
self.toolbar.addAction(parent_action)
#------ SpyderPluginWidget API ---------------------------------------------
def get_plugin_title(self):
"""Return widget title"""
return _('Current working directory')
def get_plugin_icon(self):
"""Return widget icon"""
return ima.icon('DirOpenIcon')
def get_plugin_actions(self):
"""Setup actions"""
return [None, None]
def register_plugin(self):
"""Register plugin in Spyder's main window"""
self.redirect_stdio.connect(self.main.redirect_internalshell_stdio)
self.main.console.shell.refresh.connect(self.refresh_plugin)
iconsize = 24
self.toolbar.setIconSize(QSize(iconsize, iconsize))
self.main.addToolBar(self.toolbar)
def refresh_plugin(self):
"""Refresh widget"""
curdir = getcwd_or_home()
self.pathedit.add_text(curdir)
self.save_wdhistory()
self.set_previous_enabled.emit(
self.histindex is not None and self.histindex > 0)
self.set_next_enabled.emit(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 = get_home_dir()
wdhistory = [ workdir ]
return wdhistory
def save_wdhistory(self):
"""Save history to a text file in user home directory"""
text = [ to_text_string( self.pathedit.itemText(index) ) \
for index in range(self.pathedit.count()) ]
try:
encoding.writelines(text, self.LOG_PATH)
except EnvironmentError:
pass
@Slot()
def select_directory(self):
"""Select directory"""
self.redirect_stdio.emit(False)
directory = getexistingdirectory(self.main, _("Select directory"),
getcwd_or_home())
if directory:
self.chdir(directory)
self.redirect_stdio.emit(True)
@Slot()
def previous_directory(self):
"""Back to previous directory"""
self.histindex -= 1
self.chdir(directory='', browsing_history=True)
@Slot()
def next_directory(self):
"""Return to next directory"""
self.histindex += 1
self.chdir(directory='', browsing_history=True)
@Slot()
def parent_directory(self):
"""Change working directory to parent directory"""
self.chdir(os.path.join(getcwd_or_home(), os.path.pardir))
@Slot(str)
@Slot(str, bool)
@Slot(str, bool, bool)
@Slot(str, bool, bool, bool)
def chdir(self, directory, browsing_history=False,
refresh_explorer=True, refresh_console=True):
"""Set directory as working directory"""
if directory:
directory = osp.abspath(to_text_string(directory))
# Working directory history management
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
try:
os.chdir(directory)
if refresh_explorer:
self.set_explorer_cwd.emit(directory)
if refresh_console:
self.set_current_console_wd.emit(directory)
self.refresh_findinfiles.emit()
except OSError:
self.history.pop(self.histindex)
self.refresh_plugin()
class TyphosSidebarItem(ptypes.ParameterItem):
"""
Class to display a Device or Tool in the sidebar
"""
def __init__(self, param, depth):
super().__init__(param, depth)
# Configure a QToolbar
self.toolbar = QToolBar()
self.toolbar.setToolButtonStyle(Qt.ToolButtonIconOnly)
self.toolbar.setIconSize(QSize(15, 15))
# Setup the action to open the widget
self.open_action = QAction(qta.icon('fa.square', color='green'),
'Open', self.toolbar)
self.open_action.triggered.connect(self.open_requested)
# Setup the action to embed the widget
self.embed_action = QAction(qta.icon('fa.th-large', color='yellow'),
'Embed', self.toolbar)
self.embed_action.triggered.connect(self.embed_requested)
# Setup the action to hide the widget
self.hide_action = QAction(qta.icon('fa.times-circle', color='red'),
'Close', self.toolbar)
self.hide_action.triggered.connect(self.hide_requested)
self.hide_action.setEnabled(False)
# Add actions to toolbars
self.toolbar.addAction(self.open_action)
self.toolbar.addAction(self.hide_action)
if self.param.embeddable:
self.toolbar.insertAction(self.hide_action, self.embed_action)
def open_requested(self, triggered):
"""Request to open display for sidebar item"""
self.param.sigOpen.emit(self)
self._mark_shown()
def embed_requested(self, triggered):
"""Request to open embedded display for sidebar item"""
self.param.sigEmbed.emit(self)
self._mark_shown()
def hide_requested(self, triggered):
"""Request to hide display for sidebar item"""
self.param.sigHide.emit(self)
self._mark_hidden()
def _mark_shown(self):
self.open_action.setEnabled(False)
self.embed_action.setEnabled(False)
self.hide_action.setEnabled(True)
def _mark_hidden(self):
self.open_action.setEnabled(True)
self.embed_action.setEnabled(True)
self.hide_action.setEnabled(False)
def treeWidgetChanged(self):
"""Update the widget when add to a QTreeWidget"""
super().treeWidgetChanged()
tree = self.treeWidget()
if tree is None:
return
tree.setItemWidget(self, 1, self.toolbar)
class DockWidgetPrivate:
public: 'DockWidget'
layout: QBoxLayout
widget: QWidget
tab_widget: 'DockWidgetTab'
features: DockWidgetFeature
dock_manager: 'DockManager'
dock_area: 'DockAreaWidget'
toggle_view_action: QAction
closed: bool
scroll_area: QScrollArea
tool_bar: QToolBar
tool_bar_style_docked: int
tool_bar_style_floating: int
tool_bar_icon_size_docked: QSize
tool_bar_icon_size_floating: QSize
is_floating_top_level: bool
def __init__(self, public: 'DockWidget'):
self.public = public
self.layout = None
self.widget = None
self.tab_widget = None
self.features = DockWidgetFeature.all_features
self.dock_manager = None
self.dock_area = None
self.toggle_view_action = None
self.closed = False
self.scroll_area = None
self.tool_bar = None
self.tool_bar_style_docked = Qt.ToolButtonIconOnly
self.tool_bar_style_floating = Qt.ToolButtonTextUnderIcon
self.tool_bar_icon_size_docked = QSize(16, 16)
self.tool_bar_icon_size_floating = QSize(24, 24)
self.is_floating_top_level = False
def show_dock_widget(self):
'''
Show dock widget
'''
from .floating_dock_container import FloatingDockContainer
if not self.dock_area:
floating_widget = FloatingDockContainer(dock_widget=self.public)
floating_widget.resize(self.public.size())
floating_widget.show()
return
self.dock_area.toggle_view(True)
self.dock_area.set_current_dock_widget(self.public)
self.tab_widget.show()
splitter = find_parent(QSplitter, self.dock_area)
while splitter and not splitter.isVisible():
splitter.show()
splitter = find_parent(QSplitter, splitter)
container = self.dock_area.dock_container()
if container.is_floating():
floating_widget = find_parent(FloatingDockContainer, container)
floating_widget.show()
def hide_dock_widget(self):
'''
Hide dock widget.
'''
self.tab_widget.hide()
self.update_parent_dock_area()
def update_parent_dock_area(self):
'''
Hides a dock area if all dock widgets in the area are closed. This
function updates the current selected tab and hides the parent dock
area if it is empty
'''
if not self.dock_area:
return
next_dock_widget = self.dock_area.next_open_dock_widget(self.public)
if next_dock_widget is not None:
self.dock_area.set_current_dock_widget(next_dock_widget)
else:
self.dock_area.hide_area_with_no_visible_content()
def setup_tool_bar(self):
'''
Setup the top tool bar
'''
self.tool_bar = QToolBar(self.public)
self.tool_bar.setObjectName("dockWidgetToolBar")
self.layout.insertWidget(0, self.tool_bar)
self.tool_bar.setIconSize(QSize(16, 16))
self.tool_bar.toggleViewAction().setEnabled(False)
self.tool_bar.toggleViewAction().setVisible(False)
self.public.top_level_changed.connect(self.public.set_toolbar_floating_style)
def setup_scroll_area(self):
'''
Setup the main scroll area
'''
self.scroll_area = QScrollArea(self.public)
self.scroll_area.setObjectName("dockWidgetScrollArea")
self.scroll_area.setWidgetResizable(True)
self.layout.addWidget(self.scroll_area)
