hazza/jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/jupyterhub.git synced 2025-10-15 22:13:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

return (ip, port) from Spawner.start

Browse Source 
removes the need for Spawners to set db state themselves in most cases

Should be backward-compatible with warnings.
This commit is contained in:
Min RK
2016-07-22 14:26:15 +02:00
parent 22ff5f3d91
commit 3159b61ae7
4 changed files with 51 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
jupyterhub/spawner.py
View File

@@ -46,6 +46,9 @@ class Spawner(LoggingConfigurable):
ip = Unicode('127.0.0.1',
help="The IP address (or hostname) the single-user server should listen on"
).tag(config=True)
port = Integer(0,
help="The port for single-user servers to listen on. New in version 0.7."
)
start_timeout = Integer(60,
help="""Timeout (in seconds) before giving up on the spawner.
@@ -245,7 +248,6 @@ class Spawner(LoggingConfigurable):
"""Return the arguments to be passed after self.cmd"""
args = [
'--user=%s' % self.user.name,
'--port=%i' % self.user.server.port,
'--cookie-name=%s' % self.user.server.cookie_name,
'--base-url=%s' % self.user.server.base_url,
'--hub-host=%s' % self.hub.host,
@@ -254,6 +256,13 @@ class Spawner(LoggingConfigurable):
]
if self.ip:
args.append('--ip=%s' % self.ip)
if self.port:
args.append('--port=%i' % self.port)
elif self.user.server.port:
self.log.warning("Setting port from user.server is deprecated as of JupyterHub 0.7.")
args.append('--port=%i' % self.user.server.port)
if self.notebook_dir:
self.notebook_dir = self.notebook_dir.replace("%U",self.user.name)
args.append('--notebook-dir=%s' % self.notebook_dir)
@@ -270,7 +279,15 @@ class Spawner(LoggingConfigurable):
@gen.coroutine
def start(self):
"""Start the single-user process"""
"""Start the single-user server
Returns:
(ip, port): the ip, port where the Hub can connect to the server.
.. versionchanged:: 0.7
Return ip, port instead of setting on self.user.server directly.
"""
raise NotImplementedError("Override in subclass. Must be a Tornado gen.coroutine.")
@gen.coroutine
@@ -456,15 +473,13 @@ class LocalProcessSpawner(Spawner):
@gen.coroutine
def start(self):
"""Start the process"""
if self.ip:
self.user.server.ip = self.ip
self.user.server.port = random_port()
self.port = random_port()
cmd = []
env = self.get_env()
cmd.extend(self.cmd)
cmd.extend(self.get_args())
self.log.info("Spawning %s", ' '.join(pipes.quote(s) for s in cmd))
try:
self.proc = Popen(cmd, env=env,
@@ -478,9 +493,10 @@ class LocalProcessSpawner(Spawner):
script, self.user.name,
)
raise
self.pid = self.proc.pid
return (self.ip or '127.0.0.1', self.port)
@gen.coroutine
def poll(self):
"""Poll the process"""