playground
/
flask
mirror of https://github.com/mitsuhiko/flask.git
1
0
Fork 0
Code Issues Releases Activity
Browse Source

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
pull/2635/head
David Lord 7 years ago
parent
8cec2010c0
commit
82f0d120de
No known key found for this signature in database
GPG Key ID: 7A1C87E3F5BC42A8
4 changed files with 56 additions and 44 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 7
      CHANGES.rst
  2. 15
      docs/config.rst
  3. 50
      flask/app.py
  4. 28
      tests/test_basic.py

7
CHANGES.rst
Unescape View File

@ -139,8 +139,10 @@ unreleased
attribute on the session cookie. (`#2607`_) attribute on the session cookie. (`#2607`_)
- Added :meth:`~flask.Flask.test_cli_runner` to create a Click runner - Added :meth:`~flask.Flask.test_cli_runner` to create a Click runner
that can invoke Flask CLI commands for testing. (`#2636`_) that can invoke Flask CLI commands for testing. (`#2636`_)
- Subdomain matching is disabled by default now. It can be turned on by - Subdomain matching is disabled by default and setting
passing ``subdomain_matching=True`` to the Flask constructor. :data:`SERVER_NAME` does not implicily enable it. It can be enabled by
passing ``subdomain_matching=True`` to the ``Flask`` constructor.
(`#2635`_)
.. _pallets/meta#24: https://github.com/pallets/meta/issues/24 .. _pallets/meta#24: https://github.com/pallets/meta/issues/24
.. _#1421: https://github.com/pallets/flask/issues/1421 .. _#1421: https://github.com/pallets/flask/issues/1421
@ -183,6 +185,7 @@ unreleased
.. _#2606: https://github.com/pallets/flask/pull/2606 .. _#2606: https://github.com/pallets/flask/pull/2606
.. _#2607: https://github.com/pallets/flask/pull/2607 .. _#2607: https://github.com/pallets/flask/pull/2607
.. _#2636: https://github.com/pallets/flask/pull/2636 .. _#2636: https://github.com/pallets/flask/pull/2636
.. _#2635: https://github.com/pallets/flask/pull/2635
Version 0.12.2 Version 0.12.2

15
docs/config.rst
Unescape View File

@ -181,8 +181,8 @@ The following configuration values are used internally by Flask:
.. py:data:: SESSION_COOKIE_DOMAIN .. py:data:: SESSION_COOKIE_DOMAIN
The domain match rule that the session cookie will be valid for. If not The domain match rule that the session cookie will be valid for. If not
set, the cookie will be valid for all subdomains of ``SERVER_NAME``. If set, the cookie will be valid for all subdomains of :data:`SERVER_NAME`.
``False``, the cookie's domain will not be set. If ``False``, the cookie's domain will not be set.
Default: ``None`` Default: ``None``
@ -257,13 +257,14 @@ The following configuration values are used internally by Flask:
.. py:data:: SERVER_NAME .. py:data:: SERVER_NAME
Inform the application what host and port it is bound to. Required for Inform the application what host and port it is bound to. Required
subdomain route matching support. for subdomain route matching support.
If set, will be used for the session cookie domain if If set, will be used for the session cookie domain if
``SESSION_COOKIE_DOMAIN`` is not set. Modern web browsers will not allow :data:`SESSION_COOKIE_DOMAIN` is not set. Modern web browsers will
setting cookies for domains without a dot. To use a domain locally, not allow setting cookies for domains without a dot. To use a domain
add any names that should route to the app to your ``hosts`` file. :: locally, add any names that should route to the app to your
``hosts`` file. ::
127.0.0.1 localhost.dev 127.0.0.1 localhost.dev

50
flask/app.py
Unescape View File

