from typing import Dict, Optional, cast from django.http import HttpRequest from django.template import Context, RequestContext, Template from pytest_django.asserts import assertHTMLEqual, assertInHTML from django_components import Component, register, registry, types from django_components.util.misc import gen_id from django_components.testing import djc_test from .testutils import PARAMETRIZE_CONTEXT_BEHAVIOR, setup_test_config setup_test_config({"autodiscover": False}) # Context processor that generates a unique ID. This is used to test that the context # processor is generated only once, as each time this is called, it should generate a different ID. def dummy_context_processor(request): return {"dummy": gen_id()} ######################### # COMPONENTS ######################### def gen_simple_component(): class SimpleComponent(Component): template: types.django_html = """ Variable: {{ variable }} """ def get_template_data(self, args, kwargs, slots, context): return {"variable": kwargs.get("variable", None)} if "variable" in kwargs else {} return SimpleComponent def gen_variable_display_component(): class VariableDisplay(Component): template: types.django_html = """ {% load component_tags %}
value={{ value }};calls={{ calls }}
{% slot 'content' %}{% endslot %} """ def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) self.call_count = 0 def get_template_data(self, args, kwargs, slots, context): value = int(kwargs.get("value", 0)) if hasattr(self, "call_count"): self.call_count += 1 else: self.call_count = 1 return {"value": value + 1, "calls": self.call_count} return IncrementerComponent def gen_parent_component(): class ParentComponent(Component): template: types.django_html = """ {% load component_tags %}value=1;calls=1
', ) @djc_test(parametrize=PARAMETRIZE_CONTEXT_BEHAVIOR) def test_one_context_call_with_simple_component_and_arg(self, components_settings): registry.register(name="incrementer", component=gen_incrementer_component()) template_str: types.django_html = """ {% load component_tags %} {% component 'incrementer' value='2' %}{% endcomponent %} """ template = Template(template_str) rendered = template.render(Context()).strip() assertHTMLEqual( rendered, """value=3;calls=1
""", ) @djc_test(parametrize=PARAMETRIZE_CONTEXT_BEHAVIOR) def test_one_context_call_with_component(self, components_settings): registry.register(name="incrementer", component=gen_incrementer_component()) template_str: types.django_html = """ {% load component_tags %} {% component 'incrementer' %}{% endcomponent %} """ template = Template(template_str) rendered = template.render(Context()).strip() assertHTMLEqual(rendered, 'value=1;calls=1
') @djc_test(parametrize=PARAMETRIZE_CONTEXT_BEHAVIOR) def test_one_context_call_with_component_and_arg(self, components_settings): registry.register(name="incrementer", component=gen_incrementer_component()) template_str: types.django_html = """ {% load component_tags %} {% component 'incrementer' value='3' %}{% endcomponent %} """ template = Template(template_str) rendered = template.render(Context()).strip() assertHTMLEqual(rendered, 'value=4;calls=1
') @djc_test(parametrize=PARAMETRIZE_CONTEXT_BEHAVIOR) def test_one_context_call_with_slot(self, components_settings): registry.register(name="incrementer", component=gen_incrementer_component()) template_str: types.django_html = """ {% load component_tags %} {% component 'incrementer' %} {% fill 'content' %}slot
{% endfill %} {% endcomponent %} """ template = Template(template_str) rendered = template.render(Context()).strip() assertHTMLEqual( rendered, """value=1;calls=1
slot
""", rendered, ) @djc_test(parametrize=PARAMETRIZE_CONTEXT_BEHAVIOR) def test_one_context_call_with_slot_and_arg(self, components_settings): registry.register(name="incrementer", component=gen_incrementer_component()) template_str: types.django_html = """ {% load component_tags %} {% component 'incrementer' value='3' %} {% fill 'content' %}slot
{% endfill %} {% endcomponent %} """ template = Template(template_str) rendered = template.render(Context()).strip() assertHTMLEqual( rendered, """value=4;calls=1
slot
""", rendered, ) @djc_test class TestComponentsCanAccessOuterContext: @djc_test( parametrize=( ["components_settings", "expected_value"], [ [{"context_behavior": "django"}, "outer_value"], [{"context_behavior": "isolated"}, ""], ], ["django", "isolated"], ) ) def test_simple_component_can_use_outer_context(self, components_settings, expected_value): registry.register(name="simple_component", component=gen_simple_component()) template_str: types.django_html = """ {% load component_tags %} {% component 'simple_component' %}{% endcomponent %} """ template = Template(template_str) rendered = template.render(Context({"variable": "outer_value"})) assertHTMLEqual( rendered, f""" Variable: {expected_value} """, ) @djc_test class TestIsolatedContext: @djc_test(parametrize=PARAMETRIZE_CONTEXT_BEHAVIOR) def test_simple_component_can_pass_outer_context_in_args(self, components_settings): registry.register(name="simple_component", component=gen_simple_component()) template_str: types.django_html = """ {% load component_tags %} {% component 'simple_component' variable=variable only %}{% endcomponent %} """ template = Template(template_str) rendered = template.render(Context({"variable": "outer_value"})).strip() assert "outer_value" in rendered @djc_test(parametrize=PARAMETRIZE_CONTEXT_BEHAVIOR) def test_simple_component_cannot_use_outer_context(self, components_settings): registry.register(name="simple_component", component=gen_simple_component()) template_str: types.django_html = """ {% load component_tags %} {% component 'simple_component' only %}{% endcomponent %} """ template = Template(template_str) rendered = template.render(Context({"variable": "outer_value"})).strip() assert "outer_value" not in rendered @djc_test class TestIsolatedContextSetting: @djc_test(components_settings={"context_behavior": "isolated"}) def test_component_tag_includes_variable_with_isolated_context_from_settings( self, ): registry.register(name="simple_component", component=gen_simple_component()) template_str: types.django_html = """ {% load component_tags %} {% component 'simple_component' variable=variable %}{% endcomponent %} """ template = Template(template_str) rendered = template.render(Context({"variable": "outer_value"})) assert "outer_value" in rendered @djc_test(components_settings={"context_behavior": "isolated"}) def test_component_tag_excludes_variable_with_isolated_context_from_settings( self, ): registry.register(name="simple_component", component=gen_simple_component()) template_str: types.django_html = """ {% load component_tags %} {% component 'simple_component' %}{% endcomponent %} """ template = Template(template_str) rendered = template.render(Context({"variable": "outer_value"})) assert "outer_value" not in rendered @djc_test(components_settings={"context_behavior": "isolated"}) def test_component_includes_variable_with_isolated_context_from_settings( self, ): registry.register(name="simple_component", component=gen_simple_component()) template_str: types.django_html = """ {% load component_tags %} {% component 'simple_component' variable=variable %} {% endcomponent %} """ template = Template(template_str) rendered = template.render(Context({"variable": "outer_value"})) assert "outer_value" in rendered @djc_test(components_settings={"context_behavior": "isolated"}) def test_component_excludes_variable_with_isolated_context_from_settings( self, ): registry.register(name="simple_component", component=gen_simple_component()) template_str: types.django_html = """ {% load component_tags %} {% component 'simple_component' %} {% endcomponent %} """ template = Template(template_str) rendered = template.render(Context({"variable": "outer_value"})) assert "outer_value" not in rendered @djc_test class TestContextProcessors: @djc_test(parametrize=PARAMETRIZE_CONTEXT_BEHAVIOR) def test_request_context_in_template(self, components_settings): context_processors_data: Optional[Dict] = None inner_request: Optional[HttpRequest] = None @register("test") class TestComponent(Component): template: types.django_html = """{% csrf_token %}""" def get_template_data(self, args, kwargs, slots, context): nonlocal context_processors_data nonlocal inner_request context_processors_data = self.context_processors_data inner_request = self.request template_str: types.django_html = """ {% load component_tags %} {% component "test" %} {% endcomponent %} """ request = HttpRequest() request_context = RequestContext(request) template = Template(template_str) rendered = template.render(request_context) assert "csrfmiddlewaretoken" in rendered assert list(context_processors_data.keys()) == ["csrf_token"] # type: ignore[union-attr] assert inner_request == request @djc_test(parametrize=PARAMETRIZE_CONTEXT_BEHAVIOR) def test_request_context_in_template_nested(self, components_settings): context_processors_data = None context_processors_data_child = None parent_request: Optional[HttpRequest] = None child_request: Optional[HttpRequest] = None @register("test_parent") class TestParentComponent(Component): template: types.django_html = """ {% load component_tags %} {% component "test_child" / %} """ def get_template_data(self, args, kwargs, slots, context): nonlocal context_processors_data nonlocal parent_request context_processors_data = self.context_processors_data parent_request = self.request @register("test_child") class TestChildComponent(Component): template: types.django_html = """{% csrf_token %}""" def get_template_data(self, args, kwargs, slots, context): nonlocal context_processors_data_child nonlocal child_request context_processors_data_child = self.context_processors_data child_request = self.request template_str: types.django_html = """ {% load component_tags %} {% component "test_parent" / %} """ request = HttpRequest() request_context = RequestContext(request) template = Template(template_str) rendered = template.render(request_context) assert "csrfmiddlewaretoken" in rendered assert list(context_processors_data.keys()) == ["csrf_token"] # type: ignore[union-attr] assert list(context_processors_data_child.keys()) == ["csrf_token"] # type: ignore[union-attr] assert parent_request == request assert child_request == request @djc_test(parametrize=PARAMETRIZE_CONTEXT_BEHAVIOR) def test_request_context_in_template_slot(self, components_settings): context_processors_data = None context_processors_data_child = None parent_request: Optional[HttpRequest] = None child_request: Optional[HttpRequest] = None @register("test_parent") class TestParentComponent(Component): template: types.django_html = """ {% load component_tags %} {% slot "content" default / %} """ def get_template_data(self, args, kwargs, slots, context): nonlocal context_processors_data nonlocal parent_request context_processors_data = self.context_processors_data parent_request = self.request @register("test_child") class TestChildComponent(Component): template: types.django_html = """{% csrf_token %}""" def get_template_data(self, args, kwargs, slots, context): nonlocal context_processors_data_child nonlocal child_request context_processors_data_child = self.context_processors_data child_request = self.request template_str: types.django_html = """ {% load component_tags %} {% component "test_parent" %} {% component "test_child" / %} {% endcomponent %} """ request = HttpRequest() request_context = RequestContext(request) template = Template(template_str) rendered = template.render(request_context) assert "csrfmiddlewaretoken" in rendered assert list(context_processors_data.keys()) == ["csrf_token"] # type: ignore[union-attr] assert list(context_processors_data_child.keys()) == ["csrf_token"] # type: ignore[union-attr] assert parent_request == request assert child_request == request @djc_test(parametrize=PARAMETRIZE_CONTEXT_BEHAVIOR) def test_request_context_in_python(self, components_settings): context_processors_data = None inner_request: Optional[HttpRequest] = None @register("test") class TestComponent(Component): template: types.django_html = """{% csrf_token %}""" def get_template_data(self, args, kwargs, slots, context): nonlocal context_processors_data nonlocal inner_request context_processors_data = self.context_processors_data inner_request = self.request request = HttpRequest() request_context = RequestContext(request) rendered = TestComponent.render(context=request_context) assert "csrfmiddlewaretoken" in rendered assert list(context_processors_data.keys()) == ["csrf_token"] # type: ignore[union-attr] assert inner_request == request @djc_test(parametrize=PARAMETRIZE_CONTEXT_BEHAVIOR) def test_request_context_in_python_nested(self, components_settings): context_processors_data: Optional[Dict] = None context_processors_data_child: Optional[Dict] = None parent_request: Optional[HttpRequest] = None child_request: Optional[HttpRequest] = None @register("test_parent") class TestParentComponent(Component): template: types.django_html = """ {% load component_tags %} {% component "test_child" / %} """ def get_template_data(self, args, kwargs, slots, context): nonlocal context_processors_data nonlocal parent_request context_processors_data = self.context_processors_data parent_request = self.request @register("test_child") class TestChildComponent(Component): template: types.django_html = """{% csrf_token %}""" def get_template_data(self, args, kwargs, slots, context): nonlocal context_processors_data_child nonlocal child_request context_processors_data_child = self.context_processors_data child_request = self.request request = HttpRequest() request_context = RequestContext(request) rendered = TestParentComponent.render(request_context) assert "csrfmiddlewaretoken" in rendered assert list(context_processors_data.keys()) == ["csrf_token"] # type: ignore[union-attr] assert list(context_processors_data_child.keys()) == ["csrf_token"] # type: ignore[union-attr] assert parent_request == request assert child_request == request @djc_test(parametrize=PARAMETRIZE_CONTEXT_BEHAVIOR) def test_request_in_python(self, components_settings): context_processors_data: Optional[Dict] = None inner_request: Optional[HttpRequest] = None @register("test") class TestComponent(Component): template: types.django_html = """{% csrf_token %}""" def get_template_data(self, args, kwargs, slots, context): nonlocal context_processors_data nonlocal inner_request context_processors_data = self.context_processors_data inner_request = self.request request = HttpRequest() rendered = TestComponent.render(request=request) assert "csrfmiddlewaretoken" in rendered assert list(context_processors_data.keys()) == ["csrf_token"] # type: ignore[union-attr] assert inner_request == request @djc_test(parametrize=PARAMETRIZE_CONTEXT_BEHAVIOR) def test_request_in_python_nested(self, components_settings): context_processors_data: Optional[Dict] = None context_processors_data_child: Optional[Dict] = None parent_request: Optional[HttpRequest] = None child_request: Optional[HttpRequest] = None @register("test_parent") class TestParentComponent(Component): template: types.django_html = """ {% load component_tags %} {% component "test_child" / %} """ def get_template_data(self, args, kwargs, slots, context): nonlocal context_processors_data nonlocal parent_request context_processors_data = self.context_processors_data parent_request = self.request @register("test_child") class TestChildComponent(Component): template: types.django_html = """{% csrf_token %}""" def get_template_data(self, args, kwargs, slots, context): nonlocal context_processors_data_child nonlocal child_request context_processors_data_child = self.context_processors_data child_request = self.request request = HttpRequest() rendered = TestParentComponent.render(request=request) assert "csrfmiddlewaretoken" in rendered assert list(context_processors_data.keys()) == ["csrf_token"] # type: ignore[union-attr] assert list(context_processors_data_child.keys()) == ["csrf_token"] # type: ignore[union-attr] assert parent_request == request assert child_request == request # No request, regular Context @djc_test(parametrize=PARAMETRIZE_CONTEXT_BEHAVIOR) def test_no_context_processor_when_non_request_context_in_python(self, components_settings): context_processors_data: Optional[Dict] = None inner_request: Optional[HttpRequest] = None @register("test") class TestComponent(Component): template: types.django_html = """{% csrf_token %}""" def get_template_data(self, args, kwargs, slots, context): nonlocal context_processors_data nonlocal inner_request context_processors_data = self.context_processors_data inner_request = self.request rendered = TestComponent.render(context=Context()) assert "csrfmiddlewaretoken" not in rendered assert list(context_processors_data.keys()) == [] # type: ignore[union-attr] assert inner_request is None # No request, no Context @djc_test(parametrize=PARAMETRIZE_CONTEXT_BEHAVIOR) def test_no_context_processor_when_non_request_context_in_python_2(self, components_settings): context_processors_data: Optional[Dict] = None inner_request: Optional[HttpRequest] = None @register("test") class TestComponent(Component): template: types.django_html = """{% csrf_token %}""" def get_template_data(self, args, kwargs, slots, context): nonlocal context_processors_data nonlocal inner_request context_processors_data = self.context_processors_data inner_request = self.request rendered = TestComponent.render() assert "csrfmiddlewaretoken" not in rendered assert list(context_processors_data.keys()) == [] # type: ignore[union-attr] assert inner_request is None # Yes request, regular Context @djc_test(parametrize=PARAMETRIZE_CONTEXT_BEHAVIOR) def test_context_processor_when_regular_context_and_request_in_python(self, components_settings): context_processors_data: Optional[Dict] = None inner_request: Optional[HttpRequest] = None @register("test") class TestComponent(Component): template: types.django_html = """{% csrf_token %}""" def get_template_data(self, args, kwargs, slots, context): nonlocal context_processors_data nonlocal inner_request context_processors_data = self.context_processors_data inner_request = self.request request = HttpRequest() rendered = TestComponent.render(Context(), request=request) assert "csrfmiddlewaretoken" in rendered assert list(context_processors_data.keys()) == ["csrf_token"] # type: ignore[union-attr] assert inner_request == request @djc_test(django_settings={ "TEMPLATES": [ { "BACKEND": "django.template.backends.django.DjangoTemplates", "DIRS": ["tests/templates/", "tests/components/"], "OPTIONS": { "builtins": [ "django_components.templatetags.component_tags", ], "context_processors": [ "tests.test_context.dummy_context_processor", ], }, } ], }) def test_data_generated_only_once(self): context_processors_data: Optional[Dict] = None context_processors_data_child: Optional[Dict] = None @register("test_parent") class TestParentComponent(Component): template: types.django_html = """ {% load component_tags %} {% component "test_child" / %} """ def get_template_data(self, args, kwargs, slots, context): nonlocal context_processors_data context_processors_data = self.context_processors_data @register("test_child") class TestChildComponent(Component): template: types.django_html = """{% csrf_token %}""" def get_template_data(self, args, kwargs, slots, context): nonlocal context_processors_data_child context_processors_data_child = self.context_processors_data request = HttpRequest() TestParentComponent.render(request=request) parent_data = cast(dict, context_processors_data) child_data = cast(dict, context_processors_data_child) # Check that the context processors data is reused across the components with # the same request. assert list(parent_data.keys()) == ["csrf_token", "dummy"] assert list(child_data.keys()) == ["csrf_token", "dummy"] assert parent_data["dummy"] == "a1bc3f" assert child_data["dummy"] == "a1bc3f" assert parent_data["csrf_token"] == child_data["csrf_token"] def test_context_processors_data_outside_of_rendering(self): class TestComponent(Component): template: types.django_html = """{% csrf_token %}""" request = HttpRequest() component = TestComponent(request=request) data = component.context_processors_data assert list(data.keys()) == ["csrf_token"] def test_request_outside_of_rendering(self): class TestComponent(Component): template: types.django_html = """{% csrf_token %}""" request = HttpRequest() component = TestComponent(request=request) assert component.request == request @djc_test class TestOuterContextProperty: @djc_test(parametrize=PARAMETRIZE_CONTEXT_BEHAVIOR) def test_outer_context_property_with_component(self, components_settings): @register("outer_context_component") class OuterContextComponent(Component): template: types.django_html = """ Variable: {{ variable }} """ def get_template_data(self, args, kwargs, slots, context): return self.outer_context.flatten() # type: ignore[union-attr] template_str: types.django_html = """ {% load component_tags %} {% component 'outer_context_component' only %}{% endcomponent %} """ template = Template(template_str) rendered = template.render(Context({"variable": "outer_value"})).strip() assert "outer_value" in rendered # TODO_v1: Remove, superseded by `component_vars.slots` @djc_test class TestContextVarsIsFilled: class IsFilledVarsComponent(Component): template: types.django_html = """ {% load component_tags %}