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/plugin/samples/event/event_sample.py

@@ -1,6 +1,4 @@
-"""
-Sample plugin which responds to events
-"""
+"""Sample plugin which responds to events."""
 
 import warnings
 
@@ -11,17 +9,14 @@ from plugin.mixins import EventMixin
 
 
 class EventPluginSample(EventMixin, InvenTreePlugin):
-    """
-    A sample plugin which provides supports for triggered events
-    """
+    """A sample plugin which provides supports for triggered events."""
 
     NAME = "EventPlugin"
     SLUG = "sampleevent"
     TITLE = "Triggered Events"
 
     def process_event(self, event, *args, **kwargs):
-        """ Custom event processing """
-
+        """Custom event processing."""
         print(f"Processing triggered event: '{event}'")
         print("args:", str(args))
         print("kwargs:", str(kwargs))

InvenTree/plugin/samples/event/test_event_sample.py

@@ -1,4 +1,4 @@
-"""Unit tests for event_sample sample plugins"""
+"""Unit tests for event_sample sample plugins."""
 
 from django.conf import settings
 from django.test import TestCase
@@ -10,10 +10,10 @@ from plugin.mixins import EventMixin
 
 
 class EventPluginSampleTests(TestCase):
-    """Tests for EventPluginSample"""
+    """Tests for EventPluginSample."""
 
     def test_run_event(self):
-        """Check if the event is issued"""
+        """Check if the event is issued."""
         # Activate plugin
         config = registry.get_plugin('sampleevent').plugin_config()
         config.active = True
@@ -30,8 +30,7 @@ class EventPluginSampleTests(TestCase):
         settings.PLUGIN_TESTING_EVENTS = False
 
     def test_mixin(self):
-        """Test that MixinNotImplementedError is raised"""
-
+        """Test that MixinNotImplementedError is raised."""
         with self.assertRaises(MixinNotImplementedError):
             class Wrong(EventMixin, InvenTreePlugin):
                 pass