class FindInFiles(SpyderPluginWidget):
"""Find in files DockWidget."""
CONF_SECTION = 'find_in_files'
sig_option_changed = Signal(str, object)
toggle_visibility = Signal(bool)
def __init__(self, parent=None):
"""Initialization."""
SpyderPluginWidget.__init__(self, parent)
supported_encodings = self.get_option('supported_encodings')
search_path = self.get_option('search_path', None)
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')
in_python_path = self.get_option('in_python_path')
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, search_path, exclude,
exclude_idx, exclude_regexp, supported_encodings, in_python_path,
more_options, case_sensitive, path_history)
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())
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 []
def register_plugin(self):
"""Register plugin in Spyder's main window"""
self.findinfiles.get_pythonpath_callback = \
self.main.get_spyder_pythonpath
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.findinfiles_callback,
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(all=True)
if options is not None:
(search_text, text_re, search_path, exclude, exclude_idx,
exclude_re, in_python_path, more_options, case_sensitive,
path_history) = options
hist_limit = 15
search_text = search_text[:hist_limit]
search_path = search_path[: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('search_path', search_path)
self.set_option('exclude', exclude)
self.set_option('exclude_idx', exclude_idx)
self.set_option('exclude_regexp', exclude_re)
self.set_option('in_python_path', in_python_path)
self.set_option('more_options', more_options)
self.set_option('case_sensitive', case_sensitive)
self.set_option('path_history', path_history)
return True
class FindInFiles(SpyderPluginWidget):
"""Find in files DockWidget."""
CONF_SECTION = 'find_in_files'
sig_option_changed = Signal(str, object)
toggle_visibility = Signal(bool)
def __init__(self, parent=None):
"""Initialization."""
SpyderPluginWidget.__init__(self, parent)
supported_encodings = self.get_option('supported_encodings')
search_path = self.get_option('search_path', None)
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')
in_python_path = self.get_option('in_python_path')
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, search_path,
exclude, exclude_idx, exclude_regexp,
supported_encodings,
in_python_path, more_options,
case_sensitive, path_history)
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())
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 []
def register_plugin(self):
"""Register plugin in Spyder's main window"""
self.findinfiles.get_pythonpath_callback = \
self.main.get_spyder_pythonpath
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.findinfiles_callback,
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(all=True)
if options is not None:
(search_text, text_re, search_path,
exclude, exclude_idx, exclude_re,
in_python_path, more_options, case_sensitive,
path_history) = options
hist_limit = 15
search_text = search_text[:hist_limit]
search_path = search_path[: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('search_path', search_path)
self.set_option('exclude', exclude)
self.set_option('exclude_idx', exclude_idx)
self.set_option('exclude_regexp', exclude_re)
self.set_option('in_python_path', in_python_path)
self.set_option('more_options', more_options)
self.set_option('case_sensitive', case_sensitive)
self.set_option('path_history', path_history)
return True
class FindInFiles(SpyderPluginWidget):
"""Find in files DockWidget."""
CONF_SECTION = 'find_in_files'
sig_option_changed = Signal(str, object)
toggle_visibility = Signal(bool)
def __init__(self, parent=None):
"""Initialization."""
SpyderPluginWidget.__init__(self, parent)
supported_encodings = self.get_option('supported_encodings')
search_path = self.get_option('search_path', None)
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')
include = self.get_option('include')
if not include:
include = self.include_patterns()
include_idx = self.get_option('include_idx', None)
include_regexp = self.get_option('include_regexp')
exclude = self.get_option('exclude')
exclude_idx = self.get_option('exclude_idx', None)
exclude_regexp = self.get_option('exclude_regexp')
in_python_path = self.get_option('in_python_path')
more_options = self.get_option('more_options')
self.findinfiles = FindInFilesWidget(
self, search_text, search_text_regexp, search_path, include,
include_idx, include_regexp, exclude, exclude_idx, exclude_regexp,
supported_encodings, in_python_path, more_options)
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())
@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()
@staticmethod
def include_patterns():
"""Generate regex common usage patterns to include section."""
# Change special characters, like + and . to convert into valid re
clean_exts = []
for ext in get_edit_extensions():
ext = ext.replace('.', r'\.')
ext = ext.replace('+', r'\+')
clean_exts.append(ext)
patterns = [
r'|'.join([ext + r'$'
for ext in clean_exts if ext]) + r'|README|INSTALL',
r'\.ipy$|\.pyw?$|\.rst$|\.txt$',
'.',
]
return patterns
#------ 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 []
def register_plugin(self):
"""Register plugin in Spyder's main window"""
self.findinfiles.get_pythonpath_callback = \
self.main.get_spyder_pythonpath
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)
findinfiles_action = create_action(
self,
_("&Find in files"),
icon=ima.icon('findf'),
triggered=self.findinfiles_callback,
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(all=True)
if options is not None:
search_text, text_re, search_path, \
include, include_idx, include_re, \
exclude, exclude_idx, exclude_re, \
in_python_path, more_options = options
hist_limit = 15
search_text = search_text[:hist_limit]
search_path = search_path[:hist_limit]
include = include[:hist_limit]
exclude = exclude[:hist_limit]
self.set_option('search_text', search_text)
self.set_option('search_text_regexp', text_re)
self.set_option('search_path', search_path)
self.set_option('include', include)
self.set_option('include_idx', include_idx)
self.set_option('include_regexp', include_re)
self.set_option('exclude', exclude)
self.set_option('exclude_idx', exclude_idx)
self.set_option('exclude_regexp', exclude_re)
self.set_option('in_python_path', in_python_path)
self.set_option('more_options', more_options)
return True