orbit-oss/flask
4
5
Fork 2
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs:added return type in from* methods

Browse source
This commit is contained in:
kcoder63 2021-06-05 08:25:50 +05:30
parent 6a4e7e948d
commit cec2f1c2eb
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/flask/config.py
View file

@ -107,7 +107,7 @@ class Config(dict):
root path. root path.
:param silent: set to ``True`` if you want silent failure for missing :param silent: set to ``True`` if you want silent failure for missing
files. files.
:return: bool.
.. versionadded:: 0.7 .. versionadded:: 0.7
`silent` parameter. `silent` parameter.
""" """
@ -185,6 +185,7 @@ 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.
:return: bool.
.. versionadded:: 2.0 .. versionadded:: 2.0
""" """
@ -209,7 +210,7 @@ class Config(dict):
:param filename: The path to the JSON file. This can be an :param filename: The path to the JSON file. This can be an
absolute path or relative to the config root path. absolute path or relative to the config root path.
:param silent: Ignore the file if it doesn't exist. :param silent: Ignore the file if it doesn't exist.
:return: bool.
.. deprecated:: 2.0.0 .. deprecated:: 2.0.0
Will be removed in Flask 2.1. Use :meth:`from_file` instead. Will be removed in Flask 2.1. Use :meth:`from_file` instead.
This was removed early in 2.0.0, was added back in 2.0.1. This was removed early in 2.0.0, was added back in 2.0.1.
@ -232,7 +233,7 @@ class Config(dict):
) -> bool: ) -> bool:
"""Updates the config like :meth:`update` ignoring items with non-upper """Updates the config like :meth:`update` ignoring items with non-upper
keys. keys.
:return: bool.
.. versionadded:: 0.11 .. versionadded:: 0.11
""" """
mappings: t.Dict[str, t.Any] = {} mappings: t.Dict[str, t.Any] = {}
@ -271,7 +272,6 @@ class Config(dict):
dictionary should be lowercase dictionary should be lowercase
:param trim_namespace: a flag indicating if the keys of the resulting :param trim_namespace: a flag indicating if the keys of the resulting
dictionary should not include the namespace dictionary should not include the namespace
.. versionadded:: 0.11 .. versionadded:: 0.11
""" """
rv = {} rv = {}