root
/
flask
mirror of https://github.com/pallets/flask.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity
4,848 Commits 4 Branches 68 Tags 38 MiB
Commit Graph

1585 Commits

Author SHA1 Message Date
Grey Li a541c2ac8b Fix view decorators docs 2021-05-21 12:11:03 +00:00
David Lord cfda270899
update pallets-sphinx-themes 2021-05-20 21:03:02 -07:00
Rafael Aviles 9c186ccfe8 Use escape function in return statement for username and subpath. 2021-05-14 13:23:34 -07:00
Andrew J Roth 2889ea4dd9
Added Google Cloud Run as a Hosted option 2021-05-12 09:14:34 -04:00
Grey Li 57b19fda54 Fix typo in the example of nesting bp docs 2021-05-12 07:49:34 +00:00
David Lord 52adf2ec21
rename default branch in files 2021-05-11 15:18:41 -07:00
Grey Li 531671c9c5
Improve the wording of using FLASK_APP 2021-05-10 22:58:19 -07:00
David Lord 79ac96f123
show type hints in description 2021-05-10 22:45:42 -07:00
pgjones 7f87f3dd93
Simplify the async handling code 
Firstly `run_sync` was a misleading name as it didn't run anything,
instead I think `async_to_sync` is much clearer as it converts a
coroutine function to a function. (Name stolen from asgiref).

Secondly trying to run the ensure_sync during registration made the
code more complex and brittle, e.g. the _flask_async_wrapper
usage. This was done to pay any setup costs during registration rather
than runtime, however this only saved a iscoroutne check. It allows
the weirdness of the Blueprint and Scaffold ensure_sync methods to be
removed.

Switching to runtime ensure_sync usage provides a method for
extensions to also support async, as now documented.
 2021-05-03 06:15:39 -07:00
