- Changes
- Version 3.0.2
- Version 3.0.1
- Version 3.0.0
- Version 2.3.3
- Version 2.3.2
- Version 2.3.1
- Version 2.3.0
- Version 2.2.5
- Version 2.2.4
- Version 2.2.3
- Version 2.2.2
- Version 2.2.1
- Version 2.2.0
- Version 2.1.3
- Version 2.1.2
- Version 2.1.1
- Version 2.1.0
- Version 2.0.3
- Version 2.0.2
- Version 2.0.1
- Version 2.0.0
- Version 1.1.4
- Version 1.1.3
- Version 1.1.2
- Version 1.1.1
- Version 1.1.0
- Version 1.0.4
- Version 1.0.3
- Version 1.0.2
- Version 1.0.1
- Version 1.0
Changes
Version 3.0.2
Released 2024-02-03
- Correct type for
jinja_loaderproperty. #5388 - Fix error with
--extra-filesand--exclude-patternsCLI options. #5391
Version 3.0.1
Released 2024-01-18
- Correct type for
pathargument tosend_file. #5230 - Fix a typo in an error message for the
flask run --keyoption. #5344 - Session data is untagged without relying on the built-in
json.loadsobject_hook. This allows other JSON providers that don’t implement that. #5381 - Address more type findings when using mypy strict mode. #5383
Version 3.0.0
Released 2023-09-30
- Remove previously deprecated code. #5223
- Deprecate the
__version__attribute. Use feature detection, orimportlib.metadata.version("flask"), instead. #5230 - Restructure the code such that the Flask (app) and Blueprint classes have Sans-IO bases. #5127
- Allow self as an argument to url_for. #5264
- Require Werkzeug >= 3.0.0.
Version 2.3.3
Released 2023-08-21
- Python 3.12 compatibility.
- Require Werkzeug >= 2.3.7.
- Use
flit_coreinstead ofsetuptoolsas build backend. - Refactor how an app’s root and instance paths are determined. #5160
Version 2.3.2
Released 2023-05-01
- Set
Vary: Cookieheader when the session is accessed, modified, or refreshed. - Update Werkzeug requirement to >=2.3.3 to apply recent bug fixes.
Version 2.3.1
Released 2023-04-25
- Restore deprecated
from flask import Markup. #5084
Version 2.3.0
Released 2023-04-25
- Drop support for Python 3.7. #5072
- Update minimum requirements to the latest versions: Werkzeug>=2.3.0, Jinja2>3.1.2, itsdangerous>=2.1.2, click>=8.1.3.
-
Remove previously deprecated code. #4995
-
The
pushandpopmethods of the deprecated_app_ctx_stackand_request_ctx_stackobjects are removed.topstill exists to give extensions more time to update, but it will be removed. - The
FLASK_ENVenvironment variable,ENVconfig key, andapp.envproperty are removed. - The
session_cookie_name,send_file_max_age_default,use_x_sendfile,propagate_exceptions, andtemplates_auto_reloadproperties onappare removed. - The
JSON_AS_ASCII,JSON_SORT_KEYS,JSONIFY_MIMETYPE, andJSONIFY_PRETTYPRINT_REGULARconfig keys are removed. - The
app.before_first_requestandbp.before_app_first_requestdecorators are removed. json_encoderandjson_decoderattributes on app and blueprint, and the correspondingjson.JSONEncoderandJSONDecoderclasses, are removed.- The
json.htmlsafe_dumpsandhtmlsafe_dumpfunctions are removed. - Calling setup methods on blueprints after registration is an error instead of a warning. #4997
- Importing
escapeandMarkupfromflaskis deprecated. Import them directly frommarkupsafeinstead. #4996 - The
app.got_first_requestproperty is deprecated. #4997 - The
locked_cached_propertydecorator is deprecated. Use a lock inside the decorated function if locking is needed. #4993 - Signals are always available.
blinker>=1.6.2is a required dependency. Thesignals_availableattribute is deprecated. #5056 - Signals support
asyncsubscriber functions. #5049 - Remove uses of locks that could cause requests to block each other very briefly. #4993
- Use modern packaging metadata with
pyproject.tomlinstead ofsetup.cfg. #4947 - Ensure subdomains are applied with nested blueprints. #4834
config.from_filecan usetext=Falseto indicate that the parser wants a binary file instead. #4989- If a blueprint is created with an empty name it raises a
ValueError. #5010 SESSION_COOKIE_DOMAINdoes not fall back toSERVER_NAME. The default is not to set the domain, which modern browsers interpret as an exact match rather than a subdomain match. Warnings aboutlocalhostand IP addresses are also removed. #5051- The
routescommand shows each rule’ssubdomainorhostwhen domain matching is in use. #5004 - Use postponed evaluation of annotations. #5071
Version 2.2.5
Released 2023-05-02
- Update for compatibility with Werkzeug 2.3.3.
- Set
Vary: Cookieheader when the session is accessed, modified, or refreshed.
Version 2.2.4
Released 2023-04-25
- Update for compatibility with Werkzeug 2.3.
Version 2.2.3
Released 2023-02-15
- Autoescape is enabled by default for
.svgtemplate files. #4831 - Fix the type of
template_folderto acceptpathlib.Path. #4892 - Add
--debugoption to theflask runcommand. #4777
Version 2.2.2
Released 2022-08-08
- Update Werkzeug dependency to >= 2.2.2. This includes fixes related to the new faster router, header parsing, and the development server. #4754
- Fix the default value for
app.envto be"production". This attribute remains deprecated. #4740
Version 2.2.1
Released 2022-08-03
- Setting or accessing
json_encoderorjson_decoderraises a deprecation warning. #4732
Version 2.2.0
Released 2022-08-01
-
Remove previously deprecated code. #4667
-
Old names for some
send_fileparameters have been removed.download_namereplacesattachment_filename,max_agereplacescache_timeout, andetagreplacesadd_etags. Additionally,pathreplacesfilenameinsend_from_directory. - The
RequestContext.gproperty returningAppContext.gis removed. - Update Werkzeug dependency to >= 2.2.
-
The app and request contexts are managed using Python context vars directly rather than Werkzeug’s
LocalStack. This should result in better performance and memory use. #4682 -
Extension maintainers, be aware that
_app_ctx_stack.topand_request_ctx_stack.topare deprecated. Store data onginstead using a unique prefix, likeg._extension_name_attr. - The
FLASK_ENVenvironment variable andapp.envattribute are deprecated, removing the distinction between development and debug mode. Debug mode should be controlled directly using the--debugoption orapp.run(debug=True). #4714 - Some attributes that proxied config keys on
appare deprecated:session_cookie_name,send_file_max_age_default,use_x_sendfile,propagate_exceptions, andtemplates_auto_reload. Use the relevant config keys instead. #4716 -
Add new customization points to the
Flaskapp object for many previously global behaviors. -
flask.url_forwill callapp.url_for. #4568 flask.abortwill callapp.aborter.Flask.aborter_classandFlask.make_abortercan be used to customize this aborter. #4567flask.redirectwill callapp.redirect. #4569flask.jsonis an instance ofJSONProvider. A different provider can be set to use a different JSON library.flask.jsonifywill callapp.json.response, other functions inflask.jsonwill call corresponding functions inapp.json. #4692- JSON configuration is moved to attributes on the default
app.jsonprovider.JSON_AS_ASCII,JSON_SORT_KEYS,JSONIFY_MIMETYPE, andJSONIFY_PRETTYPRINT_REGULARare deprecated. #4692 - Setting custom
json_encoderandjson_decoderclasses on the app or a blueprint, and the correspondingjson.JSONEncoderandJSONDecoderclasses, are deprecated. JSON behavior can now be overridden using theapp.jsonprovider interface. #4692 json.htmlsafe_dumpsandjson.htmlsafe_dumpare deprecated, the function is built-in to Jinja now. #4692- Refactor
register_error_handlerto consolidate error checking. Rewrite some error messages to be more consistent. #4559 - Use Blueprint decorators and functions intended for setup after registering the blueprint will show a warning. In the next version, this will become an error just like the application setup methods. #4571
before_first_requestis deprecated. Run setup code when creating the application instead. #4605- Added the
View.init_every_requestclass attribute. If a view subclass sets this toFalse, the view will not create a new instance on every request. #2520. - A
flask.cli.FlaskGroupClick group can be nested as a sub-command in a custom CLI. #3263 - Add
--appand--debugoptions to theflaskCLI, instead of requiring that they are set through environment variables. #2836 - Add
--env-fileoption to theflaskCLI. This allows specifying a dotenv file to load in addition to.envand.flaskenv. #3108 - It is no longer required to decorate custom CLI commands on
app.cliorblueprint.cliwith@with_appcontext, an app context will already be active at that point. #2410 SessionInterface.get_expiration_timeuses a timezone-aware value. #4645- View functions can return generators directly instead of wrapping them in a
Response. #4629 - Add
stream_templateandstream_template_stringfunctions to render a template as a stream of pieces. #4629 -
A new implementation of context preservation during debugging and testing. #4666
-
request,g, and other context-locals point to the correct data when running code in the interactive debugger console. #2836 - Teardown functions are always run at the end of the request, even if the context is preserved. They are also run after the preserved context is popped.
stream_with_contextpreserves context separately from awith clientblock. It will be cleaned up whenresponse.get_data()orresponse.close()is called.- Allow returning a list from a view function, to convert it to a JSON response like a dict is. #4672
- When type checking, allow
TypedDictto be returned from view functions. #4695 - Remove the
--eager-loading/--lazy-loadingoptions from theflask runcommand. The app is always eager loaded the first time, then lazily loaded in the reloader. The reloader always prints errors immediately but continues serving. Remove the internalDispatchingAppmiddleware used by the previous implementation. #4715
Version 2.1.3
Released 2022-07-13
- Inline some optional imports that are only used for certain CLI commands. #4606
- Relax type annotation for
after_requestfunctions. #4600 instance_pathfor namespace packages uses the path closest to the imported submodule. #4610- Clearer error message when
render_templateandrender_template_stringare used outside an application context. #4693
Version 2.1.2
Released 2022-04-28
- Fix type annotation for
json.loads, it accepts str or bytes. #4519 - The
--certand--keyoptions onflask runcan be given in either order. #4459
Version 2.1.1
Released on 2022-03-30
- Set the minimum required version of importlib_metadata to 3.6.0, which is required on Python < 3.10. #4502
Version 2.1.0
Released 2022-03-28
- Drop support for Python 3.6. #4335
- Update Click dependency to >= 8.0. #4008
-
Remove previously deprecated code. #4337
-
The CLI does not pass
script_infoto app factory functions. config.from_jsonis replaced byconfig.from_file(name, load=json.load).jsonfunctions no longer take anencodingparameter.safe_joinis removed, usewerkzeug.utils.safe_joininstead.total_secondsis removed, usetimedelta.total_secondsinstead.- The same blueprint cannot be registered with the same name. Use
name=when registering to specify a unique name. - The test client’s
as_tupleparameter is removed. Useresponse.request.environinstead. #4417 -
Some parameters in
send_fileandsend_from_directorywere renamed in 2.0. The deprecation period for the old names is extended to 2.2. Be sure to test with deprecation warnings visible. -
attachment_filenameis renamed todownload_name. cache_timeoutis renamed tomax_age.add_etagsis renamed toetag.filenameis renamed topath.- The
RequestContext.gproperty is deprecated. Usegdirectly orAppContext.ginstead. #3898 copy_current_request_contextcan decorate async functions. #4303- The CLI uses
importlib.metadatainstead ofpkg_resourcesto load command entry points. #4419 - Overriding
FlaskClient.openwill not cause an error on redirect. #3396 - Add an
--exclude-patternsoption to theflask runCLI command to specify patterns that will be ignored by the reloader. #4188 - When using lazy loading (the default with the debugger), the Click context from the
flask runcommand remains available in the loader thread. #4460 - Deleting the session cookie uses the
httponlyflag. #4485 - Relax typing for
errorhandlerto allow the user to use more precise types and decorate the same function multiple times. #4095, #4295, #4297 - Fix typing for
__exit__methods for better compatibility withExitStack. #4474 - From Werkzeug, for redirect responses the
Locationheader URL will remain relative, and exclude the scheme and domain, by default. #4496 - Add
Config.from_prefixed_env()to load config values from environment variables that start withFLASK_or another prefix. This parses values as JSON by default, and allows setting keys in nested dicts. #4479
Version 2.0.3
Released 2022-02-14
- The test client’s
as_tupleparameter is deprecated and will be removed in Werkzeug 2.1. It is now also deprecated in Flask, to be removed in Flask 2.1, while remaining compatible with both in 2.0.x. Useresponse.request.environinstead. #4341 - Fix type annotation for
errorhandlerdecorator. #4295 - Revert a change to the CLI that caused it to hide
ImportErrortracebacks when importing the application. #4307 app.json_encoderandjson_decoderare only passed todumpsandloadsif they have custom behavior. This improves performance, mainly on PyPy. #4349- Clearer error message when
after_this_requestis used outside a request context. #4333
Version 2.0.2
Released 2021-10-04
- Fix type annotation for
teardown_*methods. #4093 - Fix type annotation for
before_requestandbefore_app_requestdecorators. #4104 - Fixed the issue where typing requires template global decorators to accept functions with no arguments. #4098
- Support View and MethodView instances with async handlers. #4112
- Enhance typing of
app.errorhandlerdecorator. #4095 - Fix registering a blueprint twice with differing names. #4124
- Fix the type of
static_folderto acceptpathlib.Path. #4150 jsonifyhandlesdecimal.Decimalby encoding tostr. #4157- Correctly handle raising deferred errors in CLI lazy loading. #4096
- The CLI loader handles
**kwargsin acreate_appfunction. #4170 - Fix the order of
before_requestand other callbacks that trigger before the view returns. They are called from the app down to the closest nested blueprint. #4229
Version 2.0.1
Released 2021-05-21
- Re-add the
filenameparameter insend_from_directory. Thefilenameparameter has been renamed topath, the old name is deprecated. #4019 - Mark top-level names as exported so type checking understands imports in user projects. #4024
- Fix type annotation for
gand inform mypy that it is a namespace object that has arbitrary attributes. #4020 - Fix some types that weren’t available in Python 3.6.0. #4040
- Improve typing for
send_file,send_from_directory, andget_send_file_max_age. #4044, #4026 - Show an error when a blueprint name contains a dot. The
.has special meaning, it is used to separate (nested) blueprint names and the endpoint name. #4041 - Combine URL prefixes when nesting blueprints that were created with a
url_prefixvalue. #4037 - Revert a change to the order that URL matching was done. The URL is again matched after the session is loaded, so the session is available in custom URL converters. #4053
- Re-add deprecated
Config.from_json, which was accidentally removed early. #4078 - Improve typing for some functions using
Callablein their type signatures, focusing on decorator factories. #4060 - Nested blueprints are registered with their dotted name. This allows different blueprints with the same name to be nested at different locations. #4069
register_blueprinttakes anameoption to change the (pre-dotted) name the blueprint is registered with. This allows the same blueprint to be registered multiple times with unique names forurl_for. Registering the same blueprint with the same name multiple times is deprecated. #1091- Improve typing for
stream_with_context. #4052
Version 2.0.0
Released 2021-05-11
- Drop support for Python 2 and 3.5.
- Bump minimum versions of other Pallets projects: Werkzeug >= 2, Jinja2 >= 3, MarkupSafe >= 2, ItsDangerous >= 2, Click >= 8. Be sure to check the change logs for each project. For better compatibility with other applications (e.g. Celery) that still require Click 7, there is no hard dependency on Click 8 yet, but using Click 7 will trigger a DeprecationWarning and Flask 2.1 will depend on Click 8.
- JSON support no longer uses simplejson. To use another JSON module, override
app.json_encoderandjson_decoder. #3555 - The
encodingoption to JSON functions is deprecated. #3562 - Passing
script_infoto app factory functions is deprecated. This was not portable outside theflaskcommand. Useclick.get_current_context().objif it’s needed. #3552 - The CLI shows better error messages when the app failed to load when looking up commands. #2741
- Add
SessionInterface.get_cookie_nameto allow setting the session cookie name dynamically. #3369 - Add
Config.from_fileto load config using arbitrary file loaders, such astoml.loadorjson.load.Config.from_jsonis deprecated in favor of this. #3398 - The
flask runcommand will only defer errors on reload. Errors present during the initial call will cause the server to exit with the traceback immediately. #3431 send_fileraises aValueErrorwhen passed anioobject in text mode. Previously, it would respond with 200 OK and an empty file. #3358- When using ad-hoc certificates, check for the cryptography library instead of PyOpenSSL. #3492
- When specifying a factory function with
FLASK_APP, keyword argument can be passed. #3553 - When loading a
.envor.flaskenvfile, the current working directory is no longer changed to the location of the file. #3560 - When returning a
(response, headers)tuple from a view, the headers replace rather than extend existing headers on the response. For example, this allows setting theContent-Typeforjsonify(). Useresponse.headers.extend()if extending is desired. #3628 - The
Scaffoldclass provides a common API for theFlaskandBlueprintclasses.Blueprintinformation is stored in attributes just likeFlask, rather than opaque lambda functions. This is intended to improve consistency and maintainability. #3215 - Include
samesiteandsecureoptions when removing the session cookie. #3726 - Support passing a
pathlib.Pathtostatic_folder. #3579 send_fileandsend_from_directoryare wrappers around the implementations inwerkzeug.utils. #3828- Some
send_fileparameters have been renamed, the old names are deprecated.attachment_filenameis renamed todownload_name.cache_timeoutis renamed tomax_age.add_etagsis renamed toetag. #3828, #3883 send_filepassesdownload_nameeven ifas_attachment=Falseby usingContent-Disposition: inline. #3828send_filesetsconditional=Trueandmax_age=Noneby default.Cache-Controlis set tono-cacheifmax_ageis not set, otherwisepublic. This tells browsers to validate conditional requests instead of using a timed cache. #3828helpers.safe_joinis deprecated. Usewerkzeug.utils.safe_joininstead. #3828- The request context does route matching before opening the session. This could allow a session interface to change behavior based on
request.endpoint. #3776 - Use Jinja’s implementation of the
|tojsonfilter. #3881 - Add route decorators for common HTTP methods. For example,
@app.post("/login")is a shortcut for@app.route("/login", methods=["POST"]). #3907 - Support async views, error handlers, before and after request, and teardown functions. #3412
- Support nesting blueprints. #593, #1548, #3923
- Set the default encoding to “UTF-8” when loading
.envand.flaskenvfiles to allow to use non-ASCII characters. #3931 flask shellsets up tab and history completion like the defaultpythonshell ifreadlineis installed. #3941helpers.total_seconds()is deprecated. Usetimedelta.total_seconds()instead. #3962- Add type hinting. #3973.
Version 1.1.4
Released 2021-05-13
- Update
static_folderto use_compat.fspathinstead ofos.fspathto continue supporting Python < 3.6 #4050
Version 1.1.3
Released 2021-05-13
- Set maximum versions of Werkzeug, Jinja, Click, and ItsDangerous. #4043
- Re-add support for passing a
pathlib.Pathforstatic_folder. #3579
Version 1.1.2
Released 2020-04-03
- Work around an issue when running the
flaskcommand with an external debugger on Windows. #3297 - The static route will not catch all URLs if the
Flaskstatic_folderargument ends with a slash. #3452
Version 1.1.1
Released 2019-07-08
- The
flask.json_availableflag was added back for compatibility with some extensions. It will raise a deprecation warning when used, and will be removed in version 2.0.0. #3288
Version 1.1.0
Released 2019-07-04
- Bump minimum Werkzeug version to >= 0.15.
- Drop support for Python 3.4.
-
Error handlers for
InternalServerErroror500will always be passed an instance ofInternalServerError. If they are invoked due to an unhandled exception, that original exception is now available ase.original_exceptionrather than being passed directly to the handler. The same is true if the handler is for the baseHTTPException. This makes error handler behavior more consistent. #3266 -
Flask.finalize_requestis called for all unhandled exceptions even if there is no500error handler. Flask.loggertakes the same name asFlask.name(the value passed asFlask(import_name). This reverts 1.0’s behavior of always logging to"flask.app", in order to support multiple apps in the same process. A warning will be shown if old configuration is detected that needs to be moved. #2866RequestContext.copyincludes the current session object in the request context copy. This preventssessionpointing to an out-of-date object. #2935- Using built-in RequestContext, unprintable Unicode characters in Host header will result in a HTTP 400 response and not HTTP 500 as previously. #2994
send_filesupportsPathLikeobjects as described in PEP 519, to supportpathlibin Python 3. #3059send_filesupportsBytesIOpartial content. #2957open_resourceaccepts the “rt” file mode. This still does the same thing as “r”. #3163- The
MethodView.methodsattribute set in a base class is used by subclasses. #3138 Flask.jinja_optionsis adictinstead of anImmutableDictto allow easier configuration. Changes must still be made before creating the environment. #3190- Flask’s
JSONMixinfor the request and response wrappers was moved into Werkzeug. Use Werkzeug’s version with Flask-specific support. This bumps the Werkzeug dependency to >= 0.15. #3125 - The
flaskcommand entry point is simplified to take advantage of Werkzeug 0.15’s better reloader support. This bumps the Werkzeug dependency to >= 0.15. #3022 - Support
static_url_paththat ends with a forward slash. #3134 - Support empty
static_folderwithout requiring setting an emptystatic_url_pathas well. #3124 jsonifysupportsdataclassobjects. #3195- Allow customizing the
Flask.url_map_classused for routing. #3069 - The development server port can be set to 0, which tells the OS to pick an available port. #2926
- The return value from
cli.load_dotenvis more consistent with the documentation. It will returnFalseif python-dotenv is not installed, or if the given path isn’t a file. #2937 - Signaling support has a stub for the
connect_viamethod when the Blinker library is not installed. #3208 - Add an
--extra-filesoption to theflask runCLI command to specify extra files that will trigger the reloader on change. #2897 - Allow returning a dictionary from a view function. Similar to how returning a string will produce a
text/htmlresponse, returning a dict will calljsonifyto produce aapplication/jsonresponse. #3111 - Blueprints have a
cliClick group likeapp.cli. CLI commands registered with a blueprint will be available as a group under theflaskcommand. #1357. - When using the test client as a context manager (
with client:), all preserved request contexts are popped when the block exits, ensuring nested contexts are cleaned up correctly. #3157 - Show a better error message when the view return type is not supported. #3214
flask.testing.make_test_environ_builder()has been deprecated in favour of a new classflask.testing.EnvironBuilder. #3232- The
flask runcommand no longer fails if Python is not built with SSL support. Using the--certoption will show an appropriate error message. #3211 - URL matching now occurs after the request context is pushed, rather than when it’s created. This allows custom URL converters to access the app and request contexts, such as to query a database for an id. #3088
Version 1.0.4
Released 2019-07-04
- The key information for
BadRequestKeyErroris no longer cleared outside debug mode, so error handlers can still access it. This requires upgrading to Werkzeug 0.15.5. #3249 send_fileurl quotes the “:” and “/” characters for more compatible UTF-8 filename support in some browsers. #3074- Fixes for PEP 451 import loaders and pytest 5.x. #3275
- Show message about dotenv on stderr instead of stdout. #3285
Version 1.0.3
Released 2019-05-17
send_fileencodes filenames as ASCII instead of Latin-1 (ISO-8859-1). This fixes compatibility with Gunicorn, which is stricter about header encodings than PEP 3333. #2766- Allow custom CLIs using
FlaskGroupto set the debug flag without it always being overwritten based on environment variables. #2765 flask --versionoutputs Werkzeug’s version and simplifies the Python version. #2825send_filehandles anattachment_filenamethat is a native Python 2 string (bytes) with UTF-8 coded bytes. #2933- A catch-all error handler registered for
HTTPExceptionwill not handleRoutingException, which is used internally during routing. This fixes the unexpected behavior that had been introduced in 1.0. #2986 - Passing the
jsonargument toapp.test_clientdoes not push/pop an extra app context. #2900
Version 1.0.2
Released 2018-05-02
- Fix more backwards compatibility issues with merging slashes between a blueprint prefix and route. #2748
- Fix error with
flask routescommand when there are no routes. #2751
Version 1.0.1
Released 2018-04-29
- Fix registering partials (with no
__name__) as view functions. #2730 - Don’t treat lists returned from view functions the same as tuples. Only tuples are interpreted as response data. #2736
- Extra slashes between a blueprint’s
url_prefixand a route URL are merged. This fixes some backwards compatibility issues with the change in 1.0. #2731, #2742 - Only trap
BadRequestKeyErrorerrors in debug mode, not allBadRequesterrors. This allowsabort(400)to continue working as expected. #2735 - The
FLASK_SKIP_DOTENVenvironment variable can be set to1to skip automatically loading dotenv files. #2722
Version 1.0
Released 2018-04-26
- Python 2.6 and 3.3 are no longer supported.
- Bump minimum dependency versions to the latest stable versions: Werkzeug >= 0.14, Jinja >= 2.10, itsdangerous >= 0.24, Click >= 5.1. #2586
- Skip
app.runwhen a Flask application is run from the command line. This avoids some behavior that was confusing to debug. - Change the default for
JSONIFY_PRETTYPRINT_REGULARtoFalse.~json.jsonifyreturns a compact format by default, and an indented format in debug mode. #2193 Flask.__init__accepts thehost_matchingargument and sets it onFlask.url_map. #1559Flask.__init__accepts thestatic_hostargument and passes it as thehostargument when defining the static route. #1559send_filesupports Unicode inattachment_filename. #2223- Pass
_schemeargument fromurl_fortoFlask.handle_url_build_error. #2017 Flask.add_url_ruleaccepts theprovide_automatic_optionsargument to disable adding theOPTIONSmethod. #1489MethodViewsubclasses inherit method handlers from base classes. #1936- Errors caused while opening the session at the beginning of the request are handled by the app’s error handlers. #2254
- Blueprints gained
Blueprint.json_encoderandBlueprint.json_decoderattributes to override the app’s encoder and decoder. #1898 Flask.make_responseraisesTypeErrorinstead ofValueErrorfor bad response types. The error messages have been improved to describe why the type is invalid. #2256- Add
routesCLI command to output routes registered on the application. #2259 - Show warning when session cookie domain is a bare hostname or an IP address, as these may not behave properly in some browsers, such as Chrome. #2282
- Allow IP address as exact session cookie domain. #2282
SESSION_COOKIE_DOMAINis set if it is detected throughSERVER_NAME. #2282- Auto-detect zero-argument app factory called
create_appormake_appfromFLASK_APP. #2297 - Factory functions are not required to take a
script_infoparameter to work with theflaskcommand. If they take a single parameter or a parameter namedscript_info, theScriptInfoobject will be passed. #2319 FLASK_APPcan be set to an app factory, with arguments if needed, for exampleFLASK_APP=myproject.app:create_app('dev'). #2326FLASK_APPcan point to local packages that are not installed in editable mode, althoughpip install -eis still preferred. #2414- The
Viewclass attributeView.provide_automatic_optionsis set inView.as_view, to be detected byFlask.add_url_rule. #2316 - Error handling will try handlers registered for
blueprint, code,app, code,blueprint, exception,app, exception. #2314 Cookieis added to the response’sVaryheader if the session is accessed at all during the request (and not deleted). #2288Flask.test_request_contextacceptssubdomainandurl_schemearguments for use when building the base URL. #1621- Set
APPLICATION_ROOTto'/'by default. This was already the implicit default when it was set toNone. TRAP_BAD_REQUEST_ERRORSis enabled by default in debug mode.BadRequestKeyErrorhas a message with the bad key in debug mode instead of the generic bad request message. #2348- Allow registering new tags with
TaggedJSONSerializerto support storing other types in the session cookie. #2352 - Only open the session if the request has not been pushed onto the context stack yet. This allows
stream_with_contextgenerators to access the same session that the containing view uses. #2354 - Add
jsonkeyword argument for the test client request methods. This will dump the given object as JSON and set the appropriate content type. #2358 - Extract JSON handling to a mixin applied to both the
RequestandResponseclasses. This adds theResponse.is_jsonandResponse.get_jsonmethods to the response to make testing JSON response much easier. #2358 - Removed error handler caching because it caused unexpected results for some exception inheritance hierarchies. Register handlers explicitly for each exception if you want to avoid traversing the MRO. #2362
- Fix incorrect JSON encoding of aware, non-UTC datetimes. #2374
- Template auto reloading will honor debug mode even even if
Flask.jinja_envwas already accessed. #2373 -
The following old deprecated code was removed. #2385
-
flask.ext- import extensions directly by their name instead of through theflask.extnamespace. For example,import flask.ext.sqlalchemybecomesimport flask_sqlalchemy. Flask.init_jinja_globals- extendFlask.create_jinja_environmentinstead.Flask.error_handlers- tracked byFlask.error_handler_spec, useFlask.errorhandlerto register handlers.Flask.request_globals_class- useFlask.app_ctx_globals_classinstead.Flask.static_path- useFlask.static_url_pathinstead.Request.module- useRequest.blueprintinstead.- The
Request.jsonproperty is no longer deprecated. #1421 - Support passing a
EnvironBuilderordicttotest_client.open. #2412 - The
flaskcommand andFlask.runwill load environment variables from.envand.flaskenvfiles if python-dotenv is installed. #2416 - When passing a full URL to the test client, the scheme in the URL is used instead of
PREFERRED_URL_SCHEME. #2430 Flask.loggerhas been simplified.LOGGER_NAMEandLOGGER_HANDLER_POLICYconfig was removed. The logger is always namedflask.app. The level is only set on first access, it doesn’t checkFlask.debugeach time. Only one format is used, not different ones depending onFlask.debug. No handlers are removed, and a handler is only added if no handlers are already configured. #2436- Blueprint view function names may not contain dots. #2450
- Fix a
ValueErrorcaused by invalidRangerequests in some cases. #2526 - The development server uses threads by default. #2529
- Loading config files with
silent=Truewill ignoreENOTDIRerrors. #2581 - Pass
--certand--keyoptions toflask runto run the development server over HTTPS. #2606 - Added
SESSION_COOKIE_SAMESITEto control theSameSiteattribute on the session cookie. [#2607
(本文超出单文档体积上限,已截断)
