Функции обратного вызова в Dash

Dash позволяет разработчикам использовать Python для создания динамичных, отзывчивых пользовательских интерфейсов.

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

Функции обратного вызова — это основной механизм в Dash для обработки пользовательских взаимодействий. Они позволяют динамически обновлять макет или данные приложения, когда пользователь взаимодействует с приложением. Проще говоря, функция обратного вызова — это функция Python, которая запускается при изменении определённых входных данных и обновляет выходные данные на основе изменений этих входных данных.

Типичная функция обратного вызова в Dash состоит из следующих частей:

  1. Input: Указывает, изменения каких свойств компонента будут запускать функцию обратного вызова.
  2. Output: Указывает, какие свойства компонента будут обновлены после выполнения функции обратного вызова.
  3. State: Необязательный параметр, используется для передачи данных, которые не запускают обратный вызов, но должны использоваться внутри обратного вызова.
  4. Тело функции обратного вызова: Содержит фактический код логики, используемый для обработки входных данных и генерации выходных данных.

Базовая структура функций обратного вызова

@app.callback(
    Output(component_id='output-component', component_property='output-property'),
    Input(component_id='input-component', component_property='input-property')
)
def update_output(input_value):
    # 根据输入值计算输出值
    return output_value
  1. Output:

    • Указывает целевой объект вывода функции обратного вызова.

    • component_id: ID целевого компонента.

    • component_property: Свойство целевого компонента (например,children、valueи т.д.).

  2. Input:

    • Указывает источник входных данных функции обратного вызова.

    • component_id: ID входного компонента.

    • component_property: Свойство входного компонента (например,value、n_clicksи т.д.).

  3. функция обратного вызова:

    • Получает входные значения, вычисляет и возвращает выходные значения.

    • Имя функции можно настроить (например,update_output)。

Пример

В следующем примере показано, как динамически обновлять текстовое содержимое на основе значения поля ввода:

Пример

from dash import Dash, html, dcc, Ввод, Вывод

# Создать приложение Dash
app = Dash(__name__)

# Определить макет
app.layout = html.Div([
    dcc.Input(id='input', type='text', placeholder='Пожалуйста, введите содержимое...'),
    html.Div(id='output')
])

# Определить функцию обратного вызова
@app.callback(
    Output('output', 'children'),
    Input('input', 'value')
)
def update_output(input_value):
    return f'Вы ввели: {input_value}'

# Запустить приложение
if __name__ == '__main__':
    app.run_server(debug=True)

В следующем примере показано, как динамически обновлять график на основе выбора в выпадающем меню:

Пример

from dash import Dash, html, dcc, Ввод, Вывод
import plotly.express as px
import pandas as pd

# Создать приложение Dash
app = Dash(__name__)

# Пример данных
df = pd.DataFrame({
    'city': ['Пекин', 'Шанхай', 'Гуанчжоу', 'Shenzhen'],
    'Population': [2171, 2424, 1490, 1303]
})

# Определить макет
app.layout = html.Div([
    dcc.Dropdown(
        id='dropdown',
        options=[{'label': city, 'value': city} for city in df['city']],
        value='Beijing'  # Значение по умолчанию
    ),
    dcc.Graph(id='graph')
])

# Определить функцию обратного вызова
@app.callback(
    Output('graph', 'figure'),
    Input('dropdown', 'value')
)
def update_graph(selected_city):
    filtered_df = df[df['city'] == selected_city]
    fig = px.bar(filtered_df, x='city', y='Population', title=f'{selected_city} данные о населении')
    return fig

# Запустить приложение
if __name__ == '__main__':
    app.run_server(debug=True)

После выполнения приведённого выше кода, когда вы выбираете город в раскрывающемся меню, диаграмма динамически обновляется, чтобы отобразить данные о населении для этого города.

В следующем примере после того, как пользователь вводит число, отображается квадрат этого числа:

Пример

from dash import Dash, html, dcc, Ввод, Вывод

# Создать приложение Dash
app = Dash(__name__)

# Определить макет
app.layout = html.Div([
    html.H1("Вычислить квадрат"),  # Заголовок
    dcc.Input(
        id='number-input',  # Идентификатор поля ввода
        type='number',  # Тип ввода — число
        placeholder='Пожалуйста, введите число...',  # Текст подсказки поля ввода
        value=''  # Начальное значение пусто
    ),
    html.Div(id='output')  # Div для отображения результатов
])

# Определить функцию обратного вызова
@app.callback(
    Output('output', 'children'),  # Вывод в свойство children компонента Div с id 'output'
    Input('number-input', 'value')  # ввод берётся из атрибута value элемента input с id 'number-input'
)
def calculate_square(number):
    if number is None or number == '':  # Если ввод пуст
        return 'Пожалуйста, введите число.'
    try:
        number = float(number)  # Преобразовать ввод в число с плавающей точкой
        square = number ** 2  # Вычислить квадрат
        return f'Квадрат числа {number} равен: {square}'  # Вернуть результат
    except ValueError:  # Если ввод не является числом
        return 'Пожалуйста, введите корректное число.'

