Docstring checks in QC checks (#3089)

* Add pre-commit to the stack

* exclude static

* Add locales to excludes

* fix style errors

* rename pipeline steps

* also wait on precommit

* make template matching simpler

* Use the same code for python setup everywhere

* use step and cache for python setup

* move regular settings up into general envs

* just use full update

* Use invoke instead of static references

* make setup actions more similar

* use python3

* refactor names to be similar

* fix runner version

* fix references

* remove incidential change

* use matrix for os

* Github can't do this right now

* ignore docstyle errors

* Add seperate docstring test

* update flake call

* do not fail on docstring

* refactor setup into workflow

* update reference

* switch to action

* resturcture

* add bash statements

* remove os from cache

* update input checks

* make code cleaner

* fix boolean

* no relative paths

* install wheel by python

* switch to install

* revert back to simple wheel

* refactor import export tests

* move setup keys back to not disturbe tests

* remove docstyle till that is fixed

* update references

* continue on error

* add docstring test

* use relativ action references

* Change step / job docstrings

* update to merge

* reformat comments 1

* fix docstrings 2

* fix docstrings 3

* fix docstrings 4

* fix docstrings 5

* fix docstrings 6

* fix docstrings 7

* fix docstrings 8

* fix docstirns 9

* fix docstrings 10

* docstring adjustments

* update the remaining docstrings

* small docstring changes

* fix function name

* update support files for docstrings

* Add missing args to docstrings

* Remove outdated function

* Add docstrings for the 'build' app

* Make API code cleaner

* add more docstrings for plugin app

* Remove dead code for plugin settings
No idea what that was even intended for

* ignore __init__ files for docstrings

* More docstrings

* Update docstrings for the 'part' directory

* Fixes for related_part functionality

* Fix removed stuff from merge 99676ee

* make more consistent

* Show statistics for docstrings

* add more docstrings

* move specific register statements to make them clearer to understant

* More docstrings for common

* and more docstrings

* and more

* simpler call

* docstrings for notifications

* docstrings for common/tests

* Add docs for common/models

* Revert "move specific register statements to make them clearer to understant"

This reverts commit ca96654622.

* use typing here

* Revert "Make API code cleaner"

This reverts commit 24fb68bd3e.

* docstring updates for the 'users' app

* Add generic Meta info to simple Meta classes

* remove unneeded unique_together statements

* More simple metas

* Remove unnecessary format specifier

* Remove extra json format specifiers

* Add docstrings for the 'plugin' app

* Docstrings for the 'label' app

* Add missing docstrings for the 'report' app

* Fix build test regression

* Fix top-level files

* docstrings for InvenTree/InvenTree

* reduce unneeded code

* add docstrings

* and more docstrings

* more docstrings

* more docstrings for stock

* more docstrings

* docstrings for order/views

* Docstrings for various files in the 'order' app

* Docstrings for order/test_api.py

* Docstrings for order/serializers.py

* Docstrings for order/admin.py

* More docstrings for the order app

* Add docstrings for the 'company' app

* Add unit tests for rebuilding the reference fields

* Prune out some more dead code

* remove more dead code

Co-authored-by: Oliver Walters <oliver.henry.walters@gmail.com>

InvenTree/order/tests.py

@@ -1,4 +1,4 @@
-# -*- coding: utf-8 -*-
+"""Various unit tests for order models"""
 
 from datetime import datetime, timedelta
 
@@ -14,9 +14,7 @@ from .models import PurchaseOrder, PurchaseOrderLineItem
 
 
 class OrderTest(TestCase):
-    """
-    Tests to ensure that the order models are functioning correctly.
-    """
+    """Tests to ensure that the order models are functioning correctly."""
 
     fixtures = [
         'company',
@@ -30,8 +28,7 @@ class OrderTest(TestCase):
     ]
 
     def test_basics(self):
-        """ Basic tests e.g. repr functions etc """
-
+        """Basic tests e.g. repr functions etc."""
         order = PurchaseOrder.objects.get(pk=1)
 
         self.assertEqual(order.get_absolute_url(), '/order/purchase-order/1/')
@@ -42,11 +39,19 @@ class OrderTest(TestCase):
 
         self.assertEqual(str(line), "100 x ACME0001 from ACME (for PO0001 - ACME)")
 
-    def test_overdue(self):
-        """
-        Test overdue status functionality
-        """
+    def test_rebuild_reference(self):
+        """Test that the reference_int field is correctly updated when the model is saved"""
 
+        order = PurchaseOrder.objects.get(pk=1)
+        order.save()
+        self.assertEqual(order.reference_int, 1)
+
+        order.reference = '12345XYZ'
+        order.save()
+        self.assertEqual(order.reference_int, 12345)
+
+    def test_overdue(self):
+        """Test overdue status functionality."""
         today = datetime.now().date()
 
         order = PurchaseOrder.objects.get(pk=1)
@@ -61,8 +66,7 @@ class OrderTest(TestCase):
         self.assertFalse(order.is_overdue)
 
     def test_on_order(self):
-        """ There should be 3 separate items on order for the M2x4 LPHS part """
-
+        """There should be 3 separate items on order for the M2x4 LPHS part."""
         part = Part.objects.get(name='M2x4 LPHS')
 
         open_orders = []
@@ -76,8 +80,7 @@ class OrderTest(TestCase):
         self.assertEqual(part.on_order, 1400)
 
     def test_add_items(self):
-        """ Test functions for adding line items to an order """
-
+        """Test functions for adding line items to an order."""
         order = PurchaseOrder.objects.get(pk=1)
 
         self.assertEqual(order.status, PurchaseOrderStatus.PENDING)
@@ -113,8 +116,7 @@ class OrderTest(TestCase):
             order.add_line_item(sku, 99)
 
     def test_pricing(self):
-        """ Test functions for adding line items to an order including price-breaks """
-
+        """Test functions for adding line items to an order including price-breaks."""
         order = PurchaseOrder.objects.get(pk=7)
 
         self.assertEqual(order.status, PurchaseOrderStatus.PENDING)
@@ -146,8 +148,7 @@ class OrderTest(TestCase):
         self.assertEqual(order.lines.first().purchase_price.amount, 1.25)
 
     def test_receive(self):
-        """ Test order receiving functions """
-
+        """Test order receiving functions."""
         part = Part.objects.get(name='M2x4 LPHS')
 
         # Receive some items