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

simplify and clarify override of methods that could be defined on BaseHandler

Browse Source
This commit is contained in:
Min RK
2021-02-01 08:47:47 +01:00
parent 1b12107c54
commit 471d1f0a2f
1 changed files with 20 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
jupyterhub/singleuser/mixins.py
View File

@@ -95,9 +95,10 @@ class JupyterHubLoginHandlerMixin:
"""alternative get_current_user to query the Hub """alternative get_current_user to query the Hub
Thus shouldn't be called anymore because HubAuthenticatedHandler Thus shouldn't be called anymore because HubAuthenticatedHandler
should have already overridden get_current_user() should have already overridden get_current_user().
Keep here to prevent unlikely circumstance from losing auth.
""" """
# patch in HubAuthenticated class for querying the Hub for cookie authentication
if HubAuthenticatedHandler not in handler.__class__.mro(): if HubAuthenticatedHandler not in handler.__class__.mro():
warnings.warn( warnings.warn(
f"Expected to see HubAuthenticatedHandler in {handler.__class__}.mro()", f"Expected to see HubAuthenticatedHandler in {handler.__class__}.mro()",
@@ -715,25 +716,25 @@ def make_singleuser_app(App):
"{}.base_handler_class must be defined".format(App.__name__) "{}.base_handler_class must be defined".format(App.__name__)
) )
# patch-in hub HubOAuthCallbackHandler to BaseHandler, # patch-in HubAuthenticatedHandler to BaseHandler,
# so anything inheriting from BaseHandler uses Hub authentication # so anything inheriting from BaseHandler uses Hub authentication
if HubAuthenticatedHandler not in BaseHandler.__bases__: if HubAuthenticatedHandler not in BaseHandler.__bases__:
log.debug(f"Patching {HubAuthenticatedHandler} into {BaseHandler}") new_bases = (HubAuthenticatedHandler,) + BaseHandler.__bases__
BaseHandler.__bases__ = (HubAuthenticatedHandler,) + BaseHandler.__bases__ log.debug(
# adding it to bases isn't enough to override methods defined on BaseHandler, though. f"Patching {BaseHandler}{BaseHandler.__bases__} -> {BaseHandler}{new_bases}"
# we still need to override any methods defined on BaseHandler *itself* that we should override )
# since bases come immediately *after* the class itself BaseHandler.__bases__ = new_bases
# as of writing, there are no collisions on the default classes # We've now inserted our class as a parent of BaseHandler,
# so this block has no effect for ServerApp or NotebookApp # but we also need to ensure BaseHandler *itself* doesn't
seen = set() # override the public tornado API methods we have inserted.
for cls in HubAuthenticatedHandler.mro(): # If they are defined in BaseHandler, explicitly replace them with our methods.
for name, method in cls.__dict__.items(): for name in ("get_current_user", "get_login_url"):
if name in seen or name.startswith("__"): if name in BaseHandler.__dict__:
continue log.debug(
seen.add(name) f"Overriding {BaseHandler}.{name} with HubAuthenticatedHandler.{name}"
if name in BaseHandler.__dict__: )
log.debug(f"Overriding {BaseHandler}.{name} with {cls}.{name}") method = getattr(HubAuthenticatedHandler, name)
setattr(BaseHandler, name, method) setattr(BaseHandler, name, method)
# create Handler classes from mixins + bases # create Handler classes from mixins + bases
class JupyterHubLoginHandler(JupyterHubLoginHandlerMixin, LoginHandler): class JupyterHubLoginHandler(JupyterHubLoginHandlerMixin, LoginHandler):