数据结构

Werkzeug提供了一些常见的python对象的子类，用附加的特性来扩展它们。其中一些用于使它们不可变，另一些用于更改某些语义以更好地使用HTTP。

一般用途

Changelog

在 0.6 版本发生变更: 现在，只要包含的对象是可酸洗的，通用类就可以在每个协议中进行酸洗。这意味着 FileMultiDict 一旦它包含一个文件，就不会被pickle。

class werkzeug.datastructures.TypeConversionDict

就像一个普通的口述，但是 get() 方法无法执行类型转换。 MultiDict 和 CombinedMultiDict 是此类的子类并提供相同的功能。

Changelog

在 0.5 版本加入.

get(key, default=None, type=None)

如果请求的数据不存在，则返回默认值。如果 type 是可调用的，它应转换值、返回值或引发 ValueError 如果不可能的话。在这种情况下，函数将返回默认值，就像找不到值一样：

>>> d = TypeConversionDict(foo='42', bar='blub')
>>> d.get('foo', type=int)
42
>>> d.get('bar', -1, type=int)
-1

参数:

• key -- 要查找的密钥。

• default -- 无法查找键时返回的默认值。如果没有进一步规定 None 返回。

• type -- 用于在 MultiDict . 如果A ValueError 由该可调用项引发，将返回默认值。

class werkzeug.datastructures.ImmutableTypeConversionDict

像一个 TypeConversionDict 但不支持修改。

Changelog

在 0.5 版本加入.

copy()

返回此对象的浅可变副本。请记住，标准库的 copy() 函数是此类的no op，与任何其他Python不可变类型（例如： tuple ）

class werkzeug.datastructures.MultiDict(mapping=None)

A MultiDict 是一个字典子类，它是为处理同一个键的多个值而定制的，例如由包装器中的解析函数使用。这是必需的，因为某些HTML表单元素为同一个键传递多个值。

MultiDict 实现所有标准字典方法。在内部，它将键的所有值保存为一个列表，但是标准的dict访问方法将只返回键的第一个值。如果您还想访问其他值，则必须使用 list 方法如下所述。

基本用途：

>>> d = MultiDict([('a', 'b'), ('a', 'c')])
>>> d
MultiDict([('a', 'b'), ('a', 'c')])
>>> d['a']
'b'
>>> d.getlist('a')
['b', 'c']
>>> 'a' in d
True

它的行为类似于普通的dict，因此当找到一个键的多个值时，所有dict函数都只返回第一个值。

从Werkzeug 0.3起， KeyError 由此类引发的也是 BadRequest HTTP异常，并将呈现 400 BAD REQUEST 如果在一个catch all中捕获HTTP异常。

A MultiDict 可由以下项构成 (key, value) Tuples，一个dict，一个 MultiDict 或者从werkzeug 0.2开始一些关键字参数。

参数:

mapping -- 的初始值 MultiDict .或者是普通的口述，或者是 (key, value) 元组或 None .

add(key, value)

为键添加新值。

Changelog

在 0.6 版本加入.

参数:

• key -- 值的键。

• value -- 要添加的值。

clear() → None.  Remove all items from D.

copy()

返回此对象的浅副本。

deepcopy(memo=None)

返回此对象的深度副本。

fromkeys(value=None, /)

使用iterable中的键和设置为value的值创建新字典。

get(key, default=None, type=None)

如果请求的数据不存在，则返回默认值。如果 type 是可调用的，它应转换值、返回值或引发 ValueError 如果不可能的话。在这种情况下，函数将返回默认值，就像找不到值一样：

>>> d = TypeConversionDict(foo='42', bar='blub')
>>> d.get('foo', type=int)
42
>>> d.get('bar', -1, type=int)
-1

参数:

• key -- 要查找的密钥。

• default -- 无法查找键时返回的默认值。如果没有进一步规定 None 返回。

• type -- 用于在 MultiDict . 如果A ValueError 由该可调用项引发，将返回默认值。

getlist(key, type=None)

返回给定键的项目列表。如果该密钥不在 MultiDict ，则返回值将为空列表。就像 get ， getlist 接受一个 type 参数。所有项目都将使用在那里定义的可调用项进行转换。

参数:

• key -- 要查找的密钥。

• type -- 用于在 MultiDict . 如果A ValueError 由该可调用项引发，该值将从列表中删除。

