Report merge

docs/docs/report/context_variables.md

@@ -23,6 +23,8 @@ In addition to the [global context](#global-context), all *report* templates hav
 
 {{ report_context("base", "report") }}
 
+`merge` exposes the selected items in the `items` context variable. {{ templatefile("report/inventree_stock_report_merge.html") }} shows an example on how to use this context variable.
+
 Note that custom plugins may also add additional context variables to the report context.
 
 ::: report.models.ReportTemplate.get_context

docs/docs/report/samples.md

@@ -22,6 +22,8 @@ The following report templates are provided "out of the box" and can be used as
 | [Sales Order Shipment](#sales-order-shipment) | [SalesOrderShipment](../sales/sales_order.md) | Sales Order Shipment report |
 | [Stock Location](#stock-location) | [StockLocation](../stock/index.md#stock-location) | Stock Location report |
 | [Test Report](#test-report) | [StockItem](../stock/index.md#stock-item) | Test Report |
+| [Selected Stock Items Report](#selected-stock-items-report) | [StockItem](../stock/index.md#stock-item) | Selected Stock Items report |
+
 
 ### Bill of Materials Report
 
@@ -55,6 +57,10 @@ The following report templates are provided "out of the box" and can be used as
 
 {{ templatefile("report/inventree_test_report.html") }}
 
+### Selected Stock Items Report
+
+{{ templatefile("report/inventree_stock_report_merge.html") }}
+
 ## Label Templates
 
 The following label templates are provided "out of the box" and can be used as a starting point, or as a reference for creating custom label templates:

src/backend/InvenTree/InvenTree/api_version.py

@@ -1,12 +1,16 @@
 """InvenTree API version information."""
 
 # InvenTree API version
-INVENTREE_API_VERSION = 342
+INVENTREE_API_VERSION = 343
 
 """Increment this API version number whenever there is a significant change to the API that any clients need to know about."""
 
 
 INVENTREE_API_TEXT = """
+
+v343 -> 2025-05-10 : https://github.com/inventree/InvenTree/pull/9532
+    - Adds "merge" field to the ReportTemplate model
+
 v342 -> 2025-05-09 : https://github.com/inventree/InvenTree/pull/9651
     - Fix serializer to match Generate API for serial numbers
 

src/backend/InvenTree/report/apps.py

@@ -224,6 +224,13 @@ def create_default_reports(self):
                 'description': 'Sample stock item test report',
                 'model_type': 'stockitem',
             },
+            {
+                'file': 'inventree_stock_report_merge.html',
+                'name': 'InvenTree Default Stock Report Merge',
+                'description': 'Sample stock item report merge',
+                'model_type': 'stockitem',
+                'merge': True,
+            },
             {
                 'file': 'inventree_stock_location_report.html',
                 'name': 'InvenTree Stock Location Report',

src/backend/InvenTree/report/migrations/0031_reporttemplate_merge.py

@@ -0,0 +1,22 @@
+# Generated by Django 4.2.20 on 2025-04-03 01:17
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("report", "0030_alter_labeltemplate_model_type_and_more"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="reporttemplate",
+            name="merge",
+            field=models.BooleanField(
+                default=False,
+                help_text="Render a single report against selected items",
+                verbose_name="Merge",
+            ),
+        ),
+    ]

src/backend/InvenTree/report/models.py

@@ -170,10 +170,12 @@ class ReportContextExtension(TypedDict):
     Attributes:
         page_size: The page size of the report
         landscape: Boolean value, True if the report is in landscape mode
+        merge: Boolean value, True if the a single report is generated against multiple items
     """
 
     page_size: str
     landscape: bool
+    merge: bool
 
 
 class ReportTemplateBase(MetadataMixin, InvenTree.models.InvenTreeModel):
@@ -231,31 +233,34 @@ def generate_filename(self, context, **kwargs):
 
         return template_string.render(Context(context))
 
-    def render_as_string(self, instance, request=None, **kwargs) -> str:
+    def render_as_string(self, instance, request=None, context=None, **kwargs) -> str:
         """Render the report to a HTML string.
 
         Arguments:
             instance: The model instance to render against
             request: A HTTPRequest object (optional)
+            context: Django template language contexts (optional)
 
         Returns:
             str: HTML string
         """
-        context = self.get_context(instance, request, **kwargs)
+        if context is None:
+            context = self.get_context(instance, request, **kwargs)
 
         return render_to_string(self.template_name, context, request)
 
-    def render(self, instance, request=None, **kwargs) -> bytes:
+    def render(self, instance, request=None, context=None, **kwargs) -> bytes:
         """Render the template to a PDF file.
 
         Arguments:
             instance: The model instance to render against
             request: A HTTPRequest object (optional)
+            context: Django template langaguage contexts (optional)
 
         Returns:
             bytes: PDF data
         """
-        html = self.render_as_string(instance, request, **kwargs)
+        html = self.render_as_string(instance, request, context, **kwargs)
         pdf = HTML(string=html).write_pdf()
 
         return pdf
@@ -372,6 +377,12 @@ def __init__(self, *args, **kwargs):
         help_text=_('Render report in landscape orientation'),
     )
 
+    merge = models.BooleanField(
+        default=False,
+        verbose_name=_('Merge'),
+        help_text=_('Render a single report against selected items'),
+    )
+
     def get_report_size(self) -> str:
         """Return the printable page size for this report."""
         try:
@@ -388,17 +399,29 @@ def get_report_size(self) -> str:
 
         return page_size
 
-    def get_context(self, instance, request=None, **kwargs):
-        """Supply context data to the report template for rendering."""
-        base_context = super().get_context(instance, request)
+    def get_report_context(self):
+        """Return report template context."""
         report_context: ReportContextExtension = {
             'page_size': self.get_report_size(),
             'landscape': self.landscape,
+            'merge': self.merge,
         }
 
+        return report_context
+
+    def get_context(self, instance, request=None, **kwargs):
+        """Supply context data to the report template for rendering."""
+        base_context = super().get_context(instance, request)
+        report_context: ReportContextExtension = self.get_report_context()
+
         context = {**base_context, **report_context}
 
         # Pass the context through to the plugin registry for any additional information
+        context = self.get_plugin_context(instance, request, context)
+        return context
+
+    def get_plugin_context(self, instance, request, context):
+        """Get the context for the plugin."""
         for plugin in registry.with_mixin(PluginMixinEnum.REPORT):
             try:
                 plugin.add_report_context(self, instance, request, context)
@@ -409,6 +432,27 @@ def get_context(self, instance, request=None, **kwargs):
 
         return context
 
+    def handle_attachment(self, instance, report, report_name, request, debug_mode):
+        """Attach the generated report to the model instance (if required)."""
+        if self.attach_to_model and not debug_mode:
+            instance.create_attachment(
+                attachment=ContentFile(report, report_name),
+                comment=_(f'Report generated from template {self.name}'),
+                upload_user=request.user
+                if request and request.user.is_authenticated
+                else None,
+            )
+
+    def notify_plugins(self, instance, report, request):
+        """Provide generated report to any interested plugins."""
+        report_plugins = registry.with_mixin(PluginMixinEnum.REPORT)
+
+        for plugin in report_plugins:
+            try:
+                plugin.report_callback(self, instance, report, request)
+            except Exception:
+                InvenTree.exceptions.log_error(f'plugins.{plugin.slug}.report_callback')
+
     def print(self, items: list, request=None, output=None, **kwargs) -> DataOutput:
         """Print reports for a list of items against this template.
 
@@ -440,8 +484,6 @@ def print(self, items: list, request=None, output=None, **kwargs) -> DataOutput:
         # Start with a default report name
         report_name = None
 
-        report_plugins = registry.with_mixin(PluginMixinEnum.REPORT)
-
         # If a DataOutput object is not provided, create a new one
         if not output:
             output = DataOutput.objects.create(
@@ -461,46 +503,72 @@ def print(self, items: list, request=None, output=None, **kwargs) -> DataOutput:
             output.save()
 
         try:
-            for instance in items:
-                context = self.get_context(instance, request)
+            if self.merge:
+                base_context = super().base_context(request)
+                report_context = self.get_report_context()
+                item_contexts = []
+                for instance in items:
+                    instance_context = instance.report_context()
+                    instance_context = self.get_plugin_context(
+                        instance, request, instance_context
+                    )
+                    item_contexts.append(instance_context)
+
+                contexts = {
+                    **base_context,
+                    **report_context,
+                    'instances': item_contexts,
+                }
 
                 if report_name is None:
-                    report_name = self.generate_filename(context)
+                    report_name = self.generate_filename(contexts)
 
-                # Render the report output
                 try:
                     if debug_mode:
-                        report = self.render_as_string(instance, request)
+                        report = self.render_as_string(instance, request, contexts)
                     else:
-                        report = self.render(instance, request)
+                        report = self.render(instance, request, contexts)
                 except TemplateDoesNotExist as e:
                     t_name = str(e) or self.template
                     raise ValidationError(f'Template file {t_name} does not exist')
 
                 outputs.append(report)
 
-                # Attach the generated report to the model instance (if required)
-                if self.attach_to_model and not debug_mode:
-                    instance.create_attachment(
-                        attachment=ContentFile(report, report_name),
-                        comment=_(f'Report generated from template {self.name}'),
-                        upload_user=request.user
-                        if request and request.user.is_authenticated
-                        else None,
-                    )
-
-                # Provide generated report to any interested plugins
-                for plugin in report_plugins:
-                    try:
-                        plugin.report_callback(self, instance, report, request)
-                    except Exception:
-                        InvenTree.exceptions.log_error(
-                            f'plugins.{plugin.slug}.report_callback'
-                        )
+                self.handle_attachment(
+                    instance, report, report_name, request, debug_mode
+                )
+                self.notify_plugins(instance, report, request)
 
                 # Update the progress of the report generation
                 output.progress += 1
                 output.save()
+            else:
+                for instance in items:
+                    context = self.get_context(instance, request)
+
+                    if report_name is None:
+                        report_name = self.generate_filename(context)
+
+                    # Render the report output
+                    try:
+                        if debug_mode:
+                            report = self.render_as_string(instance, request, None)
+                        else:
+                            report = self.render(instance, request, None)
+                    except TemplateDoesNotExist as e:
+                        t_name = str(e) or self.template
+                        raise ValidationError(f'Template file {t_name} does not exist')
+
+                    outputs.append(report)
+
+                    self.handle_attachment(
+                        instance, report, report_name, request, debug_mode
+                    )
+                    self.notify_plugins(instance, report, request)
+
+                    # Update the progress of the report generation
+                    output.progress += 1
+                    output.save()
 
         except Exception as exc:
             # Something went wrong during the report generation process

src/backend/InvenTree/report/serializers.py

@@ -65,7 +65,12 @@ class Meta:
         """Metaclass options."""
 
         model = report.models.ReportTemplate
-        fields = [*ReportSerializerBase.base_fields(), 'page_size', 'landscape']
+        fields = [
+            *ReportSerializerBase.base_fields(),
+            'page_size',
+            'landscape',
+            'merge',
+        ]
 
     page_size = serializers.ChoiceField(
         required=False,