6872102289

Committed 15 Nov 2023 02:18AM UTC coverage: 88.546% (+0.05%) from 88.5%

Build # 6872102289

Build Type

push

github

Committed by

web-flow

Commit Message

Cherry pick changes from <a class=hub.com/inventree/InvenTree/commit/fe0d9c19230013471a2100fbc1f41c7694f318fa">fe0d9c192 (#5917)

* Cherry pick changes from fe0d9c19230013471a2100fbc1f41c7694f318fa

* Bump version number

* Quick fix for unit test

- Sometimes the items are returned in a different order, maybe?

Run Details

61 of 66 new or added lines in 6 files covered. (92.42%)

38 existing lines in 1 file now uncovered.

26903 of 30383 relevant lines covered (88.55%)

0.89 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

92.86

/InvenTree/company/api.py

"""Provides a JSON API for the Company app."""

from django.db.models import Q
from django.urls import include, path, re_path

from django_filters import rest_framework as rest_filters
from django_filters.rest_framework import DjangoFilterBackend

import part.models
from InvenTree.api import (AttachmentMixin, ListCreateDestroyAPIView,
                           MetadataView)
from InvenTree.filters import (ORDER_FILTER, SEARCH_ORDER_FILTER,
                               SEARCH_ORDER_FILTER_ALIAS)
from InvenTree.helpers import str2bool
from InvenTree.mixins import ListCreateAPI, RetrieveUpdateDestroyAPI

from .models import (Address, Company, CompanyAttachment, Contact,
                     ManufacturerPart, ManufacturerPartAttachment,
                     ManufacturerPartParameter, SupplierPart,
                     SupplierPriceBreak)
from .serializers import (AddressSerializer, CompanyAttachmentSerializer,
                          CompanySerializer, ContactSerializer,
                          ManufacturerPartAttachmentSerializer,
                          ManufacturerPartParameterSerializer,
                          ManufacturerPartSerializer, SupplierPartSerializer,
                          SupplierPriceBreakSerializer)


class CompanyList(ListCreateAPI):
    """API endpoint for accessing a list of Company objects.

    Provides two methods:

    - GET: Return list of objects
    - POST: Create a new Company object
    """

    serializer_class = CompanySerializer
    queryset = Company.objects.all()

    def get_queryset(self):
        """Return annotated queryset for the company list endpoint"""
        queryset = super().get_queryset()
        queryset = CompanySerializer.annotate_queryset(queryset)

        return queryset

    filter_backends = SEARCH_ORDER_FILTER

    filterset_fields = [
        'is_customer',
        'is_manufacturer',
        'is_supplier',
        'name',
    ]

    search_fields = [
        'name',
        'description',
        'website',
    ]

    ordering_fields = [
        'name',
        'parts_supplied',
        'parts_manufactured',
    ]

    ordering = 'name'


class CompanyDetail(RetrieveUpdateDestroyAPI):
    """API endpoint for detail of a single Company object."""

    queryset = Company.objects.all()
    serializer_class = CompanySerializer

    def get_queryset(self):
        """Return annotated queryset for the company detail endpoint"""
        queryset = super().get_queryset()
        queryset = CompanySerializer.annotate_queryset(queryset)

        return queryset


class CompanyAttachmentList(AttachmentMixin, ListCreateDestroyAPIView):
    """API endpoint for the CompanyAttachment model"""

    queryset = CompanyAttachment.objects.all()
    serializer_class = CompanyAttachmentSerializer

    filter_backends = [
        DjangoFilterBackend,
    ]

    filterset_fields = [
        'company',
    ]


class CompanyAttachmentDetail(AttachmentMixin, RetrieveUpdateDestroyAPI):
    """Detail endpoint for CompanyAttachment model."""

    queryset = CompanyAttachment.objects.all()
    serializer_class = CompanyAttachmentSerializer


class ContactList(ListCreateDestroyAPIView):
    """API endpoint for list view of Company model"""

    queryset = Contact.objects.all()
    serializer_class = ContactSerializer

    filter_backends = SEARCH_ORDER_FILTER

    filterset_fields = [
        'company',
    ]

    search_fields = [
        'company__name',
        'name',
    ]

    ordering_fields = [
        'name',
    ]

    ordering = 'name'


class ContactDetail(RetrieveUpdateDestroyAPI):
    """Detail endpoint for Company model"""

    queryset = Contact.objects.all()
    serializer_class = ContactSerializer


class AddressList(ListCreateDestroyAPIView):
    """API endpoint for list view of Address model"""

    queryset = Address.objects.all()
    serializer_class = AddressSerializer

    filter_backends = SEARCH_ORDER_FILTER

    filterset_fields = [
        'company',
    ]

    ordering_fields = [
        'title',
    ]

    ordering = 'title'


class AddressDetail(RetrieveUpdateDestroyAPI):
    """API endpoint for a single Address object"""

    queryset = Address.objects.all()
    serializer_class = AddressSerializer


