Merge branch 'master' into AvivC-improve-docs-in-Flask.preprocess_request

Author: davidism

.gitattributes

@@ -0,0 +1 @@
+CHANGES merge=union

.github/ISSUE_TEMPLATE.rst

@@ -0,0 +1,2 @@
+The issue tracker is a tool to address bugs.
+Please use the #pocoo IRC channel on freenode or Stack Overflow for questions.

.gitignore

@@ -11,3 +11,9 @@ _mailinglist
 .tox
 .cache/
 .idea/
+
+# Coverage reports
+htmlcov
+.coverage
+.coverage.*
+*,cover

.travis.yml

@@ -8,22 +8,35 @@ python:
   - "3.3"
   - "3.4"
   - "3.5"
+  - "3.6"
 
 env:
   - REQUIREMENTS=lowest
+  - REQUIREMENTS=lowest-simplejson
   - REQUIREMENTS=release
+  - REQUIREMENTS=release-simplejson
   - REQUIREMENTS=devel
+  - REQUIREMENTS=devel-simplejson
 
 matrix:
   exclude:
     # Python 3 support currently does not work with lowest requirements
     - python: "3.3"
       env: REQUIREMENTS=lowest
+    - python: "3.3"
+      env: REQUIREMENTS=lowest-simplejson
     - python: "3.4"
       env: REQUIREMENTS=lowest
+    - python: "3.4"
+      env: REQUIREMENTS=lowest-simplejson
     - python: "3.5"
       env: REQUIREMENTS=lowest
-
+    - python: "3.5"
+      env: REQUIREMENTS=lowest-simplejson
+    - python: "3.6"
+      env: REQUIREMENTS=lowest
+    - python: "3.6"
+      env: REQUIREMENTS=lowest-simplejson
 
 install:
     - pip install tox

AUTHORS

@@ -15,9 +15,13 @@ Patches and Suggestions
 - Chris Grindstaff
 - Christopher Grebs
 - Daniel Neuhäuser
+- Dan Sully
+- David Lord @davidism
 - Edmond Burnett
 - Florent Xicluna
 - Georg Brandl
+- Jeff Widman @jeffwidman
+- Joshua Bronson @jab
 - Justin Quick
 - Kenneth Reitz
 - Keyan Pishdadian
@@ -32,4 +36,3 @@ Patches and Suggestions
 - Stephane Wirtel
 - Thomas Schranz
 - Zhao Xiaohong
-- David Lord @davidism

CHANGES

@@ -3,11 +3,103 @@ Flask Changelog
 
 Here you can see the full list of changes between each Flask release.
 
