Browse Source

fix changelog indentation

pull/2711/head
David Lord 7 years ago
parent
commit
16549370fd
No known key found for this signature in database
GPG Key ID: 7A1C87E3F5BC42A8
  1. 98
      CHANGES.rst

98
CHANGES.rst

@ -13,23 +13,24 @@ unreleased
- Bump minimum dependency versions to the latest stable versions: - Bump minimum dependency versions to the latest stable versions:
Werkzeug >= 0.14, Jinja >= 2.10, itsdangerous >= 0.24, Click >= 5.1. Werkzeug >= 0.14, Jinja >= 2.10, itsdangerous >= 0.24, Click >= 5.1.
(`#2586`_) (`#2586`_)
- Skip :meth:`app.run <Flask.run>` when a Flask application is run from - Skip :meth:`app.run <Flask.run>` when a Flask application is run
the command line. This avoids some behavior that was confusing to from the command line. This avoids some behavior that was confusing
debug. to debug.
- Change the default for :data:`JSONIFY_PRETTYPRINT_REGULAR` to - Change the default for :data:`JSONIFY_PRETTYPRINT_REGULAR` to
``False``. :func:`~json.jsonify` returns a compact format by default, ``False``. :func:`~json.jsonify` returns a compact format by
and an indented format in debug mode. (`#2193`_) default, and an indented format in debug mode. (`#2193`_)
- :meth:`Flask.__init__ <Flask>` accepts the ``host_matching`` argument - :meth:`Flask.__init__ <Flask>` accepts the ``host_matching``
and sets it on :attr:`~Flask.url_map`. (`#1559`_) argument and sets it on :attr:`~Flask.url_map`. (`#1559`_)
- :meth:`Flask.__init__ <Flask>` accepts the ``static_host`` argument - :meth:`Flask.__init__ <Flask>` accepts the ``static_host`` argument
and passes it as the ``host`` argument when defining the static route. and passes it as the ``host`` argument when defining the static
(`#1559`_) route. (`#1559`_)
- :func:`send_file` supports Unicode in ``attachment_filename``. - :func:`send_file` supports Unicode in ``attachment_filename``.
(`#2223`_) (`#2223`_)
- Pass ``_scheme`` argument from :func:`url_for` to - Pass ``_scheme`` argument from :func:`url_for` to
:meth:`~Flask.handle_url_build_error`. (`#2017`_) :meth:`~Flask.handle_url_build_error`. (`#2017`_)
- :meth:`~Flask.add_url_rule` accepts the ``provide_automatic_options`` - :meth:`~Flask.add_url_rule` accepts the
argument to disable adding the ``OPTIONS`` method. (`#1489`_) ``provide_automatic_options`` argument to disable adding the
``OPTIONS`` method. (`#1489`_)
- :class:`~views.MethodView` subclasses inherit method handlers from - :class:`~views.MethodView` subclasses inherit method handlers from
base classes. (`#1936`_) base classes. (`#1936`_)
- Errors caused while opening the session at the beginning of the - Errors caused while opening the session at the beginning of the
@ -50,12 +51,13 @@ unreleased
``SERVER_NAME``. (`#2282`_) ``SERVER_NAME``. (`#2282`_)
- Auto-detect zero-argument app factory called ``create_app`` or - Auto-detect zero-argument app factory called ``create_app`` or
``make_app`` from ``FLASK_APP``. (`#2297`_) ``make_app`` from ``FLASK_APP``. (`#2297`_)
- Factory functions are not required to take a ``script_info`` parameter - Factory functions are not required to take a ``script_info``
to work with the ``flask`` command. If they take a single parameter or parameter to work with the ``flask`` command. If they take a single
a parameter named ``script_info``, the :class:`~cli.ScriptInfo` object parameter or a parameter named ``script_info``, the
will be passed. (`#2319`_) :class:`~cli.ScriptInfo` object will be passed. (`#2319`_)
- ``FLASK_APP`` can be set to an app factory, with arguments if needed, - ``FLASK_APP`` can be set to an app factory, with arguments if
for example ``FLASK_APP=myproject.app:create_app('dev')``. (`#2326`_) needed, for example ``FLASK_APP=myproject.app:create_app('dev')``.
(`#2326`_)
- ``FLASK_APP`` can point to local packages that are not installed in - ``FLASK_APP`` can point to local packages that are not installed in
editable mode, although ``pip install -e`` is still preferred. editable mode, although ``pip install -e`` is still preferred.
(`#2414`_) (`#2414`_)
@ -77,8 +79,8 @@ unreleased
``BadRequestKeyError`` has a message with the bad key in debug mode ``BadRequestKeyError`` has a message with the bad key in debug mode
instead of the generic bad request message. (`#2348`_) instead of the generic bad request message. (`#2348`_)
- Allow registering new tags with - Allow registering new tags with
:class:`~json.tag.TaggedJSONSerializer` to support storing other types :class:`~json.tag.TaggedJSONSerializer` to support storing other
in the session cookie. (`#2352`_) types in the session cookie. (`#2352`_)
- Only open the session if the request has not been pushed onto the - Only open the session if the request has not been pushed onto the
context stack yet. This allows :func:`~stream_with_context` context stack yet. This allows :func:`~stream_with_context`
generators to access the same session that the containing view uses. generators to access the same session that the containing view uses.
@ -86,32 +88,36 @@ unreleased
- Add ``json`` keyword argument for the test client request methods. - Add ``json`` keyword argument for the test client request methods.
This will dump the given object as JSON and set the appropriate This will dump the given object as JSON and set the appropriate
content type. (`#2358`_) content type. (`#2358`_)
- Extract JSON handling to a mixin applied to both the :class:`Request` - Extract JSON handling to a mixin applied to both the
and :class:`Response` classes. This adds the :meth:`~Response.is_json` :class:`Request` and :class:`Response` classes. This adds the
and :meth:`~Response.get_json` methods to the response to make testing :meth:`~Response.is_json` and :meth:`~Response.get_json` methods to
JSON response much easier. (`#2358`_) the response to make testing JSON response much easier. (`#2358`_)
- Removed error handler caching because it caused unexpected results for - Removed error handler caching because it caused unexpected results
some exception inheritance hierarchies. Register handlers explicitly for some exception inheritance hierarchies. Register handlers
for each exception if you want to avoid traversing the MRO. (`#2362`_) explicitly for each exception if you want to avoid traversing the
MRO. (`#2362`_)
- Fix incorrect JSON encoding of aware, non-UTC datetimes. (`#2374`_) - Fix incorrect JSON encoding of aware, non-UTC datetimes. (`#2374`_)
- Template auto reloading will honor debug mode even even if - Template auto reloading will honor debug mode even even if
:attr:`~Flask.jinja_env` was already accessed. (`#2373`_) :attr:`~Flask.jinja_env` was already accessed. (`#2373`_)
- The following old deprecated code was removed. (`#2385`_) - The following old deprecated code was removed. (`#2385`_)
- ``flask.ext`` - import extensions directly by their name instead of - ``flask.ext`` - import extensions directly by their name instead
through the ``flask.ext`` namespace. For example, of through the ``flask.ext`` namespace. For example,
``import flask.ext.sqlalchemy`` becomes ``import flask_sqlalchemy``. ``import flask.ext.sqlalchemy`` becomes
``import flask_sqlalchemy``.
- ``Flask.init_jinja_globals`` - extend - ``Flask.init_jinja_globals`` - extend
:meth:`Flask.create_jinja_environment` instead. :meth:`Flask.create_jinja_environment` instead.
- ``Flask.error_handlers`` - tracked by - ``Flask.error_handlers`` - tracked by
:attr:`Flask.error_handler_spec`, use :meth:`Flask.errorhandler` to :attr:`Flask.error_handler_spec`, use :meth:`Flask.errorhandler`
register handlers. to register handlers.
- ``Flask.request_globals_class`` - use - ``Flask.request_globals_class`` - use
:attr:`Flask.app_ctx_globals_class` instead. :attr:`Flask.app_ctx_globals_class` instead.
- ``Flask.static_path`` - use :attr:`Flask.static_url_path` instead. - ``Flask.static_path`` - use :attr:`Flask.static_url_path`
instead.
- ``Request.module`` - use :attr:`Request.blueprint` instead. - ``Request.module`` - use :attr:`Request.blueprint` instead.
- The :attr:`Request.json` property is no longer deprecated. (`#1421`_) - The :attr:`Request.json` property is no longer deprecated.
(`#1421`_)
- Support passing a :class:`~werkzeug.test.EnvironBuilder` or - Support passing a :class:`~werkzeug.test.EnvironBuilder` or
``dict`` to :meth:`test_client.open <werkzeug.test.Client.open>`. ``dict`` to :meth:`test_client.open <werkzeug.test.Client.open>`.
(`#2412`_) (`#2412`_)
@ -122,11 +128,11 @@ unreleased
used instead of :data:`PREFERRED_URL_SCHEME`. (`#2430`_) used instead of :data:`PREFERRED_URL_SCHEME`. (`#2430`_)
- :attr:`Flask.logger` has been simplified. ``LOGGER_NAME`` and - :attr:`Flask.logger` has been simplified. ``LOGGER_NAME`` and
``LOGGER_HANDLER_POLICY`` config was removed. The logger is always ``LOGGER_HANDLER_POLICY`` config was removed. The logger is always
named ``flask.app``. The level is only set on first access, it doesn't named ``flask.app``. The level is only set on first access, it
check :attr:`Flask.debug` each time. Only one format is used, not doesn't check :attr:`Flask.debug` each time. Only one format is
different ones depending on :attr:`Flask.debug`. No handlers are used, not different ones depending on :attr:`Flask.debug`. No
removed, and a handler is only added if no handlers are already handlers are removed, and a handler is only added if no handlers are
configured. (`#2436`_) already configured. (`#2436`_)
- Blueprint view function names may not contain dots. (`#2450`_) - Blueprint view function names may not contain dots. (`#2450`_)
- Fix a ``ValueError`` caused by invalid ``Range`` requests in some - Fix a ``ValueError`` caused by invalid ``Range`` requests in some
cases. (`#2526`_) cases. (`#2526`_)
@ -140,18 +146,18 @@ unreleased
- Added :meth:`~flask.Flask.test_cli_runner` to create a Click runner - Added :meth:`~flask.Flask.test_cli_runner` to create a Click runner
that can invoke Flask CLI commands for testing. (`#2636`_) that can invoke Flask CLI commands for testing. (`#2636`_)
- Subdomain matching is disabled by default and setting - Subdomain matching is disabled by default and setting
:data:`SERVER_NAME` does not implicily enable it. It can be enabled by :data:`SERVER_NAME` does not implicily enable it. It can be enabled
passing ``subdomain_matching=True`` to the ``Flask`` constructor. by passing ``subdomain_matching=True`` to the ``Flask`` constructor.
(`#2635`_) (`#2635`_)
- A single trailing slash is stripped from the blueprint ``url_prefix`` - A single trailing slash is stripped from the blueprint
when it is registered with the app. (`#2629`_) ``url_prefix`` when it is registered with the app. (`#2629`_)
- :meth:`Request.get_json` doesn't cache the - :meth:`Request.get_json` doesn't cache the
result if parsing fails when ``silent`` is true. (`#2651`_) result if parsing fails when ``silent`` is true. (`#2651`_)
- :func:`Request.get_json` no longer accepts arbitrary encodings. - :func:`Request.get_json` no longer accepts arbitrary encodings.
Incoming JSON should be encoded using UTF-8 per :rfc:`8259`, but Flask Incoming JSON should be encoded using UTF-8 per :rfc:`8259`, but
will autodetect UTF-8, -16, or -32. (`#2691`_) Flask will autodetect UTF-8, -16, or -32. (`#2691`_)
- Added :data:`MAX_COOKIE_SIZE` and :attr:`Response.max_cookie_size` to - Added :data:`MAX_COOKIE_SIZE` and :attr:`Response.max_cookie_size`
control when Werkzeug warns about large cookies that browsers may to control when Werkzeug warns about large cookies that browsers may
ignore. (`#2693`_) ignore. (`#2693`_)
- Updated documentation theme to make docs look better in small - Updated documentation theme to make docs look better in small
windows. (`#2709`_) windows. (`#2709`_)

Loading…
Cancel
Save