Как описать Generic класс?

Question

[Ilya Chichak]

есть базовый класс:

PayloadT = TypeVar('PayloadT', bound=Payload)
ParamsT = TypeVar('ParamsT', bound=Params)

class BaseService(Generic[PayloadT, ParamsT]):
    payload_class: Optional[Type[PayloadT]] = None
    params_class: Optional[Type[ParamsT]] = None

    def __init__(self, payload: Optional[PayloadT] = None, params: Optional[ParamsT] = None) -> None:
        self.payload = payload
        self.params = params

    def do_something(self) -> None:
        raise NotImplementedError()

и есть несколько его наследников:

class ServicePayload(Payload):
    some_string: str

class ServiceParams(Params):
    some_int: int

class Service1(BaseService[ServicePayload, None]):
    payload_class: Type[ServicePayload] = ServicePayload

    def do_something(self) -> None:
        print(self.payload.some_string)  # например

class Service2(BaseService[None, ServiceParams]):
    params_class: Type[ServiceParams] = ServiceParams

    def do_something(self) -> None:
        print(self.params.some_int)  # например

class Service3(BaseService[ServicePayload, ServiceParams]):
    payload_class: Type[ServicePayload] = ServicePayload
    params_class: Type[ServiceParams] = ServiceParams

    def do_something(self) -> None:
        print(self.payload.some_string)  # например
        print(self.params.some_int)  # например

при описании методов в классах наследниках, mypy выдает ошибку на строках, где я пытаюсь что-то сделать с атрибутами ServicePayload и ServiceParams:

...error: Item "None" of "Optional[Any]" has no attribute "some_string"
...error: Item "None" of "Optional[Any]" has no attribute "some_int"

Как описать type hints для подобной ситуации?

подразумевается, что BaseService не будет использоваться напрямую, только через наследников

Comments

[Алан Гибизов]

А что означают «квадратные скобки» в такой записи:
class Service1(BaseService[ServicePayload, None]):
Просто никогда не сталкивался с такой записью, опыт небольшой, поэтому любопытствую.

Также и в следующей строке:

payload_class: Type[ServicePayload] = ServicePayload

- квадратные скобки в отношении класса Type что делают?

Можно в документацию послать...

[Ilya Chichak]

Алан Гибизов, при аннотации типов используется такая нотация
можно почитать тут: https://docs.python.org/3/library/typing.html

payload_class: Type[ServicePayload] = ServicePayload

означает, что описываемая переменная будет с типом "класс ServicePayload".
если бы было
payload_class: ServicePayload = ServicePayload()
ожидалось бы, что в переменную должен быть помещен экземпляр класса

так же, как и с другими подобными описаниями:
items: List[str]
будет ожидать, что в переменной будет список строк

или
items: List[Union[str, int]]
список строк или чисел (принимается вариант ['a', 1, 'b', 42], но будет ошибка, если будет передано ['a', 3.14])

TypeVar используется, чтобы создавать свои "кастомные" типы и использовать их, например в следующем виде:

T = TypeVar('T')

def enum(iterable: Iterable[T]) -> Tuple[int, T]:
    ...

то есть, если передать в данную функцию итерируемый объект с объектами типа str, вернется (int, str), а если передать итерируемый объект с объектами int - вернется (int, int)

Answer 1

[Ilya Chichak]

эксперименты показали, что, как вариант, наследников можно описывать так:

class Service1(BaseService[ServicePayload, None]):
    payload_class = ServicePayload
    payload: ServicePayload

    def do_something(self) -> None:
        print(self.payload.some_string)  # например

class Service2(BaseService[None, ServiceParams]):
    params_class = ServiceParams
    params: ServiceParams

    def do_something(self) -> None:
        print(self.params.some_int)  # например

class Service3(BaseService[ServicePayload, ServiceParams]):
    payload_class = ServicePayload
    payload: ServicePayload
    params_class = ServiceParams
    params: ServiceParams

    def do_something(self) -> None:
        print(self.payload.some_string)  # например
        print(self.params.some_int)  # например

но, возможно, есть более "правильный" это сделать?