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/test_sales_order.py

@@ -1,4 +1,4 @@
-# -*- coding: utf-8 -*-
+"""Unit tests for the SalesOrder models"""
 
 from datetime import datetime, timedelta
 
@@ -15,13 +15,10 @@ from stock.models import StockItem
 
 
 class SalesOrderTest(TestCase):
-    """
-    Run tests to ensure that the SalesOrder model is working correctly.
-
-    """
+    """Run tests to ensure that the SalesOrder model is working correctly."""
 
     def setUp(self):
-
+        """Initial setup for this set of unit tests"""
         # Create a Company to ship the goods to
         self.customer = Company.objects.create(name="ABC Co", description="My customer", is_customer=True)
 
@@ -48,11 +45,21 @@ class SalesOrderTest(TestCase):
         # Create a line item
         self.line = SalesOrderLineItem.objects.create(quantity=50, order=self.order, part=self.part)
 
-    def test_overdue(self):
-        """
-        Tests for overdue functionality
-        """
+    def test_rebuild_reference(self):
+        """Test that the 'reference_int' field gets rebuilt when the model is saved"""
 
+        self.assertEqual(self.order.reference_int, 1234)
+
+        self.order.reference = '999'
+        self.order.save()
+        self.assertEqual(self.order.reference_int, 999)
+
+        self.order.reference = '1000K'
+        self.order.save()
+        self.assertEqual(self.order.reference_int, 1000)
+
+    def test_overdue(self):
+        """Tests for overdue functionality."""
         today = datetime.now().date()
 
         # By default, order is *not* overdue as the target date is not set
@@ -69,6 +76,7 @@ class SalesOrderTest(TestCase):
         self.assertFalse(self.order.is_overdue)
 
     def test_empty_order(self):
+        """Test for an empty order"""
         self.assertEqual(self.line.quantity, 50)
         self.assertEqual(self.line.allocated_quantity(), 0)
         self.assertEqual(self.line.fulfilled_quantity(), 0)
@@ -79,14 +87,13 @@ class SalesOrderTest(TestCase):
         self.assertFalse(self.order.is_fully_allocated())
 
     def test_add_duplicate_line_item(self):
-        # Adding a duplicate line item to a SalesOrder is accepted
+        """Adding a duplicate line item to a SalesOrder is accepted"""
 
         for ii in range(1, 5):
             SalesOrderLineItem.objects.create(order=self.order, part=self.part, quantity=ii)
 
     def allocate_stock(self, full=True):
-
-        # Allocate stock to the order
+        """Allocate stock to the order"""
         SalesOrderAllocation.objects.create(
             line=self.line,
             shipment=self.shipment,
@@ -101,7 +108,7 @@ class SalesOrderTest(TestCase):
         )
 
     def test_allocate_partial(self):
-        # Partially allocate stock
+        """Partially allocate stock"""
         self.allocate_stock(False)
 
         self.assertFalse(self.order.is_fully_allocated())
@@ -110,7 +117,7 @@ class SalesOrderTest(TestCase):
         self.assertEqual(self.line.fulfilled_quantity(), 0)
 
     def test_allocate_full(self):
-        # Fully allocate stock
+        """Fully allocate stock"""
         self.allocate_stock(True)
 
         self.assertTrue(self.order.is_fully_allocated())
@@ -118,8 +125,7 @@ class SalesOrderTest(TestCase):
         self.assertEqual(self.line.allocated_quantity(), 50)
 
     def test_order_cancel(self):
-        # Allocate line items then cancel the order
-
+        """Allocate line items then cancel the order"""
         self.allocate_stock(True)
 
         self.assertEqual(SalesOrderAllocation.objects.count(), 2)
@@ -137,8 +143,7 @@ class SalesOrderTest(TestCase):
         self.assertFalse(result)
 
     def test_complete_order(self):
-        # Allocate line items, then ship the order
-
+        """Allocate line items, then ship the order"""
         # Assert some stuff before we run the test
         # Initially there are two stock items
         self.assertEqual(StockItem.objects.count(), 2)
@@ -199,8 +204,7 @@ class SalesOrderTest(TestCase):
         self.assertEqual(self.line.allocated_quantity(), 50)
 
     def test_default_shipment(self):
-        # Test sales order default shipment creation
-
+        """Test sales order default shipment creation"""
         # Default setting value should be False
         self.assertEqual(False, InvenTreeSetting.get_setting('SALESORDER_DEFAULT_SHIPMENT'))