JupyterHub 用户共享功能详解：通过API实现Python控制

原创于 2025-06-05 09:10:32 发布 · 289 阅读

5 ·

CC 4.0 BY-SA版权

JupyterHub 用户共享功能详解：通过API实现Python控制

jupyterhub Multi-user server for Jupyter notebooks 项目地址: https://gitcode.com/gh_mirrors/ju/jupyterhub

概述

JupyterHub作为多用户Jupyter环境的管理平台，提供了强大的用户共享功能。本文将深入探讨如何通过Python代码利用JupyterHub的共享API，实现对服务器访问权限的精细化管理。

环境准备

要使用共享API，首先需要获取必要的环境变量和配置信息：

import os

# 获取JupyterHub API基础信息
hub_api = os.environ["JUPYTERHUB_API_URL"]
token = os.environ["JUPYTERHUB_API_TOKEN"]
username = os.environ["JUPYTERHUB_USER"]
user_server = f"{username}/{os.environ['JUPYTERHUB_SERVER_NAME']}"
hub_host = os.environ["JUPYTERHUB_HOST"]
server_base_url = os.environ["JUPYTERHUB_SERVICE_PREFIX"]

这些环境变量由JupyterHub自动注入到用户环境中，包含了访问API所需的关键信息。

创建API会话

使用requests库创建一个带有认证头的会话对象：

import requests

session = requests.Session()
session.headers = {"Authorization": f"Bearer {token}"}

这个会话对象将在后续所有API请求中使用，自动携带认证令牌。

权限检查

在开始共享操作前，建议先检查当前令牌的权限范围：

r = session.get(f"{hub_api}/user")
user_info = r.json()
print(user_info["scopes"])  # 显示当前令牌的所有权限

权限检查可以帮助开发者确认是否具备必要的共享操作权限。

共享功能实现

1. 创建共享链接

生成一个允许他人访问当前服务器的共享链接：

share_codes_url = f"{hub_api}/share-codes/{user_server}"
r = session.post(share_codes_url)
code_info = r.json()

# 生成完整的分享链接
full_accept_url = f"{hub_host}{code_info['accept_url']}"
print(f"分享链接: {full_accept_url}")

生成的链接可以发送给其他用户，他们点击后将获得访问权限。

2. 定向共享

可以指定用户接受共享后跳转的特定页面：

from urllib.parse import urlencode

target_url = server_base_url + "lab/tree/example.ipynb"
directed_accept_url = full_accept_url + "&" + urlencode({"next": target_url})

这在需要共享特定笔记本或文件时非常有用。

3. 高级共享选项

共享时可以自定义权限范围和有效期：

import json

options = {
    "scopes": [
        f"access:servers!server={user_server}",  # 基础访问权限
        f"servers!server={user_server}",        # 允许启动/停止服务器
        f"shares!server={user_server}",         # 允许被共享者继续共享
    ],
    "expires_in": 3600,  # 1小时后过期
}

r = session.post(share_codes_url, data=json.dumps(options))

权限管理

1. 查看当前共享状态

shares_url = f"{hub_api}/shares/{user_server}"
r = session.get(shares_url)
print(r.json())  # 显示当前所有共享关系

2. 查看共享码状态

r = session.get(share_codes_url)
print(r.json())  # 显示所有活跃的共享码

3. 撤销特定权限

options = {
    "user": "shared-with-user",
    "scopes": ['shares!server=sharer/'],  # 仅撤销共享权限
}
session.patch(shares_url, data=json.dumps(options))

4. 完全撤销共享

# 撤销特定用户的全部权限
options = {"user": "shared-with-user"}
session.patch(shares_url, data=json.dumps(options))

# 或删除所有共享关系
session.delete(shares_url)

# 删除所有共享码
session.delete(share_codes_url)