arrow-py / arrow

🏹 Better dates & times for Python
https://arrow.readthedocs.io
Apache License 2.0
8.63k stars 669 forks source link

Use `typing.Self` to support subclassing #1168

Open sebastianvitterso opened 6 months ago

sebastianvitterso commented 6 months ago

Feature Request

We've implemented our own subclass of the arrow.Arrow class, to directly support pydantic serialization. This helps us in our use case, but we're having some troubles with the typing system, as (virtually) every function in the arrow.Arrow class returns -> "Arrow", meaning we have to create a wrapper for every function we want to use in our subclass.

Example of -> "Arrow" in Arrow.now():

https://github.com/arrow-py/arrow/blob/87a1a774aad0505d9da18ad1d16f6e571f262503/arrow/arrow.py#L185-L214

By replacing these (where correct) -> "Arrow" instances with -> typing.Self, all subclasses will have their inherited functionality correctly typed automatically, instead of this having to be done via wrapper functions.


Caveats

I'm not sure there are many, but there is one:

Self wasn't introduced into the typing module until Python 3.11, meaning this might cause the support chart to look quite differently. It could, however, be possible to use typing_extensions.Self for backwards compatibility?