register_dataframe_accessor causes "Untyped class decorator obscures type of class; ignoring decorator"

davetapley commented 5 months ago

Describe the bug Example from the docs causes:

Untyped class decorator obscures type of class; ignoring decoratorPylance[reportUntypedClassDecorator](https://github.com/microsoft/pyright/blob/main/docs/configuration.md#reportUntypedClassDecorator)

in VSCode.

To Reproduce

In VSCode:

@pd.api.extensions.register_dataframe_accessor("geo")
class GeoAccessor:
    ...

Please complete the following information:

OS: Ubuntu
OS Version 20.04
python version 3.11
version of type checker pyright v1.1.354
version of installed pandas-stubs v2.2.1.240316

Additional context

This fixes it, PR welcome?

from typing import Callable, TypeVar

T = TypeVar('T')  # return type

def register_dataframe_accessor(name: str) -> Callable[[T], T]: ...

See also:

https://github.com/pandas-dev/pandas/issues/58244

twoertwein commented 5 months ago

This fixes it, PR welcome?

Yes - probably should use a more specific TypeVar, maybe DataFrameT = TypeVar("DataFrameT", bound=DataFrame).

twoertwein commented 5 months ago

I opened https://github.com/pandas-dev/pandas/pull/58339 for pandas. Feel free to open a similar PR here

pandas-dev / pandas-stubs

register_dataframe_accessor causes "Untyped class decorator obscures type of class; ignoring decorator" #906