返回:

一 list 键的所有值。

items(multi=False)

返回的迭代器 (key, value) 对。

参数:

multi -- 如果设置为 True 返回的迭代器对于每个键的每个值都有一对。否则，它将只包含每个键的第一个值的对。

keys() → a set-like object providing a view on D's keys

lists()

返回的迭代器 (key, values) pairs，其中values是与键关联的所有值的列表。

listvalues()

返回与键关联的所有值的迭代器。压缩 keys() 这和打电话一样 lists() ：

>>> d = MultiDict({"foo": [1, 2, 3]})
>>> zip(d.keys(), d.listvalues()) == d.lists()
True

pop(key, default=no value)

在dict上弹出列表的第一项。然后从dict中删除键，因此将丢弃其他值：

>>> d = MultiDict({"foo": [1, 2, 3]})
>>> d.pop("foo")
1
>>> "foo" in d
False

参数:

• key -- 弹出的键。

• default -- 如果提供了要在密钥不在字典中时返回的值。

popitem()

从听写中弹出一个项目。

popitemlist()

流行音乐 (key, list) 口述中的元组。

poplist(key)

从dict中弹出键列表。如果键不在dict中，则返回空列表。

Changelog

在 0.5 版本发生变更: 如果该键不再存在，将返回一个列表，而不是引发错误。

setdefault(key, default=None)

如果键在dict中，则返回该键的值，否则返回 default 并将该值设置为 key .

参数:

• key -- 要查找的密钥。

• default -- 如果密钥不在dict中，则返回默认值。如果未进一步指定，则返回 None .

setlist(key, new_list)

删除键的旧值并添加新值。请注意，传递值的列表在插入字典之前将被浅复制。

>>> d = MultiDict()
>>> d.setlist('foo', ['1', '2'])
>>> d['foo']
'1'
>>> d.getlist('foo')
['1', '2']

参数:

• key -- 为其设置值的键。

• new_list -- 具有键的新值的iterable。先删除旧值。

setlistdefault(key, default_list=None)

喜欢 setdefault 但设置多个值。返回的列表不是副本，而是实际在内部使用的列表。这意味着您可以通过将项附加到列表中，将新值放入dict中：

>>> d = MultiDict({"foo": 1})
>>> d.setlistdefault("foo").extend([2, 3])
>>> d.getlist("foo")
[1, 2, 3]

参数:

• key -- 要查找的密钥。

• default_list -- 默认值的可重复项。它要么被复制（如果它是一个列表），要么在返回之前被转换成一个列表。

返回:

一 list

to_dict(flat=True)

将内容作为常规dict.if返回 flat 是 True 如果 flat 是 False 所有值都将作为列表返回。

参数:

flat -- 如果设置为 False 返回的dict将包含包含所有值的列表。否则，它将只包含每个键的第一个值。

返回:

一 dict

update(mapping)

update（）扩展而不是替换现有的键列表：

>>> a = MultiDict({'x': 1})
>>> b = MultiDict({'x': 2, 'y': 3})
>>> a.update(b)
>>> a
MultiDict([('y', 3), ('x', 1), ('x', 2)])

如果键的值列表 other_dict 为空，不会向dict添加新值，也不会创建键：

>>> x = {'empty_list': []}
>>> y = MultiDict()
>>> y.update(x)
>>> y
MultiDict([])

values()

返回每个键值列表中第一个值的迭代器。

class werkzeug.datastructures.OrderedMultiDict(mapping=None)

像普通人一样工作 MultiDict 但保持了田地的秩序。要将有序的多听写转换为列表，可以使用 items() 方法并通过 multi=True .

一般来说 OrderedMultiDict 是一个数量级慢于 MultiDict .

笔记

由于python的限制，不能使用 dict(multidict) .相反，你必须使用 to_dict() 方法，否则将暴露内部bucket对象。

class werkzeug.datastructures.ImmutableMultiDict(mapping=None)

不变的 MultiDict .

Changelog

在 0.5 版本加入.

copy()

返回此对象的浅可变副本。请记住，标准库的 copy() 函数是此类的no op，与任何其他Python不可变类型（例如： tuple ）

class werkzeug.datastructures.ImmutableOrderedMultiDict(mapping=None)

不变的 OrderedMultiDict .

Changelog

在 0.6 版本加入.

