Skip to content

plugin point for ClassDef #18729

Open
Open
@asottile-sentry

Description

@asottile-sentry

Feature

there are various plugin points for ClassDef (either by base class, metaclass, decorators, etc.)

these are useful when one of those are present but it can be difficult to adjust a class's definition otherwise

I would like a plugin hook similar to the existing ones but called based on the fullname of the class itself independent of whether it has a base class / decorator / metaclass etc. to dynamically adjust the class members

Pitch

admittedly the plugin that I'm working on is currently a bit of a hack -- I'm utilizing a mypy plugin to teach it about particular django plugin added attributes to its classes. currently I'm working around this limitation by using a baseclass hook and then searching around for the actual class I care about -- https://github.com/getsentry/sentry/blob/ea729dd46ecdbe030477b6759b00dca6e424ca63/tools/mypy_helpers/plugin.py#L159-L166

it would be nice if I could do something like:

    def get_class_def_hook(self, fullname: str) -> Callable[[ClassDefContext], None] | None:
        if fullname == 'django.http.HttpRequest':
            return _adjust_http_request_members
       elif fullname == 'rest_framework.request.Request':
            return _adjust_request_members
       else:
            return None

the reason I'm raising this now rather than when I wrote that plugin a while ago is I haven't found an appropriate way to adjust a class when it doesn't have a base class, metaclass, or decorator (such as django.http.HttpResponseBase) and I'm currently hooking into a subclass of that and then adjusting the base class but it makes me nervous that this breaks the cache somehow

getsentry/sentry@fdb6490

Metadata

Metadata

Assignees

No one assigned

    Labels

    featuretopic-pluginsThe plugin API and ideas for new plugins

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions