Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PR: Add function/class search shortcut, menu and toolbar entries #3878

Merged
merged 11 commits into from
Jan 10, 2017
Merged

PR: Add function/class search shortcut, menu and toolbar entries #3878

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
e2051bd
Now can invoke symbol finder via Ctrl+Alt+P
andfoy Dec 22, 2016
318a9d3
Minor correction update in default configuration example file
andfoy Dec 22, 2016
57ac0f1
PEP8 style corrections
andfoy Dec 23, 2016
e8ae93b
PEP8 style corrections
andfoy Dec 23, 2016
c668115
Reset defaults file
andfoy Dec 23, 2016
08ead8e
Merge remote-tracking branch 'upstream/3.x' into symbolfindershort
andfoy Dec 23, 2016
28a20c3
Removed show/hide project explorer shortcut
andfoy Dec 23, 2016
388e7b1
PEP8 style issues corrected
andfoy Dec 23, 2016
df9d53e
PEP8 style issues corrected
andfoy Dec 23, 2016
684b3fa
Merge branch '3.x' into symbolfindershort
ccordoba12 Jan 10, 2017
dc5e91f
Config: Bump CONF_VERSION because of the removed option
ccordoba12 Jan 10, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion spyder/config/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,7 @@
'_/quit': "Ctrl+Q",
# -- In plugins/editor
'_/file switcher': 'Ctrl+P',
'_/symbol finder': 'Ctrl+Alt+P',
'_/debug': "Ctrl+F5",
'_/debug step over': "Ctrl+F10",
'_/debug continue': "Ctrl+F12",
Expand Down Expand Up @@ -426,7 +427,7 @@
'editor/run cell and advance': RUN_CELL_AND_ADVANCE_SHORTCUT,
# -- In plugins/editor.py
'editor/show/hide outline': "Ctrl+Alt+O",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this shortcut is no more needed because

  1. If Spyder has no project active, the Project explorer is empty.
  2. If the project is active, I think users would expect the Project explorer to be visible all the time.

@goanpeca, what do you think?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, then @andfoy please remove this shortcut as part of this PR.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the project is active, I think users would expect the Project explorer to be visible all the time.

I don't mind that much about the shortcut, but I don't expect the Project explorer to be visible all the time. I actually close the Project explorer when working on my laptop because the screen is not big enough, and I find it pretty annoying that it always comes back when I launch Spyder. Even on my desktop screen, which is big enough, I don't find the Project explorer particularly useful - I only use it when opening files.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, the Project Explorer can be closed at any time, so it's not enforced on users. It's just a visual clue that you're working on a project.

I find it pretty annoying that it always comes back when I launch Spyder

Please submit a PR to fix that. I don't have a problem with it :-)

'editor/show/hide project explorer': "Ctrl+Alt+P",
'editor/show/hide project explorer': "Ctrl+Alt+J",
# -- In Breakpoints
'_/switch to breakpoints': "Ctrl+Shift+B",
# ---- Consoles (in widgets/shell) ----
Expand Down
3 changes: 2 additions & 1 deletion spyder/defaults/defaults-3.0.0.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,8 @@ _/debug step into = Ctrl+F11
_/fullscreen mode = F11
editor/toggle comment = Ctrl+1
editor/go to definition = Ctrl+G
editor/show/hide project explorer = Ctrl+Alt+P
editor/show/hide project explorer = Ctrl+Alt+J
_/symbol finder = Ctrl+Alt+P
_/debug step return = Ctrl+Shift+F11
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ccordoba12 I thought we were supposed to not touch these files?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry! I thought that file should be modified because a default shortcut was altered and a new one was introduced in this PR

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/spyder-ide/spyder/tree/master/spyder/defaults

:-)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, should I remove those edits?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep

editor/new file = Ctrl+N
_/debug step over = Ctrl+F10
Expand Down
17 changes: 16 additions & 1 deletion spyder/plugins/editor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -651,6 +651,14 @@ def get_plugin_actions(self):
self.register_shortcut(self.file_switcher_action, context="_",
name="File switcher", add_sc_to_tip=True)

self.symbol_finder_action = create_action(self, _('Symbol finder...'),
icon=ima.icon('symbol_find'),
tip=_('Fast symbol search in file'),
triggered=self.call_symbol_finder,
context=Qt.ApplicationShortcut)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not saying you should change this, just a comment for reference.