copy()

返回此对象的浅可变副本。请记住，标准库的 copy() 函数是此类的no op，与任何其他Python不可变类型（例如： tuple ）

class werkzeug.datastructures.CombinedMultiDict(dicts=None)

A只读 MultiDict 你可以通过多次 MultiDict 实例作为序列，它将组合所有包装的dict的返回值：

>>> from werkzeug.datastructures import CombinedMultiDict, MultiDict
>>> post = MultiDict([('foo', 'bar')])
>>> get = MultiDict([('blub', 'blah')])
>>> combined = CombinedMultiDict([get, post])
>>> combined['foo']
'bar'
>>> combined['blub']
'blah'

这适用于所有读取操作，并将引发 TypeError 对于通常更改不可能的数据的方法。

从Werkzeug 0.3起， KeyError 由此类引发的也是 BadRequest HTTP异常，并将呈现 400 BAD REQUEST 如果在一个catch all中捕获HTTP异常。

class werkzeug.datastructures.ImmutableDict

不变的 dict .

Changelog

在 0.5 版本加入.

copy()

返回此对象的浅可变副本。请记住，标准库的 copy() 函数是此类的no op，与任何其他Python不可变类型（例如： tuple ）

class werkzeug.datastructures.ImmutableList(iterable=(), /)

不变的 list .

Changelog

在 0.5 版本加入.

私有的:

class werkzeug.datastructures.FileMultiDict(mapping=None)

一个特别的 MultiDict 它有向其中添加文件的方便方法。这是用来 EnvironBuilder 通常用于单元测试。

Changelog

在 0.5 版本加入.

add_file(name, file, filename=None, content_type=None)

将新文件添加到dict。 file 可以是文件名或 file -就像或是 FileStorage 对象。

参数:

• name -- the name of the field.

• file -- 文件名或 file -像物体

• filename -- 可选文件名

• content_type -- 可选内容类型

HTTP相关

class werkzeug.datastructures.Headers([defaults])

存储一些标头的对象。它有一个类似字典的界面，但是是有序的，可以多次存储相同的键，并且迭代结果 (key, value) 对，而不仅仅是密钥。

如果您希望使用更好的方法来处理作为元组存储在列表中的wsgi头，则此数据结构非常有用。

从Werkzeug 0.3起， KeyError 由此类引发的也是 BadRequest HTTP异常，并将呈现 400 BAD REQUEST 如果在一个catch all中捕获HTTP异常。

头文件主要与python兼容 wsgiref.headers.Headers 类，但不包括 __getitem__ . wsgiref 将返回 None 对于 headers['missing'] 而 Headers 将提高 KeyError .

要创建新的 Headers 对象，则向其传递列表、dict或其他 Headers 具有默认值的。验证这些值的方式与稍后添加的值相同。

参数:

defaults -- 的默认值列表 Headers .

Changelog

在 2.1.0 版本发生变更: 对缺省值的验证与稍后添加的值相同。

在 0.9 版本发生变更: 此数据结构现在存储的Unicode值与多字典的存储方式类似。主要的区别是也可以设置字节，这些字节将自动进行Latin1解码。

在 0.9 版本发生变更: 这个 linked() 函数未经替换就被删除，因为它是一个不支持对编码模型进行更改的API。

add(_key, _value, **kw)

向列表中添加新的头元组。

关键字参数可以为头值指定其他参数，下划线转换为短划线：：

>>> d = Headers()
>>> d.add('Content-Type', 'text/plain')
>>> d.add('Content-Disposition', 'attachment', filename='foo.png')

关键字参数转储使用 dump_options_header() 在幕后。

Changelog

在 0.4.1 版本加入: 为添加了关键字参数 wsgiref 兼容性。

add_header(_key, _value, **_kw)

向列表中添加新的头元组。

的别名 add() 为了与 wsgiref add_header() 方法。

clear()

清除所有邮件头。

extend(*args, **kwargs)

使用另一个对象中包含头项和关键字参数的项来扩展此对象中的头。

要替换现有密钥而不是扩展密钥，请使用 update() 相反。

如果提供，第一个参数可以是另一个参数 Headers 对象，A MultiDict ， dict ，或是成对的。

Changelog

在 1.0 版本发生变更: 支持 MultiDict . 允许超车 kwargs .

get(key, default=None, type=None)

