NbserverStopApp: stop notebooks through cli - jupyter notebook stop <… #2388

brookisme · 2017-04-08T00:32:56Z

usage: jupyter notebook stop <PORT>
defaults to 8888
no tests (sorry)

…PORT>

gnestor · 2017-04-08T00:47:14Z

Thanks @brookisme! I tested and it's working for me!

@minrk Can you review?

minrk

Thanks! I think this makes sense in principle. I've made some comments in-line for updating the PR.

If you would like any help addressing the comments, feel free to ask.

minrk · 2017-04-08T08:20:27Z

notebook/notebookapp.py

+              "Produce machine-readable JSON output."),
+    )
+
+    json = Bool(True, config=True,


json is unused and can be removed

minrk · 2017-04-08T08:20:50Z

notebook/notebookapp.py

+    version = __version__
+    description="Stop currently running notebook server for a given port"
+    kill_cmd='kill'
+    kill_signal='-3'


signal should be an integer from the signal module, e.g.signal.SIGTERM

~~using signal.SIGQUIT since signal.SIGTERM requests confirmation~~
UPDATE: SIGQUIT works fine. See comment below.

minrk · 2017-04-08T08:23:09Z

notebook/notebookapp.py

+    def start(self):
+        server=next((server for server in list_running_servers(self.runtime_dir) if server.get('port')==self.port),None)
+        if server:
+            subprocess.Popen([self.kill_cmd,self.kill_signal,str(server.get('pid'))],stdout=subprocess.PIPE).communicate()


Rather than Popen(['kill', ...]), it would be better to use os.kill here.

minrk · 2017-04-08T08:24:49Z

notebook/notebookapp.py

+
+    flags = dict(
+        json=({'NbserverStopApp': {'json': True}},
+              "Produce machine-readable JSON output."),


flags here are also unused and can be removed

minrk · 2017-04-08T08:25:29Z

notebook/notebookapp.py

+        else:
+            ports=[s.get('port') for s in list_running_servers(self.runtime_dir)]
+            if ports:
+                print("There is currently no server running on port {}.".format(self.port))


This print statement can be moved up one level, and only print ports below.

These print statements should also go on stderr, since they are error output.

It we move this above if ports: the output for no running servers will be

There is currently no server running on port 8888 There are currently no running servers

Its seems the

There are currently no running servers

might be better. Thoughts?

minrk · 2017-04-08T08:26:37Z

notebook/notebookapp.py

+                print("Ports currently in use:")
+                for port in ports: print("\t* {}".format(port))
+            else:
+                print("There are currently no running servers")


This should also end with self.exit(1) when no server can be found to stop.

brookisme · 2017-04-08T19:49:23Z

@minrk thanks for the feedback. This should be complete apart from the minor no servers running issue commented on above.

gnestor · 2017-04-09T17:15:36Z

Should to docs be updated to reflect this new subcommand?

minrk · 2017-04-10T10:10:52Z

notebook/notebookapp.py

+
+    def start(self):
+        server=next((server for server in list_running_servers(self.runtime_dir) if server.get('port')==self.port),None)
+        if server: os.kill(server.get('pid'), signal.SIGQUIT)


I think SIGTERM is probably the right signal here, instead of SIGQUIT.

So strange... I could swear my initial tests requested confirmation after sending sigterm (which is why I switched to sigquit) but I just double checked and sigterm worked fine. Anyway its fixed now.

Is it possible you tested with SIGINT initially? IIRC that's the one that asks for confirmation.

probably something like that. apologies for confusion though - glad it worked in the end :)

takluyver

Other than these things, this looks good to me.

takluyver · 2017-04-11T14:48:26Z

notebook/notebookapp.py

+            self.port=int(self.extra_args[0])
+
+    def start(self):
+        server=next((server for server in list_running_servers(self.runtime_dir) if server.get('port')==self.port),None)


Can this line be broken up a bit? We're not strict about any particular code style, but this isn't super readable.

i pulled list_running_servers out of the list comprehension so its a little bit shorter but i'm not sure if you'd like more.

takluyver · 2017-04-11T14:49:52Z

notebook/notebookapp.py

+            if ports:
+                print("There is currently no server running on port {}.".format(self.port))
+                print("Ports currently in use:")
+                for port in ports: print("\t* {}".format(port))


This branch should have exit code 1 as well.

takluyver · 2017-04-11T15:36:51Z

notebook/notebookapp.py

+        server=next((server for server in servers if server.get('port')==self.port),None)
+        if server: os.kill(server.get('pid'), signal.SIGTERM)
+        else:
+            ports=[s.get('port') for s in list_running_servers(self.runtime_dir)]


You can now reuse the servers variable here.

ha - yeah, that was the very first thing i did, back before my initial commit, but list_running_servers returns an iterator so it doesn't work...

In [1]: from notebook.notebookapp import * In [2]: nbstop=NbserverStopApp() In [3]: servers=list_running_servers(nbstop.runtime_dir) In [4]: [s for s in servers] Out[4]: [{u'base_url': u'/', u'hostname': u'localhost', u'notebook_dir': u'/Users/brook/code/jupyter/notebook', u'password': False, u'pid': 27105, u'port': 8888, u'secure': False, u'token': u'48019c94f11b76fa4690c1a7d431bf58e4b2fb2d0cd65ae5', u'url': u'http://localhost:8888/'}, {u'base_url': u'/', u'hostname': u'localhost', u'notebook_dir': u'/Users/brook/code/jupyter/notebook', u'password': False, u'pid': 27213, u'port': 8889, u'secure': False, u'token': u'4c1588c1139d214b9d1eb432fd000270e2645a226633fde5', u'url': u'http://localhost:8889/'}, {u'base_url': u'/', u'hostname': u'localhost', u'notebook_dir': u'/Users/brook/code/jupyter/notebook', u'password': False, u'pid': 27238, u'port': 8890, u'secure': False, u'token': u'db40ac85ddd5694cc4f67d9c4a18f4c066b63887f6d9fb9b', u'url': u'http://localhost:8890/'}] In [5]: [s for s in servers] Out[5]: []

Aha, OK then. Thanks, merging :-)

