Add HttpRequest subclass with htmx property type hint

[Tobi-De]

I added this for convenience, I don't know how others handle this, but I was tired of having to add # type: ignore every time I use request.htmx.

class HttpRequest(HttpRequestBase):
    htmx: HtmxDetails

[adamchainz]

django-stubs recommends creating a per-project request subclass with your custom User model: https://github.com/typeddjango/django-stubs#how-can-i-create-a-httprequest-thats-guaranteed-to-have-an-authenticated-user . I think this advice probably applies generally for anything your middleware adds to request.

I am hesitant to add a request subclass in the package. It saves one line in your custom request class, which is not a huge ask for projects that use typing. In my experience, there are many custom types needed to properly type a Django project, even with everything django-stubs gives us.

Perhaps we could make this a documentation-only change, showing how to define htmx on a custom request class on top of django-stubs’ recommendation?

[Tobi-De]

django-stubs recommends creating a per-project request subclass with your custom User model: typeddjango/django-stubs#how-can-i-create-a-httprequest-thats-guaranteed-to-have-an-authenticated-user . I think this advice probably applies generally for anything your middleware adds to request.

I am hesitant to add a request subclass in the package. It saves one line in your custom request class, which is not a huge ask for projects that use typing. In my experience, there are many custom types needed to properly type a Django project, even with everything django-stubs gives us.

Perhaps we could make this a documentation-only change, showing how to define htmx on a custom request class on top of django-stubs’ recommendation?

Okay, understood. I will remove the code and update the docs.
Just curious, are there any conventions on where to place the types? Perhaps in a module like types.py? If not, do you have any suggestions or recommendations?

[Tobi-De]

Considering the recommendations from django-stubs, here's what I believe is the optimal approach:

from django.http import HttpRequest as HttpRequestBase
from my_user_app.models import MyUser

class HttpRequest(HttpRequestBase):
    htmx: HtmxDetails

class AuthenticatedHttpRequest(HttpRequest):
    user: MyUser

Any thoughts on a more refined solution? Perhaps introducing a dedicated HtmxRequest class could be a cleaner option?