mirror of https://github.com/pallets/flask.git
add text parameter to config.from_file
This commit is contained in:
parent
4c288bc97e
commit
b10b6d4af1
|
@ -33,6 +33,8 @@ Unreleased
|
||||||
- Use modern packaging metadata with ``pyproject.toml`` instead of ``setup.cfg``.
|
- Use modern packaging metadata with ``pyproject.toml`` instead of ``setup.cfg``.
|
||||||
:pr:`4947`
|
:pr:`4947`
|
||||||
- Ensure subdomains are applied with nested blueprints. :issue:`4834`
|
- Ensure subdomains are applied with nested blueprints. :issue:`4834`
|
||||||
|
- ``config.from_file`` can use ``text=False`` to indicate that the parser wants a
|
||||||
|
binary file instead. :issue:`4989`
|
||||||
|
|
||||||
|
|
||||||
Version 2.2.3
|
Version 2.2.3
|
||||||
|
|
|
@ -234,6 +234,7 @@ class Config(dict):
|
||||||
filename: str,
|
filename: str,
|
||||||
load: t.Callable[[t.IO[t.Any]], t.Mapping],
|
load: t.Callable[[t.IO[t.Any]], t.Mapping],
|
||||||
silent: bool = False,
|
silent: bool = False,
|
||||||
|
text: bool = True,
|
||||||
) -> bool:
|
) -> bool:
|
||||||
"""Update the values in the config from a file that is loaded
|
"""Update the values in the config from a file that is loaded
|
||||||
using the ``load`` parameter. The loaded data is passed to the
|
using the ``load`` parameter. The loaded data is passed to the
|
||||||
|
@ -244,8 +245,8 @@ class Config(dict):
|
||||||
import json
|
import json
|
||||||
app.config.from_file("config.json", load=json.load)
|
app.config.from_file("config.json", load=json.load)
|
||||||
|
|
||||||
import toml
|
import tomllib
|
||||||
app.config.from_file("config.toml", load=toml.load)
|
app.config.from_file("config.toml", load=tomllib.load, text=False)
|
||||||
|
|
||||||
:param filename: The path to the data file. This can be an
|
:param filename: The path to the data file. This can be an
|
||||||
absolute path or relative to the config root path.
|
absolute path or relative to the config root path.
|
||||||
|
@ -254,14 +255,18 @@ class Config(dict):
|
||||||
:type load: ``Callable[[Reader], Mapping]`` where ``Reader``
|
:type load: ``Callable[[Reader], Mapping]`` where ``Reader``
|
||||||
implements a ``read`` method.
|
implements a ``read`` method.
|
||||||
:param silent: Ignore the file if it doesn't exist.
|
:param silent: Ignore the file if it doesn't exist.
|
||||||
|
:param text: Open the file in text or binary mode.
|
||||||
:return: ``True`` if the file was loaded successfully.
|
:return: ``True`` if the file was loaded successfully.
|
||||||
|
|
||||||
|
.. versionchanged:: 2.3
|
||||||
|
The ``text`` parameter was added.
|
||||||
|
|
||||||
.. versionadded:: 2.0
|
.. versionadded:: 2.0
|
||||||
"""
|
"""
|
||||||
filename = os.path.join(self.root_path, filename)
|
filename = os.path.join(self.root_path, filename)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
with open(filename) as f:
|
with open(filename, "r" if text else "rb") as f:
|
||||||
obj = load(f)
|
obj = load(f)
|
||||||
except OSError as e:
|
except OSError as e:
|
||||||
if silent and e.errno in (errno.ENOENT, errno.EISDIR):
|
if silent and e.errno in (errno.ENOENT, errno.EISDIR):
|
||||||
|
|
|
@ -0,0 +1,2 @@
|
||||||
|
TEST_KEY="foo"
|
||||||
|
SECRET_KEY="config"
|
|
@ -6,7 +6,6 @@ import pytest
|
||||||
|
|
||||||
import flask
|
import flask
|
||||||
|
|
||||||
|
|
||||||
# config keys used for the TestConfig
|
# config keys used for the TestConfig
|
||||||
TEST_KEY = "foo"
|
TEST_KEY = "foo"
|
||||||
SECRET_KEY = "config"
|
SECRET_KEY = "config"
|
||||||
|
@ -30,13 +29,23 @@ def test_config_from_object():
|
||||||
common_object_test(app)
|
common_object_test(app)
|
||||||
|
|
||||||
|
|
||||||
def test_config_from_file():
|
def test_config_from_file_json():
|
||||||
app = flask.Flask(__name__)
|
app = flask.Flask(__name__)
|
||||||
current_dir = os.path.dirname(os.path.abspath(__file__))
|
current_dir = os.path.dirname(os.path.abspath(__file__))
|
||||||
app.config.from_file(os.path.join(current_dir, "static", "config.json"), json.load)
|
app.config.from_file(os.path.join(current_dir, "static", "config.json"), json.load)
|
||||||
common_object_test(app)
|
common_object_test(app)
|
||||||
|
|
||||||
|
|
||||||
|
def test_config_from_file_toml():
|
||||||
|
tomllib = pytest.importorskip("tomllib", reason="tomllib added in 3.11")
|
||||||
|
app = flask.Flask(__name__)
|
||||||
|
current_dir = os.path.dirname(os.path.abspath(__file__))
|
||||||
|
app.config.from_file(
|
||||||
|
os.path.join(current_dir, "static", "config.toml"), tomllib.load, text=False
|
||||||
|
)
|
||||||
|
common_object_test(app)
|
||||||
|
|
||||||
|
|
||||||
def test_from_prefixed_env(monkeypatch):
|
def test_from_prefixed_env(monkeypatch):
|
||||||
monkeypatch.setenv("FLASK_STRING", "value")
|
monkeypatch.setenv("FLASK_STRING", "value")
|
||||||
monkeypatch.setenv("FLASK_BOOL", "true")
|
monkeypatch.setenv("FLASK_BOOL", "true")
|
||||||
|
|
Loading…
Reference in New Issue