def setup_findinfiles(qtbot, *args, **kwargs):
"""Set up find in files widget."""
widget = FindInFilesWidget(None, *args, **kwargs)
widget.resize(640, 480)
qtbot.addWidget(widget)
widget.show()
return widget
def __init__(self, parent=None):
"""Initialization."""
super().__init__(parent)
supported_encodings = self.get_option('supported_encodings')
self.search_text_samples = self.get_option('search_text_samples')
search_text = self.get_option('search_text')
search_text = [
txt for txt in search_text if txt not in self.search_text_samples
]
search_text += self.search_text_samples
search_text_regexp = self.get_option('search_text_regexp')
exclude = self.get_option('exclude')
exclude_idx = self.get_option('exclude_idx', None)
exclude_regexp = self.get_option('exclude_regexp')
more_options = self.get_option('more_options')
case_sensitive = self.get_option('case_sensitive')
path_history = self.get_option('path_history', [])
search_in_index = self.get_option('search_in_index', default=0)
max_results = self.get_option('max_results')
self.findinfiles = FindInFilesWidget(
self,
search_text,
search_text_regexp,
exclude,
exclude_idx,
exclude_regexp,
supported_encodings,
more_options,
case_sensitive,
path_history,
search_in_index,
options_button=self.options_button,
text_color=ima.MAIN_FG_COLOR,
max_results=max_results)
layout = QVBoxLayout()
layout.addWidget(self.findinfiles)
self.setLayout(layout)
self.toggle_visibility.connect(self.toggle)
def setup_findinfiles(qtbot, *args, **kwargs):
"""Set up find in files widget."""
widget = FindInFilesWidget(None, *args, **kwargs)
widget.resize(640, 480)
qtbot.addWidget(widget)
widget.show()
return widget
def __init__(self, parent=None):
"""Initialization."""
SpyderPluginWidget.__init__(self, parent)
supported_encodings = self.get_option('supported_encodings')
self.search_text_samples = self.get_option('search_text_samples')
search_text = self.get_option('search_text')
search_text = [txt for txt in search_text \
if txt not in self.search_text_samples]
search_text += self.search_text_samples
search_text_regexp = self.get_option('search_text_regexp')
exclude = self.get_option('exclude')
exclude_idx = self.get_option('exclude_idx', None)
exclude_regexp = self.get_option('exclude_regexp')
more_options = self.get_option('more_options')
case_sensitive = self.get_option('case_sensitive')
path_history = self.get_option('path_history', [])
self.findinfiles = FindInFilesWidget(
self,
search_text,
search_text_regexp,
exclude,
exclude_idx,
exclude_regexp,
supported_encodings,
more_options,
case_sensitive,
path_history,
options_button=self.options_button)
layout = QVBoxLayout()
layout.addWidget(self.findinfiles)
self.setLayout(layout)
# Initialize plugin
self.initialize_plugin()
self.toggle_visibility.connect(self.toggle)
def findinfiles(qtbot, request):
"""Set up find in files widget."""
if getattr(request, 'param', False):
param = request.param
else:
param = None
if param:
widget = FindInFilesWidget(None, **param)
else:
widget = FindInFilesWidget(None)
widget.resize(640, 480)
qtbot.addWidget(widget)
widget.show()
return widget
def findinfiles(qtbot, request):
"""Set up find in files widget."""
if getattr(request, 'param', False):
param = request.param
else:
param = None
if param:
widget = FindInFilesWidget(None, **param)
else:
widget = FindInFilesWidget(None)
widget.resize(640, 480)
qtbot.addWidget(widget)
widget.show()
return widget
def __init__(self, parent=None):
"""Initialization."""
SpyderPluginWidget.__init__(self, parent)
supported_encodings = self.get_option('supported_encodings')
self.search_text_samples = self.get_option('search_text_samples')
search_text = self.get_option('search_text')
search_text = [txt for txt in search_text \
if txt not in self.search_text_samples]
search_text += self.search_text_samples
search_text_regexp = self.get_option('search_text_regexp')
exclude = self.get_option('exclude')
exclude_idx = self.get_option('exclude_idx', None)
exclude_regexp = self.get_option('exclude_regexp')
more_options = self.get_option('more_options')
case_sensitive = self.get_option('case_sensitive')
path_history = self.get_option('path_history', [])
self.findinfiles = FindInFilesWidget(
self,
search_text, search_text_regexp,
exclude, exclude_idx, exclude_regexp,
supported_encodings,
more_options,
case_sensitive, path_history,
options_button=self.options_button,
text_color=ima.MAIN_FG_COLOR)
layout = QVBoxLayout()
layout.addWidget(self.findinfiles)
self.setLayout(layout)
# Initialize plugin
self.initialize_plugin()
self.toggle_visibility.connect(self.toggle)
def findinfiles(qtbot, request):
"""Set up find in files widget."""
if getattr(request, 'param', False):
param = request.param
else:
param = None
if param:
options = FindInFilesWidget.DEFAULT_OPTIONS.copy()
options.update(param)
widget = FindInFilesWidget('find_in_files', options=options)
widget._setup(options=options)
widget.setup(options=options)
else:
widget = FindInFilesWidget('find_in_files')
widget._setup()
widget.setup()
widget.resize(640, 480)
qtbot.addWidget(widget)
widget.show()
return widget
class FindInFiles(SpyderPluginWidget):
"""Find in files DockWidget."""
CONF_SECTION = 'find_in_files'
toggle_visibility = Signal(bool)
def __init__(self, parent=None):
"""Initialization."""
SpyderPluginWidget.__init__(self, parent)
supported_encodings = self.get_option('supported_encodings')
self.search_text_samples = self.get_option('search_text_samples')
search_text = self.get_option('search_text')
search_text = [txt for txt in search_text \
if txt not in self.search_text_samples]
search_text += self.search_text_samples
search_text_regexp = self.get_option('search_text_regexp')
exclude = self.get_option('exclude')
exclude_idx = self.get_option('exclude_idx', None)
exclude_regexp = self.get_option('exclude_regexp')
more_options = self.get_option('more_options')
case_sensitive = self.get_option('case_sensitive')
path_history = self.get_option('path_history', [])
self.findinfiles = FindInFilesWidget(
self,
search_text,
search_text_regexp,
exclude,
exclude_idx,
exclude_regexp,
supported_encodings,
more_options,
case_sensitive,
path_history,
options_button=self.options_button,
text_color=ima.MAIN_FG_COLOR)
layout = QVBoxLayout()
layout.addWidget(self.findinfiles)
self.setLayout(layout)
# Initialize plugin
self.initialize_plugin()
self.toggle_visibility.connect(self.toggle)
def toggle(self, state):
"""Toggle widget visibility"""
if self.dockwidget:
self.dockwidget.setVisible(state)
def refreshdir(self):
"""Refresh search directory"""
self.findinfiles.find_options.set_directory(getcwd_or_home())
def set_project_path(self, path):
"""Refresh current project path"""
self.findinfiles.find_options.set_project_path(path)
def set_current_opened_file(self, path):
"""Get path of current opened file in editor"""
self.findinfiles.find_options.set_file_path(path)
def unset_project_path(self):
"""Refresh current project path"""
self.findinfiles.find_options.disable_project_search()
@Slot()
def findinfiles_callback(self):
"""Find in files callback"""
widget = QApplication.focusWidget()
if not self.ismaximized:
self.dockwidget.setVisible(True)
self.dockwidget.raise_()
text = ''
try:
if widget.has_selected_text():
text = widget.get_selected_text()
except AttributeError:
# This is not a text widget deriving from TextEditBaseWidget
pass
self.findinfiles.set_search_text(text)
if text:
self.findinfiles.find()
#------ SpyderPluginMixin API ---------------------------------------------
def switch_to_plugin(self):
"""Switch to plugin
This method is called when pressing plugin's shortcut key"""
self.findinfiles_callback() # Necessary at least with PyQt5 on Windows
super(SpyderPluginWidget, self).switch_to_plugin()
#------ SpyderPluginWidget API --------------------------------------------
def get_plugin_title(self):
"""Return widget title"""
return _("Find in files")
def get_focus_widget(self):
"""
Return the widget to give focus to when
this plugin's dockwidget is raised on top-level
"""
return self.findinfiles.find_options.search_text
def get_plugin_actions(self):
"""Return a list of actions related to plugin"""
return self.findinfiles.result_browser.get_menu_actions()
def register_plugin(self):
"""Register plugin in Spyder's main window"""
self.main.add_dockwidget(self)
self.findinfiles.result_browser.sig_edit_goto.connect(
self.main.editor.load)
self.findinfiles.find_options.redirect_stdio.connect(
self.main.redirect_internalshell_stdio)
self.main.workingdirectory.refresh_findinfiles.connect(self.refreshdir)
self.main.projects.sig_project_loaded.connect(self.set_project_path)
self.main.projects.sig_project_closed.connect(self.unset_project_path)
self.main.editor.open_file_update.connect(self.set_current_opened_file)
findinfiles_action = create_action(
self,
_("&Find in files"),
icon=ima.icon('findf'),
triggered=self.switch_to_plugin,
shortcut=QKeySequence(self.shortcut),
context=Qt.WidgetShortcut,
tip=_("Search text in multiple files"))
self.main.search_menu_actions += [MENU_SEPARATOR, findinfiles_action]
self.main.search_toolbar_actions += [
MENU_SEPARATOR, findinfiles_action
]
self.refreshdir()
def refresh_plugin(self):
"""Refresh widget"""
pass
def closing_plugin(self, cancelable=False):
"""Perform actions before parent main window is closed"""
self.findinfiles.closing_widget() # stop search thread and clean-up
options = self.findinfiles.find_options.get_options(to_save=True)
if options is not None:
(search_text, text_re, exclude, exclude_idx, exclude_re,
more_options, case_sensitive, path_history) = options
hist_limit = 15
search_text = search_text[:hist_limit]
exclude = exclude[:hist_limit]
path_history = path_history[-hist_limit:]
self.set_option('search_text', search_text)
self.set_option('search_text_regexp', text_re)
self.set_option('exclude', exclude)
self.set_option('exclude_idx', exclude_idx)
self.set_option('exclude_regexp', exclude_re)
self.set_option('more_options', more_options)
self.set_option('case_sensitive', case_sensitive)
self.set_option('path_history', path_history)
return True
def on_first_registration(self):
"""Action to be performed on first plugin registration"""
self.main.tabify_plugins(self.main.variableexplorer, self)
class FindInFiles(SpyderPluginWidget):
"""Find in files DockWidget."""
CONF_SECTION = 'find_in_files'
toggle_visibility = Signal(bool)
def __init__(self, parent=None):
"""Initialization."""
SpyderPluginWidget.__init__(self, parent)
supported_encodings = self.get_option('supported_encodings')
self.search_text_samples = self.get_option('search_text_samples')
search_text = self.get_option('search_text')
search_text = [txt for txt in search_text \
if txt not in self.search_text_samples]
search_text += self.search_text_samples
search_text_regexp = self.get_option('search_text_regexp')
exclude = self.get_option('exclude')
exclude_idx = self.get_option('exclude_idx', None)
exclude_regexp = self.get_option('exclude_regexp')
more_options = self.get_option('more_options')
case_sensitive = self.get_option('case_sensitive')
path_history = self.get_option('path_history', [])
self.findinfiles = FindInFilesWidget(
self,
search_text, search_text_regexp,
exclude, exclude_idx, exclude_regexp,
supported_encodings,
more_options,
case_sensitive, path_history,
options_button=self.options_button,
text_color=ima.MAIN_FG_COLOR)
layout = QVBoxLayout()
layout.addWidget(self.findinfiles)
self.setLayout(layout)
# Initialize plugin
self.initialize_plugin()
self.toggle_visibility.connect(self.toggle)
def toggle(self, state):
"""Toggle widget visibility"""
if self.dockwidget:
self.dockwidget.setVisible(state)
def refreshdir(self):
"""Refresh search directory"""
self.findinfiles.find_options.set_directory(
getcwd_or_home())
def set_project_path(self, path):
"""Refresh current project path"""
self.findinfiles.find_options.set_project_path(path)
def set_current_opened_file(self, path):
"""Get path of current opened file in editor"""
self.findinfiles.find_options.set_file_path(path)
def unset_project_path(self):
"""Refresh current project path"""
self.findinfiles.find_options.disable_project_search()
@Slot()
def findinfiles_callback(self):
"""Find in files callback"""
widget = QApplication.focusWidget()
if not self.ismaximized:
self.dockwidget.setVisible(True)
self.dockwidget.raise_()
text = ''
try:
if widget.has_selected_text():
text = widget.get_selected_text()
except AttributeError:
# This is not a text widget deriving from TextEditBaseWidget
pass
self.findinfiles.set_search_text(text)
if text:
self.findinfiles.find()
#------ SpyderPluginMixin API ---------------------------------------------
def switch_to_plugin(self):
"""Switch to plugin
This method is called when pressing plugin's shortcut key"""
self.findinfiles_callback() # Necessary at least with PyQt5 on Windows
super(SpyderPluginWidget, self).switch_to_plugin()
#------ SpyderPluginWidget API --------------------------------------------
def get_plugin_title(self):
"""Return widget title"""
return _("Find in files")
def get_focus_widget(self):
"""
Return the widget to give focus to when
this plugin's dockwidget is raised on top-level
"""
return self.findinfiles.find_options.search_text
def get_plugin_actions(self):
"""Return a list of actions related to plugin"""
return self.findinfiles.result_browser.get_menu_actions()
def register_plugin(self):
"""Register plugin in Spyder's main window"""
self.main.add_dockwidget(self)
self.findinfiles.result_browser.sig_edit_goto.connect(
self.main.editor.load)
self.findinfiles.find_options.redirect_stdio.connect(
self.main.redirect_internalshell_stdio)
self.main.workingdirectory.refresh_findinfiles.connect(self.refreshdir)
self.main.projects.sig_project_loaded.connect(self.set_project_path)
self.main.projects.sig_project_closed.connect(self.unset_project_path)
self.main.editor.open_file_update.connect(self.set_current_opened_file)
findinfiles_action = create_action(
self, _("&Find in files"),
icon=ima.icon('findf'),
triggered=self.switch_to_plugin,
shortcut=QKeySequence(self.shortcut),
context=Qt.WidgetShortcut,
tip=_("Search text in multiple files"))
self.main.search_menu_actions += [MENU_SEPARATOR, findinfiles_action]
self.main.search_toolbar_actions += [MENU_SEPARATOR,
findinfiles_action]
self.refreshdir()
def refresh_plugin(self):
"""Refresh widget"""
pass
def closing_plugin(self, cancelable=False):
"""Perform actions before parent main window is closed"""
self.findinfiles.closing_widget() # stop search thread and clean-up
options = self.findinfiles.find_options.get_options(to_save=True)
if options is not None:
(search_text, text_re,
exclude, exclude_idx, exclude_re,
more_options, case_sensitive,
path_history) = options
hist_limit = 15
search_text = search_text[:hist_limit]
exclude = exclude[:hist_limit]
path_history = path_history[-hist_limit:]
self.set_option('search_text', search_text)
self.set_option('search_text_regexp', text_re)
self.set_option('exclude', exclude)
self.set_option('exclude_idx', exclude_idx)
self.set_option('exclude_regexp', exclude_re)
self.set_option('more_options', more_options)
self.set_option('case_sensitive', case_sensitive)
self.set_option('path_history', path_history)
return True
def on_first_registration(self):
"""Action to be performed on first plugin registration"""
self.main.tabify_plugins(self.main.variableexplorer, self)
def setup_findinfiles(qtbot, *args, **kwargs):
"""Set up find in files widget."""
widget = FindInFilesWidget(None, *args, **kwargs)
qtbot.addWidget(widget)
return widget
def findinfiles(qtbot, request):
"""Set up find in files widget."""
if getattr(request, 'param', False):
param = request.param
else:
param = None
plugin_mock = MagicMock()
plugin_mock.CONF_SECTION = 'find_in_files'
if param:
prev_values = {}
for param_name in param:
value = param[param_name]
prev_values[param_name] = CONF.get('find_in_files', param_name)
CONF.set('find_in_files', param_name, value)
widget = FindInFilesWidget('find_in_files', plugin=plugin_mock)
widget._setup()
widget.setup()
def teardown():
for param_name in prev_values:
value = prev_values[param_name]
CONF.set('find_in_files', param_name, value)
request.addfinalizer(teardown)
else:
widget = FindInFilesWidget('find_in_files', plugin=plugin_mock)
widget._setup()
widget.setup()
widget.resize(640, 480)
qtbot.addWidget(widget)
widget.show()
return widget