Improve typing & test approach for widgets

[neiljp]

Following up on earlier work on polls and todo widget handling in messages, this could involve:

• Use TypedDict (or dataclass) for the result of process_todo_widget (and for polls) instead of a nested dict with a union.
• Consider if the extracted JSON should match specific types, that we can define using TypedDict or similar too.
• Consider factory fixtures for the Submessage content in tests.
• Move Submessage into api_types.py, and use it to improve the definition of Message.

See # zulip-terminal > Widget followup work for the original listing of these points and for followup discussion. These points arose in earlier work on widget implementation, so you might read those PRs to understand the background further.

[zulipbot]

Hello @zulip/server-refactoring members, this issue was labeled with the "area: refactoring" label, so you may want to check it out!

[ellikamishra]

I would like to work on this issue.

[apoorvapendse]

Hey @ellikamishra, you can claim the issue using @zulipbot claim
Checkout this section of the contributing guide for more info.

[ellikamishra]

@zulipbot claim

[zulipbot]

Welcome to Zulip, @ellikamishra! We just sent you an invite to collaborate on this repository at https://github.com/zulip/zulip-terminal/invitations. Please accept this invite in order to claim this issue and begin a fun, rewarding experience contributing to Zulip!

Here's some tips to get you off to a good start:

• Join me on the Zulip developers' server, to get help, chat about this issue, and meet the other developers.
• Unwatch this repository, so that you don't get 100 emails a day.

As you work on this issue, you'll also want to refer to the Zulip code contribution guide, as well as the rest of the developer documentation on that site.

See you on the other side (that is, the pull request side)!

[Gopinath-Mahendiran]

@ellikamishra are you working on this ?

[ellikamishra]

@ellikamishra are you working on this ?

Yes