Refactor attachment class (#234)

* Refactor attachment class

- Support legacy API
- Support modern API

* Update test process

- Skip steps we don't need

* Fix URL

* Simplify attachments model

- Min API version is now 207
- Just use a single Attachment table

* Fix docker compose file for testing

- Not sure why this was pinned at 0.12.8
- Latest and greatest, thanks!

* Cleanup unit tests

* Cleanup test_part.py

* Clean containers after run

* PEP style fixes

* Update unit tests

* Unit test updates

* More unit test updates

* Remove unused imports

* Unit test updates

* Debug statements

* Fix test call

* Tweak unit tests

- Skip attachment tests for older API version

* Bump version number

- Skip to 0.16.0
- Lines up with supported server version

* Skip test

Author: SchrodingersGat

inventree/api.py

@@ -22,7 +22,7 @@ class InvenTreeAPI(object):
     Basic class for performing Inventree API requests.
     """
 
-    MIN_SUPPORTED_API_VERSION = 51
+    MIN_SUPPORTED_API_VERSION = 206
 
     @staticmethod
     def getMinApiVersion():

inventree/base.py

@@ -3,11 +3,10 @@
 import json
 import logging
 import os
-from typing import Type
 
 from . import api as inventree_api
 
-INVENTREE_PYTHON_VERSION = "0.14.0"
+INVENTREE_PYTHON_VERSION = "0.16.0"
 
 
 logger = logging.getLogger('inventree')
@@ -19,6 +18,11 @@ class InventreeObject(object):
     # API URL (required) for the particular model type
     URL = ""
 
+    @classmethod
+    def get_url(cls, api):
+        """Helper method to get the URL associated with this model."""
+        return cls.URL
+
     # Minimum server version for the particular model type
     MIN_API_VERSION = None
     MAX_API_VERSION = None
@@ -85,7 +89,9 @@ def __init__(self, api, pk=None, data=None):
             if pk <= 0:
                 raise ValueError(f"Supplier <pk> value ({pk}) for {self.__class__} must be positive.")
 
-        self._url = f"{self.URL}/{pk}/"
+        url = self.get_url(api)
+
+        self._url = f"{url}/{pk}/"
         self._api = api
 
         if data is None:
@@ -374,9 +380,6 @@ def bulkDelete(cls, api: inventree_api.InvenTreeAPI, items=None, filters=None):
 
         """
 
-        if api.api_version < 58:
-            raise NotImplementedError("bulkDelete requires API version 58 or newer")
-
         if not items and not filters:
             raise ValueError("Must supply either 'items' or 'filters' argument")
 
@@ -395,14 +398,12 @@ def bulkDelete(cls, api: inventree_api.InvenTreeAPI, items=None, filters=None):
 
 
 class Attachment(BulkDeleteMixin, InventreeObject):
-    """
-    Class representing a file attachment object
+    """Class representing a file attachment object."""
 
-    Multiple sub-classes exist, representing various types of attachment models in the database.
-    """
+    URL = 'attachment/'
 
-    # Name of the primary key field of the InventreeObject the attachment will be attached to
-    ATTACH_TO = None
+    # Ref: https://github.com/inventree/InvenTree/pull/7420
+    MIN_API_VERSION = 207
 
     @classmethod
     def add_link(cls, api, link, comment="", **kwargs):
@@ -420,9 +421,6 @@ def add_link(cls, api, link, comment="", **kwargs):
         data["comment"] = comment
         data["link"] = link
 
-        if cls.ATTACH_TO not in kwargs:
-            raise ValueError(f"Required argument '{cls.ATTACH_TO}' not supplied to add_link method")
-
         if response := api.post(cls.URL, data):
             logger.info(f"Link attachment added to {cls.URL}")
         else:
@@ -446,18 +444,14 @@ def upload(cls, api, attachment, comment='', **kwargs):
         data = kwargs
         data['comment'] = comment
 
-        if cls.ATTACH_TO not in kwargs:
-            raise ValueError(f"Required argument '{cls.ATTACH_TO}' not supplied to upload method")
-
         if type(attachment) is str:
             if not os.path.exists(attachment):
                 raise FileNotFoundError(f"Attachment file '{attachment}' does not exist")
 
             # Load the file as an in-memory file object
             with open(attachment, 'rb') as fo:
-
                 response = api.post(
-                    cls.URL,
+                    Attachment.URL,
                     data,
                     files={
                         'attachment': (os.path.basename(attachment), fo),
@@ -467,8 +461,9 @@ def upload(cls, api, attachment, comment='', **kwargs):
         else:
             # Assumes a StringIO or BytesIO like object
             name = getattr(attachment, 'name', 'filename')
+
             response = api.post(
-                cls.URL,
+                Attachment.URL,
                 data,
                 files={
                     'attachment': (name, attachment),
@@ -490,47 +485,44 @@ def download(self, destination, **kwargs):
         return self._api.downloadFile(self.attachment, destination, **kwargs)
 
 
-def AttachmentMixin(AttachmentSubClass: Type[Attachment]):
-    class Mixin(Attachment):
-        def getAttachments(self):
-            return AttachmentSubClass.list(
-                self._api,
-                **{AttachmentSubClass.ATTACH_TO: self.pk},
-            )
+class AttachmentMixin:
+    """Mixin class which allows a model class to interact with attachments."""
 
-        def uploadAttachment(self, attachment, comment=""):
-            """
-            Upload an attachment (file) against this Object.
+    def getAttachments(self):
+        """Return a list of attachments associated with this object."""
 
-            Args:
-                attachment: Either a string (filename) or a file object
-                comment: Attachment comment
-            """
+        return Attachment.list(
+            self._api,
+            model_type=self.getModelType(),
+            model_id=self.pk
+        )
 
-            return AttachmentSubClass.upload(
-                self._api,
-                attachment,
-                comment=comment,
-                **{AttachmentSubClass.ATTACH_TO: self.pk},
-            )
+    def uploadAttachment(self, attachment, comment=""):
+        """Upload a file attachment against this model instance."""
+
+        return Attachment.upload(
+            self._api,
+            attachment,
+            comment=comment,
+            model_type=self.getModelType(),
+            model_id=self.pk
+        )
 
-        def addLinkAttachment(self, link, comment=""):
-            """
-            Add an external link attachment against this Object.
-
-            Args:
-                link: The link to attach
-                comment: Attachment comment
-            """
-
-            return AttachmentSubClass.add_link(
-                self._api,
-                link,
-                comment=comment,
-                **{AttachmentSubClass.ATTACH_TO: self.pk},
-            )
+    def addLinkAttachment(self, link, comment=""):
+        """Add an external link attachment against this Object.
 
-    return Mixin
+        Args:
+            link: The link to attach
+            comment: Attachment comment
+        """
+
+        return Attachment.add_link(
+            self._api,
+            link,
+            comment=comment,
+            model_type=self.getModelType(),
+            model_id=self.pk
+        )
 
 
 class MetadataMixin:
@@ -553,10 +545,6 @@ def getMetadata(self):
         """Read model instance metadata"""
         if self._api:
 
-            if self._api.api_version < 49:
-                logger.error("API version 49 or newer required to access instance metadata")
-                return {}
-
             response = self._api.get(self.metadata_url)
 
             return response['metadata']
@@ -576,10 +564,6 @@ def setMetadata(self, data, overwrite=False):
 
         if self._api:
 
-            if self._api.api_version < 49:
-                logger.error("API version 49 or newer required to access instance metadata")
-                return None
-
             if overwrite:
                 return self._api.put(
                     self.metadata_url,

inventree/build.py

@@ -4,15 +4,8 @@
 import inventree.report
 
 
-class BuildAttachment(inventree.base.Attachment):
-    """Class representing an attachment against a Build object"""
-
-    URL = 'build/attachment'
-    ATTACH_TO = 'build'
-
-
 class Build(
-    inventree.base.AttachmentMixin(BuildAttachment),
+    inventree.base.AttachmentMixin,
     inventree.base.StatusMixin,
     inventree.base.MetadataMixin,
     inventree.report.ReportPrintingMixin,
@@ -23,10 +16,6 @@ class Build(
     URL = 'build'
     MODEL_TYPE = 'build'
 
-    # Setup for Report mixin
-    REPORTNAME = 'build'
-    REPORTITEM = 'build'
-
     def complete(
         self,
         accept_overallocated='reject',

inventree/company.py

@@ -26,6 +26,7 @@ class Company(inventree.base.ImageMixin, inventree.base.MetadataMixin, inventree
     """ Class representing the Company database model """
 
     URL = 'company'
+    MODEL_TYPE = "company"
 
     def getContacts(self, **kwargs):
         """Return contacts associated with this Company"""
@@ -110,15 +111,8 @@ def getPriceBreaks(self):
         return SupplierPriceBreak.list(self._api, part=self.pk)
 
 
-class ManufacturerPartAttachment(inventree.base.Attachment):
-    """Class representing an attachment against a ManufacturerPart object"""
-
-    URL = 'company/part/manufacturer/attachment'
-    ATTACH_TO = 'manufacturer_part'
-
-
 class ManufacturerPart(
-    inventree.base.AttachmentMixin(ManufacturerPartAttachment),
+    inventree.base.AttachmentMixin,
     inventree.base.BulkDeleteMixin,
     inventree.base.MetadataMixin,
     inventree.base.InventreeObject,
@@ -129,6 +123,7 @@ class ManufacturerPart(
     """
 
     URL = 'company/part/manufacturer'
+    MODEL_TYPE = "manufacturerpart"
 
     def getParameters(self, **kwargs):
         """

inventree/currency.py

@@ -23,17 +23,11 @@ def __init__(self, api):
     def refreshExchangeRates(self):
         """Request the server update exchange rates from external service"""
 
-        if self.api.api_version < 93:
-            raise ValueError(f"Server API version ({self.api.api_version}) is older than v93, which is required for manual exchange rate updates")
-
         return self.api.post('currency/refresh/', {})
 
     def updateFromServer(self):
         """Retrieve currency data from the server"""
 
-        if self.api.api_version < 92:
-            raise ValueError(f"Server API version ({self.api.api_version}) is older than v92, which is required for currency support")
-
         response = self.api.get(self.CURRENCY_ENDPOINT)
 
         if response is None: