Users

Module: jupyterhub.user

UserDict

class jupyterhub.user.UserDict(db_factory, settings)

Like defaultdict, but for users

Getting by a user id OR an orm.User instance returns a User wrapper around the orm user.

add(orm_user)

Add a user to the UserDict

count_active_users()

Count the number of user servers that are active/pending/ready

Returns dict with counts of active/pending/ready servers

delete(key)

Delete a user from the cache and the database

User

class jupyterhub.user.User(orm_user, settings=None, db=None)

High-level wrapper around an orm.User object

name

The user’s name

server

The user’s Server data object if running, None otherwise. Has ip, port attributes.

spawner

The user’s Spawner instance.

property escaped_name

My name, escaped for use in URLs, cookies, etc.