cardinal_pythonlib.wsgi.headers_mw

Original code copyright (C) 2009-2022 Rudolf Cardinal (rudolf@pobox.com).

This file is part of cardinal_pythonlib.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

WSGI middleware to add arbitrary HTTP headers.

class cardinal_pythonlib.wsgi.headers_mw.AddHeadersMiddleware(app: Callable[[Dict[str, str], Callable[[str, List[Tuple[str, str]], Tuple[Type[BaseException] | None, BaseException | None, TracebackType | None] | None], Callable[[str], None]]], Iterable[bytes]], headers: List[Tuple[str, str]], method: int = 0)[source]

WSGI middleware to add arbitrary HTTP headers.

See e.g. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers for a list of possible HTTP headers.

Note:

HTTP headers are case-insensitive. However, the canonical form is hyphenated camel case; https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers.
You can specify the same HTTP header multiple times; apart from Set-Cookie, this should have the effect of the browser treating them as concatenated in a CSV format. https://stackoverflow.com/questions/3096888; https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2

Parameters:

app¶ – The WSGI app to which to apply the middleware.
headers¶ – A list of tuples, each of the form (key, value).

class cardinal_pythonlib.wsgi.headers_mw.HeaderModifyMode[source]: Options for cardinal_pythonlib.wsgi.headers_mw.AddHeadersMiddleware.