Add custom Flake8 plugin

Create a new python project for flake8 plugins, currently only containing
a plugin to test for unsafe usage of models with visibility

Dockerfile

@@ -22,6 +22,7 @@ RUN apt-get update && apt-get install -y \
     curl build-essential git \
  && rm -rf /var/lib/apt/lists/*
 
+COPY ./flake8-thunderstore/ /flake8-thunderstore
 COPY ./python-packages/ /python-packages
 COPY ./django/pyproject.toml ./django/poetry.lock /app/
 

django/pyproject.toml

@@ -70,6 +70,7 @@ flake8-comprehensions = "^3.3.1"
 flake8-pie = "^0.6.1"
 flake8-printf-formatting = "^1.1.0"
 flake8-pytest-style = "^1.3.0"
+flake8-thunderstore = { path = "../flake8-thunderstore", develop = true }
 pep8-naming = "^0.11.1"
 watchdog = {extras = ["watchmedo"], version = "^1.0.2"}
 mypy-boto3-s3 = "^1.17.47"

flake8-thunderstore/flake8_thunderstore/__init__.py

@@ -0,0 +1 @@
+from .visibility_coding_conventions import VisibilityCodingConventions

flake8-thunderstore/flake8_thunderstore/visibility_coding_conventions.py

@@ -0,0 +1,36 @@
+import ast
+
+from flake8_plugin_utils import Plugin
+
+
+class VisibilityCodingConventions(Plugin):
+    name = "visibility-coding-conventions"
+    version = "1.0.1"
+
+    visibility_classes = ["PackageListing", "PackageVersion"]
+    safe_functions = ["public_list", "system", "get", "create", "get_or_create"]
+    excluded_filepaths = ["/migrations/", "/tests/", "/commands/", "/conftest.py"]
+
+    def __init__(self, tree: ast.AST, filename: str) -> None:
+        self.tree = tree
+        self.filename = filename
+
+    def run(self):
+        if any(excluded in self.filename for excluded in self.excluded_filepaths):
+            return
+
+        for node in ast.walk(self.tree):
+            if (
+                isinstance(node, ast.Attribute)
+                and isinstance(node.value, ast.Attribute)
+                and node.value.attr == "objects"
+                and isinstance(node.value.value, ast.Name)
+                and node.value.value.id in self.visibility_classes
+                and node.attr not in self.safe_functions
+            ):
+                yield (
+                    node.lineno,
+                    node.col_offset,
+                    f"VIS753 {node.value.value.id}.objects.{node.attr} is unsafe; Objects with visibility should always be called with .public_list() or .system())",
+                    type(self),
+                )

flake8-thunderstore/pyproject.toml

@@ -0,0 +1,18 @@
+[tool.poetry]
+name = "flake8-thunderstore"
+version = "1.0.2"
+description = "Custom Flake8 plugins for Thunderstore"
+authors = ["753 <[email protected]>"]
+packages = [
+    { include = "flake8_thunderstore" },
+]
+
+[tool.poetry.dependencies]
+python = "*"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.plugins."flake8.extension"]
+VIS = 'flake8_thunderstore.visibility_coding_conventions:VisibilityCodingConventions'