如果请求的数据不存在，则返回默认值。如果 type 是可调用的，它应转换值、返回值或引发 ValueError 如果不可能的话。在这种情况下，函数将返回默认值，就像找不到值一样：

>>> d = Headers([('Content-Length', '42')])
>>> d.get('Content-Length', type=int)
42

参数:

• key -- 要查找的密钥。

• default -- 无法查找键时返回的默认值。如果没有进一步规定 None 返回。

• type -- 用于在 Headers . 如果A ValueError 由该可调用项引发，将返回默认值。

在 3.0 版本发生变更: 这个 as_bytes 参数已删除。

Changelog

在 0.9 版本发生变更: 这个 as_bytes 参数已添加。

get_all(name)

返回命名字段的所有值的列表。

此方法与 wsgiref get_all() 方法。

getlist(key, type=None)

返回给定键的项目列表。如果该密钥不在 Headers ，则返回值将为空列表。就像 get() ， getlist() 接受一个 type 参数。所有项目都将使用在那里定义的可调用项进行转换。

参数:

• key -- 要查找的密钥。

• type -- 用于在 Headers . 如果A ValueError 由该可调用项引发，该值将从列表中删除。

返回:

一 list 键的所有值。

在 3.0 版本发生变更: 这个 as_bytes 参数已删除。

Changelog

在 0.9 版本发生变更: 这个 as_bytes 参数已添加。

pop(key=None, default=no value)

移除并返回键或索引。

参数:

key -- 要弹出的键。如果这是一个整数，则该位置的项将被删除，如果它是一个字符串，则该键的值为。如果钥匙被省略或 None 最后一项被删除。

返回:

一个项目。

popitem()

移除键或索引并返回（键、值）项。

remove(key)

取下钥匙。

参数:

key -- 要删除的密钥。

set(_key, _value, **kw)

删除的所有头元组 key 并添加一个新的。如果没有条目，新添加的键将显示在列表的末尾，或者替换第一个条目。

关键字参数可以为头值指定其他参数，下划线转换为短划线。参见 add() 更多信息。

Changelog

在 0.6.1 版本发生变更: set() 现在接受与 add() .

参数:

• key -- 要插入的密钥。

• value -- 要插入的值。

setdefault(key, default)

如果头中的值是由头中的第一个值设置的，则返回给头中的第一个值 default 把那个还给我。

参数:

• key -- 要获取的标题键。

• default -- 如果键不在标头中，则为该键设置的值。

setlist(key, values)

删除标头的所有现有值并添加新值。

参数:

• key -- 要设置的标题键。

• values -- 要为键设置的值的iterable。

Changelog

在 1.0 版本加入.

setlistdefault(key, default)

如果键在标题中，则返回该键的值列表，否则将该头设置为 default 把那个还给我。

不像 MultiDict.setlistdefault() ，修改返回的列表不会影响标题。

参数:

• key -- 要获取的标题键。

• default -- 如果键不在标头中，则为该键设置的值的iterable。

Changelog

在 1.0 版本加入.

to_wsgi_list()

将标题转换为适合于wsgi的列表。

返回:

列表

update(*args, **kwargs)

用另一个headers对象中的项和关键字参数替换此对象中的头。

若要扩展现有密钥而不是替换密钥，请使用 extend() 相反。

如果提供，第一个参数可以是另一个参数 Headers 对象，A MultiDict ， dict ，或是成对的。

Changelog

在 1.0 版本加入.

class werkzeug.datastructures.EnvironHeaders(environ)

来自WSGI环境的头的只读版本。这提供了与 Headers 并且是从WSGI环境构建的。从Werkzeug 0.3开始， KeyError 由此类引发的类也是 BadRequest 异常，并将为 400 BAD REQUEST 如果被捕获到HTTP异常的所有捕获中。

class werkzeug.datastructures.HeaderSet(headers=None, on_update=None)

类似于 ETags 类，它实现一个类似集合的结构。不像 ETags 这不区分大小写，用于vary、allow和content语言头。

如果不是使用 parse_set_header() 函数实例化的工作方式如下：

>>> hs = HeaderSet(['foo', 'bar', 'baz'])
>>> hs
HeaderSet(['foo', 'bar', 'baz'])

add(header)

向集合中添加新标题。

as_set(preserve_casing=False)

