extensions/interactions/MusicNotesInput/MusicNotesInput.py - develop - githubmirror/oppia

extensions/interactions/MusicNotesInput/MusicNotesInput.py
79 строк2 KB
Gabriel Fuentes
Black formatter staging (#23456)
05 окт 2025, 06:15
05 окт 2025, 06:1562ec95a
# coding: utf-8
#
# Copyright 2014 The Oppia Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, softwar
# distributed under the License is distributed on an "AS-IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Python configuration for MusicNotesInput interaction."""

from __future__ import annotations

from extensions.interactions import base

from typing import List

MYPY = False
if MYPY:  # pragma: no cover
    from extensions import domain


class MusicNotesInput(base.BaseInteraction):
    """Interaction for music notes input."""

    name: str = 'Music Notes Input'
    description: str = (
        'Allows learners to drag and drop notes onto the lines of a music '
        'staff.'
    )
    display_mode: str = base.DISPLAY_MODE_SUPPLEMENTAL
    _dependency_ids: List[str] = ['midijs']
    answer_type: str = 'MusicPhrase'
    instructions: str = 'I18N_INTERACTIONS_MUSIC_INSTRUCTION'
    narrow_instructions: str = 'I18N_INTERACTIONS_MUSIC_NARROW_INSTRUCTION'
    needs_summary: bool = True
    can_have_solution: bool = True
    show_generic_submit_button: bool = True

    _customization_arg_specs: List[domain.CustomizationArgSpecsDict] = [
        {
            'name': 'sequenceToGuess',
            'description': 'Correct sequence of notes',
            'schema': {
                'type': 'custom',
                'obj_type': 'MusicPhrase',
            },
            'default_value': [],
        },
        {
            'name': 'initialSequence',
            'description': 'Starting notes on the staff',
            'schema': {
                'type': 'custom',
                'obj_type': 'MusicPhrase',
            },
            'default_value': [],
        },
    ]

    _answer_visualization_specs: List[base.AnswerVisualizationSpecsDict] = [
        {
            # Table with answer counts for top N answers.
            'id': 'FrequencyTable',
            'options': {
                'column_headers': ['Answer', 'Count'],
                'title': 'Top 10 answers',
            },
            'calculation_id': 'Top10AnswerFrequencies',
            'addressed_info_is_supported': True,
        }
    ]