Generate mypy types

[jdahlin]

It would be nice to have the option to generate mypy types in addition to TypeScript definitions.

The use case would allow you to pass around typed dictionaries in Python code that is either passed into or returned from a DRF Serializer.

[adenh93]

Hi @jdahlin,

Sounds interesting, what would be an example of the input and generated output?

Thank you 👍

[jdahlin]

Something like this, completely untested but to give you an idea.

Input:

class QueueTextGenerationItem(serializers.DictField):
    channel_id = serializers.IntegerField()
    language_code = serializers.CharField()
    product_id = serializers.CharField()
    force_regenerate = serializers.BooleanField(required=False)

class QueueTextGenerationRequest(serializers.Serializer):
    generation_requests = serializers.ListField(child=QueueTextGenerationItem())
    text_status = serializers.CharField()

Output:

from typing import List
from typing_extensions import TypedDict

class QueueTextGenerationItem(TypedDict):
    channel_id: int
    language_code: str
    channel_id: str
    force_regenerate: Optional[bool]

class QueueTextGenerationRequest(TypedDict):
    generation_requests: List[QueueTextGenerationItem]
    text_status: str

[adenh93]

Hi @jdahlin,

Looks simple enough actually, I'll try knock this one at lunch time today (it's ~8:40 AM here).

Thanks for the suggestion! 👍

[adenh93]

Hi @jdahlin,

I've determined that this might actually be difficult to implement without introducing breaking changes, so I'll do a bit more analysis.

Ideally, I'll add the ability to support a number of different generators (Typescript, MyPy, etc) based on an abstract class.

Keeping this issue open, since I intend to add this support 👍