class ManufacturerPartFilter(rest_filters.FilterSet):
    """Custom API filters for the ManufacturerPart list endpoint."""

    class Meta:
        """Metaclass options."""

        model = ManufacturerPart
        fields = [
            'manufacturer',
            'MPN',
            'part',
            'tags__name',
            'tags__slug',
        ]

    # Filter by 'active' status of linked part
    active = rest_filters.BooleanFilter(field_name='part__active')


class ManufacturerPartList(ListCreateDestroyAPIView):
    """API endpoint for list view of ManufacturerPart object.

    - GET: Return list of ManufacturerPart objects
    - POST: Create a new ManufacturerPart object
    """

    queryset = ManufacturerPart.objects.all().prefetch_related(
        'part',
        'manufacturer',
        'supplier_parts',
        'tags',
    )

    serializer_class = ManufacturerPartSerializer
    filterset_class = ManufacturerPartFilter

    def get_serializer(self, *args, **kwargs):
        """Return serializer instance for this endpoint"""
        # Do we wish to include extra detail?
        try:
            params = self.request.query_params

            kwargs['part_detail'] = str2bool(params.get('part_detail', None))
            kwargs['manufacturer_detail'] = str2bool(params.get('manufacturer_detail', None))
            kwargs['pretty'] = str2bool(params.get('pretty', None))
        except AttributeError:
            pass

        kwargs['context'] = self.get_serializer_context()

        return self.serializer_class(*args, **kwargs)

    filter_backends = SEARCH_ORDER_FILTER

    search_fields = [
        'manufacturer__name',
        'description',
        'MPN',
        'part__IPN',
        'part__name',
        'part__description',
        'tags__name',
        'tags__slug',
    ]


class ManufacturerPartDetail(RetrieveUpdateDestroyAPI):
    """API endpoint for detail view of ManufacturerPart object.

    - GET: Retrieve detail view
    - PATCH: Update object
    - DELETE: Delete object
    """

    queryset = ManufacturerPart.objects.all()
    serializer_class = ManufacturerPartSerializer


class ManufacturerPartAttachmentList(AttachmentMixin, ListCreateDestroyAPIView):
    """API endpoint for listing (and creating) a ManufacturerPartAttachment (file upload)."""

    queryset = ManufacturerPartAttachment.objects.all()
    serializer_class = ManufacturerPartAttachmentSerializer

    filter_backends = [
        DjangoFilterBackend,
    ]

    filterset_fields = [
        'manufacturer_part',
    ]


class ManufacturerPartAttachmentDetail(AttachmentMixin, RetrieveUpdateDestroyAPI):
    """Detail endpooint for ManufacturerPartAttachment model."""

    queryset = ManufacturerPartAttachment.objects.all()
    serializer_class = ManufacturerPartAttachmentSerializer


class ManufacturerPartParameterFilter(rest_filters.FilterSet):
    """Custom filterset for the ManufacturerPartParameterList API endpoint"""

    class Meta:
        """Metaclass options"""
        model = ManufacturerPartParameter
        fields = [
            'name',
            'value',
            'units',
            'manufacturer_part',
        ]

    manufacturer = rest_filters.ModelChoiceFilter(queryset=Company.objects.all(), field_name='manufacturer_part__manufacturer')

    part = rest_filters.ModelChoiceFilter(queryset=part.models.Part.objects.all(), field_name='manufacturer_part__part')


class ManufacturerPartParameterList(ListCreateDestroyAPIView):
    """API endpoint for list view of ManufacturerPartParamater model."""

    queryset = ManufacturerPartParameter.objects.all()
    serializer_class = ManufacturerPartParameterSerializer
    filterset_class = ManufacturerPartParameterFilter

    def get_serializer(self, *args, **kwargs):
        """Return serializer instance for this endpoint"""
        # Do we wish to include any extra detail?
        try:
            params = self.request.query_params

            optional_fields = [
                'manufacturer_part_detail',
            ]

            for key in optional_fields:
                kwargs[key] = str2bool(params.get(key, None))

        except AttributeError:
            pass

        kwargs['context'] = self.get_serializer_context()

        return self.serializer_class(*args, **kwargs)

    filter_backends = SEARCH_ORDER_FILTER

    search_fields = [
        'name',
        'value',
        'units',
    ]


class ManufacturerPartParameterDetail(RetrieveUpdateDestroyAPI):
    """API endpoint for detail view of ManufacturerPartParameter model."""

    queryset = ManufacturerPartParameter.objects.all()
    serializer_class = ManufacturerPartParameterSerializer


class SupplierPartFilter(rest_filters.FilterSet):
    """API filters for the SupplierPartList endpoint"""

    class Meta:
        """Metaclass option"""

        model = SupplierPart
        fields = [
            'supplier',
            'part',
            'manufacturer_part',
            'SKU',
            'tags__name',
            'tags__slug',
        ]

    # Filter by 'active' status of linked part
    active = rest_filters.BooleanFilter(field_name='part__active')

    # Filter by the 'MPN' of linked manufacturer part
    MPN = rest_filters.CharFilter(
        label='Manufacturer Part Number',
        field_name='manufacturer_part__MPN',
        lookup_expr='iexact'
    )


