./www/py-werkzeug-docs, Python WSGI Utility Library (HTML documentation)

[ CVSweb ] [ Homepage ] [ RSS ] [ Required by ] [ Add to tracker ]

Branch: CURRENT, Version: 1.0.1, Package name: py37-werkzeug-docs-1.0.1, Maintainer: kleink

This package contains the HTML documentation for Werkzeug.

Werkzeug is a WSGI utility library for Python. It's widely used
and BSD licensed.

Werkzeug started as a simple collection of various utilities for
WSGI applications and has become one of the most advanced WSGI
utility modules. It includes a powerful debugger, fully featured
request and response objects, HTTP utilities to handle entity tags,
cache control headers, HTTP dates, cookie handling, file uploads,
a powerful URL routing system and a bunch of community contributed
addon modules.

It does Unicode and doesn't enforce a specific template engine,
database adapter or anything else. It doesn't even enforce a specific
way of handling requests and leaves all that up to the developer.

Required to build:
[pkgtools/cwrappers] [lang/python37]

Master sites:

SHA1: 07b0f2dcd460076d437d1481c556584db88df199
RMD160: 9dc625e19c6cb90783972a8d467bd5270aafe30c
Filesize: 883.257 KB

Version history: (Expand)

CVS history: (Expand)

   2020-04-01 19:44:55 by Adam Ciarcinski | Files touched by this commit (4) | Package updated
Log message:
py-werkzeug{-docs}: updated to 1.0.1

Version 1.0.1
-   Make the argument to ``RequestRedirect.get_response`` optional.
-   Only allow a single access control allow origin value.
-   Fix crash when trying to parse a non-existent Content Security
    Policy header.
-   ``http_date`` zero fills years < 1000 to always output four digits.
-   Fix missing local variables in interactive debugger console.
-   Fix passing file-like objects like ``io.BytesIO`` to

Version 1.0.0
-   Drop support for Python 3.4. (:issue:`1478`)
-   Remove code that issued deprecation warnings in version 0.15.
-   Remove most top-level attributes provided by the ``werkzeug``
    module in favor of direct imports. For example, instead of
    ``import werkzeug; werkzeug.url_quote``, do
    ``from werkzeug.urls import url_quote``. Install version 0.16 first
    to see deprecation warnings while upgrading.
-   Added ``utils.invalidate_cached_property()`` to invalidate cached
    properties. (:pr:`1474`)
-   Directive keys for the ``Set-Cookie`` response header are not
    ignored when parsing the ``Cookie`` request header. This allows
    cookies with names such as "expires" and "version". \ 
-   Request cookies are parsed into a ``MultiDict`` to capture all
    values for cookies with the same key. ``cookies[key]`` returns the
    first value rather than the last. Use ``cookies.getlist(key)`` to
    get all values. ``parse_cookie`` also defaults to a ``MultiDict``.
-   Add ``charset=utf-8`` to an HTTP exception response's
    ``CONTENT_TYPE`` header. (:pr:`1526`)
-   The interactive debugger handles outer variables in nested scopes
    such as lambdas and comprehensions.
-   The user agent for Opera 60 on Mac is correctly reported as
    "opera" instead of "chrome".
-   The platform for Crosswalk on Android is correctly reported as
    "android" instead of "chromeos". (:pr:`1572`)
-   Issue a warning when the current server name does not match the
    configured server name.
-   A configured server name with the default port for a scheme will
    match the current server name without the port if the current scheme
-   :exc:`~exceptions.InternalServerError` has a ``original_exception``
    attribute that frameworks can use to track the original cause of the
-   Headers are tested for equality independent of the header key case,
    such that ``X-Foo`` is the same as ``x-foo``.
-   :meth:`http.dump_cookie` accepts ``'None'`` as a value for
-   :meth:`~test.Client.set_cookie` accepts a ``samesite`` argument.
-   Support the Content Security Policy header through the
    `Response.content_security_policy` data structure.
-   ``LanguageAccept`` will fall back to matching "en" for \ 
"en-US" or
    "en-US" for "en" to better support clients or \ 
translations that
    only match at the primary language tag.