@ -123,13 +123,13 @@ class Flask(_PackageBoundObject):
.. versionadded:: 0.11 .. versionadded:: 0.11
The `root_path` parameter was added. The `root_path` parameter was added.
.. versionadded:: 0.13 .. versionadded:: 1.0
The `host_matching` and `static_host` parameters were added. The ``host_matching`` and ``static_host`` parameters were added.
.. versionadded:: 1.0 .. versionadded:: 1.0
The `subdomain_matching` parameter was added. Subdomain matching The ``subdomain_matching`` parameter was added. Subdomain
needs to be enabled manually now. Setting `SERVER_NAME` does not matching needs to be enabled manually now. Setting
implicitly enable it. :data:`SERVER_NAME` does not implicitly enable it.
:param import_name: the name of the application package :param import_name: the name of the application package
:param static_url_path: can be used to specify a different path for the :param static_url_path: can be used to specify a different path for the
@ -138,11 +138,13 @@ class Flask(_PackageBoundObject):
:param static_folder: the folder with static files that should be served :param static_folder: the folder with static files that should be served
at `static_url_path`. Defaults to the ``'static'`` at `static_url_path`. Defaults to the ``'static'``
folder in the root path of the application. folder in the root path of the application.
:param host_matching: sets the app's ``url_map.host_matching`` to the given :param static_host: the host to use when adding the static route.
value. Defaults to False. Defaults to None. Required when using ``host_matching=True``
:param static_host: the host to use when adding the static route. Defaults with a ``static_folder`` configured.
to None. Required when using ``host_matching=True`` :param host_matching: set ``url_map.host_matching`` attribute.
with a ``static_folder`` configured. Defaults to False.
:param subdomain_matching: consider the subdomain relative to
:data:`SERVER_NAME` when matching routes. Defaults to False.
:param template_folder: the folder that contains the templates that should :param template_folder: the folder that contains the templates that should
be used by the application. Defaults to be used by the application. Defaults to
``'templates'`` folder in the root path of the ``'templates'`` folder in the root path of the
@ -1984,26 +1986,30 @@ class Flask(_PackageBoundObject):
return rv return rv
def create_url_adapter(self, request): def create_url_adapter(self, request):
"""Creates a URL adapter for the given request. The URL adapter """Creates a URL adapter for the given request. The URL adapter
is created at a point where the request context is not yet set up is created at a point where the request context is not yet set
so the request is passed explicitly. up so the request is passed explicitly.
.. versionadded:: 0.6 .. versionadded:: 0.6
.. versionchanged:: 0.9 .. versionchanged:: 0.9
This can now also be called without a request object when the This can now also be called without a request object when the
URL adapter is created for the application context. URL adapter is created for the application context.
.. versionchanged:: 1.0
:data:`SERVER_NAME` no longer implicitly enables subdomain
matching. Use :attr:`subdomain_matching` instead.
""" """
if request is not None: if request is not None:
rv = self.url_map.bind_to_environ(request.environ, # If subdomain matching is disabled (the default), use the
server_name=self.config['SERVER_NAME']) # default subdomain in all cases. This should be the default
# If subdomain matching is not enabled (which is the default # in Werkzeug but it currently does not have that feature.
# we put back the default subdomain in all cases. This really subdomain = ((self.url_map.default_subdomain or None)
# should be the default in Werkzeug but it currently does not if not self.subdomain_matching else None)
# have that feature. return self.url_map.bind_to_environ(
if not self.subdomain_matching: request.environ,
rv.subdomain = self.url_map.default_subdomain server_name=self.config['SERVER_NAME'],
return rv subdomain=subdomain)
# We need at the very least the server name to be set for this # We need at the very least the server name to be set for this
# to work. # to work.
if self.config['SERVER_NAME'] is not None: if self.config['SERVER_NAME'] is not None:

28
tests/test_basic.py
Unescape View File

@ -1831,21 +1831,23 @@ def test_subdomain_matching_with_ports():
assert rv.data == b'index for mitsuhiko' assert rv.data == b'index for mitsuhiko'
def test_subdomain_matching_behavior(): @pytest.mark.parametrize('matching', (False, True))
for matching in False, True: def test_subdomain_matching_other_name(matching):
app = flask.Flask(__name__, subdomain_matching=matching) app = flask.Flask(__name__, subdomain_matching=matching)
app.config['SERVER_NAME'] = 'localhost.localdomain:3000' app.config['SERVER_NAME'] = 'localhost.localdomain:3000'
client = app.test_client() client = app.test_client()
@app.route('/') @app.route('/')
def index(): def index():
return 'matched without subdomain' return '', 204
rv = client.get('/', 'http://127.0.0.1:3000/') # ip address can't match name
if matching: rv = client.get('/', 'http://127.0.0.1:3000/')
assert rv.status_code == 404 assert rv.status_code == 404 if matching else 204
else:
assert rv.data == b'matched without subdomain' # allow all subdomains if matching is disabled
rv = client.get('/', 'http://www.localhost.localdomain:3000/')
assert rv.status_code == 404 if matching else 204
def test_multi_route_rules(app, client): def test_multi_route_rules(app, client):

Write Preview
Loading…
Cancel
Save