inventree-manufacturing-costs 0.1.0__py3-none-any.whl

manufacturing_costs/views.py

@@ -0,0 +1,276 @@
+"""API views for the ManufacturingCosts plugin."""
+
+from decimal import Decimal
+from typing import cast
+
+import tablib
+
+from django.db.models import Q
+from django_filters import rest_framework as rest_filters
+from rest_framework import filters, permissions
+from rest_framework.views import APIView
+
+from InvenTree.helpers import DownloadFile
+from InvenTree.mixins import ListCreateAPI, RetrieveUpdateDestroyAPI
+import part.models
+
+from .models import ManufacturingRate, ManufacturingCost
+from .serializers import (
+    ManufacturingRateSerializer,
+    ManufacturingCostSerializer,
+    AssemblyCostRequestSerializer,
+)
+
+
+class ManufacturingRateMixin:
+    """Mixin class for ManufacturingRate API endpoints."""
+
+    # TODO: Fix up the permissions and authentication for this mixin
+    permission_classes = [permissions.IsAuthenticated]
+    serializer_class = ManufacturingRateSerializer
+    queryset = ManufacturingRate.objects.all()
+
+
+class ManufacturingRateList(ManufacturingRateMixin, ListCreateAPI):
+    """API endpoint for listing and creating ManufacturingRate instances."""
+
+    filter_backends = [filters.OrderingFilter, filters.SearchFilter]
+
+    ordering_fields = [
+        "pk",
+        "name",
+        "units",
+    ]
+
+    search_fields = [
+        "name",
+        "description",
+    ]
+
+
+class ManufacturingRateDetail(ManufacturingRateMixin, RetrieveUpdateDestroyAPI):
+    """API endpoint for retrieving, updating, and deleting a ManufacturingRate instance."""
+
+    ...
+
+
+class ManufacturingCostMixin:
+    """Mixin class for ManufacturingCost API endpoints."""
+
+    permission_classes = [permissions.IsAuthenticated]
+    serializer_class = ManufacturingCostSerializer
+    queryset = ManufacturingCost.objects.all()
+
+    def get_queryset(self):
+        """Return the queryset for the ManufacturingRate model."""
+        queryset = super().get_queryset()
+        queryset = queryset.prefetch_related("part")
+
+        return queryset
+
+
+class ManufacturingCostFilter(rest_filters.FilterSet):
+    """Filter class for ManufacturingCost API endpoints."""
+
+    class Meta:
+        model = ManufacturingCost
+        fields = [
+            "active",
+            "inherited",
+        ]
+
+    part = rest_filters.ModelChoiceFilter(
+        queryset=part.models.Part.objects.all(), label="Part", method="filter_part"
+    )
+
+    def filter_part(self, queryset, name, part):
+        """Filter ManufacturingCost instances by part."""
+
+        parts = part.get_ancestors(include_self=True)
+        Q1 = Q(part__in=parts, inherited=True)
+        Q2 = Q(part=part, inherited=False)
+
+        return queryset.filter(Q1 | Q2).distinct()
+
+
+class ManufacturingCostList(ManufacturingCostMixin, ListCreateAPI):
+    """API endpoint for listing and creating ManufacturingCost instances."""
+
+    filterset_class = ManufacturingCostFilter
+
+    filter_backends = [
+        rest_filters.DjangoFilterBackend,
+        filters.OrderingFilter,
+        filters.SearchFilter,
+    ]
+
+    ordering_fields = ["pk", "part", "rate", "quantity"]
+
+    search_fields = [
+        "part__name",
+        "part__IPN",
+        "rate__name",
+        "rate__description",
+        "notes",
+    ]
+
+
+class ManufacturingCostDetail(ManufacturingCostMixin, RetrieveUpdateDestroyAPI):
+    """API endpoint for retrieving, updating, and deleting a ManufacturingCost instance."""
+
+    ...
+
+
+class AssemblyCostExport(APIView):
+    """API endpoint for exporting ManufacturingCost data for a single assembly."""
+
+    permission_classes = [permissions.IsAuthenticated]
+
+    def get(self, request):
+        """Export manufacturing cost data for a given assembly part."""
+
+        serializer = AssemblyCostRequestSerializer(data=request.query_params)
+
+        serializer.is_valid(raise_exception=True)
+        data = cast(dict, serializer.validated_data)
+
+        self.part = data["part"]
+        self.include_subassemblies = data.get("include_subassemblies", True)
+        self.export_format = data.get("export_format", "csv")
+
+        return self.export_data()
+
+    def export_data(self):
+        """Construct a dataset for export."""
+
+        headers = self.file_headers()
+        self.dataset = tablib.Dataset(headers=map(str, headers))
+
+        # Start the processing with the top-level assembly
+        self.process_assembly(self.part)
+
+        data = self.dataset.export(self.export_format)
+
+        return DownloadFile(
+            data,
+            filename=f"assembly_costs_{self.part.full_name}.{self.export_format}",
+        )
+
+    def file_headers(self):
+        """Return the headers for the exported dataset."""
+
+        return [
+            "BOM Level",
+            "Quantity Multiplier",
+            "Part ID",
+            "Part IPN",
+            "Part Name",
+            "Rate",
+            "Rate Description",
+            "Cost",
+            "Notes",
+            "Base Quantity",
+            "Total Quantity",
+            "Unit Cost",
+            "Total Cost",
+            "Currency",
+        ]
+
+    def find_costs_for_assembly(self, part):
+        """Find all ManufacturingCost entries for a given assembly part.
+
+        These may be direct costs, or inherited costs from template parts.
+        """
+
+        parents = part.get_ancestors(include_self=True)
+        Q1 = Q(part__in=parents, inherited=True)
+        Q2 = Q(part=part, inherited=False)
+
+        costs = ManufacturingCost.objects.filter(active=True).filter(Q1 | Q2).distinct()
+        costs = costs.prefetch_related("part", "rate")
+
+        return costs
+
+    def process_assembly(self, part, level: int = 1, multiplier: Decimal = Decimal(1)):
+        """Process an assembly part and its sub-assemblies to populate the dataset."""
+
+        base_row_data = [
+            level,
+            multiplier,
+            part.pk,
+            part.IPN,
+            part.name,
+        ]
+
+        costs = self.find_costs_for_assembly(part)
+
+        for cost in costs:
+            unit_cost = cost.calculate_cost(1.0)
+
+            row = [
+                *base_row_data,
+                cost.rate.name if cost.rate else "-",
+                cost.rate.description if cost.rate else "-",
+                cost.description,
+                cost.notes,
+                float(cost.quantity),
+                float(cost.quantity * multiplier),
+                float(unit_cost.amount),
+                float(unit_cost.amount * cost.quantity * multiplier),
+                str(unit_cost.currency),
+            ]
+
+            # Add this row to the dataset
+            self.dataset.append(row)
+
+        # Process sub-assemblies as required
+        if self.include_subassemblies:
+            # Find all subassemblies
+            bom_items = part.get_bom_items().filter(sub_part__assembly=True)
+
+            for bom_item in bom_items:
+                self.process_assembly(
+                    bom_item.sub_part,
+                    level=level + 1,
+                    multiplier=multiplier * bom_item.quantity,
+                )
+
+
+def construct_urls():
+    """Construct the URL patterns for the ManufacturingCosts plugin."""
+
+    from django.urls import path, include
+
+    return [
+        path(
+            "rate/",
+            include([
+                path(
+                    "<int:pk>/",
+                    ManufacturingRateDetail.as_view(),
+                    name="manufacturing-rate-detail",
+                ),
+                path(
+                    "", ManufacturingRateList.as_view(), name="manufacturing-rate-list"
+                ),
+            ]),
+        ),
+        path(
+            "cost/",
+            include([
+                path(
+                    "export/",
+                    AssemblyCostExport.as_view(),
+                    name="assembly-cost-export",
+                ),
+                path(
+                    "<int:pk>/",
+                    ManufacturingCostDetail.as_view(),
+                    name="manufacturing-cost-detail",
+                ),
+                path(
+                    "", ManufacturingCostList.as_view(), name="manufacturing-cost-list"
+                ),
+            ]),
+        ),
+    ]