Commit graph

115 commits

Author SHA1 Message Date
Ryan Nevius
225ff3ea6c Fix example SECRET_KEY generation code
Removes the extra `)` in: `print(secrets.token_hex())`
2021-10-18 10:41:39 +02:00
Kevin Kirsche
58a08a1d73
use secrets instead of os.urandom 2021-10-13 08:12:51 -07: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
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
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
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
7673835b3d
remove Python 2 from docs 2020-04-04 12:05:44 -07: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
David Lord
df470aecb9
use app.name as app.logger name 2019-07-01 14:56:18 -07:00
Paul Butler
a3272941ce Clarify documentation about how url_for uses configuration values (#2759) 2019-05-31 15:33:06 -04:00
David Lord
2236ba980c
Merge branch '1.0.x' 2019-05-16 12:18:36 -07:00
A Brooks
4e272fc042
Fix various small spelling errors. 2019-05-16 11:50:10 -07:00
jordan bonser
800c744fe7
improve env vars config example 2019-05-16 08:48:34 -07:00
Martin Michlmayr
7b88b35747
Fix typos in the documentation 2019-02-24 10:40:23 +00:00
David Lord
ac6746d1be
Merge branch '1.0-maintenance' 2019-01-06 15:46:33 -08:00
garenchan
5409606c3b
Docs: fix some typos in config.rst 2019-01-06 14:45:10 -08:00
Douglas Thor
830c77cb44
document that Config.from_object uses object as-is 2019-01-06 14:34:05 -08:00
Aditya
f05625eb82 Use https for external links wherever possible 2018-10-27 17:58:45 +05:30
Grey Li
21b0aa6dd8 Add prefix for all commands in documentation (#2877)
* Add prefix for commands in docs

* Add prefix for commands in example's README
2018-09-09 17:41:56 +09:00
Vik
9394c389bf
Update config.rst
Fix Debug Default: By default Debug is only True when ENV is 'development'
2018-04-27 10:17:43 -07:00
Vik
ad1ce2721b
Update config.rst
Fix Debug Default: By default Debug is only True when ENV is 'development'
2018-04-27 15:37:13 +01:00
David Lord
1ed756a523
add Response.max_cookie_size config 2018-04-10 11:17:18 -07:00
David Lord
82f0d120de
use subdomain arg in url_map.bind_to_environ
rename new subdomain test, parametrize
test allowing subdomains as well as ips
add subdomain_matching param to docs
add some references to docs
add version changed to create_url_adapter
2018-02-23 08:39:31 -08:00
David Lord
382b13581e
clean up samesite docs 2018-01-23 15:11:50 -08:00
Fadhel_Chaabane
a1d9ebe4ab New Feature: Added Support for cookie's SameSite attribute. 2018-01-23 13:57:50 +00:00
David Lord
87c2e121e0
clean up FLASK_ENV docs [ci skip] 2018-01-10 15:46:11 -08:00
Armin Ronacher
2433522d29
Add Support for FLASK_ENV (#2570)
This introduces environments to Flask
2018-01-06 17:07:56 +01:00
Grey Li
8a5e389da0
Docs: Fixed typo 2017-12-14 11:08:33 +08:00
David Lord
2efb565fbc
mention that session signature checks max age
add expiration to cookie security docs
closes #2422
2017-08-01 08:28:32 -07:00
David Lord
66b1b752da
simplify logging configuration
single default handler and formatter
don't remove handlers
configure level once using setLevel
document logging
reorganize logging tests
2017-07-31 12:49:03 -07:00
David Lord
01e2d80660
one more secret key in docs 2017-06-28 08:02:51 -07:00
David Lord
465922e5f1
clean up secret key docs
consistent key across docs and examples
consistent key across tests, set in conftest
2017-06-28 07:58:06 -07:00
trirpi
bfc2ee7dfd removed bug in memory sqlite uri 2017-06-16 21:15:33 +02:00
David Lord
01d2f725d3
formatting
[ci skip]
2017-06-09 10:28:54 -07:00
tristan fisher
53ff054fd3 Fixes grammar and phrasing on envvar how-to 2017-06-09 10:54:47 -04:00
tristan fisher
067686b471 Add basic how-to on using envvars for config 2017-06-09 10:19:08 -04:00
David Lord
045dccaefb
make debugging bad key errors easier
* TRAP_BAD_REQUEST_ERRORS is enabled by default in debug mode
* BadRequestKeyError has the key in the description in debug mode

closes #382
2017-05-29 19:08:25 -07:00
David Lord
abf54c8182
fix some config names in new doc 2017-05-29 10:29:06 -07:00
David Lord
60feecc26c
reformat config from table to linkable sections 2017-05-28 14:04:18 -07:00
Larivact
2995366dde Clarify APPLICATION_ROOT #1714 2017-03-17 05:41:20 +01:00
Hsiaoming Yang
a7f1a21c12 Don't rely on X-Requested-With for pretty print json response (#2193)
* Don't rely on X-Requested-With for pretty print json response

* Fix test cases for pretty print json patch

* Fix gramma error in docs for pretty print json config

* Add changelog for JSONIFY_PRETTYPRINT_REGULAR
2017-03-07 10:09:46 +09:00
Grey Li
c43560777a Add tips for debug config with flask cli (#2196)
* Add tips for debug config with flask cli

`app.debug` and `app.config['DEBUG']` are not compatible with the `flask` script.

* Grammar fix

* Grammar fix
2017-03-04 11:29:04 +01:00
Jannis Leidel
4cf4229355 Fix rST rendering of env var (#2085)
This was broken in ad011bc32d (diff-fd40cf2be7711772de9d8316da038cceR263)
2016-11-15 11:57:09 +01:00
Josh Soref
6e6c3a4636 Spelling (#1998)
* spelling: cacheability

* spelling: conceptually

* spelling: javascript

* spelling: reset

* spelling: raised

* comma: instead..., they...
2016-08-30 00:26:20 +02:00
Jason Brazeal
d88c08e56f improved documentation for config.from_object (#1870) 2016-06-02 15:40:59 -07:00