Как правильно сделать подсказки для IDE?

Question

[KitCat12]

Есть такой кусок кода

async def SummonerByName(self, region, summonerName):

        response = await self.fetch(
            await self.summoner_v4.SummonerByName(
                region=region,
                summonerName=summonerName,
            )
        )

        class data:
            id = response['id']
            accountId = response['accountId']
            puuid = response['puuid']
            name = response['name']
            profileIconId = response['profileIconId']
            revisionDate = response['revisionDate']
            summonerLevel = response['summonerLevel']

        return data

Выполняется запрос к API и приходит ответ в формате json
Я хочу чтобы в среде выводились вот такие подсказки


Собственно говоря они и выводятся, но правильно ли я это делаю?

Answer 1

[Дмитрий]

1. Создаешь отдельно класс Data (невнутри функции)
2. Делаешь так, чтобы функция summoner_v4.SummonerByName возвращала экземпляр класса Data

Comments

[KitCat12]

Спасибо

Answer 2

[Влад Григорьев]

Модель правильнее держать вне функции, и создавать экземпляр класса
ещё лучше посмотреть в pydantic или dataclass_json, так как если появятся сложные вложенные типы, то ручками их разбирать то еще удовольствие

from dataclasses import dataclass


@dataclass
class Summoner:
    id: str = ''
    accountId: str = ''
    puuid: str = ''
    name: str = ''
    profileIconId: str = ''
    revisionDate: str = ''
    summonerLevel: str = ''


async def SummonerByName(self, region, summonerName):
    response = await self.fetch(
        await self.summoner_v4.SummonerByName(
            region=region,
            summonerName=summonerName,
        )
    )

    return Summoner(**response)

Comments

[KitCat12]

Спасибо