Метод get

Метод get применяется к объекту конфигурации app.config приложения Flask. Первым параметром передаётся ключ параметра конфигурации. Вторым необязательным параметром передаётся значение по умолчанию, которое будет возвращено, если такого ключа в конфигурации нет.

Если ключ присутствует в конфигурации, метод возвращает его значение. Если ключа нет и значение по умолчанию не передано, метод возвращает None. Метод не выбрасывает исключение при отсутствии ключа, что делает его удобным для безопасного чтения параметров.

Синтаксис

app.config.get(key, default)

Пример

Давайте прочитаем параметр SECRET_KEY, который установлен в конфигурации:

from flask import Flask

app = Flask(__name__)
app.config['SECRET_KEY'] = 'abcde'

res = app.config.get('SECRET_KEY')
print(res)

Результат выполнения кода:

"abcde"

Пример

Давайте попробуем прочитать ключ, которого нет в конфигурации. Без значения по умолчанию метод вернёт None:

from flask import Flask

app = Flask(__name__)

res = app.config.get('NOT_EXIST')
print(res)

Результат выполнения кода:

None

Пример

Давайте передадим значение по умолчанию вторым параметром, чтобы получить его вместо None:

from flask import Flask

app = Flask(__name__)

res = app.config.get('NOT_EXIST', 'default_value')
print(res)

Результат выполнения кода:

"default_value"

Пример

Давайте используем метод get внутри обработчика маршрута, чтобы прочитать параметр DEBUG и вернуть его в ответе:

from flask import Flask

app = Flask(__name__)
app.config['DEBUG'] = True

@app.route('/')
def index():
	debug = app.config.get('DEBUG', False)
	return str(debug)

Результат выполнения кода для адреса /:

True

Смотрите также

класс Config,
который хранит конфигурацию приложения
метод setdefault,
который устанавливает значение, если ключа нет
метод update,
который обновляет сразу несколько параметров
метод from_mapping,
который загружает конфигурацию из словаря