Как отобразить автоподсказки при типе typing.List[typing.Union] для любого элемента списка?

Question

[Финник Здоров]

Мне необходимо сделать так, чтобы при вводе точки, пайчарм предлагал мне методы не только связанные с dict, но и с str.
Например чтобы в подсказке были и join(), и items()

class A(BaseModel):
    items: List[dict] = Field(None)


class B(BaseModel):
    items: List[str] = Field(None)


class C(BaseModel):
    response: Union[A, B] = Field(None)


c = C(**{'response': {'items': [1, 2, 3]}})

Answer 1

[Сергей П]

Вы хотите странного.
А именно, по какой то причине хотите сделать заведомо небезопасный код, и при этом хотите, чтобы IDE вам в этом помогал. Это я к чему: кейс, который вы здесь привели, - это антипаттерн; было бы странно ожидать такую специфическую обработку этой ситуации от IDE.

В чем, собственно, проблема.
Метод, который вы вызываете у объекта, не должен зависеть от того, какие данные у вас на входе, иначе ваш код становится небезопасным и при жругом наборе данных возможна ошибка из-за отсутствия вызванного метода.

Такие вещи нужно в коде разбирать явно.
К примеру можно явно проверить переменную на принадлежность типу и IDE это учтёт делая подсказку:

resp = c.response
if isinstance(resp, A):
    resp.items[0].

Comments

[Финник Здоров]

Здравствуйте, большое спасибо за ответ.

Сейчас я пишу библиотеку для VK на python. И дело в том, что в зависимости от параметров определенных методов, функции API возвращают разные объекты.
Например, метод, возвращающий информацию о друзьях.

# Метод ниже возвращает объект с полями:
#     count - количество друзей
#     items - массив id друзей
api.friends.get() # no fields


# Метод ниже возвращает объект с полями:
#     count - количество друзей
#     items - массив объектов информации о друзей. Один такой объект содержит в себе поля:
#         id - id друга
#         firstname - имя друга


api.friends.get(fields = 'firstname') # fields

для разделения таких ответов, я пробовал использовать typing.overload декоратор. Но он не работает, если параметров в методе много и если нужно устанавливать дефолтное значение параметра.
Попытки на полупсевдокоде реализации:

from typing import overload

@overload
def friends.get(fields: None) -> FriendsGetResponseNoFields: ...
@overload
def friends.get(fields: str) -> FriendsGetResponseWithFields: ...
def friends.get(count: int = None, ......, frields:=None):
    pass

При попытке вызова friends.get и с параметром fields, и без него, pycharm выдавал один и тот же результат.

Есть ли у вас мысли, как можно было бы лучше организовать подсказки?

Буду признателен за ваш ответ.

[Сергей П]

Финник Здоров, вам не подсказки надо организховывать, а код нормально писать.
Мало ли что и в каком виде отдаёт API. Вам нужно сделать логичный и удобный биндинг этого API в ООП на питоне.
Плохая идея делать функцию, которая в зависимости от аргументов возвращает данные в разных структурах. Это следует оформлять в виде отдельных методов.

Если кто-то и принял решение под одно имя в Web API поместить две такие различные функции, то вас так грешить никто не заставляет. Делайте отдельные функции.

Исходя из вашей спецификации у вас и там и там список под именем items, а вовсе никакой не словарь. Это значит, что словарь-обёртка вам не нужна, поскольку count можно вычилить в питоне так: len(items), причем за O(1). В этой обёртке может еще помещаться сообщение об ошибке, к примеру, об ошибке доступа, тогда тоже ник чему её выдавать в результате, нужно бросать исключение.
Выходит ваша функция будет специфицироваться либо так:

get_friends(**kw): List[Union[str, Dict[str, str]]]

Либо лучше делайте отдельные функции для этого и не стесняйтесь их назвать понятно.