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

extensions/interactions/TextInput/TextInput.py
109 строк4 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 TextInput interaction."""

from __future__ import annotations

from extensions.interactions import base

from typing import List, Optional

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


class TextInput(base.BaseInteraction):
    """Interaction for entering text strings."""

    name: str = 'Text Input'
    description: str = 'Allows learners to enter arbitrary text strings.'
    display_mode: str = base.DISPLAY_MODE_INLINE
    is_trainable: bool = True
    _dependency_ids: List[str] = []
    answer_type: str = 'NormalizedString'
    instructions: Optional[str] = None
    narrow_instructions: Optional[str] = None
    needs_summary: bool = False
    can_have_solution: bool = True
    show_generic_submit_button: bool = True

    # NB: There used to be an integer-typed parameter here called 'columns'
    # that was removed in revision 628942010573. Some text interactions in
    # older explorations may have this customization parameter still set
    # in the exploration definition, so, in order to minimize the possibility
    # of collisions, do not add a new parameter with this name to this list.
    # TODO(#20445): Migrate old definitions which still contain the 'columns'
    # parameter.
    _customization_arg_specs: List[domain.CustomizationArgSpecsDict] = [
        {
            'name': 'placeholder',
            'description': 'Placeholder text (optional)',
            'schema': {'type': 'custom', 'obj_type': 'SubtitledUnicode'},
            'default_value': {'content_id': None, 'unicode_str': ''},
        },
        {
            'name': 'rows',
            'description': 'Height (in rows)',
            'schema': {
                'type': 'int',
                'validators': [
                    {
                        'id': 'is_at_least',
                        'min_value': 1,
                    },
                    {
                        'id': 'is_at_most',
                        'max_value': 10,
                    },
                ],
            },
            'default_value': 1,
        },
        {
            'name': 'catchMisspellings',
            'description': (
                'Catch Misspellings (Detect if answer is misspelled'
                ' and nudge the learner to correct the misspelling)'
            ),
            'schema': {'type': 'bool'},
            'default_value': False,
        },
    ]

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