class SupplierPartList(ListCreateDestroyAPIView):
    """API endpoint for list view of SupplierPart object.

    - GET: Return list of SupplierPart objects
    - POST: Create a new SupplierPart object
    """

    queryset = SupplierPart.objects.all().prefetch_related(
        'tags',
    )
    filterset_class = SupplierPartFilter

    def get_queryset(self, *args, **kwargs):
        """Return annotated queryest object for the SupplierPart list"""
        queryset = super().get_queryset(*args, **kwargs)
        queryset = SupplierPartSerializer.annotate_queryset(queryset)

        return queryset

    def filter_queryset(self, queryset):
        """Custom filtering for the queryset."""
        queryset = super().filter_queryset(queryset)

        params = self.request.query_params

        # Filter by manufacturer
        manufacturer = params.get('manufacturer', None)

        if manufacturer is not None:
            queryset = queryset.filter(manufacturer_part__manufacturer=manufacturer)

        # Filter by EITHER manufacturer or supplier
        company = params.get('company', None)

        if company is not None:
            queryset = queryset.filter(Q(manufacturer_part__manufacturer=company) | Q(supplier=company)).distinct()

        return queryset

    def get_serializer(self, *args, **kwargs):
        """Return serializer instance for this endpoint"""

        # Do we wish to include extra detail?
        try:
            params = self.request.query_params
            kwargs['part_detail'] = str2bool(params.get('part_detail', None))
            kwargs['supplier_detail'] = str2bool(params.get('supplier_detail', True))
            kwargs['manufacturer_detail'] = str2bool(params.get('manufacturer_detail', None))
            kwargs['pretty'] = str2bool(params.get('pretty', None))
        except AttributeError:
            pass

        kwargs['context'] = self.get_serializer_context()

        return self.serializer_class(*args, **kwargs)

    serializer_class = SupplierPartSerializer

    filter_backends = SEARCH_ORDER_FILTER_ALIAS

    ordering_fields = [
        'SKU',
        'part',
        'supplier',
        'manufacturer',
        'MPN',
        'packaging',
        'pack_quantity',
        'in_stock',
        'updated',
    ]

    ordering_field_aliases = {
        'part': 'part__name',
        'supplier': 'supplier__name',
        'manufacturer': 'manufacturer_part__manufacturer__name',
        'MPN': 'manufacturer_part__MPN',
        'pack_quantity': ['pack_quantity_native', 'pack_quantity'],
    }

    search_fields = [
        'SKU',
        'supplier__name',
        'manufacturer_part__manufacturer__name',
        'description',
        'manufacturer_part__MPN',
        'part__IPN',
        'part__name',
        'part__description',
        'part__keywords',
        'tags__name',
        'tags__slug',
    ]


class SupplierPartDetail(RetrieveUpdateDestroyAPI):
    """API endpoint for detail view of SupplierPart object.

    - GET: Retrieve detail view
    - PATCH: Update object
    - DELETE: Delete object
    """

    queryset = SupplierPart.objects.all()
    serializer_class = SupplierPartSerializer

    read_only_fields = [
    ]


class SupplierPriceBreakFilter(rest_filters.FilterSet):
    """Custom API filters for the SupplierPriceBreak list endpoint"""

    class Meta:
        """Metaclass options"""

        model = SupplierPriceBreak
        fields = [
            'part',
            'quantity',
        ]

    base_part = rest_filters.ModelChoiceFilter(
        label='Base Part',
        queryset=part.models.Part.objects.all(),
        field_name='part__part',
    )

    supplier = rest_filters.ModelChoiceFilter(
        label='Supplier',
        queryset=Company.objects.all(),
        field_name='part__supplier',
    )


class SupplierPriceBreakList(ListCreateAPI):
    """API endpoint for list view of SupplierPriceBreak object.

    - GET: Retrieve list of SupplierPriceBreak objects
    - POST: Create a new SupplierPriceBreak object
    """

    queryset = SupplierPriceBreak.objects.all()
    serializer_class = SupplierPriceBreakSerializer
    filterset_class = SupplierPriceBreakFilter

    def get_serializer(self, *args, **kwargs):
        """Return serializer instance for this endpoint"""

        try:
            params = self.request.query_params

            kwargs['part_detail'] = str2bool(params.get('part_detail', False))
            kwargs['supplier_detail'] = str2bool(params.get('supplier_detail', False))

        except AttributeError:
            pass

        kwargs['context'] = self.get_serializer_context()

        return self.serializer_class(*args, **kwargs)

    filter_backends = ORDER_FILTER

    ordering_fields = [
        'quantity',
    ]

    ordering = 'quantity'


