Skip to content

trading_agent.requests.question_response

The user's answers to a desk's questions: checked against the options, and written up for the desk.

Typical usage example:

response = QuestionResponse(request, [{'selected': ['Wait'], 'other': ''}]) response.check() text = response.message()

QuestionResponse 

QuestionResponse(request, answers)

One answer per question: the options chosen, and any text typed under "Other".

Creates the response.

Parameters:

Name Type Description Default
request UserRequest

The question request.

 required
answers Sequence[dict[str, Any]]

One {"selected": [labels], "other": text} per question, in order.

 required
Source code in src/trading_agent/requests/question_response.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
def __init__(
    self,
    request: user_request_module.UserRequest,
    answers: Sequence[dict[str, Any]],
):
    """Creates the response.

    Args:
        request (user_request_module.UserRequest): The question request.
        answers (Sequence[dict[str, Any]]): One {"selected": [labels], "other": text} per question, in order.
    """
    self._request = request
    self._answers = list(answers)

check 

check()

Checks that each answer fits its question.

Raises:

Type Description
ValueError

The number of answers is wrong, an answer names an option the question does not have, a single-choice question has more or fewer than one answer, or a multiple-choice question has none.
Source code in src/trading_agent/requests/question_response.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
def check(self) -> None:
    """Checks that each answer fits its question.

    Raises:
        ValueError: The number of answers is wrong, an answer names an option the question does not have, a single-choice question has more or fewer than one answer, or a multiple-choice question has none.
    """
    questions = self._request.content['questions']
    if len(self._answers) != len(questions):
        raise ValueError(
            f'Expected {len(questions)} answers, got {len(self._answers)}'
        )
    for question, answer in zip(questions, self._answers):
        labels = []
        for option in question['options']:
            labels.append(option['label'])
        selected = list(answer.get('selected') or [])
        for label in selected:
            if label not in labels:
                raise ValueError(
                    f'{label!r} is not an option of {question["question"]!r}'
                )
        chosen = len(selected)
        if str(answer.get('other') or '').strip():
            chosen += 1
        if question.get('multi_select'):
            if chosen == 0:
                raise ValueError(
                    f'Choose at least one answer to {question["question"]!r}'
                )
        elif chosen != 1:
            raise ValueError(
                f'Choose exactly one answer to {question["question"]!r}'
            )

stored 

stored()

The response as saved with the request.

Returns:

Type Description
dict[str, Any]

The answers, cleaned.
Source code in src/trading_agent/requests/question_response.py 
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
def stored(self) -> dict[str, Any]:
    """The response as saved with the request.

    Returns:
        dict[str, Any]: The answers, cleaned.
    """
    answers = []
    for answer in self._answers:
        answers.append(
            {
                'selected': list(answer.get('selected') or []),
                'other': str(answer.get('other') or '').strip(),
            }
        )
    return {
        'answers': answers,
    }

message 

message()

The message the desk receives.

Returns:

Type Description
str

Each question with the user's answer.
Source code in src/trading_agent/requests/question_response.py 
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def message(self) -> str:
    """The message the desk receives.

    Returns:
        str: Each question with the user's answer.
    """
    questions = self._request.content['questions']
    lines = [
        f'The user answered your question{"s" if len(questions) > 1 else ""} (request {self._request.request_id}):',
    ]
    for index, question in enumerate(questions):
        answer = self.stored()['answers'][index]
        chosen = []
        for label in answer['selected']:
            chosen.append(f'"{label}"')
        if answer['other']:
            chosen.append(f'their own answer: "{answer["other"]}"')
        lines.append(f'{index + 1}. {question["question"]}')
        lines.append(f'   Answer: {", ".join(chosen)}')
    return '\n'.join(lines)