将集合返回为真正的python集合类型。调用此函数时，所有项都将转换为小写，并且顺序将丢失。

参数:

preserve_casing -- 如果设置为 True 返回的集合中的项将具有原始大小写，如 HeaderSet ，否则它们将是小写的。

clear()

清除集合。

discard(header)

喜欢 remove() 但忽略错误。

参数:

header -- 要丢弃的头。

find(header)

返回集合中标题的索引，如果找不到，则返回-1。

参数:

header -- 要查找的标题。

index(header)

返回集合中标题的索引或提升 IndexError .

参数:

header -- 要查找的标题。

remove(header)

从集合中移除标题。这引发了 KeyError 如果标题不在集合中。

Changelog

在 0.5 版本发生变更: 在旧版本A中 IndexError 被提升而不是 KeyError 如果对象丢失。

参数:

header -- 要拆下的收割台。

to_header()

将头集转换为HTTP头字符串。

update(iterable)

将ITerable中的所有头添加到集合中。

参数:

iterable -- 使用ITerable中的项更新集合。

class werkzeug.datastructures.Accept(values=())

安 Accept 对象只是列表的子类 (value, quality) 元组。它会根据特定性和质量自动排序。

所有 Accept 对象的工作方式与列表类似，但为处理数据提供了额外的功能。安全壳检查规范化为该头的规则：

>>> a = CharsetAccept([('ISO-8859-1', 1), ('utf-8', 0.7)])
>>> a.best
'ISO-8859-1'
>>> 'iso-8859-1' in a
True
>>> 'UTF8' in a
True
>>> 'utf7' in a
False

要获取项目的质量，可以使用常规项目查找：

>>> print a['utf-8']
0.7
>>> a['utf7']
0

Changelog

在 1.0.0 版本发生变更: Accept 对于等质量标记，内部值不再按字母顺序排序。相反，初始顺序被保留。

在 0.5 版本发生变更: Accept 对象现在被强制不可变。

property best

最佳匹配值。

best_match(matches, default=None)

根据客户端的特殊性和质量从可能匹配的列表中返回最佳匹配。如果两个项目的质量和特异性相同，则返回第一个项目。

参数:

• matches -- 要检查的匹配项列表

• default -- 如果没有匹配则返回的值

find(key)

获取入口或返回的位置-1。

参数:

key -- 要查找的密钥。

index(key)

获取入口或提升位置 ValueError .

参数:

key -- 要查找的密钥。

Changelog

在 0.5 版本发生变更: 这个用来提高 IndexError ，与列表API不一致。

quality(key)

返回键的质量。

Changelog

在 0.6 版本加入: 在以前的版本中，您必须使用项目查找语法（例如： obj[key] 而不是 obj.quality(key) ）

to_header()

将头集转换为HTTP头字符串。

values()

迭代所有值。

class werkzeug.datastructures.MIMEAccept(values=())

喜欢 Accept 但对于含羞草有特殊的方法和行为。

property accept_html

如果此对象接受HTML，则为true。

property accept_json

如果此对象接受JSON，则为true。

property accept_xhtml

如果此对象接受XHTML，则为true。

class werkzeug.datastructures.CharsetAccept(values=())

喜欢 Accept 但是有了字符集的规范化。

class werkzeug.datastructures.LanguageAccept(values=())

喜欢 Accept 但是语言标签的规范化。

class werkzeug.datastructures.RequestCacheControl(values=(), on_update=None)

请求的缓存控件。这是不可变的，允许访问所有与请求相关的缓存控制头。

获取 RequestCacheControl 对象再次可以将对象转换为字符串或调用 to_header() 方法。如果计划对其进行子类化并添加自己的项，请查看该类的源代码。

Changelog

在 2.1.0 版本发生变更: 设置int属性，如 max_age 将值转换为整型。

在 0.5 版本加入: 在以前的版本中a CacheControl 存在用于请求和响应的类。

no_cache

“无缓存”的访问器

no_store

'no store'的访问器

max_age

“max age”的访问器

no_transform

“no transform”的访问器

property max_stale

'max stale'的访问器

property min_fresh

“Min Fresh”的访问器

property only_if_cached

'only if cached'的访问器

class werkzeug.datastructures.ResponseCacheControl(values=(), on_update=None)

响应的缓存控件。不像 RequestCacheControl 这是可变的，允许访问与响应相关的缓存控制头。