class SupplierPriceBreakDetail(RetrieveUpdateDestroyAPI):
    """Detail endpoint for SupplierPriceBreak object."""

    queryset = SupplierPriceBreak.objects.all()
    serializer_class = SupplierPriceBreakSerializer


manufacturer_part_api_urls = [

    # Base URL for ManufacturerPartAttachment API endpoints
    re_path(r'^attachment/', include([
        path(r'<int:pk>/', ManufacturerPartAttachmentDetail.as_view(), name='api-manufacturer-part-attachment-detail'),
        re_path(r'^$', ManufacturerPartAttachmentList.as_view(), name='api-manufacturer-part-attachment-list'),
    ])),

    re_path(r'^parameter/', include([
        path(r'<int:pk>/', ManufacturerPartParameterDetail.as_view(), name='api-manufacturer-part-parameter-detail'),

        # Catch anything else
        re_path(r'^.*$', ManufacturerPartParameterList.as_view(), name='api-manufacturer-part-parameter-list'),
    ])),

    re_path(r'^(?P<pk>\d+)/?', include([
        re_path('^metadata/', MetadataView.as_view(), {'model': ManufacturerPart}, name='api-manufacturer-part-metadata'),
        re_path('^.*$', ManufacturerPartDetail.as_view(), name='api-manufacturer-part-detail'),
    ])),

    # Catch anything else
    re_path(r'^.*$', ManufacturerPartList.as_view(), name='api-manufacturer-part-list'),
]


supplier_part_api_urls = [

    re_path(r'^(?P<pk>\d+)/?', include([
        re_path('^metadata/', MetadataView.as_view(), {'model': SupplierPart}, name='api-supplier-part-metadata'),
        re_path('^.*$', SupplierPartDetail.as_view(), name='api-supplier-part-detail'),
    ])),

    # Catch anything else
    re_path(r'^.*$', SupplierPartList.as_view(), name='api-supplier-part-list'),
]


company_api_urls = [
    re_path(r'^part/manufacturer/', include(manufacturer_part_api_urls)),

    re_path(r'^part/', include(supplier_part_api_urls)),

    # Supplier price breaks
    re_path(r'^price-break/', include([

        re_path(r'^(?P<pk>\d+)/?', SupplierPriceBreakDetail.as_view(), name='api-part-supplier-price-detail'),
        re_path(r'^.*$', SupplierPriceBreakList.as_view(), name='api-part-supplier-price-list'),
    ])),

    re_path(r'^(?P<pk>\d+)/?', include([
        re_path(r'^metadata/', MetadataView.as_view(), {'model': Company}, name='api-company-metadata'),
        re_path(r'^.*$', CompanyDetail.as_view(), name='api-company-detail'),
    ])),

    re_path(r'^attachment/', include([
        path(r'<int:pk>/', CompanyAttachmentDetail.as_view(), name='api-company-attachment-detail'),
        re_path(r'^$', CompanyAttachmentList.as_view(), name='api-company-attachment-list'),
    ])),

    re_path(r'^contact/', include([
        re_path(r'^(?P<pk>\d+)/?', include([
            re_path('^metadata/', MetadataView.as_view(), {'model': Contact}, name='api-contact-metadata'),
            re_path('^.*$', ContactDetail.as_view(), name='api-contact-detail'),
        ])),
        re_path(r'^.*$', ContactList.as_view(), name='api-contact-list'),
    ])),

    re_path(r'^address/', include([
        path('<int:pk>/', AddressDetail.as_view(), name='api-address-detail'),
        re_path(r'^.*$', AddressList.as_view(), name='api-address-list'),
    ])),

    re_path(r'^.*$', CompanyList.as_view(), name='api-company-list'),

]