# Запустить приложение
if __name__ == '__main__':
    app.run_server(debug=True)  # Запускает приложение, debug=True включает режим отладки

Пояснение к коду:

1. Раздел макета:

  • Использованиеhtml.H1Создайте заголовок "Вычислить квадрат".

  • Использованиеdcc.InputСоздайте поле для ввода числа,idявляетсяnumber-input, тип —number。

  • Использованиеhtml.DivСоздайте область для отображения результатов,idявляетсяoutput。

2. Функция обратного вызова:

  • Использование@app.callbackДекоратор определяет функцию обратного вызова.

  • входные данные —number-inputполя вводаvalueСвойство.

  • выходные данные —outputDivchildrenСвойство.

  • В функции обратного вызова:

    • Проверьте, пусты ли входные данные.

    • Преобразуйте входные данные в float и вычислите квадрат.

    • Верните отформатированный результат.

3. Запустите приложение: Используйтеapp.run_server(debug=True)Запустите приложение,debug=TrueУказывает, что включён режим отладки. Результат выполнения отображается следующим образом:


Как работают функции обратного вызова

1. Привязка входов и выходов

В Dash входы и выходы функции обратного вызова задаются черезInputиOutputЗадаются объектом.InputОбъект указывает, какие изменения свойств компонента будут запускать функцию обратного вызова, в то время какOutputОбъект указывает, какие свойства каких компонентов будут обновлены после выполнения функции обратного вызова.

2. Запуск функций обратного вызова

Когда пользователь выполняет действие в интерфейсе (например, вводит текст, нажимает кнопку и т. д.), соответствующие свойства компонента изменяются. Dash обнаруживает эти изменения и автоматически вызывает привязанную к ним функцию обратного вызова.

3. Выполнение функций обратного вызова

Когда выполняется функция обратного вызова, Dash передаёт текущие значения входных свойств в качестве параметров в функцию обратного вызова. Функция обратного вызова выполняет вычисления или обработку на основе этих входных значений и возвращает новые значения для выходных свойств. Dash автоматически обновляет возвращённые значения в указанных свойствах компонента.


Расширенное использование функций обратного вызова

1. Несколько входов и выходов

Функция обратного вызова может иметь несколько входов и выходов. Например:

Пример

@app.callback(
    [Output('output-div-1', 'children'),
     Output('output-div-2', 'children')],
    [Input('input-1', 'value'),
     Input('input-2', 'value')]
)
def update_outputs(input1, input2):
    return f'Input 1: {input1}', f'Input 2: {input2}'

В этом примере функция обратного вызоваupdate_outputsимеет два входа и два выхода. Когдаinput-1илиinput-2значение ... изменяется, функция обратного вызова срабатывает, и она обновляет ... двух выходных компонентов.childrenСвойство.

2. Использование State

Иногда вам может понадобиться использовать данные в обратном вызове, которые не запускают обратный вызов. В этом случае вы можете использоватьStateОбъект.Stateобъект иInputПохож на объект, но не вызывает функцию обратного вызова.

Пример

@app.callback(
    Output('output-div', 'children'),
    [Input('submit-button', 'n_clicks')],
    [State('input-text', 'value')]
)
def update_output(n_clicks, input_value):
    if n_clicks is None:
        return 'No clicks yet'
    return f'Button clicked {n_clicks} times. Input: {input_value}'

В этом примере,n_clicks— это входные данные, которые запускают callback, тогда какinput_valueЭто состояние, используемое в callback-функции. Callback-функция будет вызвана только при нажатии кнопки, но текущее значение поля ввода можно использовать внутри callback.

3. Предотвращение дублирующего выполнения callback-функций

В некоторых случаях callback-функции могут вызываться часто, что приводит к проблемам производительности. Чтобы избежать этого, можно использоватьdash.no_updateчтобы предотвратить ненужные обновления.

Пример

@app.callback(
    Output('output-div', 'children'),
    [Input('input-text', 'value')]
)
def update_output(input_value):
    if not input_value:
        return dash.no_update
    return f'You have entered: {input_value}'

В этом примере, если значение поля ввода пусто, callback-функция не будет обновлять выходной компонент.


Распространённые проблемы и решения

1. Callback-функция не срабатывает

Если функция обратного вызова не срабатывает, как ожидалось, это может быть вызвано одной из следующих причин:

  • Несоответствие ID входных или выходных данных: убедитесьInputиOutputID компонентов в ... соответствуют ID в макете.
  • Ошибка имени атрибута: убедитесьInputиOutputУбедитесь, что имена свойств в ... указаны правильно.
  • Функция обратного вызова не зарегистрирована: Убедитесь, что функция обратного вызова правильно зарегистрирована в приложении.

2. Медленное выполнение функции обратного вызова

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

  • Снизьте вычислительную нагрузку функции обратного вызова: Старайтесь избегать выполнения сложных вычислений в функции обратного вызова.
  • Используйте кэш: Для повторяющихся результатов вычислений можно использовать кэширование, чтобы сократить время вычислений.
  • Асинхронный обратный вызов: Для длительных задач можно использовать асинхронные обратные вызовы, чтобы избежать блокировки основного потока.
Другие расширения