# I tend to favor this one for several reasons. 
# It can be automatically performed and enforced by tools like yapf
# it results in more lines of code but ir more readable as each line corresponds 
# to a parameter
self.symbol_finder_action = create_action(
    self,
    _('Symbol finder...'),
    icon=ima.icon('symbol_find'),
    tip=_('Fast symbol search in file'),
    triggered=self.call_symbol_finder,
    context=Qt.ApplicationShortcut)

# or 

self.symbol_finder_action = create_action(self,
                                          _('Symbol finder...'),
                                          icon=ima.icon('symbol_find'),
                                          tip=_('Fast symbol search in file'),
                                          triggered=self.call_symbol_finder,
                                          context=Qt.ApplicationShortcut)

self.register_shortcut(self.symbol_finder_action, context="_",
name="symbol finder", add_sc_to_tip=True)

self.revert_action = create_action(self, _("&Revert"),
icon=ima.icon('revert'), tip=_("Revert file from disk"),
triggered=self.revert)
Expand Down Expand Up @@ -995,6 +1003,7 @@ def get_plugin_actions(self):
self.save_all_action,
save_as_action,
self.file_switcher_action,
self.symbol_finder_action,
self.revert_action,
MENU_SEPARATOR,
print_preview_action,
Expand All @@ -1007,7 +1016,8 @@ def get_plugin_actions(self):
self.main.file_menu_actions += file_menu_actions
file_toolbar_actions = [self.new_action, self.open_action,
self.save_action, self.save_all_action,
self.file_switcher_action]
self.file_switcher_action,
self.symbol_finder_action]
self.main.file_toolbar_actions += file_toolbar_actions

# ---- Find menu/toolbar construction ----
Expand Down Expand Up @@ -1725,6 +1735,11 @@ def call_file_switcher(self):
if self.editorstacks:
self.get_current_editorstack().open_fileswitcher_dlg()

@Slot()
def call_symbol_finder(self):
if self.editorstacks:
self.get_current_editorstack().open_symbolfinder_dlg()

def update_recent_file_menu(self):
"""Update recent file menu"""
recent_files = []
Expand Down
1 change: 1 addition & 0 deletions spyder/utils/icon_manager.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,7 @@
'spyder.autopep8': [('fa.eye',), {}],
'spyder.memory_profiler': [('fa.eye',), {}],
'spyder.line_profiler': [('fa.eye',), {}],
'symbol_find': [('fa.at',), {}]
}


Expand Down
10 changes: 10 additions & 0 deletions spyder/widgets/editor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,6 +346,10 @@ def __init__(self, parent, actions):
fileswitcher_action = create_action(self, _("File switcher..."),
icon=ima.icon('filelist'),
triggered=self.open_fileswitcher_dlg)
symbolfinder_action = create_action(self,
_("Find symbols in file..."),
icon=ima.icon('filelist'),
triggered=self.open_symbolfinder_dlg)
copy_to_cb_action = create_action(self, _("Copy path to clipboard"),
icon=ima.icon('editcopy'),
triggered=lambda:
Expand All @@ -356,6 +360,7 @@ def __init__(self, parent, actions):
triggered=self.close_all_but_this)

self.menu_actions = actions + [None, fileswitcher_action,
symbolfinder_action,
copy_to_cb_action, None, close_right,
close_all_but_this]
self.outlineexplorer = None
Expand Down Expand Up @@ -617,6 +622,11 @@ def open_fileswitcher_dlg(self):
self.fileswitcher_dlg.show()
self.fileswitcher_dlg.is_visible = True

@Slot()
def open_symbolfinder_dlg(self):
self.open_fileswitcher_dlg()
self.fileswitcher_dlg.set_search_text('@')

def update_fileswitcher_dlg(self):
"""Synchronize file list dialog box with editor widget tabs"""
if self.fileswitcher_dlg:
Expand Down
3 changes: 3 additions & 0 deletions spyder/widgets/fileswitcher.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,6 +316,9 @@ def filter_text(self):
"""Get the normalized (lowecase) content of the filter text."""
return to_text_string(self.edit.text()).lower()

def set_search_text(self, _str):
self.edit.setText(_str)

def save_initial_state(self):
"""Saves initial cursors and initial active editor."""
paths = self.paths
Expand Down