Werkzeug v2.1.0 Release Notes

  • ๐Ÿš€ Unreleased

    • ๐Ÿ‘ Drop support for Python 3.6. :pr:2277
    • Using gevent or eventlet requires greenlet>=1.0 or PyPy>=7.3.7. werkzeug.locals and contextvars will not work correctly with older versions. :pr:2278
    • ๐Ÿšš Remove previously deprecated code. :pr:2276

      • Remove the non-standard shutdown function from the WSGI environ when running the development server. See the docs for alternatives.
      • Request and response mixins have all been merged into the Request and Response classes.
      • The user agent parser and the useragents module is removed. The user_agent module provides an interface that can be subclassed to add a parser, such as ua-parser. By default it only stores the whole string.
      • The test client returns TestResponse instances and can no longer be treated as a tuple. All data is available as properties on the response.
      • Remove locals.get_ident and related thread-local code from locals, it no longer makes sense when moving to a contextvars-based implementation.
      • Remove the python -m werkzeug.serving CLI.
      • The has_key method on some mapping datastructures; use key in data instead.
      • Request.disable_data_descriptor is removed, pass shallow=True instead.
      • Remove the no_etag parameter from Response.freeze().
      • Remove the HTTPException.wrap class method.
      • Remove the cookie_date function. Use http_date instead.
      • Remove the pbkdf2_hex, pbkdf2_bin, and safe_str_cmp functions. Use equivalents in hashlib and hmac modules instead.
      • Remove the Href class.
      • Remove the HTMLBuilder class.
      • Remove the invalidate_cached_property function. Use del obj.attr instead.
      • Remove bind_arguments and validate_arguments. Use :meth:Signature.bind and :func:inspect.signature instead.
      • Remove detect_utf_encoding, it's built-in to json.loads.
      • Remove format_string, use :class:string.Template instead.
      • Remove escape and unescape. Use MarkupSafe instead.
    • Rely on :pep:538 and :pep:540 to handle decoding file names with the correct filesystem encoding. The filesystem module is removed. :issue:1760

    • 0๏ธโƒฃ Default values passed to Headers are validated the same way values added later are. :issue:1608

    • Setting CacheControl int properties, such as max_age, will convert the value to an int. :issue:2230

    • Always use socket.fromfd when restarting the dev server. :pr:2287

    • ๐Ÿ— When passing a dict of URL values to Map.build, list values do not filter out None or collapse to a single value. Passing a MultiDict does collapse single items. This undoes a previous change that made it difficult to pass a list, or None values in a list, to custom URL converters. :issue:2249

    • run_simple shows instructions for dealing with "address already in use" errors, including extra instructions for macOS. :pr:2321

    • Extend list of characters considered always safe in URLs based on :rfc:3986. :issue:2319

    • โšก๏ธ Optimize the stat reloader to avoid watching unnecessary files in more cases. The watchdog reloader is still recommended for performance and accuracy. :issue:2141

    • The development server uses Transfer-Encoding: chunked for streaming responses when it is configured for HTTP/1.1. :issue:2090, 1327, :pr:2091

    • The development server uses HTTP/1.1, which enables keep-alive connections and chunked streaming responses, when threaded or processes is enabled. :pr:2323

    • cached_property works for classes with __slots__ if a corresponding _cache_{name} slot is added. :pr:2332

    • ๐Ÿ”จ Refactor the debugger traceback formatter to use Python's built-in traceback module as much as possible. :issue:1753

    • โœ… The TestResponse.text property is a shortcut for r.get_data(as_text=True), for convenient testing against text instead of bytes. :pr:2337

    • safe_join ensures that the path remains relative if the trusted directory is the empty string. :pr:2349