Skip to content

PR: Use new public API in Spyder 4 #198

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

Closed
ccordoba12 wants to merge 3 commits into from
Closed

PR: Use new public API in Spyder 4 #198

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9216c7b
Use new API to open notebooks directly from Spyder's 'Open file' dialog
ccordoba12 Feb 28, 2019
2036fca
Use switch_to_plugin when adding a new tab instead of raise
ccordoba12 Feb 28, 2019
c88909b
Use public API to save notebooks when pressing the Save button in Spy…
ccordoba12 Mar 2, 2019
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
92 changes: 52 additions & 40 deletions spyder_notebook/notebookplugin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

# Qt imports
from qtpy import PYQT4, PYSIDE
from qtpy.compat import getsavefilename, getopenfilenames
from qtpy.compat import getsavefilename
from qtpy.QtCore import Qt, QEventLoop, QTimer, Signal
from qtpy.QtGui import QIcon
from qtpy.QtWidgets import QApplication, QMessageBox, QVBoxLayout, QMenu
Expand Down Expand Up @@ -63,6 +63,12 @@ class NotebookPlugin(SpyderPluginWidget):
CONF_SECTION = 'notebook'
focus_changed = Signal()

# To open these file extensions directly here
file_extensions = ['.ipynb']

# Tell Spyder that this plugin is able to save files
can_save_files = True

def __init__(self, parent, testing=False):
"""Constructor."""
SpyderPluginWidget.__init__(self, parent)
Expand Down Expand Up @@ -114,7 +120,7 @@ def __init__(self, parent, testing=False):
layout.addWidget(self.tabwidget)
self.setLayout(layout)

# ------ SpyderPluginMixin API --------------------------------------------
# ------ SpyderPluginWidget API -------------------------------------------
def on_first_registration(self):
"""Action to be performed on first plugin registration."""
self.main.tabify_plugins(self.main.editor, self)
Expand All @@ -125,7 +131,6 @@ def update_font(self):
# this.
pass

# ------ SpyderPluginWidget API -------------------------------------------
def get_plugin_title(self):
"""Return widget title."""
title = _('Notebook')
Expand Down Expand Up @@ -169,10 +174,6 @@ def get_plugin_actions(self):
_("Save as..."),
icon=ima.icon('filesaveas'),
triggered=self.save_as)
open_action = create_action(self,
_("Open..."),
icon=ima.icon('fileopen'),
triggered=self.open_notebook)
self.open_console_action = create_action(self,
_("Open console"),
icon=ima.icon(
Expand All @@ -182,9 +183,11 @@ def get_plugin_actions(self):
create_action(self, _("Clear this list"),
triggered=self.clear_recent_notebooks)
# Plugin actions
self.menu_actions = [create_nb_action, open_action,
self.recent_notebook_menu, MENU_SEPARATOR,
self.save_as_action, MENU_SEPARATOR,
self.menu_actions = [create_nb_action,
self.recent_notebook_menu,
MENU_SEPARATOR,
self.save_as_action,
MENU_SEPARATOR,
self.open_console_action]
self.setup_menu_actions()

Expand Down Expand Up @@ -213,6 +216,10 @@ def check_compatibility(self):
value = False
return value, message

def open_file(self, filename):
"""Open notebooks using Spyder's 'Open file' dialog."""
self.create_new_client(filename=filename)

# ------ Public API (for clients) -----------------------------------------
def setup_menu_actions(self):
"""Setup and update the menu actions."""
Expand Down Expand Up @@ -365,24 +372,7 @@ def close_client(self, index=None, client=None, save=False):

is_welcome = client.get_filename() == WELCOME
if not save and not is_welcome:
client.save()
wait_save = QEventLoop()
QTimer.singleShot(1000, wait_save.quit)
wait_save.exec_()
path = client.get_filename()
fname = osp.basename(path)
nb_contents = nbformat.read(path, as_version=4)

if ('untitled' in fname and len(nb_contents['cells']) > 0 and
len(nb_contents['cells'][0]['source']) > 0):
buttons = QMessageBox.Yes | QMessageBox.No
answer = QMessageBox.question(self, self.get_plugin_title(),
_("<b>{0}</b> has been modified."
"<br>Do you want to "
"save changes?".format(fname)),
buttons)
if answer == QMessageBox.Yes:
self.save_as(close=True)
self.save_untitled()
if not is_welcome:
client.shutdown_kernel()
client.close()
Expand All @@ -409,6 +399,38 @@ def create_welcome_client(self):
self.add_tab(client)
return client

def save_file(self):
"""Save current notebook."""
client = self.get_current_client()
if 'untitled' in client.get_filename():
self.save_untitled()
else:
client.save()

def save_untitled(self):
"""Save operation for untitled notebooks."""
client = self.get_current_client()
client.save()
wait_save = QEventLoop()
QTimer.singleShot(1000, wait_save.quit)
wait_save.exec_()
path = client.get_filename()
fname = osp.basename(path)
nb_contents = nbformat.read(path, as_version=4)

if ('untitled' in fname and len(nb_contents['cells']) > 0 and
len(nb_contents['cells'][0]['source']) > 0):
buttons = QMessageBox.Yes | QMessageBox.No
answer = QMessageBox.question(
self,
self.get_plugin_title(),
_("<b>{0}</b> has been modified."
"<br>Do you want to "
"save changes?".format(fname)),
buttons)
if answer == QMessageBox.Yes:
self.save_as(close=True)

def save_as(self, name=None, close=False):
"""Save notebook as."""
current_client = self.get_current_client()
Expand All @@ -427,15 +449,6 @@ def save_as(self, name=None, close=False):
self.close_client(save=True)
self.create_new_client(filename=filename)

def open_notebook(self, filenames=None):
"""Open a notebook from file."""
if not filenames:
filenames, _selfilter = getopenfilenames(self, _("Open notebook"),
'', FILES_FILTER)
if filenames:
for filename in filenames:
self.create_new_client(filename=filename)

def open_console(self, client=None):
"""Open an IPython console for the given client or the current one."""
if not client:
Expand All @@ -461,9 +474,8 @@ def add_tab(self, widget):
index = self.tabwidget.addTab(widget, widget.get_short_name())
self.tabwidget.setCurrentIndex(index)
self.tabwidget.setTabToolTip(index, widget.get_filename())
if self.dockwidget and not self.ismaximized:
self.dockwidget.setVisible(True)
self.dockwidget.raise_()
if self.dockwidget:
self.switch_to_plugin()
self.activateWindow()
widget.notebookwidget.setFocus()

Expand Down