-   ``MIMEAccept`` uses MIME parameters for specificity when matching.
-   If the development server is started with an ``SSLContext``
    configured to verify client certificates, the certificate in PEM
    format will be available as ``environ["SSL_CLIENT_CERT"]``.
-   ``is_resource_modified`` will run for methods other than ``GET`` and
    ``HEAD``, rather than always returning ``False``.
-   ``SharedDataMiddleware`` returns 404 rather than 500 when trying to
    access a directory instead of a file with the package loader. The
    dependency on setuptools and pkg_resources is removed.
-   Add a ``response.cache_control.immutable`` flag. Keep in mind that
    browser support for this ``Cache-Control`` header option is still
    experimental and may not be implemented.
-   Optional request log highlighting with the development server is
    handled by Click instead of termcolor.
-   Optional ad-hoc TLS support for the development server is handled
    by cryptography instead of pyOpenSSL.
-   ``FileStorage.save()`` supports ``pathlib`` and :pep:`519`
    ``PathLike`` objects.
-   The debugger security pin is unique in containers managed by Podman.
-   Building a URL when ``host_matching`` is enabled takes into account
    the current host when there are duplicate endpoints with different
-   The ``429 TooManyRequests`` and ``503 ServiceUnavailable`` HTTP
    exceptions takes a ``retry_after`` parameter to set the
    ``Retry-After`` header.
-   ``Map`` and ``Rule`` have a ``merge_slashes`` option to collapse
    multiple slashes into one, similar to how many HTTP servers behave.
    This is enabled by default.
-   Add HTTP 103, 208, 306, 425, 506, 508, and 511 to the list of status
-   Add ``update``, ``setlist``, and ``setlistdefault`` methods to the
    ``Headers`` data structure. ``extend`` method can take ``MultiDict``
    and kwargs.
-   The development server accepts paths that start with two slashes,
    rather than stripping off the first path segment.
-   Add access control (Cross Origin Request Sharing, CORS) header
    properties to the ``Request`` and ``Response`` wrappers.
-   ``Accept`` values are no longer ordered alphabetically for equal
    quality tags. Instead the initial order is preserved.
-   Added ``Map.lock_class`` attribute for alternative
-   Support matching and building WebSocket rules in the routing system,
    for use by async frameworks.
-   Range requests that span an entire file respond with 206 instead of
    200, to be more compliant with :rfc:`7233`. This may help serving
    media to older browsers.
-   The :class:`~middleware.shared_data.SharedDataMiddleware` default
    ``fallback_mimetype`` is ``application/octet-stream``. If a filename
    looks like a text mimetype, the ``utf-8`` charset is added to it.
    This matches the behavior of :class:`~wrappers.BaseResponse` and
    Flask's ``send_file()``.
   2020-02-03 21:04:57 by Adam Ciarcinski | Files touched by this commit (1)
Log message:
reset revision
   2019-11-14 06:25:43 by David H. Gutteridge | Files touched by this commit (1)
Log message:
py-werkzeug-docs: reflect dependency change

This package now depends on py-pallets-sphinx-themes>=1.2.2nb1, since
the latter added a new dependency for its basic functioning (and 1.2.2
pre-revbump was broken).
   2019-10-22 00:11:34 by Adam Ciarcinski | Files touched by this commit (7)
Log message:
Switch sphinx to versioned deps.
   2019-09-14 19:09:11 by David H. Gutteridge | Files touched by this commit (1)
Log message:
py-werkzeug-docs: note py-werkzeug dependency