1	"""Provides a JSON API for the Company app."""
2
3	from django.db.models import Q
4	from django.urls import include, path, re_path
5
6	from django_filters import rest_framework as rest_filters
7	from django_filters.rest_framework import DjangoFilterBackend
8
9	import part.models
10	from InvenTree.api import (AttachmentMixin, ListCreateDestroyAPIView,
11	MetadataView)
12	from InvenTree.filters import (ORDER_FILTER, SEARCH_ORDER_FILTER,
13	SEARCH_ORDER_FILTER_ALIAS)
14	from InvenTree.helpers import str2bool
15	from InvenTree.mixins import ListCreateAPI, RetrieveUpdateDestroyAPI
16
17	from .models import (Address, Company, CompanyAttachment, Contact,
18	ManufacturerPart, ManufacturerPartAttachment,
19	ManufacturerPartParameter, SupplierPart,
20	SupplierPriceBreak)
21	from .serializers import (AddressSerializer, CompanyAttachmentSerializer,
22	CompanySerializer, ContactSerializer,
23	ManufacturerPartAttachmentSerializer,
24	ManufacturerPartParameterSerializer,
25	ManufacturerPartSerializer, SupplierPartSerializer,
26	SupplierPriceBreakSerializer)
27
28
29	class CompanyList(ListCreateAPI):
30	"""API endpoint for accessing a list of Company objects.
31
32	Provides two methods:
33
34	- GET: Return list of objects
35	- POST: Create a new Company object
36	"""
37
38	serializer_class = CompanySerializer	1✔
39	queryset = Company.objects.all()	1✔
40
41	def get_queryset(self):	1✔
42	"""Return annotated queryset for the company list endpoint"""
43	queryset = super().get_queryset()
44	queryset = CompanySerializer.annotate_queryset(queryset)
45
46	return queryset
47
48	filter_backends = SEARCH_ORDER_FILTER
49
50	filterset_fields = [
51	'is_customer',
52	'is_manufacturer',
53	'is_supplier',
54	'name',
55	]
56
57	search_fields = [
58	'name',
59	'description',
60	'website',
61	]
62
63	ordering_fields = [
64	'name',
65	'parts_supplied',
66	'parts_manufactured',
67	]
68
69	ordering = 'name'
70
71
72	class CompanyDetail(RetrieveUpdateDestroyAPI):
73	"""API endpoint for detail of a single Company object."""
74
75	queryset = Company.objects.all()	1✔
76	serializer_class = CompanySerializer	1✔
77
78	def get_queryset(self):	1✔
79	"""Return annotated queryset for the company detail endpoint"""
80	queryset = super().get_queryset()
81	queryset = CompanySerializer.annotate_queryset(queryset)
82
83	return queryset
84
85
86	class CompanyAttachmentList(AttachmentMixin, ListCreateDestroyAPIView):
87	"""API endpoint for the CompanyAttachment model"""
88
89	queryset = CompanyAttachment.objects.all()	1✔
90	serializer_class = CompanyAttachmentSerializer	1✔
91
92	filter_backends = [	1✔
93	DjangoFilterBackend,	1✔
94	]
95
96	filterset_fields = [	1✔
97	'company',	1✔
98	]
99
100
101	class CompanyAttachmentDetail(AttachmentMixin, RetrieveUpdateDestroyAPI):	1✔
102	"""Detail endpoint for CompanyAttachment model."""
103
104	queryset = CompanyAttachment.objects.all()
105	serializer_class = CompanyAttachmentSerializer
106
107
108	class ContactList(ListCreateDestroyAPIView):
109	"""API endpoint for list view of Company model"""
110
111	queryset = Contact.objects.all()	1✔
112	serializer_class = ContactSerializer	1✔
113
114	filter_backends = SEARCH_ORDER_FILTER	1✔
115
116	filterset_fields = [	1✔
117	'company',	1✔
118	]
119
120	search_fields = [	1✔
121	'company__name',	1✔
122	'name',	1✔
123	]
124
125	ordering_fields = [	1✔
126	'name',	1✔
127	]
128
129	ordering = 'name'	1✔
130
131
132	class ContactDetail(RetrieveUpdateDestroyAPI):	1✔
133	"""Detail endpoint for Company model"""
134
135	queryset = Contact.objects.all()
136	serializer_class = ContactSerializer
137
138
139	class AddressList(ListCreateDestroyAPIView):
140	"""API endpoint for list view of Address model"""
141
142	queryset = Address.objects.all()	1✔
143	serializer_class = AddressSerializer	1✔
144
145	filter_backends = SEARCH_ORDER_FILTER	1✔
146
147	filterset_fields = [	1✔
148	'company',	1✔
149	]
150
151	ordering_fields = [	1✔
152	'title',	1✔
153	]
154
155	ordering = 'title'	1✔
156
157
158	class AddressDetail(RetrieveUpdateDestroyAPI):	1✔
159	"""API endpoint for a single Address object"""
160
161	queryset = Address.objects.all()
162	serializer_class = AddressSerializer
163
164
165	class ManufacturerPartFilter(rest_filters.FilterSet):
166	"""Custom API filters for the ManufacturerPart list endpoint."""
167
168	class Meta:	1✔
169	"""Metaclass options."""
170
171	model = ManufacturerPart
172	fields = [
173	'manufacturer',
174	'MPN',
175	'part',
176	'tags__name',
177	'tags__slug',
178	]
179
180	# Filter by 'active' status of linked part
181	active = rest_filters.BooleanFilter(field_name='part__active')
182
183
184	class ManufacturerPartList(ListCreateDestroyAPIView):
185	"""API endpoint for list view of ManufacturerPart object.
186
187	- GET: Return list of ManufacturerPart objects
188	- POST: Create a new ManufacturerPart object
189	"""
190
191	queryset = ManufacturerPart.objects.all().prefetch_related(	1✔
192	'part',	1✔
193	'manufacturer',	1✔
194	'supplier_parts',	1✔
195	'tags',	1✔
196	)
197
198	serializer_class = ManufacturerPartSerializer	1✔
199	filterset_class = ManufacturerPartFilter	1✔
200
201	def get_serializer(self, args, *kwargs):	1✔
202	"""Return serializer instance for this endpoint"""
203	# Do we wish to include extra detail?
204	try:
205	params = self.request.query_params
206
207	kwargs['part_detail'] = str2bool(params.get('part_detail', None))
208	kwargs['manufacturer_detail'] = str2bool(params.get('manufacturer_detail', None))
209	kwargs['pretty'] = str2bool(params.get('pretty', None))
210	except AttributeError:
211	pass
212
213	kwargs['context'] = self.get_serializer_context()
214
215	return self.serializer_class(args, *kwargs)
216
217	filter_backends = SEARCH_ORDER_FILTER
218
219	search_fields = [
220	'manufacturer__name',
221	'description',
222	'MPN',
223	'part__IPN',
224	'part__name',
225	'part__description',
226	'tags__name',
227	'tags__slug',
228	]
229
230
231	class ManufacturerPartDetail(RetrieveUpdateDestroyAPI):
232	"""API endpoint for detail view of ManufacturerPart object.
233
234	- GET: Retrieve detail view
235	- PATCH: Update object
236	- DELETE: Delete object
237	"""
238
239	queryset = ManufacturerPart.objects.all()	1✔
240	serializer_class = ManufacturerPartSerializer	1✔
241
242
243	class ManufacturerPartAttachmentList(AttachmentMixin, ListCreateDestroyAPIView):	1✔
244	"""API endpoint for listing (and creating) a ManufacturerPartAttachment (file upload)."""
245
246	queryset = ManufacturerPartAttachment.objects.all()
247	serializer_class = ManufacturerPartAttachmentSerializer
248
249	filter_backends = [
250	DjangoFilterBackend,
251	]
252
253	filterset_fields = [
254	'manufacturer_part',
255	]
256
257
258	class ManufacturerPartAttachmentDetail(AttachmentMixin, RetrieveUpdateDestroyAPI):
259	"""Detail endpooint for ManufacturerPartAttachment model."""
260
261	queryset = ManufacturerPartAttachment.objects.all()	1✔
262	serializer_class = ManufacturerPartAttachmentSerializer	1✔
263
264
265	class ManufacturerPartParameterFilter(rest_filters.FilterSet):	1✔
266	"""Custom filterset for the ManufacturerPartParameterList API endpoint"""
267
268	class Meta:
269	"""Metaclass options"""
270	model = ManufacturerPartParameter	1✔
271	fields = [	1✔
272	'name',
273	'value',
274	'units',
275	'manufacturer_part',
276	]
277
278	manufacturer = rest_filters.ModelChoiceFilter(queryset=Company.objects.all(), field_name='manufacturer_part__manufacturer')	1✔
279
280	part = rest_filters.ModelChoiceFilter(queryset=part.models.Part.objects.all(), field_name='manufacturer_part__part')	1✔
281
282
283	class ManufacturerPartParameterList(ListCreateDestroyAPIView):	1✔
284	"""API endpoint for list view of ManufacturerPartParamater model."""
285
286	queryset = ManufacturerPartParameter.objects.all()
287	serializer_class = ManufacturerPartParameterSerializer
288	filterset_class = ManufacturerPartParameterFilter
289
290	def get_serializer(self, args, *kwargs):
291	"""Return serializer instance for this endpoint"""
292	# Do we wish to include any extra detail?
293	try:	×
294	params = self.request.query_params	×
295
296	optional_fields = [
297	'manufacturer_part_detail',
298	]
299
300	for key in optional_fields:	×
301	kwargs[key] = str2bool(params.get(key, None))	×
302
303	except AttributeError:	×
304	pass	×
305
306	kwargs['context'] = self.get_serializer_context()	×
307
308	return self.serializer_class(args, *kwargs)	×
309
310	filter_backends = SEARCH_ORDER_FILTER	1✔
311
312	search_fields = [	1✔
313	'name',
314	'value',
315	'units',
316	]
317
318
319	class ManufacturerPartParameterDetail(RetrieveUpdateDestroyAPI):	1✔
320	"""API endpoint for detail view of ManufacturerPartParameter model."""
321
322	queryset = ManufacturerPartParameter.objects.all()
323	serializer_class = ManufacturerPartParameterSerializer
324
325
326	class SupplierPartFilter(rest_filters.FilterSet):
327	"""API filters for the SupplierPartList endpoint"""
328
329	class Meta:	1✔
330	"""Metaclass option"""
331
332	model = SupplierPart
333	fields = [
334	'supplier',
335	'part',
336	'manufacturer_part',
337	'SKU',
338	'tags__name',
339	'tags__slug',
340	]
341
342	# Filter by 'active' status of linked part
343	active = rest_filters.BooleanFilter(field_name='part__active')
344
345	# Filter by the 'MPN' of linked manufacturer part
346	MPN = rest_filters.CharFilter(
347	label='Manufacturer Part Number',
348	field_name='manufacturer_part__MPN',
349	lookup_expr='iexact'
350	)
351
352
353	class SupplierPartList(ListCreateDestroyAPIView):
354	"""API endpoint for list view of SupplierPart object.
355
356	- GET: Return list of SupplierPart objects
357	- POST: Create a new SupplierPart object
358	"""
359
360	queryset = SupplierPart.objects.all().prefetch_related(	1✔
361	'tags',	1✔
362	)
363	filterset_class = SupplierPartFilter	1✔
364
365	def get_queryset(self, args, *kwargs):	1✔
366	"""Return annotated queryest object for the SupplierPart list"""
367	queryset = super().get_queryset(args, *kwargs)
368	queryset = SupplierPartSerializer.annotate_queryset(queryset)
369
370	return queryset
371
372	def filter_queryset(self, queryset):
373	"""Custom filtering for the queryset."""
374	queryset = super().filter_queryset(queryset)	1✔
375
376	params = self.request.query_params	1✔
377
378	# Filter by manufacturer
379	manufacturer = params.get('manufacturer', None)	1✔
380
381	if manufacturer is not None:	1✔
382	queryset = queryset.filter(manufacturer_part__manufacturer=manufacturer)	×
383
384	# Filter by EITHER manufacturer or supplier
385	company = params.get('company', None)	1✔
386
387	if company is not None:	1✔
NEW 388	queryset = queryset.filter(Q(manufacturer_part__manufacturer=company) \| Q(supplier=company)).distinct()	×
389
390	return queryset	1✔
391
392	def get_serializer(self, args, *kwargs):	1✔
393	"""Return serializer instance for this endpoint"""
394
395	# Do we wish to include extra detail?
396	try:
397	params = self.request.query_params
398	kwargs['part_detail'] = str2bool(params.get('part_detail', None))
399	kwargs['supplier_detail'] = str2bool(params.get('supplier_detail', True))
400	kwargs['manufacturer_detail'] = str2bool(params.get('manufacturer_detail', None))
401	kwargs['pretty'] = str2bool(params.get('pretty', None))
402	except AttributeError:
403	pass
404
405	kwargs['context'] = self.get_serializer_context()
406
407	return self.serializer_class(args, *kwargs)
408
409	serializer_class = SupplierPartSerializer
410
411	filter_backends = SEARCH_ORDER_FILTER_ALIAS
412
413	ordering_fields = [
414	'SKU',
415	'part',
416	'supplier',
417	'manufacturer',
418	'MPN',
419	'packaging',
420	'pack_quantity',
421	'in_stock',
422	'updated',
423	]
424
425	ordering_field_aliases = {
426	'part': 'part__name',
427	'supplier': 'supplier__name',
428	'manufacturer': 'manufacturer_part__manufacturer__name',
429	'MPN': 'manufacturer_part__MPN',
430	'pack_quantity': ['pack_quantity_native', 'pack_quantity'],
431	}
432
433	search_fields = [
434	'SKU',
435	'supplier__name',
436	'manufacturer_part__manufacturer__name',
437	'description',
438	'manufacturer_part__MPN',
439	'part__IPN',
440	'part__name',
441	'part__description',
442	'part__keywords',
443	'tags__name',
444	'tags__slug',
445	]
446
447
448	class SupplierPartDetail(RetrieveUpdateDestroyAPI):
449	"""API endpoint for detail view of SupplierPart object.
450
451	- GET: Retrieve detail view
452	- PATCH: Update object
453	- DELETE: Delete object
454	"""
455
456	queryset = SupplierPart.objects.all()	1✔
457	serializer_class = SupplierPartSerializer	1✔
458
459	read_only_fields = [	1✔
460	]
461
462
463	class SupplierPriceBreakFilter(rest_filters.FilterSet):	1✔
464	"""Custom API filters for the SupplierPriceBreak list endpoint"""
465
466	class Meta:
467	"""Metaclass options"""
468
469	model = SupplierPriceBreak	1✔
470	fields = [	1✔
471	'part',	1✔
472	'quantity',	1✔
473	]
474
475	base_part = rest_filters.ModelChoiceFilter(	1✔
476	label='Base Part',	1✔
477	queryset=part.models.Part.objects.all(),	1✔
478	field_name='part__part',	1✔
479	)
480
481	supplier = rest_filters.ModelChoiceFilter(	1✔
482	label='Supplier',	1✔
483	queryset=Company.objects.all(),	1✔
484	field_name='part__supplier',	1✔
485	)
486
487
488	class SupplierPriceBreakList(ListCreateAPI):	1✔
489	"""API endpoint for list view of SupplierPriceBreak object.
490
491	- GET: Retrieve list of SupplierPriceBreak objects
492	- POST: Create a new SupplierPriceBreak object
493	"""
494
495	queryset = SupplierPriceBreak.objects.all()	1✔
496	serializer_class = SupplierPriceBreakSerializer	1✔
497	filterset_class = SupplierPriceBreakFilter	1✔
498
499	def get_serializer(self, args, *kwargs):	1✔
500	"""Return serializer instance for this endpoint"""
501
502	try:
503	params = self.request.query_params
504
505	kwargs['part_detail'] = str2bool(params.get('part_detail', False))
506	kwargs['supplier_detail'] = str2bool(params.get('supplier_detail', False))
507
508	except AttributeError:
509	pass
510
511	kwargs['context'] = self.get_serializer_context()
512
513	return self.serializer_class(args, *kwargs)
514
515	filter_backends = ORDER_FILTER
516
517	ordering_fields = [
518	'quantity',
519	]
520
521	ordering = 'quantity'
522
523
524	class SupplierPriceBreakDetail(RetrieveUpdateDestroyAPI):
525	"""Detail endpoint for SupplierPriceBreak object."""
526
527	queryset = SupplierPriceBreak.objects.all()	1✔
528	serializer_class = SupplierPriceBreakSerializer	1✔
529
530
531	manufacturer_part_api_urls = [	1✔
532
533	# Base URL for ManufacturerPartAttachment API endpoints
534	re_path(r'^attachment/', include([	1✔
535	path(r'<int:pk>/', ManufacturerPartAttachmentDetail.as_view(), name='api-manufacturer-part-attachment-detail'),	1✔
536	re_path(r'^$', ManufacturerPartAttachmentList.as_view(), name='api-manufacturer-part-attachment-list'),	1✔
537	])),
538
539	re_path(r'^parameter/', include([	1✔
540	path(r'<int:pk>/', ManufacturerPartParameterDetail.as_view(), name='api-manufacturer-part-parameter-detail'),	1✔
541
542	# Catch anything else
543	re_path(r'^.*$', ManufacturerPartParameterList.as_view(), name='api-manufacturer-part-parameter-list'),	1✔
544	])),
545
546	re_path(r'^(?P<pk>\d+)/?', include([	1✔
547	re_path('^metadata/', MetadataView.as_view(), {'model': ManufacturerPart}, name='api-manufacturer-part-metadata'),	1✔
548	re_path('^.*$', ManufacturerPartDetail.as_view(), name='api-manufacturer-part-detail'),	1✔
549	])),
550
551	# Catch anything else
552	re_path(r'^.*$', ManufacturerPartList.as_view(), name='api-manufacturer-part-list'),	1✔
553	]
554
555
556	supplier_part_api_urls = [	1✔
557
558	re_path(r'^(?P<pk>\d+)/?', include([	1✔
559	re_path('^metadata/', MetadataView.as_view(), {'model': SupplierPart}, name='api-supplier-part-metadata'),	1✔
560	re_path('^.*$', SupplierPartDetail.as_view(), name='api-supplier-part-detail'),	1✔
561	])),
562
563	# Catch anything else
564	re_path(r'^.*$', SupplierPartList.as_view(), name='api-supplier-part-list'),	1✔
565	]
566
567
568	company_api_urls = [	1✔
569	re_path(r'^part/manufacturer/', include(manufacturer_part_api_urls)),	1✔
570
571	re_path(r'^part/', include(supplier_part_api_urls)),	1✔
572
573	# Supplier price breaks
574	re_path(r'^price-break/', include([	1✔
575
576	re_path(r'^(?P<pk>\d+)/?', SupplierPriceBreakDetail.as_view(), name='api-part-supplier-price-detail'),	1✔
577	re_path(r'^.*$', SupplierPriceBreakList.as_view(), name='api-part-supplier-price-list'),	1✔
578	])),
579
580	re_path(r'^(?P<pk>\d+)/?', include([	1✔
581	re_path(r'^metadata/', MetadataView.as_view(), {'model': Company}, name='api-company-metadata'),	1✔
582	re_path(r'^.*$', CompanyDetail.as_view(), name='api-company-detail'),	1✔
583	])),
584
585	re_path(r'^attachment/', include([	1✔
586	path(r'<int:pk>/', CompanyAttachmentDetail.as_view(), name='api-company-attachment-detail'),	1✔
587	re_path(r'^$', CompanyAttachmentList.as_view(), name='api-company-attachment-list'),	1✔
588	])),
589
590	re_path(r'^contact/', include([	1✔
591	re_path(r'^(?P<pk>\d+)/?', include([	1✔
592	re_path('^metadata/', MetadataView.as_view(), {'model': Contact}, name='api-contact-metadata'),	1✔
593	re_path('^.*$', ContactDetail.as_view(), name='api-contact-detail'),	1✔
594	])),
595	re_path(r'^.*$', ContactList.as_view(), name='api-contact-list'),	1✔
596	])),
597
598	re_path(r'^address/', include([	1✔
599	path('<int:pk>/', AddressDetail.as_view(), name='api-address-detail'),	1✔
600	re_path(r'^.*$', AddressList.as_view(), name='api-address-list'),	1✔
601	])),
602
603	re_path(r'^.*$', CompanyList.as_view(), name='api-company-list'),	1✔
604
605	]

inventree / InvenTree / 6872102289

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous