bokeh.server.util

提供一些实用函数，用于实现bokeh.server中的不同组件。

bind_sockets(address: str | None, port: int) → tuple[list[socket], int]

将套接字绑定到地址上的端口。

Parameters:

• 地址 (str) – 绑定端口的地址，例如 "localhost"

• port (int) –

  要绑定的端口号。

  传递0以让操作系统自动选择一个空闲端口。

此函数返回一个包含新套接字作为第一个元素的2元组， 以及绑定端口作为第二个元素。（当传递0作为端口号以绑定任何空闲端口时非常有用。）

Returns:

(socket, port)

check_allowlist(host: str, allowlist: Sequence[str]) → bool

检查给定的请求主机是否在允许列表中。

Parameters:

• host (str) –

  一个用于与白名单进行比较的主机字符串。

  如果主机没有指定端口，则隐式假定为 ":80"。

• allowlist (seq[str]) – 用于匹配的主机模式列表

Returns:

True，如果host匹配allowlist中的任何模式，否则 False

create_hosts_allowlist(host_list: Sequence[str] | None, port: int | None) → list[str]

此白名单可用于限制WebSocket或其他连接，仅允许明确来自已批准主机的连接。

Parameters:

• host_list (seq[str]) –

  要添加到白名单中的字符串 或 : 值的列表。

  如果在主机字符串中未指定端口，则默认假定为 ":80"。

• port (int) –

  如果 host_list 为空或 None，则允许列表将是 单个项目列表 `` [ ‘localhost:’ ]``

  如果 host_list 不为空，则此参数无效。

Returns:

列表[字符串]

Raises:

ValueError, 如果主机或端口值无效 –

注意

如果host_list中的任何主机包含通配符*，将会记录一个关于宽松的websocket连接的警告。

match_host(host: str, pattern: str) → bool

将主机字符串与模式进行匹配

Parameters:

• host (str) – 要与给定模式进行比较的主机名

• pattern (str) – 表示主机名模式的字符串，可能包括用于IP地址八位组或端口的通配符。

如果主机名与模式匹配，包括任何通配符，此函数将返回 True。如果模式包含端口，主机字符串也必须包含匹配的端口。

Returns:

布尔

示例

>>> match_host('192.168.0.1:80', '192.168.0.1:80')
True
>>> match_host('192.168.0.1:80', '192.168.0.1')
True
>>> match_host('192.168.0.1:80', '192.168.0.1:8080')
False
>>> match_host('192.168.0.1', '192.168.0.2')
False
>>> match_host('192.168.0.1', '192.168.*.*')
True
>>> match_host('alice', 'alice')
True
>>> match_host('alice:80', 'alice')
True
>>> match_host('alice', 'bob')
False
>>> match_host('foo.example.com', 'foo.example.com.net')
False
>>> match_host('alice', '*')
True
>>> match_host('alice', '*:*')
True
>>> match_host('alice:80', '*')
True
>>> match_host('alice:80', '*:80')
True
>>> match_host('alice:8080', '*:80')
False