Fix bulk builds by noting this depends on py-werkzeug. (While here,
   2019-05-23 14:00:48 by Adam Ciarcinski | Files touched by this commit (4) | Package updated
Log message:
py-werkzeug: updated to 0.15.4

Version 0.15.4
-   Fix a SyntaxError on Python 2.7.5. (:issue:1544)

Version 0.15.3
-   Properly handle multi-line header folding in development server in
    Python 2.7. (:issue:1080)
-   Restore the response argument to :exc:~exceptions.Unauthorized.
-   :exc:~exceptions.Unauthorized doesn't add the WWW-Authenticate
    header if www_authenticate is not given. (:issue:1516)
-   The default URL converter correctly encodes bytes to string rather
    than representing them with b''. (:issue:1502)
-   Fix the filename format string in
    :class:~middleware.profiler.ProfilerMiddleware to correctly handle
    float values. (:issue:1511)
-   Update :class:~middleware.lint.LintMiddleware to work on Python 3.
-   The debugger detects cycles in chained exceptions and does not time
    out in that case. (:issue:1536)
-   When running the development server in Docker, the debugger security
    pin is now unique per container.
   2019-04-24 18:05:43 by Adam Ciarcinski | Files touched by this commit (4) | Package updated
Log message:
py-werkzeug: updated to 0.15.2

Version 0.15.2
-   Rule code generation uses a filename that coverage will ignore.
    The previous value, "generated", was causing coverage to fail.

-   The test client removes the cookie header if there are no persisted
    cookies. This fixes an issue introduced in 0.15.0 where the cookies
    from the original request were used for redirects, causing functions
    such as logout to fail.
-   The test client copies the environ before passing it to the app, to
    prevent in-place modifications from affecting redirect requests.

-   The "werkzeug" logger only adds a handler if there is no handler
    configured for its level in the logging chain. This avoids double
    logging if other code configures logging first.

Version 0.15.1
-   :class:~exceptions.Unauthorized takes description as the first
    argument, restoring previous behavior. The new www_authenticate
    argument is listed second.

Version 0.15.0
-   Building URLs is ~7x faster. Each :class:~routing.Rule compiles
    an optimized function for building itself.
-   :meth:MapAdapter.build() <routing.MapAdapter.build> can be passed
    a :class:~datastructures.MultiDict to represent multiple values
    for a key. It already did this when passing a dict with a list
-   path_info defaults to '/' for
    :meth:Map.bind() <routing.Map.bind>.
-   Change RequestRedirect code from 301 to 308, preserving the verb
    and request body (form data) during redirect.
-   int and float converters in URL rules will handle negative
    values if passed the signed=True parameter. For example,
-   Location autocorrection in :func:Response.get_wsgi_headers()
    <wrappers.BaseResponse.get_wsgi_headers> is relative to the current
    path rather than the root path.
-   412 responses once again include entity headers and an error message
    in the body. They were originally omitted when implementing

-   The Content-Length header is removed for 1xx and 204 responses. This
    fixes a previous change where no body would be sent, but the header
    would still be present. The new behavior matches RFC 7230.

-   :class:~exceptions.Unauthorized takes a www_authenticate
    parameter to set the WWW-Authenticate header for the response,
    which is technically required for a valid 401 response.

-   Add support for status code 424 :exc:~exceptions.FailedDependency.

-   :func:http.parse_cookie ignores empty segments rather than
    producing a cookie with no key or value.
-   :func:~http.parse_authorization_header (and
    :attr:~wrappers.Request.authorization) treats the authorization
    header as UTF-8. On Python 2, basic auth username and password are
-   :func:~http.parse_options_header understands :rfc:2231 parameter
-   :func:~urls.uri_to_iri does not unquote ASCII characters in the
    unreserved class, such as space, and leaves invalid bytes quoted
    when decoding. :func:~urls.iri_to_uri does not quote reserved
    characters. See :rfc:3987 for these character classes.

-   get_content_type appends a charset for any mimetype that ends
    with +xml, not just those that start with application/.
    Known text types such as application/javascript are also given
-   Clean up werkzeug.security module, remove outdated hashlib
-   In :func:~security.generate_password_hash, PBKDF2 uses 150000
    iterations by default, increased from 50000.
-   :class:~wsgi.ClosingIterator calls close on the wrapped
    *iterable*, not the internal iterator. This doesn't affect objects
    where __iter__ returned self. For other objects, the method
    was not called before.
-   Bytes may be used as keys in :class:~datastructures.Headers, they
    will be decoded as Latin-1 like values are.
-   :class:~datastructures.Range validates that list of range tuples
    passed to it would produce a valid Range header.
-   :class:~datastructures.FileStorage looks up attributes on
    stream._file if they don't exist on stream, working around
    an issue where :func:tempfile.SpooledTemporaryFile didn't
    implement all of :class:io.IOBase. See
-   :class:CombinedMultiDict.copy() <datastructures.CombinedMultiDict>
    returns a shallow mutable copy as a
    :class:~datastructures.MultiDict. The copy no longer reflects
    changes to the combined dicts, but is more generally useful.

-   The version of jQuery used by the debugger is updated to 3.3.1.

-   The debugger correctly renders long markupsafe.Markup instances.

-   The debugger can serve resources when Werkzeug is installed as a
    zip file. DebuggedApplication.get_resource uses
-   The debugger and server log support Python 3's chained exceptions.

-   The interactive debugger highlights frames that come from user code
    to make them easy to pick out in a long stack trace. Note that if an
    env was created with virtualenv instead of venv, the debugger may
    incorrectly classify some frames.
-   Clicking the error message at the top of the interactive debugger
    will jump down to the bottom of the traceback.
-   When generating a PIN, the debugger will ignore a KeyError
    raised when the current UID doesn't have an associated username,
    which can happen in Docker.
-   :class:~exceptions.BadRequestKeyError adds the KeyError
    message to the description, making it clearer what caused the 400
    error. Frameworks like Flask can omit this information in production
    by setting e.args = ().
-   If a nested ImportError occurs from :func:~utils.import_string
    the traceback mentions the nested import. Removes an untested code
    path for handling "modules not yet set up by the parent."

-   Triggering a reload while using a tool such as PDB no longer hides
-   The reloader will not prepend the Python executable to the command
    line if the Python file is marked executable. This allows the
    reloader to work on NixOS.
-   Fix an issue where sys.path would change between reloads when
    running with python -m app. The reloader can detect that a
    module was run with "-m" and reconstructs that instead of the file
    path in sys.argv when reloading.
-   The dev server can bind to a Unix socket by passing a hostname like
-   Server uses IPPROTO_TCP constant instead of SOL_TCP for
    Jython compatibility.
-   When using an adhoc SSL cert with :func:~serving.run_simple, the
    cert is shown as self-signed rather than signed by an invalid
-   The development server logs the unquoted IRI rather than the raw
    request line, to make it easier to work with Unicode in request
    paths during development.
-   The development server recognizes ConnectionError on Python 3 to
    silence client disconnects, and does not silence other OSErrors
    that may have been raised inside the application.
-   The environ keys REQUEST_URI and RAW_URI contain the raw
    path before it was percent-decoded. This is non-standard, but many
    WSGI servers add them. Middleware could replace PATH_INFO with
    this to route based on the raw value.
-   :class:~test.EnvironBuilder doesn't set CONTENT_TYPE or
    CONTENT_LENGTH in the environ if they aren't set. Previously
    these used default values if they weren't set. Now it's possible to
    distinguish between empty and unset values.
-   The test client raises a ValueError if a query string argument
    would overwrite a query string in the path.
-   :class:test.EnvironBuilder and :class:test.Client take a
    json argument instead of manually passing data and
    content_type. This is serialized using the
    :meth:test.EnvironBuilder.json_dumps method.
-   :class:test.Client redirect handling is rewritten.

    -   The redirect environ is copied from the initial request environ.
    -   Script root and path are correctly distinguished when
        redirecting to a path under the root.
    -   The HEAD method is not changed to GET.
    -   307 and 308 codes preserve the method and body. All others
        ignore the body and related headers.
    -   Headers are passed to the new request for all codes, following
        what browsers do.
    -   :class:test.EnvironBuilder sets the content type and length
        headers in addition to the WSGI keys when detecting them from
        the data.
    -   Intermediate response bodies are iterated over even when
        buffered=False to ensure iterator middleware can run cleanup
        code safely. Only the last response is not buffered.

-   :class:~test.EnvironBuilder, :class:~datastructures.FileStorage,
    and :func:wsgi.get_input_stream no longer share a global
    _empty_stream instance. This improves test isolation by
    preventing cases where closing the stream in one request would
    affect other usages.
-   The default :attr:SecureCookie.serialization_method
    <contrib.securecookie.SecureCookie.serialization_method> will
    change from :mod:pickle to :mod:json in 1.0. To upgrade existing
    tokens, override :meth:~contrib.securecookie.SecureCookie.unquote
    to try pickle if json fails.
-   CGIRootFix no longer modifies PATH_INFO for very old
    versions of Lighttpd. LighttpdCGIRootFix was renamed to
    CGIRootFix in 0.9. Both are deprecated and will be removed in
    version 1.0.
-   :class:werkzeug.wrappers.json.JSONMixin has been replaced with
    Flask's implementation. Check the docs for the full API.

-   The :doc:contrib modules </contrib/index> are deprecated and will
    either be moved into werkzeug core or removed completely in
    version 1.0. Some modules that already issued deprecation warnings
    have been removed. Be sure to run or test your code with
    python -W default::DeprecationWarning to catch any deprecated
    code you're using.

    -   LintMiddleware has moved to :mod:werkzeug.middleware.lint.
    -   ProfilerMiddleware has moved to
    -   ProxyFix has moved to :mod:werkzeug.middleware.proxy_fix.
    -   JSONRequestMixin has moved to :mod:werkzeug.wrappers.json.
    -   cache has been extracted into a separate project,
        cachelib <https://github.com/pallets/cachelib>_. The version
        in Werkzeug is deprecated.
    -   securecookie and sessions have been extracted into a
        separate project,
        secure-cookie <https://github.com/pallets/secure-cookie>_. The
        version in Werkzeug is deprecated.
    -   Everything in fixers, except ProxyFix, is deprecated.
    -   Everything in wrappers, except JSONMixin, is deprecated.
    -   atom is deprecated. This did not fit in with the rest of
        Werkzeug, and is better served by a dedicated library in the
    -   jsrouting is removed. Set URLs when rendering templates
        or JSON responses instead.
    -   limiter is removed. Its specific use is handled by Werkzeug
        directly, but stream limiting is better handled by the WSGI
        server in general.
    -   testtools is removed. It did not offer significant benefit
        over the default test client.
    -   iterio is deprecated.

-   :func:wsgi.get_host no longer looks at X-Forwarded-For. Use
    :class:~middleware.proxy_fix.ProxyFix to handle that.

-   :class:~middleware.proxy_fix.ProxyFix is refactored to support
    more headers, multiple values, and more secure configuration.

    -   Each header supports multiple values. The trusted number of
        proxies is configured separately for each header. The
        num_proxies argument is deprecated.
    -   Sets SERVER_NAME and SERVER_PORT based on
    -   Sets SERVER_PORT and modifies HTTP_HOST based on
    -   Sets SCRIPT_NAME based on X-Forwarded-Prefix.

    -   The original WSGI environment values are stored in the
        werkzeug.proxy_fix.orig key, a dict. The individual keys
        werkzeug.proxy_fix.orig_wsgi_url_scheme, and
        werkzeug.proxy_fix.orig_http_host are deprecated.

-   Middleware from werkzeug.wsgi has moved to separate modules
    under werkzeug.middleware, along with the middleware moved from
    werkzeug.contrib. The old werkzeug.wsgi imports are
    deprecated and will be removed in version 1.0.

    -   werkzeug.wsgi.DispatcherMiddleware has moved to
    -   werkzeug.wsgi.ProxyMiddleware as moved to
    -   werkzeug.wsgi.SharedDataMiddleware has moved to

-   :class:~middleware.http_proxy.ProxyMiddleware proxies the query
-   The filenames generated by
    :class:~middleware.profiler.ProfilerMiddleware can be customized.

-   The werkzeug.wrappers module has been converted to a package,
    and its various classes have been organized into separate modules.
    Any previously documented classes, understood to be the existing
    public API, are still importable from werkzeug.wrappers, or may
    be imported from their specific modules.
   2017-05-31 10:24:38 by Adam Ciarcinski | Files touched by this commit (6)
Log message:
Version 0.12.2
- Fix regression: Pull request ``892`` prevented Werkzeug from correctly
  logging the IP of a remote client behind a reverse proxy, even when using
- Fix a bug in `safe_join` on Windows.