获取 ResponseCacheControl 对象再次可以将对象转换为字符串或调用 to_header() 方法。如果计划对其进行子类化并添加自己的项，请查看该类的源代码。

Changelog

在 2.1.1 版本发生变更: s_maxage 将值转换为整型。

在 2.1.0 版本发生变更: 设置int属性，如 max_age 将值转换为整型。

在 0.5 版本加入: 在以前的版本中a CacheControl 存在用于请求和响应的类。

no_cache

“无缓存”的访问器

no_store

'no store'的访问器

max_age

“max age”的访问器

no_transform

“no transform”的访问器

property immutable

“不可变”的访问器

property must_revalidate

“必须重新验证”的访问器

property private

“private”的访问器

property proxy_revalidate

“proxy revalidate”的访问器

property public

“public”的访问器

property s_maxage

's-maxage'的访问器

class werkzeug.datastructures.ETags(strong_etags=None, weak_etags=None, star_tag=False)

一个集合，用于检查一个ETag是否存在于一个ETag集合中。

as_set(include_weak=False)

转换 ETags 对象转换为python集。默认情况下，所有弱etags都不属于此集合。

contains(etag)

检查etag是否是集合的一部分，忽略弱标记。也可以使用 in 操作员。

contains_raw(etag)

当传递一个带引号的标记时，它将检查这个标记是否是集合的一部分。如果标签是弱的，则检查弱的和强的标签，否则只检查强的。

contains_weak(etag)

检查etag是否是集合的一部分，包括弱标记和强标记。

is_strong(etag)

检查ETAG是否牢固。

is_weak(etag)

检查ETAG是否弱。

to_header()

将etags集转换为HTTP头字符串。

class werkzeug.datastructures.Authorization(auth_type, data=None, token=None)

表示某个部分的 Authorization 请求头。

Request.authorization 如果设置了标头，则返回一个实例。

可以在测试中使用实例 Client 请求方法‘ auth 参数在测试请求中发送标头。

根据身份验证方案， parameters 或 token 都会设置好。这个 Basic 方案的令牌被解码为 username 和 password 参数。

为了方便起见， auth["key"] 和 auth.key 两者都访问 parameters Dict，以及 auth.get("key") 和 "key" in auth 。

Changelog

在 2.3 版本发生变更: 这个 token 添加了参数和属性以支持使用令牌而不是参数的身份验证方案，例如 Bearer 。

在 2.3 版本发生变更: 该对象不再是 dict 。

在 0.5 版本发生变更: 对象是一个不变的规则。

参数:

• auth_type (str) --

• data (dict[str, str | None] | None) --

• token (str | None) --

classmethod from_header(value)

解析AN Authorization 标头值并返回一个实例，或者 None 如果值为空，则返回。

参数:

value (str | None) -- 要分析的标头值。

返回类型:

te.Self | None

Changelog

在 2.3 版本加入.

parameters

从标头解析的参数字典。要么是这个，要么是 token 对于给定的方案将具有值。

to_header()

制作一份 Authorization 表示此数据的标头值。

Changelog

在 2.0 版本加入.

返回类型:

str

token

从标头解析的令牌。要么是这个，要么是 parameters 对于给定的方案将具有值。

Changelog

在 2.3 版本加入.

type

授权方案，如 basic ， digest ，或 bearer 。

class werkzeug.datastructures.WWWAuthenticate(auth_type, values=None, token=None)

表示的是 WWW-Authenticate 响应头。

集 Response.www_authenticate 到实例列表的实例，以在响应中为此标头设置值。修改此实例将修改标头值。

根据身份验证方案， parameters 或 token 应该设置。这个 Basic 方案将进行编码 username 和 password 参数添加到令牌。

为了方便起见， auth["key"] 和 auth.key 两者都是按照 parameters Dict，并可用于获取、设置或删除参数。 auth.get("key") 和 "key" in auth 还提供了。

Changelog

在 2.3 版本发生变更: 这个 token 添加了参数和属性以支持使用令牌而不是参数的身份验证方案，例如 Bearer 。

在 2.3 版本发生变更: 该对象不再是 dict 。

在 2.3 版本发生变更: 这个 on_update 参数已删除。

参数:

• auth_type (str) --

• values (dict[str, str | None] | None) --

