rename db.py orm.py

less confusing to have self.db and orm.User
than self.db and db.User.

jupyterhub/app.py

@@ -32,7 +32,7 @@ from .handlers import (
     UserHandler,
 )
 
-from . import db
+from . import orm
 from ._data import DATA_FILES_PATH
 from .utils import url_path_join
 
@@ -62,7 +62,7 @@ class JupyterHubApp(Application):
         help="The Proxy Auth token"
     )
     def _proxy_auth_token_default(self):
-        return db.new_token()
+        return orm.new_token()
     
     proxy_api_ip = Unicode('localhost', config=True,
         help="The ip for the proxy API handlers"
@@ -185,12 +185,12 @@ class JupyterHubApp(Application):
     def init_db(self):
         # TODO: load state from db for resume
         # TODO: if not resuming, clear existing db contents
-        self.db = db.new_session(self.db_url, echo=self.debug_db)
+        self.db = orm.new_session(self.db_url, echo=self.debug_db)
     
     def init_hub(self):
         """Load the Hub config into the database"""
-        self.hub = db.Hub(
+        self.hub = orm.Hub(
-            server=db.Server(
+            server=orm.Server(
                 ip=self.hub_ip,
                 port=self.hub_port,
                 base_url=self.hub_prefix,
@@ -203,17 +203,17 @@ class JupyterHubApp(Application):
     
     def init_proxy(self):
         """Load the Proxy config into the database"""
-        self.proxy = db.Proxy(
+        self.proxy = orm.Proxy(
-            public_server=db.Server(
+            public_server=orm.Server(
                 ip=self.ip,
                 port=self.port,
             ),
-            api_server=db.Server(
+            api_server=orm.Server(
                 ip=self.proxy_api_ip,
                 port=self.proxy_api_port,
                 base_url='/api/routes/'
             ),
-            auth_token = db.new_token(),
+            auth_token = orm.new_token(),
         )
         self.db.add(self.proxy)
         self.db.commit()
@@ -272,7 +272,7 @@ class JupyterHubApp(Application):
         
         # request (async) process termination
         futures = []
-        for user in self.db.query(db.User):
+        for user in self.db.query(orm.User):
             if user.spawner is not None:
                 futures.append(user.spawner.stop())
         

jupyterhub/handlers.py

@@ -14,7 +14,7 @@ from tornado.httputil import url_concat
 from tornado.web import RequestHandler
 from tornado import gen, web
 
-from . import db
+from . import orm
 from .spawner import LocalProcessSpawner
 from .utils import wait_for_server, url_path_join
 
@@ -49,7 +49,7 @@ class BaseHandler(RequestHandler):
         
         token = self.get_cookie(self.hub.server.cookie_name, None)
         if token:
-            cookie_token = self.db.query(db.CookieToken).filter(db.CookieToken.token==token).first()
+            cookie_token = self.db.query(orm.CookieToken).filter(orm.CookieToken.token==token).first()
             if cookie_token:
                 return cookie_token.user.name
             else:
@@ -59,7 +59,7 @@ class BaseHandler(RequestHandler):
     def clear_login_cookie(self):
         username = self.get_current_user()
         if username is not None:
-            user = self.db.query(db.User).filter(name=username).first()
+            user = self.db.query(orm.User).filter(name=username).first()
             if user is not None:
                 self.clear_cookie(user.server.cookie_name, path=user.server.base_url)
         self.clear_cookie(self.cookie_name, path=self.hub.base_url)
@@ -119,7 +119,7 @@ class LoginHandler(BaseHandler):
     
     @gen.coroutine
     def notify_proxy(self, user):
-        proxy = self.db.query(db.Proxy).first()
+        proxy = self.db.query(orm.Proxy).first()
         r = requests.post(
             url_path_join(
                 proxy.api_server.url,
@@ -136,8 +136,8 @@ class LoginHandler(BaseHandler):
     
     @gen.coroutine
     def spawn_single_user(self, name):
-        user = db.User(name=name,
+        user = orm.User(name=name,
-            server=db.Server(
+            server=orm.Server(
                 cookie_name='%s-%s' % (self.hub.server.cookie_name, name),
                 cookie_secret=self.hub.server.cookie_secret,
                 base_url=url_path_join(self.base_url, 'user', name),
@@ -206,7 +206,7 @@ class LoginHandler(BaseHandler):
         username = data['username']
         authorized = yield self.authenticate(data)
         if authorized:
-            user = self.db.query(db.User).filter(db.User.name == username).first()
+            user = self.db.query(orm.User).filter(orm.User.name == username).first()
             if user is None:
                 user = yield self.spawn_single_user(username)
             self.set_login_cookies(user)
@@ -235,7 +235,7 @@ def token_authorized(method):
         if not match:
             raise web.HTTPError(403)
         token = match.group(1)
-        db_token = self.db.query(db.APIToken).filter(db.APIToken.token == token).first()
+        db_token = self.db.query(orm.APIToken).filter(orm.APIToken.token == token).first()
         if db_token is None:
             raise web.HTTPError(403)
         return method(self, *args, **kwargs)
@@ -247,7 +247,7 @@ def token_authorized(method):
 class AuthorizationsHandler(BaseHandler):
     @token_authorized
     def get(self, token):
-        db_token = self.db.query(db.CookieToken).filter(db.CookieToken.token == token).first()
+        db_token = self.db.query(orm.CookieToken).filter(orm.CookieToken.token == token).first()
         if db_token is None:
             raise web.HTTPError(404)
         self.write(json.dumps({

jupyterhub/tests/conftest.py

@@ -5,7 +5,7 @@
 
 from pytest import fixture
 
-from .. import db
+from .. import orm
 
 # global session object
 _session = None
@@ -14,5 +14,5 @@ _session = None
 def session():
     global _session
     if _session is None:
-        _session = db.new_session('sqlite:///:memory:', echo=True)
+        _session = orm.new_session('sqlite:///:memory:', echo=True)
     return _session

jupyterhub/tests/test_orm.py

@@ -3,7 +3,7 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 
-from .. import db
+from .. import orm
 
 try:
     unicode
@@ -13,7 +13,7 @@ except NameError:
 
 
 def test_server(session):
-    server = db.Server()
+    server = orm.Server()
     session.add(server)
     session.commit()
     assert server.ip == u'localhost'
@@ -26,13 +26,13 @@ def test_server(session):
 
 
 def test_proxy(session):
-    proxy = db.Proxy(
+    proxy = orm.Proxy(
         auth_token=u'abc-123',
-        public_server=db.Server(
+        public_server=orm.Server(
             ip=u'192.168.1.1',
             port=8000,
         ),
-        api_server=db.Server(
+        api_server=orm.Server(
             ip=u'127.0.0.1',
             port=8001,
         ),
@@ -45,8 +45,8 @@ def test_proxy(session):
 
 
 def test_hub(session):
-    hub = db.Hub(
+    hub = orm.Hub(
-        server=db.Server(
+        server=orm.Server(
             ip = u'1.2.3.4',
             port = 1234,
             base_url='/hubtest/',
@@ -61,8 +61,8 @@ def test_hub(session):
 
 
 def test_user(session):
-    user = db.User(name=u'kaylee',
+    user = orm.User(name=u'kaylee',
-        server=db.Server(),
+        server=orm.Server(),
         state={'pid': 4234},
     )
     session.add(user)
@@ -73,7 +73,7 @@ def test_user(session):
 
 
 def test_tokens(session):
-    user = db.User(name=u'inara')
+    user = orm.User(name=u'inara')
     session.add(user)
     session.commit()
     token = user.new_cookie_token()

jupyterhub/tests/test_spawner.py

@@ -18,7 +18,7 @@ from IPython.utils.py3compat import unicode_type
 
 from .. import spawner as spawnermod
 from ..spawner import LocalProcessSpawner
-from .. import db
+from .. import orm
 
 _echo_sleep = """
 import sys, time
@@ -43,13 +43,13 @@ def sleep(t):
 class TestLocalProcessSpawner(AsyncTestCase):
     
     def setup_class(cls):
-        session = cls.session = db.new_session('sqlite:///:memory:')
+        session = cls.session = orm.new_session('sqlite:///:memory:')
-        user = cls.user = db.User(
+        user = cls.user = orm.User(
             name=getpass.getuser(),
-            server = db.Server(),
+            server = orm.Server(),
         )
-        hub = cls.hub = db.Hub(
+        hub = cls.hub = orm.Hub(
-            server = db.Server(),
+            server = orm.Server(),
         )
         session.add(user)
         session.add(hub)