Hey, For now the signature of the "get_context_data" method is the f

Component.get_context_data : add *args and **kwargs to match the signature when overridden about django-components HOT 3 CLOSED

emilstenstrom commented on May 29, 2024

Component.get_context_data : add *args and **kwargs to match the signature when overridden

from django-components.

Comments (3)

EmilStenstrom commented on May 29, 2024

Could you say a bit more about why your want that?

from django-components.

aymericderbois commented on May 29, 2024

Yes, indeed I should have given a more complete explanation on this request.

If I take the example of the "calendar" component from the documentation :

@component.register("calendar")
class Calendar(component.Component):
    # Templates inside `[your apps]/components` dir and `[project root]/components` dir will be automatically found. To customize which template to use based on context
    # you can override def get_template_name() instead of specifying the below variable.
    template_name = "calendar/calendar.html"

    # This component takes one parameter, a date string to show in the template
    def get_context_data(self, date):
        return {
            "date": date,
        }

    class Media:
        css = "calendar/calendar.css"
        js = "calendar/calendar.js"

Pycharm will display the following warning: "method signature does not match signature of overridden method"
Pylint will display the following warning: https://pylint.pycqa.org/en/latest/user_guide/messages/warning/arguments-differ.html

And in a slightly different example, if I set the type of the date parameter like this :

@component.register("calendar")
class Calendar(component.Component):
    # Templates inside `[your apps]/components` dir and `[project root]/components` dir will be automatically found. To customize which template to use based on context
    # you can override def get_template_name() instead of specifying the below variable.
    template_name = "calendar/calendar.html"

    # This component takes one parameter, a date string to show in the template
    def get_context_data(self, date: str):
        return {
            "date": date,
        }

    class Media:
        css = "calendar/calendar.css"
        js = "calendar/calendar.js"

Then mypy will raise the following error:

myapp/components/calendar/calendar.py:8: error: Signature of "get_context_data" incompatible with supertype "Component"
myapp/components/calendar/calendar.py:8: note:      Superclass:
myapp/components/calendar/calendar.py:8: note:          def get_context_data(self) -> Any
myapp/components/calendar/calendar.py:8: note:      Subclass:
myapp/components/calendar/calendar.py:8: note:          def get_context_data(self, date: str) -> Any

from django-components.

EmilStenstrom commented on May 29, 2024

Thank you for you explanation! I fixed this as part of the 0.23 release. Let me know how it works.

from django-components.

Recommend Projects