Improve the createlivecomponent management command

Fix the Python template and add a --stateless option
to create a stateless component.

Author: imankulov

CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## UNRELEASED
+
+- Improved the createlivecomponent management command: fixed the Python template and added a --stateless option to create a stateless component.
+
 ## 1.12.4 (2024-08-15)
 
 - Improved serialization for Django forms and models: pickle now correctly handles unsaved Django model instances and validates bound forms during unpickling.

README.md

@@ -140,6 +140,8 @@ of one Python, and one HTML file.
 
 Make sure that your STATICFILES_DIRS setting includes the "components" directory of the app.
 
+Optionally, you can pass a `--stateless` flag to create a stateless component.
+
 
 ## On Component IDs
 

livecomponents/management/commands/_templates.py

@@ -36,10 +36,38 @@ def get_extra_context_data(
         return {{}}
 
     def init_state(self, context: InitStateContext) -> {class_name}State:
-        return {class_name}State(**component_kwargs)
+        return {class_name}State(**context.component_kwargs)
 
-    # @command
-    # def say_hello(self, call_context: CallContext[{class_name}State]):
-    #     \"\"\"Example command.\"\"\"
-    #     pass
+    @command
+    def say_hello(self, call_context: CallContext[{class_name}State]):
+        \"\"\"Example command.\"\"\"
+        pass
+"""
+
+STATELESS_COMPONENT_PYTHON_TEMPLATE = """from typing import Any
+from typing import Any
+from django_components import component
+
+from livecomponents import (
+    ExtraContextRequest,
+    StatelessLiveComponent,
+    command,
+    CallContext,
+)
+
+@component.register("{component_name}")
+class {class_name}Component(StatelessLiveComponent):
+    template_name = "{component_name}/{proper_name}.html"
+
+
+    def get_extra_context_data(
+        self, extra_context_request: ExtraContextRequest
+    ) -> dict[str, Any]:
+        \"\"\"Return extra context to render the component template.\"\"\"
+        return {{}}
+
+    @command
+    def say_hello(self, call_context: CallContext):
+        \"\"\"Example command.\"\"\"
+        pass
 """

livecomponents/management/commands/createlivecomponent.py

@@ -6,6 +6,7 @@
 from livecomponents.management.commands._templates import (
     COMPONENT_HTML_TEMPLATE,
     COMPONENT_PYTHON_TEMPLATE,
+    STATELESS_COMPONENT_PYTHON_TEMPLATE,
 )
 
 
@@ -40,10 +41,16 @@ def add_arguments(self, parser):
             action="store_true",
             help="Overwrite existing files",
         )
+        parser.add_argument(
+            "--stateless",
+            action="store_true",
+            help="Create a stateless component",
+        )
 
     def handle(self, *args, **options):
         app_name = options["app_name"]
         component_name = options["component_name"]
+        stateless = options["stateless"]
         proper_name = component_name.split("/")[-1]
 
         class_name = options["class_name"]
@@ -83,7 +90,7 @@ def handle(self, *args, **options):
             "proper_name": proper_name,
             "class_name": class_name,
         }
-        component_py.write_text(COMPONENT_PYTHON_TEMPLATE.format(**context))
+        component_py.write_text(self.get_python_template(stateless).format(**context))
         component_html.write_text(COMPONENT_HTML_TEMPLATE.format(**context))
         self.stdout.write(
             self.style.SUCCESS(
@@ -97,6 +104,15 @@ def handle(self, *args, **options):
         self.stdout.write(
             f'- Use component as {{% livecomponent "{component_name}" %}}'
         )
+        self.stdout.write(
+            f"- If the component is called from a parent component, use it as "
+            f'{{% livecomponent "{component_name}" parent_id=component_id %}}'
+        )
+
+    def get_python_template(self, stateless: bool) -> str:
+        if stateless:
+            return STATELESS_COMPONENT_PYTHON_TEMPLATE
+        return COMPONENT_PYTHON_TEMPLATE
 
     def get_app_path(self, app_name: str) -> Path:
         for app_config in apps.get_app_configs():