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/label/apps.py

@@ -1,3 +1,5 @@
+"""label app specification"""
+
 import hashlib
 import logging
 import os
@@ -14,10 +16,7 @@ logger = logging.getLogger("inventree")
 
 
 def hashFile(filename):
-    """
-    Calculate the MD5 hash of a file
-    """
-
+    """Calculate the MD5 hash of a file."""
     md5 = hashlib.md5()
 
     with open(filename, 'rb') as f:
@@ -28,20 +27,17 @@ def hashFile(filename):
 
 
 class LabelConfig(AppConfig):
+    """App configuration class for the 'label' app"""
+
     name = 'label'
 
     def ready(self):
-        """
-        This function is called whenever the label app is loaded
-        """
-
+        """This function is called whenever the label app is loaded."""
         if canAppAccessDatabase():
             self.create_labels()  # pragma: no cover
 
     def create_labels(self):
-        """
-        Create all default templates
-        """
+        """Create all default templates."""
         # Test if models are ready
         try:
             from .models import StockLocationLabel
@@ -56,11 +52,7 @@ class LabelConfig(AppConfig):
         self.create_part_labels()
 
     def create_stock_item_labels(self):
-        """
-        Create database entries for the default StockItemLabel templates,
-        if they do not already exist
-        """
-
+        """Create database entries for the default StockItemLabel templates, if they do not already exist."""
         from .models import StockItemLabel
 
         src_dir = os.path.join(
@@ -139,11 +131,7 @@ class LabelConfig(AppConfig):
             )
 
     def create_stock_location_labels(self):
-        """
-        Create database entries for the default StockItemLocation templates,
-        if they do not already exist
-        """
-
+        """Create database entries for the default StockItemLocation templates, if they do not already exist."""
         from .models import StockLocationLabel
 
         src_dir = os.path.join(
@@ -229,11 +217,7 @@ class LabelConfig(AppConfig):
             )
 
     def create_part_labels(self):
-        """
-        Create database entries for the default PartLabel templates,
-        if they do not already exist.
-        """
-
+        """Create database entries for the default PartLabel templates, if they do not already exist."""
         from .models import PartLabel
 
         src_dir = os.path.join(