Merge branch 'master' of github.com:inventree/inventree-python

Author: SchrodingersGat

.github/workflows/ci.yaml

@@ -8,17 +8,21 @@ jobs:
 
     env:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      INVENTREE_SITE_URL: http://localhost:8000
       INVENTREE_DB_ENGINE: django.db.backends.sqlite3
       INVENTREE_DB_NAME: ../inventree_unit_test_db.sqlite3
       INVENTREE_MEDIA_ROOT: ../test_inventree_media
       INVENTREE_STATIC_ROOT: ../test_inventree_static
       INVENTREE_BACKUP_DIR: ../test_inventree_backup
+      INVENTREE_COOKIE_SAMESITE: False
       INVENTREE_ADMIN_USER: testuser
       INVENTREE_ADMIN_PASSWORD: testpassword
       INVENTREE_ADMIN_EMAIL: [email protected]
       INVENTREE_PYTHON_TEST_SERVER: http://localhost:12345
       INVENTREE_PYTHON_TEST_USERNAME: testuser
       INVENTREE_PYTHON_TEST_PASSWORD: testpassword
+      INVENTREE_DEBUG: True
+      INVENTREE_LOG_LEVEL: DEBUG
 
     strategy:
       max-parallel: 4
@@ -43,8 +47,8 @@ jobs:
           cd inventree_server
           invoke install
           invoke migrate
-          invoke import-fixtures
-          invoke server -a 127.0.0.1:12345 &
+          invoke dev.import-fixtures
+          invoke dev.server -a 0.0.0.0:12345 &
           invoke wait
       - name: Run Tests
         run: |

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():
@@ -46,6 +46,7 @@ def __init__(self, host=None, **kwargs):
             token-name - Name of the token to use (default = 'inventree-python-client')
             use_token_auth - Use token authentication? (default = True)
             verbose - Print extra debug messages (default = False)
+            strict - Enforce strict HTTPS certificate checking (default = True)
             timeout - Set timeout to use (in seconds). Default: 10
             proxies - Definition of proxies as a dict (defaults to an empty dict)
 
@@ -66,6 +67,7 @@ def __init__(self, host=None, **kwargs):
         self.token_name = kwargs.get('token_name', os.environ.get('INVENTREE_API_TOKEN_NAME', 'inventree-python-client'))
         self.timeout = kwargs.get('timeout', os.environ.get('INVENTREE_API_TIMEOUT', 10))
         self.proxies = kwargs.get('proxies', dict())
+        self.strict = bool(kwargs.get('strict', True))
 
         self.use_token_auth = kwargs.get('use_token_auth', True)
         self.verbose = kwargs.get('verbose', False)
@@ -194,7 +196,12 @@ def testServer(self):
         logger.info("Checking InvenTree server connection...")
 
         try:
-            response = requests.get(self.api_url, timeout=self.timeout, proxies=self.proxies)
+            response = requests.get(
+                self.api_url,
+                timeout=self.timeout,
+                proxies=self.proxies,
+                verify=self.strict
+            )
         except requests.exceptions.ConnectionError as e:
             logger.fatal(f"Server connection error: {str(type(e))}")
             return False
@@ -326,6 +333,9 @@ def request(self, api_url, **kwargs):
         else:
             payload['json'] = data
 
+        # Enforce strict HTTPS certificate checking?
+        payload['verify'] = self.strict
+
         # Debug request information
         logger.debug("Sending Request:")
         logger.debug(f" - URL: {method} {api_url}")
@@ -578,13 +588,15 @@ def downloadFile(self, url, destination, overwrite=False, params=None, proxies=d
             auth = self.auth
 
         with requests.get(
-                fullurl,
-                stream=True,
-                auth=auth,
-                headers=headers,
-                params=params,
-                timeout=self.timeout,
-                proxies=self.proxies) as response:
+            fullurl,
+            stream=True,
+            auth=auth,
+            headers=headers,
+            params=params,
+            timeout=self.timeout,
+            proxies=self.proxies,
+            verify=self.strict,
+        ) as response:
 
             # Error code
             if response.status_code >= 300:

inventree/base.py

@@ -2,12 +2,12 @@
 
 import json
 import logging
+import requests
 import os
-from typing import Type
 
 from . import api as inventree_api
 
-INVENTREE_PYTHON_VERSION = "0.14.0"
+INVENTREE_PYTHON_VERSION = "0.17.4"
 
 
 logger = logging.getLogger('inventree')
@@ -19,6 +19,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 +90,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:
@@ -225,10 +232,21 @@ def list(cls, api, **kwargs):
         else:
             url = cls.URL
 
-        response = api.get(url=url, params=kwargs)
+        try:
+            response = api.get(url=url, params=kwargs)
+        except requests.exceptions.HTTPError as e:
+            logger.error(f"Error during list request: {e}")
+            # Return an empty list
+
+            raise_error = kwargs.get('raise_error', False)
+
+            if raise_error:
+                raise e
+            else:
+                return []
 
         if response is None:
-            return None
+            return []
 
         items = []
 
@@ -374,9 +392,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 +410,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 +433,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 +456,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 +473,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 +497,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 +557,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 +576,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,
@@ -664,6 +660,7 @@ def _statusupdate(self, status: str, reload=True, data=None, **kwargs):
         if status not in [
             'complete',
             'cancel',
+            'hold',
             'ship',
             'issue',
             'finish',

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,9 +16,13 @@ class Build(
     URL = 'build'
     MODEL_TYPE = 'build'
 
-    # Setup for Report mixin
-    REPORTNAME = 'build'
-    REPORTITEM = 'build'
+    def issue(self):
+        """Mark this build as 'issued'."""
+        return self._statusupdate(status='issue')
+    
+    def hold(self):
+        """Mark this build as 'on hold'."""
+        return self._statusupdate(status='hold')
 
     def complete(
         self,