-Version 1.0
------------
+Version 0.13
+------------
+
+Major release, unreleased
+
+- Make `app.run()` into a noop if a Flask application is run from the
+  development server on the command line.  This avoids some behavior that
+  was confusing to debug for newcomers.
+- Change default configuration `JSONIFY_PRETTYPRINT_REGULAR=False`. jsonify()
+  method returns compressed response by default, and pretty response in
+  debug mode.
+- Change Flask.__init__ to accept two new keyword arguments, ``host_matching``
+  and ``static_host``. This enables ``host_matching`` to be set properly by the
+  time the constructor adds the static route, and enables the static route to
+  be properly associated with the required host. (``#1559``)
+- ``send_file`` supports Unicode in ``attachment_filename``. (`#2223`_)
+- Pass ``_scheme`` argument from ``url_for`` to ``handle_build_error``.
+  (`#2017`_)
+- Add support for ``provide_automatic_options`` in ``add_url_rule`` to disable
+  adding OPTIONS method when the ``view_func`` argument is not a class.
+  (`#1489`_).
+- ``MethodView`` can 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 ``json_encoder`` and ``json_decoder`` attributes to
+  override the app's encoder and decoder. (`#1898`_)
+- ``Flask.make_response`` raises ``TypeError`` instead of ``ValueError`` for
+  bad response types. The error messages have been improved to describe why the
+  type is invalid. (`#2256`_)
+
+.. _#1489: https://github.com/pallets/flask/pull/1489
+.. _#1898: https://github.com/pallets/flask/pull/1898
+.. _#1936: https://github.com/pallets/flask/pull/1936
+.. _#2017: https://github.com/pallets/flask/pull/2017
+.. _#2223: https://github.com/pallets/flask/pull/2223
+.. _#2254: https://github.com/pallets/flask/pull/2254
+.. _#2256: https://github.com/pallets/flask/pull/2256
+
+Version 0.12.1
+--------------
+
+Bugfix release, released on March 31st 2017
+
+- Prevent `flask run` from showing a NoAppException when an ImportError occurs
+  within the imported application module.
+- Fix encoding behavior of ``app.config.from_pyfile`` for Python 3. Fix
+  ``#2118``.
+- Use the ``SERVER_NAME`` config if it is present as default values for
+  ``app.run``. ``#2109``, ``#2152``
+- Call `ctx.auto_pop` with the exception object instead of `None`, in the
+  event that a `BaseException` such as `KeyboardInterrupt` is raised in a
+  request handler.
+
+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
+--------------
+
+Bugfix release, released on June 7th 2016.
+
+- Fixed a bug that prevented ``FLASK_APP=foobar/__init__.py`` from working. See
+  pull request ``#1872``.
+
+Version 0.11
+------------
 
-(release date to be announced, codename to be selected)
+Released on May 29th 2016, codename Absinthe.
 
+- Added support to serializing top-level arrays to :func:`flask.jsonify`. This
+  introduces a security risk in ancient browsers. See
+  :ref:`json-security` for details.
 - Added before_render_template signal.
 - Added `**kwargs` to :meth:`flask.Test.test_client` to support passing
   additional keyword arguments to the constructor of
@@ -23,7 +115,7 @@ Version 1.0
   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.
@@ -57,7 +149,7 @@ Version 1.0
 - JSON responses are now terminated with a newline character, because it is a
   convention that UNIX text files end with a newline and some clients don't
   deal well when this newline is missing. See
-  https://github.com/mitsuhiko/flask/pull/1262 -- this came up originally as a
+  https://github.com/pallets/flask/pull/1262 -- this came up originally as a
   part of https://github.com/kennethreitz/httpbin/issues/168
 - The automatically provided ``OPTIONS`` method is now correctly disabled if
   the user registered an overriding rule with the lowercase-version
@@ -70,6 +162,12 @@ Version 1.0
 - ``flask.g`` now has ``pop()`` and ``setdefault`` methods.
 - Turn on autoescape for ``flask.templating.render_template_string`` by default
   (pull request ``#1515``).
+- ``flask.ext`` is now deprecated (pull request ``#1484``).
+- ``send_from_directory`` now raises BadRequest if the filename is invalid on
+  the server OS (pull request ``#1763``).
+- Added the ``JSONIFY_MIMETYPE`` configuration variable (pull request ``#1728``).
+- Exceptions during teardown handling will no longer leave bad application
+  contexts lingering around.
 
 Version 0.10.2
 --------------
@@ -292,7 +390,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.

CONTRIBUTING.rst

@@ -10,7 +10,7 @@ Support questions
 Please, don't use the issue tracker for this. Check whether the ``#pocoo`` IRC
 channel on Freenode can help with your issue. If your problem is not strictly
 Werkzeug or Flask specific, ``#python`` is generally more active.
-`StackOverflow <https://stackoverflow.com/>`_ is also worth considering.
+`Stack Overflow <https://stackoverflow.com/>`_ is also worth considering.
 
 Reporting issues
 ================
@@ -28,24 +28,24 @@ Submitting patches
   clearly under which circumstances the bug happens. Make sure the test fails
   without your patch.
 
-- Try to follow `PEP8 <http://legacy.python.org/dev/peps/pep-0008/>`_, but you
+- Try to follow `PEP8 <https://www.python.org/dev/peps/pep-0008/>`_, but you
   may ignore the line-length-limit if following it would make the code uglier.
 
 
 Running the testsuite
 ---------------------
 
 You probably want to set up a `virtualenv
-<http://virtualenv.readthedocs.org/en/latest/index.html>`_.
+<https://virtualenv.readthedocs.io/en/latest/index.html>`_.
 
-The minimal requirement for running the testsuite is ``py.test``.  You can
+The minimal requirement for running the testsuite is ``pytest``.  You can
 install it with::
 
     pip install pytest
 
 Clone this repository::
 
-    git clone https://github.com/mitsuhiko/flask.git
+    git clone https://github.com/pallets/flask.git
 
 Install Flask as an editable package using the current source::
 
@@ -54,19 +54,61 @@ Install Flask as an editable package using the current source::
 
 Then you can run the testsuite with::
 
-    py.test
+    pytest
 
-With only py.test installed, a large part of the testsuite will get skipped
+With only pytest installed, a large part of the testsuite will get skipped
 though.  Whether this is relevant depends on which part of Flask you're working
 on.  Travis is set up to run the full testsuite when you submit your pull
 request anyways.
 
 If you really want to test everything, you will have to install ``tox`` instead
-of ``pytest``. Currently we're depending on a development version of Tox
-because the released version is missing features we absolutely need. You can
-install it with::
+of ``pytest``. You can install it with::
 
-    pip install hg+https://bitbucket.org/hpk42/tox
+    pip install tox
 
 The ``tox`` command will then run all tests against multiple combinations
 Python versions and dependency versions.
+
+Running test coverage
+---------------------
+Generating a report of lines that do not have unit test coverage can indicate where
+to start contributing.  ``pytest`` integrates with ``coverage.py``, using the ``pytest-cov``
+plugin.  This assumes you have already run the testsuite (see previous section)::
+
+    pip install pytest-cov
+
+After this has been installed, you can output a report to the command line using this command::
+
+    pytest --cov=flask tests/
+
+Generate a HTML report can be done using this command::
+
+    pytest --cov-report html --cov=flask tests/
+
+Full docs on ``coverage.py`` are here: https://coverage.readthedocs.io
+
+Caution
+=======
+pushing
+-------
+This repository contains several zero-padded file modes that may cause issues when pushing this repository to git hosts other than github. Fixing this is destructive to the commit history, so we suggest ignoring these warnings. If it fails to push and you're using a self-hosted git service like Gitlab, you can turn off repository checks in the admin panel.
+
+
+cloning
+-------
+The zero-padded file modes files above can cause issues while cloning, too. If you have
+
+::
+
+    [fetch]
+    fsckobjects = true
+
+or
+
+::
+
+    [receive]
+    fsckObjects = true
+
+
+set in your git configuration file, cloning this repository will fail. The only solution is to set both of the above settings to false while cloning, and then setting them back to true after the cloning is finished.

MANIFEST.in

@@ -1,13 +1,11 @@
 include Makefile CHANGES LICENSE AUTHORS
-recursive-include artwork *
-recursive-include tests *
-recursive-include examples *
-recursive-include docs *
-recursive-exclude docs *.pyc
-recursive-exclude docs *.pyo
-recursive-exclude tests *.pyc
-recursive-exclude tests *.pyo
-recursive-exclude examples *.pyc
-recursive-exclude examples *.pyo
+
+graft artwork
+graft tests
+graft examples
+graft docs
+
+global-exclude *.py[co]
+
 prune docs/_build
 prune docs/_themes

Makefile

@@ -3,10 +3,8 @@
 all: clean-pyc test
 
 test:
-	py.test tests examples
-
-tox-test:
-	tox
+	pip install -r test-requirements.txt
+	tox -e py-release
 
 audit:
 	python setup.py audit

README

@@ -33,9 +33,11 @@
 
       Good that you're asking.  The tests are in the
       tests/ folder.  To run the tests use the
-      `py.test` testing tool:
+      `pytest` testing tool:
 
-        $ py.test
+        $ pytest
+
+      Details on contributing can be found in CONTRIBUTING.rst
 
     ~ Where can I get help?
 

docs/_templates/sidebarintro.html

@@ -16,7 +16,7 @@ <h3>Other Formats</h3>
 <h3>Useful Links</h3>
 <ul>
   <li><a href="http://flask.pocoo.org/">The Flask Website</a></li>
-  <li><a href="http://pypi.python.org/pypi/Flask">Flask @ PyPI</a></li>
-  <li><a href="http://github.com/mitsuhiko/flask">Flask @ GitHub</a></li>
-  <li><a href="http://github.com/mitsuhiko/flask/issues">Issue Tracker</a></li>
+  <li><a href="https://pypi.python.org/pypi/Flask">Flask @ PyPI</a></li>
+  <li><a href="https://github.com/pallets/flask">Flask @ GitHub</a></li>
+  <li><a href="https://github.com/pallets/flask/issues">Issue Tracker</a></li>
 </ul>