Joshua Bronson 8bfce88e39
Minor docs fixes. (#3988) 2021-05-02 16:05:08 -04:00
Grey Li ec044a24e1 Add tips for using async on Windows on Python 3.8 2021-04-29 10:59:26 +08:00
David Lord 03db9194d8
Merge pull request #3967 from pgjones/docs 2021-04-17 07:34:56 -07:00
pgjones f74cce164e Update documentation on asyncio background tasks 
This has been an early question from users, so best to explain.
 2021-04-17 15:13:33 +01:00
pgjones 1c3b53c5db Update the docs on serving with ASGI 
Whilst it has been possible to serve via an ASGI server for a while
(using WSGI to ASGI middleware/adapters) it hasn't added much. Now
though it makes sense to recommend the asgiref adapter as it
integrates with the same event loop used for async route handlers
etc...
 2021-04-17 11:30:22 +01:00
David Lord 6f09b4b5ed
Merge remote-tracking branch 'origin/1.1.x' into release-2.0.0rc1 2021-04-16 08:37:56 -07:00
pgjones f92e820b4b
Nested blueprints 
This allows blueprints to be nested within blueprints via a new
Blueprint.register_blueprint method. This should provide a use case
that has been desired for the past ~10 years.

This works by setting the endpoint name to be the blueprint names,
from parent to child delimeted by "." and then iterating over the
blueprint names in reverse order in the app (from most specific to
most general). This means that the expectation of nesting a blueprint
within a nested blueprint is met.
 2021-04-14 09:25:42 -07:00
David Lord dc3e9c0cc3
update async docs 2021-04-06 15:33:06 -07:00
pgjones 6979265fa6
Add `async` support 
This allows for async functions to be passed to the Flask class
instance, for example as a view function,

    @app.route("/")
    async def index():
        return "Async hello"

this comes with a cost though of poorer performance than using the
sync equivalent.

asgiref is the standard way to run async code within a sync context,
and is used in Django making it a safe and sane choice for this.
 2021-04-06 09:35:10 -07:00
kangetsu121 6eeaa2e50d fix a broken link 2021-03-16 16:30:54 +00:00
David Lord dcd3b5c8f8
Merge pull request #3922 from pallets/consistency 
various cleanup for consistency between projects
 2021-02-24 10:35:16 -08:00
David Lord 9e7d3a6b69
docs rename changelog to changes 2021-02-24 10:09:38 -08:00
David Lord 3cd615a1d6
update project links 2021-02-24 10:09:15 -08:00
Grey Li 76abbe9062 Remove the mention of Flask-OAuth in the extension dev docs 2021-02-19 22:59:09 +08:00
David Lord b473e7c97c
use Jinja's tojson filter 2021-02-01 22:48:09 -08:00
Tony De La Nuez 451c1f87f3
got_request_exception only sends unhandled exceptions 
Co-authored-by: David Lord <davidism@gmail.com>
 2021-02-01 20:28:10 -08:00
David Lord 64206c13c2
simplify InternalServerError.original_exception 2021-01-29 11:26:17 -08:00
David Lord 1936ca8a2e
remove BaseRequest and BaseResponse 2021-01-29 10:52:48 -08:00
David Lord fdba0d2526
remove JSONMixin 2021-01-29 10:52:48 -08:00
Elliott King 7068d0983a
Clarify json error handling 2021-01-27 12:08:02 -05:00
Grey Li de0af03862 Merge remote-tracking branch 'origin/1.1.x' 2020-12-30 21:00:49 +08:00
jordivandooren 7d3ae48d57
fix explanation of wheel name (#3848) 
* fix explanation of wheel name

* Improve the description of wheel filename format

Co-authored-by: Grey Li <withlihui@gmail.com>
 2020-12-30 18:57:37 +08:00
David Lord dc11cdb4a4
move send_file and send_from_directory to Werkzeug 
The implementations were moved to Werkzeug, Flask's functions become
wrappers around Werkzeug to pass some Flask-specific values.

cache_timeout is renamed to max_age. SEND_FILE_MAX_AGE_DEFAULT,
app.send_file_max_age_default, and app.get_send_file_max_age defaults
to None. This tells the browser to use conditional requests rather than
a 12 hour cache.

attachment_filename is renamed to download_name, and is always sent if
a name is known.

Deprecate helpers.safe_join in favor of werkzeug.utils.safe_join.

Removed most of the send_file tests, they're tested in Werkzeug.

In the file upload example, renamed the uploaded_file view to
download_file to avoid a common source of confusion.
 2020-11-05 09:27:52 -08:00
David Lord 15a49e7297
Merge branch '1.1.x' 2020-11-04 18:25:37 -08:00
Sarthak Vineet Kumar 577eec198a
updated doc for mod_wsgi (#3751) 
Co-authored-by: Sarthak <sarthak@MacBook.local>
 2020-11-04 18:20:36 -08:00
Viet Hung Nguyen 7c20611cdd
mkstemp returns a file descriptor (#3809) 2020-10-31 20:09:57 -07:00
Bart Broere 070a0c1c75
removing outdated xhtml information (#3802) 2020-10-21 14:13:41 -07:00
Grey Li 1035efc7d6
Add command switch tabs for Bash, CMD and Powershell with sphinx-tabs (#3714) 
* Enable Sphinx extension sphinx-tabs

* Add command tabs for all export commands

* Add command tabs for all venv commands

Fix trim spaces
 2020-10-15 14:08:37 -07:00
Jamiu Salimon 9d824db41c
Update the signature of the teardown function (#3730) 
Co-authored-by: David Lord <davidism@gmail.com>
 2020-10-15 14:02:54 -07:00
Henry Kobin fa5aebc842
updated Sentry link (#3788) 2020-10-11 19:15:19 -07:00
sblondon 7e312c421e
aesthetic: add a space after a comma (#3771) 2020-09-28 07:21:13 -07:00
miquelvir 598c56c498
fix grammar (#3769) 2020-09-28 06:21:59 -07:00
Ebram Shehata 12a4d15546
Update quickstart.rst (#3767) 2020-09-25 16:52:00 -07:00
girst de464c03e1
Correct Sentry advertisement (not Free Software) (#3758) 2020-09-15 09:20:10 -07:00
Grey Li 414b30b2ec Fix bad intersphinx link 2020-08-07 19:01:42 +08:00
David Lord 36e6fc8ab8
Merge pull request #3669 from ebonnecab/error-docs 
Error Docs Revision/Consolidation
 2020-07-28 14:17:36 -07:00
David Lord 89d1487b2e
rewrite debugging docs, move to separate page 2020-07-28 11:20:34 -07:00
David Lord d25ee22e34
reduce section on http status codes 
formatting in sentry section
 2020-07-28 11:07:02 -07:00
David Lord ba118b4543
adjust header levels and spacing 
use code-block consistently
 2020-07-28 10:46:22 -07:00
David Lord 2db3c9a72e
rewrite external debuggers section 2020-07-28 07:59:19 -07:00
David Lord 0db95259db
normalize sentence spacing 2020-07-28 07:57:24 -07:00
David Lord f31a8ce4bc
Merge pull request #3704 from jackwardell/no-self-required 
swapping self.assert_equal for assert
 2020-07-28 07:10:13 -07:00
jackwardell daf9ec790a swapping self.assert_equal for assert 
self.assert_equal is not in a class and is ambiguous. Beginners might copy and paste this example and not understand it.
 2020-07-28 14:23:00 +01:00
Ebonne Cabarrus 569c88d721
more changes to consolidated error handling docs 2020-07-24 09:25:07 -07:00
jackwardell 59b0b85835
consolidate error handling docs 
Remove apierrors.rst and errorpages.rst from patterns and integrate the
content into errorhandling.rst, along with other changes and extra
content.
 2020-07-24 09:15:43 -07:00
Grey Li 1580aa30cb Update Discord invite links 2020-07-21 12:11:17 +08:00
David Lord aab20ad431
fix typo 2020-07-08 08:26:21 -07:00
Armin Ronacher 4a1acc8b5f Some small doc fixes 2020-07-08 15:53:43 +02:00
Grey Li 718afcc107
Improve wording of tip for Unique URLs chapter 2020-07-05 08:25:48 +08:00
Deep R. Ode 8074cbdc47
Added very small clarification to quickstart.rst 2020-07-03 15:55:56 +05:30
Sergei 7d7e8eef23
API docs - changed flask.request description 
- the link should point to the flask's Request
 - longer description is unnecessary, as it's all explained above in flask.Request
 2020-07-02 23:54:40 +03:00
Leonardo Giordani 2254adf845 Simplified version of file-based database 2020-06-23 15:14:03 +01:00
Leonardo Giordani 26ec470afb Fixed trailing whitespace 2020-06-23 15:06:37 +01:00
Leonardo Giordani efbd721f20 Changed example DATABASE_URI values 2020-06-23 14:56:51 +01:00
Leonardo Giordani aec07a1cb5 Removed misleading DEBUG variable from examples 2020-06-21 09:29:45 +01:00
iomintz 92f648b04e
[docs] streaming contents: use app.response_class 
Examples should use app.response_class to encourage code that doesn't need to be changed should the response class be customized later on.
 2020-06-17 22:00:35 -05:00
David Lord eec29a8fc3
Merge pull request #3603 from jeffwidman/patch-1 
Fix docs link for Flask-Uploads
 2020-06-07 17:03:35 -07:00
David Lord 6eeb912a63
Merge remote-tracking branch 'origin/1.1.x' 2020-06-07 16:50:17 -07:00
David Lord 51686f5ab4
expand section on copy/paste security 2020-06-07 16:45:31 -07:00
Kai Chen 0b6a05f541
add section on copy/paste security 2020-06-05 08:51:21 -07:00
David Lord eea31f29a5
use pip-compile to pin dev requirements 2020-05-23 14:03:11 -07:00
Jeff Widman c432d8b2bc
Fix docs link for Flask-Uploads 2020-05-08 12:42:52 -07:00
David Lord ff2f71379b
use ast to parse FLASK_APP 
enables keyword arguments to factory functions
 2020-04-07 17:54:51 -07:00
David Lord fcac7f11cf
deprecate passing script_info to factory 2020-04-07 15:54:36 -07:00
David Lord 7e3b8abf99
update docs requirements 
remove duplicate docs
 2020-04-07 14:39:18 -07:00
David Lord 756902cca1
update json docs 2020-04-07 13:37:14 -07:00
David Lord c43edfc7c0
remove simplejson 
- remove encoding detection backport, json.loads supports it directly
- use str.translate instead of multiple str.replace
 2020-04-07 09:55:39 -07:00
David Lord 171aabc87d
remove unused ref directives 
replace page refs with doc directives
 2020-04-04 12:57:14 -07:00
David Lord 2ae740dd49
f-strings everywhere 2020-04-04 12:10:00 -07:00
David Lord 524fd0bc8c
apply pyupgrade 2020-04-04 12:10:00 -07:00
David Lord 7673835b3d
remove Python 2 from docs 2020-04-04 12:05:44 -07:00
David Lord 96b4dcafc3
Merge branch '1.1.x' 2020-04-03 10:25:51 -07:00
David Lord 3d61fc4428
Merge pull request #3529 from pgkrit/master 
Move HTML escaping example back to Variable Rules.
 2020-04-02 12:55:49 -07:00
David Lord 57f9623b08
move html escaping to dedicated section 2020-04-02 12:49:00 -07:00
David Lord c6a619af83
update CLI docs IDE integration 2020-04-02 12:09:04 -07:00
David Lord 037ae3f024
Merge remote-tracking branch 'origin/1.1.x' 2020-04-02 11:56:30 -07:00
David Lord ac9589ca72
Merge pull request #3530 from valleygtc/docs-fix 
docs: testing.rst function def missing colon
 2020-04-02 11:55:01 -07:00
mattc41190 1736e01ea0
Grammar and clarity fix 2020-03-25 09:20:55 -05:00
mattc41190 8fc723c7c2
itty bitty typo 2020-03-24 09:54:32 -05:00
Tobias Sette d115d843e6
docs: update "Deploying on Google App Engine" 
Use the documentation for Python 3 instead of Python 2, which is deprecated.
 2020-03-16 19:18:53 -03:00
gutianci ceed993d63 docs: testing.rst function def missing colon 2020-03-05 18:31:21 +08:00
Peter G Kritikos 56e75eace5 Move HTML escaping example back to Variable Rules. 
Demonstration of markupsafe's escape function was in the Minimal
Application example, but the minimal example does not accept user
input.
 2020-03-04 18:50:36 -05:00
ongopongo 1d45539000
Fix property name in description 
Previously, the description referred to a property named `original_error`.
However, both the code sample that followed it _and_ the Werkzeug
documentation refer to it as `original_exception` instead.

In this commit, I change the description to use the same property name
as is used in the code sample and the Werkzeug documentation.

Here's a link to the Werkzeug documentation of that property:
- https://werkzeug.palletsprojects.com/en/1.0.x/exceptions/#werkzeug.exceptions.InternalServerError.original_exception
 2020-02-28 12:09:51 -08:00
kylepollina 37f582dbb1
Fix typo in docs (#3517) 2020-02-27 23:22:03 +01:00
David Lord 909b9751ee
Merge remote-tracking branch 'origin/1.1.x' 2020-02-10 18:41:07 -08:00
yingshaoxo 7e068145df
pass static_url_path along with static_folder 2020-02-10 18:33:32 -08:00
David Lord 07556da918
Merge remote-tracking branch 'origin/1.1.x' 2020-02-10 18:29:43 -08:00
David Lord c12d9f8b49
Merge pull request #3480 from candleindark/patch-2 
Incorrect grammar
 2020-02-10 18:13:24 -08:00
Grey Li 571e92b317
add import for escape in quickstart 
import escape from markupsafe instead of flask
 2020-02-10 17:53:11 -08:00
Isaac To b80eaf2c99
Incorrect grammar 
The original sentence has incorrect grammar
 2020-02-10 17:47:42 -08:00
Gregory Pakosz aa1d4cb840
remove approved extensions in foreword 2020-02-10 17:00:53 -08:00
David Lord 2c66746a37
Merge branch '1.1.x' 2020-02-09 15:21:13 -08:00
Isaac To bb66b61d1d
A better expression for the intended meaning 2020-02-06 12:04:49 -08:00
Isaac To ce08807a8b
This is a typo. 2020-02-06 10:52:59 -08:00
Grey Li a3415fc6dc
Use https for pallets URL 2019-11-19 09:32:35 -08:00
Grey Li ef434ea998
Replace old pocoo links everywhere 
pocco.org -> palletsprojects.com
 2019-11-19 09:32:35 -08:00
David Lord 2659f0a5e6
Merge pull request #3406 from erfanio/f-string-docs 
Change docs to use f-strings
 2019-11-18 19:09:30 -08:00
David Lord a671e47921
rewrite the development server docs 2019-11-18 18:02:12 -08:00
David Lord a83d6d2528
Merge remote-tracking branch 'origin/1.1.x' 2019-11-18 17:54:20 -08:00
Thiago J. Barbalho 4f6b310513
Fix typo 2019-11-02 20:56:35 +00:00
Chris Lamb 3ddf7fd2c2 Make the documentation build reproducibly 
Whilst working on the Reproducible Builds effort [0] we noticed that
flask could not be built reproducibly.

This is because it includes an absolute build directory in the
documentation as the "json_module" attribute points to a Python class/
module which has a string representation including its path.

This commit skips this (inherited) member from the documentation.

(This was originally filed in Debian as #943674 [1].)

 [0] https://reproducible-builds.org/
 [1] https://bugs.debian.org/943674
 2019-10-28 09:16:53 +00:00
erfanio 07caa44224 Change docs to use f-strings 2019-10-26 17:19:00 +11:00
David Lord aac0f585b9
clean up config.from_file docs 2019-10-18 09:24:58 -07:00
pgjones 829aa65e64
Support loading configuration from text files 
TOML is a very popular format now, and is taking hold in the Python
ecosystem via pyproject.toml (among others). This allows toml config
files via,

    app.config.from_file("config.toml", toml.loads)

it also allows for any other file format whereby there is a loader
that takes a string and returns a mapping.
 2019-10-18 09:15:47 -07:00
Marat Sharafutdinov 468705df17
Update reqcontext.rst 2019-10-14 23:48:48 +03:00
David Lord 4bceeccfff
Merge pull request #3391 from pallets/explain-escape 
explain escape at top of quickstart
 2019-10-12 19:03:34 -07:00
David Lord 413778afc1
explain escape at top of quickstart 
* introduce escape, and explain why it's omitted in examples
* clean up imports in examples
 2019-10-12 18:53:47 -07:00
Kristin Faner af970bd20f
fix typo in request context docs 2019-10-08 09:06:01 -07:00
David Lord a3f07829ca
Merge branch '1.1.x' 2019-09-24 06:44:36 -07:00
David Lord 7fdd0df6ec
Merge branch '1.0.x' into 1.1.x 2019-09-24 06:44:18 -07:00
David Lord 563ef469f7
Merge branch '0.12.x' into 1.0.x 2019-09-24 06:43:25 -07:00
David Lord 4ed20657c6
update docs for new theme 2019-09-24 06:35:10 -07:00
bearnun 2ceae5f8a5
mention default logging level 2019-09-23 12:17:46 -07:00
David Lord 6429bf19a0
Merge branch '1.1.x' 2019-09-23 12:11:18 -07:00
David Lord 5f5e8e5339
Merge branch '1.0.x' into 1.1.x 2019-09-23 12:10:55 -07:00
David Lord 6cde195c88
reword extension python version item 2019-09-23 11:59:59 -07:00
David Lord 40eadfc52a
Merge branch '1.1.x' 2019-09-23 08:38:29 -07:00
David Lord 746d9181d7
Merge branch '1.0.x' into 1.1.x 2019-09-23 08:38:11 -07:00
David Lord e01b68e7ee
update patterns, snippets, extensions docs 2019-09-23 08:19:40 -07:00
Nathan McKinley-Pace 2ec150af02
Update testing.rst 
It now describes how to install flaskr using pip so that all tests pass.
 2019-09-02 11:31:34 -04:00
Constantin b839beb23d
fix typo: base on -> based on 2019-08-25 20:33:41 +02:00
Eido95 b33e89935a
docs: Change max content length value to megabyte 
16 * 1024 * 1024 = 16 MiB (Mebibyte)
16 * 1000 * 1000 = 16 MB (Megabyte)

The example is in megabytes, not in mebibytes.
 2019-08-13 11:02:56 +03:00
David Lord b3b38285a4
fix stylecheck 2019-08-01 13:35:38 -07:00
David Lord 02cfee8461
Merge branch '1.0.x' into 1.1.x 2019-08-01 13:08:12 -07:00
Csirmaz Bendegúz 28ffe15349
Fix typo in urlprocessors.rst 2019-08-01 12:58:07 -07:00
Grey Li 2a8ebc4411 Fix github link generator for docs 2019-08-01 22:49:31 +08:00
David Lord c42803f168
Merge branch '1.0.x' into 1.1.x 2019-07-22 13:31:05 -07:00
Grey Li 90004a83be
Update outdated extension doc 
Remove links and descriptions relate to abandoned "Flask Extension
Registry" in documentation
 2019-07-22 13:23:57 -07:00
Stéphane Wirtel 98a26cfb42 Documentation: Use Python 3.5+ 2019-07-10 19:03:10 +02:00
David Lord df470aecb9
use app.name as app.logger name 2019-07-01 14:56:18 -07:00
David Lord b05a685a03
Merge branch '1.0.x' 2019-07-01 10:54:31 -07:00
Anthony Sottile a5ecdfa7a5
Fixes for PEP451 import loaders and pytest 5.x 
- pytest 5.x drops python2 compatibility and therefore only implements PEP 451
- pytest 5.x made the repr of `ExcInfo` less confusing (fixed tests depending
  on the old format)
 2019-07-01 10:43:06 -07:00
David Lord 1351d0a565
Merge branch '1.0.x' 2019-06-23 16:57:52 -07:00
David Lord cb6272ccc8
fix docks linkcheck 2019-06-23 15:37:51 -07:00
David Lord 28b35c55a1
update docs config 2019-06-23 12:27:25 -07:00
David Lord 7d77958000
use sphinx-issues, rewrap changelog 2019-06-23 12:25:38 -07:00
David Lord e666f7a69c
standardize license and copyright 2019-06-22 13:09:09 -07:00
David Lord 146df0f9e8
use dashes for command names 2019-06-21 08:47:27 -07:00
David Lord 54519ef028
document behavior of very generic error handlers 2019-06-21 08:22:35 -07:00
David Lord 4b519f0e33
reword api error section 2019-06-12 11:02:53 -07:00
Logan Wright 7bc965fada
adds api error handling documentation 2019-06-12 10:54:12 -07:00