isabeaups · 2017-09-21T07:27:31Z

starting from which version of jupyter is this feature available?
When I try to use it I get the error

NotebookApp] No such file or directory: /Users/default/Workspace/project/stop

takluyver · 2017-09-25T15:09:50Z

It should be available from notebook 5.1.

NbserverStopApp: stop notebooks through cli - jupyter notebook stop <…

cd3233f

…PORT>

brookisme mentioned this pull request Apr 8, 2017

Feature Request: CLI method for stopping servers #2350

Open

gnestor requested a review from minrk April 8, 2017 00:46

minrk reviewed Apr 8, 2017

View reviewed changes

brookisme added 5 commits April 8, 2017 12:31

remove unused props

219c762

use os.kill

b6ac73c

exit if server not found

8b20dcc

dont cast to string

277d000

remove unused kill_cmd/signal prop

ed4de77

gnestor approved these changes Apr 9, 2017

View reviewed changes

minrk reviewed Apr 10, 2017

View reviewed changes

minrk added this to the 5.1 milestone Apr 10, 2017

SIGTERM not SIGQUIT

b2f63b4

takluyver reviewed Apr 11, 2017

View reviewed changes

always exit(1) if not server found. break up long list comprehension

44df51a

takluyver reviewed Apr 11, 2017

View reviewed changes

takluyver merged commit d00b7e3 into jupyter:master Apr 11, 2017

takluyver mentioned this pull request Apr 27, 2017

Shutdown/Restart Server menu item: Feature Request #1530

Closed

gnestor mentioned this pull request Aug 3, 2017

Add 5.1.0 to changelog #2723

Merged

takluyver mentioned this pull request Aug 23, 2017

Checking by command line if Jupyter server is running #1950

Closed

github-actions bot added the status:resolved-locked label Apr 5, 2021

github-actions bot locked as resolved and limited conversation to collaborators Apr 5, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

NbserverStopApp: stop notebooks through cli - jupyter notebook stop <… #2388

NbserverStopApp: stop notebooks through cli - jupyter notebook stop <… #2388

brookisme commented Apr 8, 2017

gnestor commented Apr 8, 2017

minrk left a comment

minrk Apr 8, 2017

minrk Apr 8, 2017

brookisme Apr 8, 2017 •

edited

Loading

minrk Apr 8, 2017

minrk Apr 8, 2017

minrk Apr 8, 2017

minrk Apr 8, 2017

brookisme Apr 8, 2017

minrk Apr 8, 2017

brookisme commented Apr 8, 2017

gnestor commented Apr 9, 2017

minrk Apr 10, 2017

brookisme Apr 10, 2017

takluyver Apr 11, 2017

brookisme Apr 11, 2017

takluyver left a comment

takluyver Apr 11, 2017

brookisme Apr 11, 2017

takluyver Apr 11, 2017

brookisme Apr 11, 2017

takluyver Apr 11, 2017

brookisme Apr 11, 2017

takluyver Apr 11, 2017

isabeaups commented Sep 21, 2017

takluyver commented Sep 25, 2017

NbserverStopApp: stop notebooks through cli - jupyter notebook stop <… #2388

NbserverStopApp: stop notebooks through cli - jupyter notebook stop <… #2388

Conversation

brookisme commented Apr 8, 2017

gnestor commented Apr 8, 2017

minrk left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brookisme Apr 8, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brookisme commented Apr 8, 2017

gnestor commented Apr 9, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

takluyver left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

isabeaups commented Sep 21, 2017

takluyver commented Sep 25, 2017

brookisme Apr 8, 2017 •

edited

Loading