• token (str | None) --

classmethod from_header(value)

解析为 WWW-Authenticate 标头值并返回一个实例，或者 None 如果值为空，则返回。

参数:

value (str | None) -- 要分析的标头值。

返回类型:

te.Self | None

Changelog

在 2.3 版本加入.

property parameters: dict[str, str | None]

标头的参数字典。只有一个是这样，或者 token 对于给定的方案应该有一个值。

to_header()

生产一种 WWW-Authenticate 表示此数据的标头值。

返回类型:

str

property token: str | None

标头的参数字典。只有一个是这样，或者 token 对于给定的方案应该有一个值。

property type: str

授权方案，如 basic ， digest ，或 bearer 。

class werkzeug.datastructures.IfRange(etag=None, date=None)

非常简单的对象，表示 If-Range 以解析形式显示的标题。它要么没有etag，要么没有日期，要么两者都没有。

Changelog

在 0.7 版本加入.

date

解析格式的日期或 None .

etag

ETag解析并没有引用。范围总是在强ETags上运行，因此不需要弱信息。

to_header()

将对象转换回HTTP头。

class werkzeug.datastructures.Range(units, ranges)

表示 Range 标题。所有方法只支持字节作为单位。如果给定，则存储一个范围列表，但仅当提供一个范围时，方法才起作用。

抛出:

ValueError -- 如果提供的范围无效。

Changelog

在 0.15 版本发生变更: 已验证传入的范围。

在 0.7 版本加入.

make_content_range(length)

创建一个 ContentRange 来自当前范围和给定内容长度的对象。

range_for_length(length)

如果范围是字节，则长度不是“无”，并且只有一个范围，并且它是可满足的，则返回 (start, stop) 否则是tuple None .

ranges

列表 (begin, end) 提供了范围头的元组。范围不包含在内。

to_content_range_header(length)

将对象转换为 Content-Range HTTP头，基于给定长度

to_header()

将对象转换回HTTP头。

units

这个范围的单位。通常是“字节”。

class werkzeug.datastructures.ContentRange(units, start, stop, length=None, on_update=None)

表示内容范围标题。

Changelog

在 0.7 版本加入.

property length

范围的长度或 None .

set(start, stop, length=None, units='bytes')

更新范围的简单方法。

property start

范围的起点或 None .

property stop

范围的停止点（非包含）或 None .只能是 None 如果也开始是 None .

property units

要使用的单位，通常是“字节”

unset()

将单位设置为 None 这表示不再使用标题。

其他

class werkzeug.datastructures.FileStorage(stream=None, filename=None, name=None, content_type=None, content_length=None, headers=None)

这个 FileStorage 类是对传入文件的精简包装。请求对象使用它来表示上载的文件。包装流的所有属性都由文件存储代理，因此可以这样做 storage.read() 而不是长形 storage.stream.read() .

stream

上载文件的输入流。这通常指向一个打开的临时文件。

filename

客户端上的文件的文件名。可以是一个 str ，或者是 os.PathLike 。

name

表单域的名称。

headers

多部分标题为 Headers 对象。这通常包含不相关的信息，但结合自定义多部分请求，原始头可能会很有趣。

Changelog

在 0.6 版本加入.

close()

如果可能，关闭基础文件。

property content_length

在标题中发送的内容长度。通常不可用

property content_type

在头中发送的内容类型。通常不可用

property mimetype

喜欢 content_type ，但不带参数（例如，不带字符集、类型等）且始终为小写。例如，如果内容类型为 text/HTML; charset=utf-8 mimetype应该是 'text/html' .

Changelog

在 0.7 版本加入.

property mimetype_params

mimetype参数为dict。例如，如果内容类型为 text/html; charset=utf-8 参数是 {{'charset': 'utf-8'}} .

Changelog

在 0.7 版本加入.

save(dst, buffer_size=16384)

将文件保存到目标路径或文件对象。如果目标是一个文件对象，那么在调用后必须自己关闭它。缓冲区大小是复制过程中内存中保留的字节数。默认为16KB。

对于安全文件保存，也可以查看 secure_filename() .

参数:

• dst -- 一个文件名， os.PathLike ，或打开要写入的文件对象。

• buffer_size -- 作为 length 参数 shutil.copyfileobj() .

Changelog

在 1.0 版本发生变更: 支架 pathlib .