[Python-modules-commits] [flask] 01/03: Import flask_0.12.orig.tar.gz
Ondřej Nový
onovy at moszumanska.debian.org
Sun Dec 25 14:05:05 UTC 2016
This is an automated email from the git hooks/post-receive script.
onovy pushed a commit to branch master
in repository flask.
commit 5219a1a4a282c1277f9c6b1cd4324e8c2d7b95f7
Author: Ondřej Nový <onovy at debian.org>
Date: Sun Dec 25 14:58:29 2016 +0100
Import flask_0.12.orig.tar.gz
---
AUTHORS | 1 +
CHANGES | 32 ++-
Flask.egg-info/PKG-INFO | 4 +-
Flask.egg-info/SOURCES.txt | 48 ++--
Flask.egg-info/requires.txt | 2 +-
Makefile | 6 +-
PKG-INFO | 4 +-
README | 2 +
docs/advanced_foreword.rst | 22 +-
docs/api.rst | 8 +-
docs/appcontext.rst | 5 +
docs/becomingbig.rst | 4 +-
docs/blueprints.rst | 21 +-
docs/cli.rst | 20 +-
docs/conf.py | 78 +++---
docs/config.rst | 5 +-
docs/deploying/index.rst | 2 +
docs/deploying/mod_wsgi.rst | 8 +-
docs/deploying/uwsgi.rst | 2 +-
docs/deploying/wsgi-standalone.rst | 4 +-
docs/errorhandling.rst | 13 +-
docs/extensions.rst | 7 +
docs/installation.rst | 49 ++--
docs/patterns/appfactories.rst | 2 +-
docs/patterns/celery.rst | 2 +-
docs/patterns/distribute.rst | 45 ++-
docs/patterns/fabric.rst | 38 +--
docs/patterns/fileuploads.rst | 10 +-
docs/patterns/flashing.rst | 6 +-
docs/patterns/index.rst | 1 +
docs/patterns/lazyloading.rst | 15 +-
docs/patterns/packages.rst | 47 +++-
docs/patterns/sqlalchemy.rst | 2 +-
docs/patterns/sqlite3.rst | 21 +-
docs/patterns/subclassing.rst | 17 ++
docs/patterns/viewdecorators.rst | 27 +-
docs/patterns/wtforms.rst | 6 +-
docs/python3.rst | 39 +--
docs/quickstart.rst | 131 +++++----
docs/testing.rst | 14 +-
docs/tutorial/css.rst | 4 +-
docs/tutorial/dbcon.rst | 28 +-
docs/tutorial/dbinit.rst | 31 ++-
docs/tutorial/folders.rst | 26 +-
docs/tutorial/index.rst | 1 +
docs/tutorial/introduction.rst | 9 +-
docs/tutorial/packaging.rst | 108 ++++++++
docs/tutorial/schema.rst | 10 +-
docs/tutorial/setup.rst | 73 ++---
docs/tutorial/templates.rst | 15 +-
docs/tutorial/testing.rst | 86 ++++++
docs/tutorial/views.rst | 43 ++-
docs/upgrading.rst | 62 ++++-
examples/flaskr/.gitignore | 1 +
examples/flaskr/MANIFEST.in | 3 +
examples/flaskr/README | 12 +-
examples/flaskr/flaskr/__init__.py | 1 +
examples/flaskr/{ => flaskr}/flaskr.py | 0
examples/flaskr/{ => flaskr}/schema.sql | 0
examples/flaskr/{ => flaskr}/static/style.css | 0
examples/flaskr/{ => flaskr}/templates/layout.html | 0
examples/flaskr/{ => flaskr}/templates/login.html | 0
.../{ => flaskr}/templates/show_entries.html | 4 +-
examples/flaskr/setup.cfg | 2 +
examples/flaskr/setup.py | 16 ++
examples/flaskr/{ => tests}/test_flaskr.py | 5 +-
examples/minitwit/.gitignore | 2 +
examples/minitwit/MANIFEST.in | 3 +
examples/minitwit/README | 12 +-
examples/minitwit/minitwit/__init__.py | 1 +
examples/minitwit/{ => minitwit}/minitwit.py | 0
examples/minitwit/{ => minitwit}/schema.sql | 0
examples/minitwit/{ => minitwit}/static/style.css | 0
.../minitwit/{ => minitwit}/templates/layout.html | 0
.../minitwit/{ => minitwit}/templates/login.html | 0
.../{ => minitwit}/templates/register.html | 0
.../{ => minitwit}/templates/timeline.html | 0
examples/minitwit/setup.cfg | 2 +
examples/minitwit/setup.py | 16 ++
examples/minitwit/{ => tests}/test_minitwit.py | 2 +-
examples/persona/README.md | 3 -
examples/persona/persona.py | 55 ----
examples/persona/static/persona.js | 52 ----
examples/persona/static/spinner.png | Bin 31201 -> 0 bytes
examples/persona/static/style.css | 39 ---
examples/persona/templates/index.html | 23 --
examples/persona/templates/layout.html | 27 --
flask/__init__.py | 4 +-
flask/_compat.py | 18 +-
flask/app.py | 78 +++---
flask/cli.py | 47 +++-
flask/config.py | 11 +-
flask/exthook.py | 2 +-
flask/helpers.py | 146 ++++++----
flask/json.py | 5 +-
flask/logging.py | 4 +
flask/sessions.py | 26 +-
flask/signals.py | 2 +-
flask/testing.py | 14 +
flask/views.py | 2 +-
flask/wrappers.py | 3 +-
setup.cfg | 5 +-
setup.py | 2 +
tests/conftest.py | 11 +-
tests/test_basic.py | 57 +++-
tests/test_cli.py | 79 +++++-
tests/test_deprecations.py | 20 +-
tests/test_ext.py | 12 +
tests/test_helpers.py | 308 +++++++++++++++------
tests/test_testing.py | 35 +++
110 files changed, 1506 insertions(+), 932 deletions(-)
diff --git a/AUTHORS b/AUTHORS
index d081d9f..cc157dc 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -15,6 +15,7 @@ Patches and Suggestions
- Chris Grindstaff
- Christopher Grebs
- Daniel Neuhäuser
+- Dan Sully
- David Lord @davidism
- Edmond Burnett
- Florent Xicluna
diff --git a/CHANGES b/CHANGES
index c057a67..73e7812 100644
--- a/CHANGES
+++ b/CHANGES
@@ -3,6 +3,34 @@ Flask Changelog
Here you can see the full list of changes between each Flask release.
+Version 0.12
+------------
+
+Released on December 21st 2016, codename Punsch.
+
+- the cli command now responds to `--version`.
+- Mimetype guessing and ETag generation for file-like objects in ``send_file``
+ has been removed, as per issue ``#104``. See pull request ``#1849``.
+- Mimetype guessing in ``send_file`` now fails loudly and doesn't fall back to
+ ``application/octet-stream``. See pull request ``#1988``.
+- Make ``flask.safe_join`` able to join multiple paths like ``os.path.join``
+ (pull request ``#1730``).
+- Revert a behavior change that made the dev server crash instead of returning
+ a Internal Server Error (pull request ``#2006``).
+- Correctly invoke response handlers for both regular request dispatching as
+ well as error handlers.
+- Disable logger propagation by default for the app logger.
+- Add support for range requests in ``send_file``.
+- ``app.test_client`` includes preset default environment, which can now be
+ directly set, instead of per ``client.get``.
+
+Version 0.11.2
+--------------
+
+Bugfix release, unreleased
+
+- Fix crash when running under PyPy3, see pull request ``#1814``.
+
Version 0.11.1
--------------
@@ -34,7 +62,7 @@ Released on May 29th 2016, codename Absinthe.
from a view function.
- Added :meth:`flask.Config.from_json`.
- Added :attr:`flask.Flask.config_class`.
-- Added :meth:`flask.config.Config.get_namespace`.
+- Added :meth:`flask.Config.get_namespace`.
- Templates are no longer automatically reloaded outside of debug mode. This
can be configured with the new ``TEMPLATES_AUTO_RELOAD`` config key.
- Added a workaround for a limitation in Python 3.3's namespace loader.
@@ -309,7 +337,7 @@ Released on September 29th 2011, codename Rakija
- Applications now not only have a root path where the resources and modules
are located but also an instance path which is the designated place to
drop files that are modified at runtime (uploads etc.). Also this is
- conceptionally only instance depending and outside version control so it's
+ conceptually only instance depending and outside version control so it's
the perfect place to put configuration files etc. For more information
see :ref:`instance-folders`.
- Added the ``APPLICATION_ROOT`` configuration variable.
diff --git a/Flask.egg-info/PKG-INFO b/Flask.egg-info/PKG-INFO
index 7bb43e5..5d3c8bb 100644
--- a/Flask.egg-info/PKG-INFO
+++ b/Flask.egg-info/PKG-INFO
@@ -1,6 +1,6 @@
Metadata-Version: 1.1
Name: Flask
-Version: 0.11.1
+Version: 0.12
Summary: A microframework based on Werkzeug, Jinja2 and good intentions
Home-page: http://github.com/pallets/flask/
Author: Armin Ronacher
@@ -41,6 +41,8 @@ Description:
$ python hello.py
* Running on http://localhost:5000/
+ Ready for production? `Read this first <http://flask.pocoo.org/docs/deploying/>`.
+
Links
`````
diff --git a/Flask.egg-info/SOURCES.txt b/Flask.egg-info/SOURCES.txt
index cc21df0..8c54d90 100644
--- a/Flask.egg-info/SOURCES.txt
+++ b/Flask.egg-info/SOURCES.txt
@@ -94,6 +94,7 @@ docs/patterns/requestchecksum.rst
docs/patterns/sqlalchemy.rst
docs/patterns/sqlite3.rst
docs/patterns/streaming.rst
+docs/patterns/subclassing.rst
docs/patterns/templateinheritance.rst
docs/patterns/urlprocessors.rst
docs/patterns/viewdecorators.rst
@@ -104,6 +105,7 @@ docs/tutorial/dbinit.rst
docs/tutorial/folders.rst
docs/tutorial/index.rst
docs/tutorial/introduction.rst
+docs/tutorial/packaging.rst
docs/tutorial/schema.rst
docs/tutorial/setup.rst
docs/tutorial/templates.rst
@@ -118,33 +120,35 @@ examples/blueprintexample/simple_page/templates/pages/index.html
examples/blueprintexample/simple_page/templates/pages/layout.html
examples/blueprintexample/simple_page/templates/pages/world.html
examples/flaskr/.gitignore
+examples/flaskr/MANIFEST.in
examples/flaskr/README
-examples/flaskr/flaskr.py
-examples/flaskr/schema.sql
-examples/flaskr/test_flaskr.py
-examples/flaskr/static/style.css
-examples/flaskr/templates/layout.html
-examples/flaskr/templates/login.html
-examples/flaskr/templates/show_entries.html
+examples/flaskr/setup.cfg
+examples/flaskr/setup.py
+examples/flaskr/flaskr/__init__.py
+examples/flaskr/flaskr/flaskr.py
+examples/flaskr/flaskr/schema.sql
+examples/flaskr/flaskr/static/style.css
+examples/flaskr/flaskr/templates/layout.html
+examples/flaskr/flaskr/templates/login.html
+examples/flaskr/flaskr/templates/show_entries.html
+examples/flaskr/tests/test_flaskr.py
examples/jqueryexample/jqueryexample.py
examples/jqueryexample/templates/index.html
examples/jqueryexample/templates/layout.html
+examples/minitwit/.gitignore
+examples/minitwit/MANIFEST.in
examples/minitwit/README
-examples/minitwit/minitwit.py
-examples/minitwit/schema.sql
-examples/minitwit/test_minitwit.py
-examples/minitwit/static/style.css
-examples/minitwit/templates/layout.html
-examples/minitwit/templates/login.html
-examples/minitwit/templates/register.html
-examples/minitwit/templates/timeline.html
-examples/persona/README.md
-examples/persona/persona.py
-examples/persona/static/persona.js
-examples/persona/static/spinner.png
-examples/persona/static/style.css
-examples/persona/templates/index.html
-examples/persona/templates/layout.html
+examples/minitwit/setup.cfg
+examples/minitwit/setup.py
+examples/minitwit/minitwit/__init__.py
+examples/minitwit/minitwit/minitwit.py
+examples/minitwit/minitwit/schema.sql
+examples/minitwit/minitwit/static/style.css
+examples/minitwit/minitwit/templates/layout.html
+examples/minitwit/minitwit/templates/login.html
+examples/minitwit/minitwit/templates/register.html
+examples/minitwit/minitwit/templates/timeline.html
+examples/minitwit/tests/test_minitwit.py
flask/__init__.py
flask/__main__.py
flask/_compat.py
diff --git a/Flask.egg-info/requires.txt b/Flask.egg-info/requires.txt
index bd0cda5..fe5cdef 100644
--- a/Flask.egg-info/requires.txt
+++ b/Flask.egg-info/requires.txt
@@ -1,4 +1,4 @@
Werkzeug>=0.7
Jinja2>=2.4
itsdangerous>=0.21
-click>=2.0
\ No newline at end of file
+click>=2.0
diff --git a/Makefile b/Makefile
index 350aa9a..f76c209 100644
--- a/Makefile
+++ b/Makefile
@@ -3,10 +3,8 @@
all: clean-pyc test
test:
- FLASK_DEBUG= py.test tests examples
-
-tox-test:
- tox
+ pip install -r test-requirements.txt
+ tox -e py-release
audit:
python setup.py audit
diff --git a/PKG-INFO b/PKG-INFO
index 7bb43e5..5d3c8bb 100644
--- a/PKG-INFO
+++ b/PKG-INFO
@@ -1,6 +1,6 @@
Metadata-Version: 1.1
Name: Flask
-Version: 0.11.1
+Version: 0.12
Summary: A microframework based on Werkzeug, Jinja2 and good intentions
Home-page: http://github.com/pallets/flask/
Author: Armin Ronacher
@@ -41,6 +41,8 @@ Description:
$ python hello.py
* Running on http://localhost:5000/
+ Ready for production? `Read this first <http://flask.pocoo.org/docs/deploying/>`.
+
Links
`````
diff --git a/README b/README
index d0e3c52..baea6b2 100644
--- a/README
+++ b/README
@@ -37,6 +37,8 @@
$ py.test
+ Details on contributing can be found in CONTRIBUTING.rst
+
~ Where can I get help?
Either use the #pocoo IRC channel on irc.freenode.net or
diff --git a/docs/advanced_foreword.rst b/docs/advanced_foreword.rst
index 22e333f..82b3dc5 100644
--- a/docs/advanced_foreword.rst
+++ b/docs/advanced_foreword.rst
@@ -46,24 +46,10 @@ spam, links to malicious software, and the like.
Flask is no different from any other framework in that you the developer must
build with caution, watching for exploits when building to your requirements.
-The Status of Python 3
-----------------------
-
-Currently the Python community is in the process of improving libraries to
-support the new iteration of the Python programming language. While the
-situation is greatly improving there are still some issues that make it
-hard for users to switch over to Python 3 just now. These problems are
-partially caused by changes in the language that went unreviewed for too
-long, partially also because we have not quite worked out how the lower-
-level API should change to account for the Unicode differences in Python 3.
-
-We strongly recommend using Python 2.7 with activated Python 3
-warnings during development. If you plan on upgrading to Python 3 in the
-near future we strongly recommend that you read `How to write forwards
-compatible Python code
-<http://lucumr.pocoo.org/2011/1/22/forwards-compatible-python/>`_.
+Python 3 Support in Flask
+-------------------------
-If you do want to dive into Python 3 already have a look at the
-:ref:`python3-support` page.
+Flask, its dependencies, and most Flask extensions all support Python 3.
+If you want to use Flask with Python 3 have a look at the :ref:`python3-support` page.
Continue to :ref:`installation` or the :ref:`quickstart`.
diff --git a/docs/api.rst b/docs/api.rst
index e72c9ac..d77da3d 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -316,13 +316,7 @@ Useful Functions and Classes
.. autofunction:: url_for
-.. function:: abort(code)
-
- Raises an :exc:`~werkzeug.exceptions.HTTPException` for the given
- status code. For example to abort request handling with a page not
- found exception, you would call ``abort(404)``.
-
- :param code: the HTTP error code.
+.. autofunction:: abort
.. autofunction:: redirect
diff --git a/docs/appcontext.rst b/docs/appcontext.rst
index 672b6bf..166c5aa 100644
--- a/docs/appcontext.rst
+++ b/docs/appcontext.rst
@@ -74,6 +74,11 @@ The application context is also used by the :func:`~flask.url_for`
function in case a ``SERVER_NAME`` was configured. This allows you to
generate URLs even in the absence of a request.
+If no request context has been pushed and an application context has
+not been explicitly set, a ``RuntimeError`` will be raised. ::
+
+ RuntimeError: Working outside of application context.
+
Locality of the Context
-----------------------
diff --git a/docs/becomingbig.rst b/docs/becomingbig.rst
index 8b0a274..0facbfe 100644
--- a/docs/becomingbig.rst
+++ b/docs/becomingbig.rst
@@ -12,7 +12,7 @@ Flask started in part to demonstrate how to build your own framework on top of
existing well-used tools Werkzeug (WSGI) and Jinja (templating), and as it
developed, it became useful to a wide audience. As you grow your codebase,
don't just use Flask -- understand it. Read the source. Flask's code is
-written to be read; it's documentation is published so you can use its internal
+written to be read; its documentation is published so you can use its internal
APIs. Flask sticks to documented APIs in upstream libraries, and documents its
internal utilities so that you can find the hook points needed for your
project.
@@ -35,7 +35,7 @@ Subclass.
The :class:`~flask.Flask` class has many methods designed for subclassing. You
can quickly add or customize behavior by subclassing :class:`~flask.Flask` (see
the linked method docs) and using that subclass wherever you instantiate an
-application class. This works well with :ref:`app-factories`.
+application class. This works well with :ref:`app-factories`. See :doc:`/patterns/subclassing` for an example.
Wrap with middleware.
---------------------
diff --git a/docs/blueprints.rst b/docs/blueprints.rst
index d22220b..89d3701 100644
--- a/docs/blueprints.rst
+++ b/docs/blueprints.rst
@@ -176,16 +176,25 @@ the `template_folder` parameter to the :class:`Blueprint` constructor::
admin = Blueprint('admin', __name__, template_folder='templates')
-As for static files, the path can be absolute or relative to the blueprint
-resource folder. The template folder is added to the searchpath of
-templates but with a lower priority than the actual application's template
-folder. That way you can easily override templates that a blueprint
-provides in the actual application.
+For static files, the path can be absolute or relative to the blueprint
+resource folder.
+
+The template folder is added to the search path of templates but with a lower
+priority than the actual application's template folder. That way you can
+easily override templates that a blueprint provides in the actual application.
+This also means that if you don't want a blueprint template to be accidentally
+overridden, make sure that no other blueprint or actual application template
+has the same relative path. When multiple blueprints provide the same relative
+template path the first blueprint registered takes precedence over the others.
+
So if you have a blueprint in the folder ``yourapplication/admin`` and you
want to render the template ``'admin/index.html'`` and you have provided
``templates`` as a `template_folder` you will have to create a file like
-this: :file:`yourapplication/admin/templates/admin/index.html`.
+this: :file:`yourapplication/admin/templates/admin/index.html`. The reason
+for the extra ``admin`` folder is to avoid getting our template overridden
+by a template named ``index.html`` in the actual application template
+folder.
To further reiterate this: if you have a blueprint named ``admin`` and you
want to render a template called :file:`index.html` which is specific to this
diff --git a/docs/cli.rst b/docs/cli.rst
index d1b0850..2ca0e83 100644
--- a/docs/cli.rst
+++ b/docs/cli.rst
@@ -32,7 +32,7 @@ Python module that contains a Flask application.
In that imported file the name of the app needs to be called ``app`` or
optionally be specified after a colon. For instance
-`mymodule:application` would tell it to use the `application` object in
+``mymodule:application`` would tell it to use the `application` object in
the :file:`mymodule.py` file.
Given a :file:`hello.py` file with the application in it named ``app``
@@ -61,9 +61,7 @@ Debug Flag
The :command:`flask` script can also be instructed to enable the debug
mode of the application automatically by exporting ``FLASK_DEBUG``. If
-set to ``1`` debug is enabled or ``0`` disables it.
-
-Or with a filename::
+set to ``1`` debug is enabled or ``0`` disables it::
export FLASK_DEBUG=1
@@ -141,8 +139,8 @@ This could be a file named :file:`autoapp.py` with these contents::
from yourapplication import create_app
app = create_app(os.environ['YOURAPPLICATION_CONFIG'])
-Once this has happened you can make the flask command automatically pick
-it up::
+Once this has happened you can make the :command:`flask` command automatically
+pick it up::
export YOURAPPLICATION_CONFIG=/path/to/config.cfg
export FLASK_APP=/path/to/autoapp.py
@@ -218,13 +216,13 @@ step.
CLI Plugins
-----------
-Flask extensions can always patch the `Flask.cli` instance with more
+Flask extensions can always patch the :attr:`Flask.cli` instance with more
commands if they want. However there is a second way to add CLI plugins
-to Flask which is through `setuptools`. If you make a Python package that
-should export a Flask command line plugin you can ship a `setup.py` file
+to Flask which is through ``setuptools``. If you make a Python package that
+should export a Flask command line plugin you can ship a :file:`setup.py` file
that declares an entrypoint that points to a click command:
-Example `setup.py`::
+Example :file:`setup.py`::
from setuptools import setup
@@ -237,7 +235,7 @@ Example `setup.py`::
''',
)
-Inside `mypackage/comamnds.py` you can then export a Click object::
+Inside :file:`mypackage/commands.py` you can then export a Click object::
import click
diff --git a/docs/conf.py b/docs/conf.py
index 880e912..b37427a 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -11,13 +11,16 @@
# All configuration values have a default; values that are commented out
# serve to show the default.
from __future__ import print_function
-import sys, os
+from datetime import datetime
+import os
+import sys
+import pkg_resources
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.append(os.path.abspath('_themes'))
-sys.path.append(os.path.abspath('.'))
+sys.path.append(os.path.join(os.path.dirname(__file__), '_themes'))
+sys.path.append(os.path.dirname(__file__))
# -- General configuration -----------------------------------------------------
@@ -46,22 +49,21 @@ master_doc = 'index'
# General information about the project.
project = u'Flask'
-copyright = u'2015, Armin Ronacher'
+copyright = u'2010 - {0}, Armin Ronacher'.format(datetime.utcnow().year)
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
-import pkg_resources
try:
release = pkg_resources.get_distribution('Flask').version
except pkg_resources.DistributionNotFound:
print('Flask must be installed to build the documentation.')
print('Install from source using `pip install -e .` in a virtualenv.')
sys.exit(1)
-del pkg_resources
if 'dev' in release:
- release = release.split('dev')[0] + 'dev'
+ release = ''.join(release.partition('dev')[:2])
+
version = '.'.join(release.split('.')[:2])
# The language for content autogenerated by Sphinx. Refer to documentation
@@ -100,14 +102,12 @@ exclude_patterns = ['_build']
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
-html_theme = 'flask'
+# html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
-html_theme_options = {
- 'touch_icon': 'touch-icon.png'
-}
+# html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = ['_themes']
@@ -126,7 +126,7 @@ html_theme_path = ['_themes']
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
-html_favicon = "flask-favicon.ico"
+html_favicon = '_static/flask-favicon.ico'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
@@ -143,9 +143,18 @@ html_static_path = ['_static']
# Custom sidebar templates, maps document names to template names.
html_sidebars = {
- 'index': ['sidebarintro.html', 'sourcelink.html', 'searchbox.html'],
- '**': ['sidebarlogo.html', 'localtoc.html', 'relations.html',
- 'sourcelink.html', 'searchbox.html']
+ 'index': [
+ 'sidebarintro.html',
+ 'sourcelink.html',
+ 'searchbox.html'
+ ],
+ '**': [
+ 'sidebarlogo.html',
+ 'localtoc.html',
+ 'relations.html',
+ 'sourcelink.html',
+ 'searchbox.html'
+ ]
}
# Additional templates that should be rendered to pages, maps page names to
@@ -187,8 +196,7 @@ htmlhelp_basename = 'Flaskdoc'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
- ('latexindex', 'Flask.tex', u'Flask Documentation',
- u'Armin Ronacher', 'manual'),
+ ('latexindex', 'Flask.tex', u'Flask Documentation', u'Armin Ronacher', 'manual'),
]
# Documents to append as an appendix to all manuals.
@@ -198,10 +206,10 @@ latex_documents = [
latex_use_modindex = False
latex_elements = {
- 'fontpkg': r'\usepackage{mathpazo}',
- 'papersize': 'a4paper',
- 'pointsize': '12pt',
- 'preamble': r'\usepackage{flaskstyle}'
+ 'fontpkg': r'\usepackage{mathpazo}',
+ 'papersize': 'a4paper',
+ 'pointsize': '12pt',
+ 'preamble': r'\usepackage{flaskstyle}'
}
latex_use_parts = True
@@ -245,21 +253,23 @@ latex_additional_files = ['flaskstyle.sty', 'logo.pdf']
#epub_tocdepth = 3
intersphinx_mapping = {
- 'https://docs.python.org/dev': None,
- 'http://werkzeug.pocoo.org/docs/': None,
- 'http://click.pocoo.org/': None,
- 'http://jinja.pocoo.org/docs/': None,
- 'http://www.sqlalchemy.org/docs/': None,
- 'https://wtforms.readthedocs.org/en/latest/': None,
- 'https://pythonhosted.org/blinker/': None
+ 'python': ('https://docs.python.org/3/', None),
+ 'werkzeug': ('http://werkzeug.pocoo.org/docs/', None),
+ 'click': ('http://click.pocoo.org/', None),
+ 'jinja': ('http://jinja.pocoo.org/docs/', None),
+ 'sqlalchemy': ('http://docs.sqlalchemy.org/en/latest/', None),
+ 'wtforms': ('https://wtforms.readthedocs.io/en/latest/', None),
+ 'blinker': ('https://pythonhosted.org/blinker/', None)
}
-pygments_style = 'flask_theme_support.FlaskyStyle'
-
-# fall back if theme is not there
try:
__import__('flask_theme_support')
-except ImportError as e:
+ pygments_style = 'flask_theme_support.FlaskyStyle'
+ html_theme = 'flask'
+ html_theme_options = {
+ 'touch_icon': 'touch-icon.png'
+ }
+except ImportError:
print('-' * 74)
print('Warning: Flask themes unavailable. Building with default theme')
print('If you want the Flask themes, run this command and build again:')
@@ -267,10 +277,6 @@ except ImportError as e:
print(' git submodule update --init')
print('-' * 74)
- pygments_style = 'tango'
- html_theme = 'default'
- html_theme_options = {}
-
# unwrap decorators
def unwrap_decorators():
diff --git a/docs/config.rst b/docs/config.rst
index 3039b3e..6d37c1e 100644
--- a/docs/config.rst
+++ b/docs/config.rst
@@ -177,7 +177,7 @@ The following configuration values are used internally by Flask:
behavior by changing this variable.
This is not recommended but might give
you a performance improvement on the
- cost of cachability.
+ cost of cacheability.
``JSONIFY_PRETTYPRINT_REGULAR`` If this is set to ``True`` (the default)
jsonify responses will be pretty printed
if they are not requested by an
@@ -262,7 +262,7 @@ So a common pattern is this::
This first loads the configuration from the
`yourapplication.default_settings` module and then overrides the values
-with the contents of the file the :envvar:``YOURAPPLICATION_SETTINGS``
+with the contents of the file the :envvar:`YOURAPPLICATION_SETTINGS`
environment variable points to. This environment variable can be set on
Linux or OS X with the export command in the shell before starting the
server::
@@ -310,6 +310,7 @@ that experience:
limit yourself to request-only accesses to the configuration you can
reconfigure the object later on as needed.
+.. _config-dev-prod:
Development / Production
------------------------
diff --git a/docs/deploying/index.rst b/docs/deploying/index.rst
index 5d88cf7..20e7176 100644
--- a/docs/deploying/index.rst
+++ b/docs/deploying/index.rst
@@ -21,8 +21,10 @@ Hosted options
- `Deploying Flask on OpenShift <https://developers.openshift.com/en/python-flask.html>`_
- `Deploying Flask on Webfaction <http://flask.pocoo.org/snippets/65/>`_
- `Deploying Flask on Google App Engine <https://github.com/kamalgill/flask-appengine-template>`_
+- `Deploying Flask on AWS Elastic Beanstalk <http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/create-deploy-python-flask.html>`_
- `Sharing your Localhost Server with Localtunnel <http://flask.pocoo.org/snippets/89/>`_
- `Deploying on Azure (IIS) <https://azure.microsoft.com/documentation/articles/web-sites-python-configure/>`_
+- `Deploying on PythonAnywhere <https://help.pythonanywhere.com/pages/Flask/>`_
Self-hosted options
-------------------
diff --git a/docs/deploying/mod_wsgi.rst b/docs/deploying/mod_wsgi.rst
index b06a190..0f4af6c 100644
--- a/docs/deploying/mod_wsgi.rst
+++ b/docs/deploying/mod_wsgi.rst
@@ -130,12 +130,12 @@ to httpd 2.4 syntax
Require all granted
-For more information consult the `mod_wsgi wiki`_.
+For more information consult the `mod_wsgi documentation`_.
-.. _mod_wsgi: http://code.google.com/p/modwsgi/
-.. _installation instructions: http://code.google.com/p/modwsgi/wiki/QuickInstallationGuide
+.. _mod_wsgi: https://github.com/GrahamDumpleton/mod_wsgi
+.. _installation instructions: http://modwsgi.readthedocs.io/en/develop/installation.html
.. _virtual python: https://pypi.python.org/pypi/virtualenv
-.. _mod_wsgi wiki: http://code.google.com/p/modwsgi/w/list
+.. _mod_wsgi documentation: http://modwsgi.readthedocs.io/en/develop/index.html
Troubleshooting
---------------
diff --git a/docs/deploying/uwsgi.rst b/docs/deploying/uwsgi.rst
index 183bdb6..fc991e7 100644
--- a/docs/deploying/uwsgi.rst
+++ b/docs/deploying/uwsgi.rst
@@ -29,7 +29,7 @@ Given a flask application in myapp.py, use the following command:
.. sourcecode:: text
- $ uwsgi -s /tmp/uwsgi.sock --manage-script-name --mount /yourapplication=myapp:app
+ $ uwsgi -s /tmp/yourapplication.sock --manage-script-name --mount /yourapplication=myapp:app
The ``--manage-script-name`` will move the handling of ``SCRIPT_NAME`` to uwsgi,
since its smarter about that. It is used together with the ``--mount`` directive
diff --git a/docs/deploying/wsgi-standalone.rst b/docs/deploying/wsgi-standalone.rst
index d546fcd..ad43c14 100644
--- a/docs/deploying/wsgi-standalone.rst
+++ b/docs/deploying/wsgi-standalone.rst
@@ -25,7 +25,7 @@ For example, to run a Flask application with 4 worker processes (``-w
.. _Gunicorn: http://gunicorn.org/
.. _eventlet: http://eventlet.net/
-.. _greenlet: http://greenlet.readthedocs.org/en/latest/
+.. _greenlet: https://greenlet.readthedocs.io/en/latest/
Gevent
-------
@@ -41,7 +41,7 @@ event loop::
http_server.serve_forever()
.. _Gevent: http://www.gevent.org/
-.. _greenlet: http://greenlet.readthedocs.org/en/latest/
+.. _greenlet: https://greenlet.readthedocs.io/en/latest/
.. _libev: http://software.schmorp.de/pkg/libev.html
Twisted Web
diff --git a/docs/errorhandling.rst b/docs/errorhandling.rst
index e2af7af..64c0f8b 100644
--- a/docs/errorhandling.rst
+++ b/docs/errorhandling.rst
@@ -36,7 +36,7 @@ overwhelming if enough users are hitting the error and log files are
typically never looked at. This is why we recommend using `Sentry
<http://www.getsentry.com/>`_ for dealing with application errors. It's
available as an Open Source project `on GitHub
-<github.com/getsentry/sentry>`__ and is also available as a `hosted version
+<https://github.com/getsentry/sentry>`__ and is also available as a `hosted version
<https://getsentry.com/signup/>`_ which you can try for free. Sentry
aggregates duplicate errors, captures the full stack trace and local
variables for debugging, and sends you mails based on new errors or
@@ -51,7 +51,7 @@ And then add this to your Flask app::
from raven.contrib.flask import Sentry
sentry = Sentry(app, dsn='YOUR_DSN_HERE')
-Of if you are using factories you can also init it later::
+Or if you are using factories you can also init it later::
from raven.contrib.flask import Sentry
sentry = Sentry(dsn='YOUR_DSN_HERE')
@@ -77,7 +77,7 @@ You might want to show custom error pages to the user when an error occurs.
This can be done by registering error handlers.
Error handlers are normal :ref:`views` but instead of being registered for
-routes they are registered for exceptions that are rised while trying to
+routes, they are registered for exceptions that are raised while trying to
do something else.
Registering
@@ -216,7 +216,7 @@ A formatter can be instantiated with a format string. Note that
tracebacks are appended to the log entry automatically. You don't have to
do that in the log formatter format string.
-Here some example setups:
+Here are some example setups:
Email
`````
@@ -276,8 +276,9 @@ that this list is not complete, consult the official documentation of the
| ``%(lineno)d`` | Source line number where the logging call was |
| | issued (if available). |
+------------------+----------------------------------------------------+
-| ``%(asctime)s`` | Human-readable time when the LogRecord` was |
-| | created. By default this is of the form |
+| ``%(asctime)s`` | Human-readable time when the |
+| | :class:`~logging.LogRecord` was created. |
+| | By default this is of the form |
| | ``"2003-07-08 16:49:45,896"`` (the numbers after |
| | the comma are millisecond portion of the time). |
| | This can be changed by subclassing the formatter |
diff --git a/docs/extensions.rst b/docs/extensions.rst
index d1d2480..6deb965 100644
--- a/docs/extensions.rst
+++ b/docs/extensions.rst
@@ -25,6 +25,13 @@ importable from ``flask_foo``::
import flask_foo
+Building Extensions
+-------------------
+
+While `Flask Extension Registry`_ contains many Flask extensions, you may not find
+an extension that fits your need. If this is the case, you can always create your own.
+Consider reading :ref:`extension-dev` to develop your own Flask extension.
+
Flask Before 0.8
----------------
diff --git a/docs/installation.rst b/docs/installation.rst
index 533a6ff..6f833ea 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -40,24 +40,20 @@ installations of Python, one for each project. It doesn't actually install
separate copies of Python, but it does provide a clever way to keep different
project environments isolated. Let's see how virtualenv works.
-If you are on Mac OS X or Linux, chances are that one of the following two
-commands will work for you::
-
- $ sudo easy_install virtualenv
-
-or even better::
+If you are on Mac OS X or Linux, chances are that the following
+command will work for you::
$ sudo pip install virtualenv
-One of these will probably install virtualenv on your system. Maybe it's even
+It will probably install virtualenv on your system. Maybe it's even
in your package manager. If you use Ubuntu, try::
$ sudo apt-get install python-virtualenv
-If you are on Windows and don't have the :command:`easy_install` command, you must
+If you are on Windows and don't have the ``easy_install`` command, you must
install it first. Check the :ref:`windows-easy-install` section for more
information about how to do that. Once you have it installed, run the same
-commands as above, but without the :command:`sudo` prefix.
+commands as above, but without the ``sudo`` prefix.
Once you have virtualenv installed, just fire up a shell and create
your own environment. I usually create a project folder and a :file:`venv`
@@ -76,7 +72,7 @@ corresponding environment. On OS X and Linux, do the following::
If you are a Windows user, the following command is for you::
- $ venv\scripts\activate
+ $ venv\Scripts\activate
Either way, you should now be using your virtualenv (notice how the prompt of
your shell has changed to show the active environment).
@@ -99,19 +95,19 @@ System-Wide Installation
------------------------
This is possible as well, though I do not recommend it. Just run
-:command:`pip` with root privileges::
+``pip`` with root privileges::
$ sudo pip install Flask
(On Windows systems, run it in a command-prompt window with administrator
-privileges, and leave out :command:`sudo`.)
+privileges, and leave out ``sudo``.)
Living on the Edge
------------------
If you want to work with the latest version of Flask, there are two ways: you
-can either let :command:`pip` pull in the development version, or you can tell
+can either let ``pip`` pull in the development version, or you can tell
it to operate on a git checkout. Either way, virtualenv is recommended.
Get the git checkout in a new virtualenv and run in development mode::
@@ -131,40 +127,34 @@ This will pull in the dependencies and activate the git head as the current
version inside the virtualenv. Then all you have to do is run ``git pull
origin`` to update to the latest version.
-
.. _windows-easy-install:
`pip` and `setuptools` on Windows
---------------------------------
-Sometimes getting the standard "Python packaging tools" like *pip*, *setuptools*
-and *virtualenv* can be a little trickier, but nothing very hard. The two crucial
-packages you will need are setuptools and pip - these will let you install
-anything else (like virtualenv). Fortunately there are two "bootstrap scripts"
-you can run to install either.
+Sometimes getting the standard "Python packaging tools" like ``pip``, ``setuptools``
+and ``virtualenv`` can be a little trickier, but nothing very hard. The crucial
+package you will need is pip - this will let you install
+anything else (like virtualenv). Fortunately there is a "bootstrap script"
+you can run to install.
-If you don't currently have either, then `get-pip.py` will install both for you
-(you won't need to run ez_setup.py).
+If you don't currently have ``pip``, then `get-pip.py` will install it for you.
`get-pip.py`_
-To install the latest setuptools, you can use its bootstrap file:
-
-`ez_setup.py`_
-
-Either should be double-clickable once you download them. If you already have pip,
+It should be double-clickable once you download it. If you already have ``pip``,
you can upgrade them by running::
> pip install --upgrade pip setuptools
-Most often, once you pull up a command prompt you want to be able to type :command:`pip`
-and :command:`python` which will run those things, but this might not automatically happen
+Most often, once you pull up a command prompt you want to be able to type ``pip``
+and ``python`` which will run those things, but this might not automatically happen
on Windows, because it doesn't know where those executables are (give either a try!).
To fix this, you should be able to navigate to your Python install directory
(e.g :file:`C:\Python27`), then go to :file:`Tools`, then :file:`Scripts`, then find the
:file:`win_add2path.py` file and run that. Open a **new** Command Prompt and
-check that you can now just type :command:`python` to bring up the interpreter.
+check that you can now just type ``python`` to bring up the interpreter.
Finally, to install `virtualenv`_, you can simply run::
@@ -173,4 +163,3 @@ Finally, to install `virtualenv`_, you can simply run::
Then you can be off on your way following the installation instructions above.
.. _get-pip.py: https://bootstrap.pypa.io/get-pip.py
-.. _ez_setup.py: https://bitbucket.org/pypa/setuptools/raw/bootstrap/ez_setup.py
diff --git a/docs/patterns/appfactories.rst b/docs/patterns/appfactories.rst
index dc9660a..c118a27 100644
... 3832 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/flask.git
More information about the Python-modules-commits
mailing list