Merge #144 - add black and isort

Author: MarkKoz

Diff for: .flake8

@@ -1,15 +1,12 @@
 [flake8]
 allow-untyped-nested = true
-application_import_names = snekbox
 docstring-convention = all
-import-order-style = pycharm
-inline-quotes = "
 max-line-length = 100
 
 exclude = __pycache__,.cache,user_base,venv,.venv,snekbox/config_pb2.py
 
 ignore =
-    W503,
+    E203, W503,
     # Missing Docstrings
     D100,D104,D105,D107,
     # Docstring Whitespace

Diff for: .github/workflows/test.yaml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-20.04, self-hosted]
+        os: [ubuntu-20.04, ubuntu-22.04]
 
     steps:
       - name: Download image artifact
@@ -53,17 +53,9 @@ jobs:
           path: .coverage.*
           retention-days: 1
 
-      # Self-hosted runner needs containers, images, networks, volumes, etc.
-      # removed because they persist across runs and may interfere.
-      - name: Docker cleanup
-        if: matrix.os == 'self-hosted' && always()
-        run: |
-          export IMAGE_SUFFIX='-venv:${{ inputs.version }}'
-          docker-compose down --rmi all --remove-orphans -v -t 0
-
   report:
     name: Report coverage
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     needs: test
 
     steps:

Diff for: .pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.4.0
+    rev: v4.2.0
     hooks:
       - id: check-merge-conflict
       - id: check-toml
@@ -9,26 +9,31 @@ repos:
       - id: trailing-whitespace
         args: [--markdown-linebreak-ext=md]
   - repo: https://github.com/pre-commit/pygrep-hooks
-    rev: v1.6.0
+    rev: v1.9.0
     hooks:
       - id: python-check-blanket-noqa
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.10.1
+    hooks:
+      - id: isort
+  - repo: https://github.com/psf/black
+    rev: 22.3.0
+    hooks:
+      - id: black
+        language_version: "3.10"
   - repo: https://github.com/PyCQA/flake8
-    rev: &flake8_version 3.8.4
+    rev: &flake8_version 4.0.1
     hooks:
       - &flake8_hook
         id: flake8
         additional_dependencies:
-          - flake8-annotations~=2.5.0
-          - flake8-bugbear~=20.11
-          - flake8-docstrings~=1.5
-          - flake8-formatter-junit-xml~=0.0.6
-          - flake8-import-order~=0.18.1
-          - flake8-quotes~=3.2
+          - flake8-annotations~=2.7
+          - flake8-bugbear==22.4.25
+          - flake8-docstrings~=1.4
           - flake8-string-format~=0.3.0
-          - flake8-tidy-imports~=4.2
           - flake8-todo~=0.7
-          - pep8-naming~=0.11.1
-          - pydocstyle~=5.1
+          - pep8-naming~=0.12.1
+          - pydocstyle~=6.1,!=6.1.0
   - repo: https://github.com/PyCQA/flake8
     rev: *flake8_version
     hooks:

Diff for: docker-compose.yml

@@ -6,6 +6,7 @@ services:
     hostname: snekbox_dev
     privileged: true
     image: ghcr.io/python-discord/snekbox${IMAGE_SUFFIX:--venv:dev}
+    pull_policy: never
     ports:
      - 8060:8060
     init: true

Diff for: pyproject.toml

@@ -59,8 +59,17 @@ exclude_lines = [
 branch = true
 data_file = "${COVERAGE_DATAFILE-.coverage}"
 include = ["snekbox/*"]
-omit =  [
-    "snekbox/api/app.py",
-    "snekbox/config_pb2.py"
-]
+omit =  ["snekbox/config_pb2.py"]
 relative_files = true
+
+[tool.black]
+line-length = 100
+target-version = ["py310"]
+force-exclude = ["snekbox/config_pb2.py"]
+
+[tool.isort]
+line_length = 100
+profile = "black"
+skip_gitignore = true
+src_paths = ["snekbox"]
+extend_skip = ["snekbox/config_pb2.py"]

Diff for: snekbox/__main__.py

@@ -27,7 +27,7 @@ def parse_args() -> argparse.Namespace:
         # Can't use double dash because that has special semantics for argparse already.
         split = unknown.index("---")
         args.nsjail_args = unknown[:split]
-        args.py_args = unknown[split + 1:]
+        args.py_args = unknown[split + 1 :]
     except ValueError:
         args.nsjail_args = unknown
 

Diff for: snekbox/api/resources/eval.py

@@ -23,19 +23,10 @@ class EvalResource:
     REQ_SCHEMA = {
         "type": "object",
         "properties": {
-            "input": {
-                "type": "string"
-            },
-            "args": {
-                "type": "array",
-                "items": {
-                    "type": "string"
-                }
-            }
+            "input": {"type": "string"},
+            "args": {"type": "array", "items": {"type": "string"}},
         },
-        "required": [
-            "input"
-        ]
+        "required": ["input"],
     }
 
     def __init__(self):
@@ -91,7 +82,4 @@ def on_post(self, req: falcon.Request, resp: falcon.Response) -> None:
             log.exception("An exception occurred while trying to process the request")
             raise falcon.HTTPInternalServerError
 
-        resp.media = {
-            "stdout": result.stdout,
-            "returncode": result.returncode
-        }
+        resp.media = {"stdout": result.stdout, "returncode": result.returncode}

Diff for: snekbox/nsjail.py

@@ -133,11 +133,7 @@ def _consume_stdout(nsjail: subprocess.Popen) -> str:
         return "".join(output)
 
     def python3(
-        self,
-        code: str,
-        *,
-        nsjail_args: Iterable[str] = (),
-        py_args: Iterable[str] = ("-c",)
+        self, code: str, *, nsjail_args: Iterable[str] = (), py_args: Iterable[str] = ("-c",)
     ) -> CompletedProcess:
         """
         Execute Python 3 code in an isolated environment and return the completed process.
@@ -153,17 +149,26 @@ def python3(
 
         if self.ignore_swap_limits:
             nsjail_args = (
-                "--cgroup_mem_memsw_max", "0", "--cgroup_mem_swap_max", "-1", *nsjail_args
+                "--cgroup_mem_memsw_max",
+                "0",
+                "--cgroup_mem_swap_max",
+                "-1",
+                *nsjail_args,
             )
 
         with NamedTemporaryFile() as nsj_log:
             args = (
                 self.nsjail_binary,
-                "--config", NSJAIL_CFG,
-                "--log", nsj_log.name,
+                "--config",
+                NSJAIL_CFG,
+                "--log",
+                nsj_log.name,
                 *nsjail_args,
                 "--",
-                self.config.exec_bin.path, *self.config.exec_bin.arg, *py_args, code
+                self.config.exec_bin.path,
+                *self.config.exec_bin.arg,
+                *py_args,
+                code,
             )
 
             msg = "Executing code..."
@@ -173,10 +178,7 @@ def python3(
 
             try:
                 nsjail = subprocess.Popen(
-                    args,
-                    stdout=subprocess.PIPE,
-                    stderr=subprocess.STDOUT,
-                    text=True
+                    args, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, text=True
                 )
             except ValueError:
                 return CompletedProcess(args, None, "ValueError: embedded null byte", None)

Diff for: snekbox/utils/cgroup.py

@@ -19,7 +19,7 @@ def get_version(config: NsJailConfig) -> int:
         config.cgroup_mem_mount,
         config.cgroup_pids_mount,
         config.cgroup_net_cls_mount,
-        config.cgroup_cpu_mount
+        config.cgroup_cpu_mount,
     )
     v1_exists = any(Path(mount).exists() for mount in cgroup_mounts)
 

Diff for: snekbox/utils/gunicorn.py

@@ -4,6 +4,7 @@
 from gunicorn.config import Config
 
 from snekbox import DEBUG
+
 from .logging import FORMAT
 
 __all__ = ("GunicornLogger",)

Diff for: snekbox/utils/logging.py

@@ -5,7 +5,6 @@
 
 from falcon.util.deprecation import DeprecatedWarning
 
-
 __all__ = ("FORMAT", "init_logger", "init_sentry")
 
 FORMAT = "%(asctime)s | %(process)5s | %(name)30s | %(levelname)8s | %(message)s"
@@ -38,5 +37,5 @@ def init_sentry(version: str) -> None:
         dsn=os.environ.get("SNEKBOX_SENTRY_DSN", ""),
         integrations=[FalconIntegration()],
         send_default_pii=True,
-        release=f"snekbox@{version}"
+        release=f"snekbox@{version}",
     )

Diff for: tests/api/__init__.py

@@ -14,10 +14,7 @@ def setUp(self):
         self.patcher = mock.patch("snekbox.api.resources.eval.NsJail", autospec=True)
         self.mock_nsjail = self.patcher.start()
         self.mock_nsjail.return_value.python3.return_value = CompletedProcess(
-            args=[],
-            returncode=0,
-            stdout="output",
-            stderr="error"
+            args=[], returncode=0, stdout="output", stderr="error"
         )
         self.addCleanup(self.patcher.stop)
 

Diff for: tests/api/test_eval.py

@@ -20,15 +20,13 @@ def test_post_invalid_schema_400(self):
 
         expected = {
             "title": "Request data failed validation",
-            "description": "'input' is a required property"
+            "description": "'input' is a required property",
         }
 
         self.assertEqual(expected, result.json)
 
     def test_post_invalid_data_400(self):
-        bodies = (
-            {"input": 400}, {"input": "", "args": [400]}
-        )
+        bodies = ({"input": 400}, {"input": "", "args": [400]})
 
         for body in bodies:
             with self.subTest():
@@ -38,7 +36,7 @@ def test_post_invalid_data_400(self):
 
                 expected = {
                     "title": "Request data failed validation",
-                    "description": "400 is not of type 'string'"
+                    "description": "400 is not of type 'string'",
                 }
 
                 self.assertEqual(expected, result.json)
@@ -52,7 +50,7 @@ def test_post_invalid_content_type_415(self):
 
         expected = {
             "title": "415 Unsupported Media Type",
-            "description": "application/xml is an unsupported media type."
+            "description": "application/xml is an unsupported media type.",
         }
 
         self.assertEqual(expected, result.json)

Diff for: tests/gunicorn_utils.py

@@ -29,12 +29,14 @@ def load_config(self):
 
 def _proc_target(config_path: str, event: multiprocessing.Event, **kwargs) -> None:
     """Run a Gunicorn app with the given config and set `event` when Gunicorn is ready."""
+
     def when_ready(_):
         event.set()
 
     app = _StandaloneApplication(config_path, when_ready=when_ready, **kwargs)
 
     import logging
+
     logging.disable(logging.INFO)
 
     app.run()
@@ -62,7 +64,7 @@ def run_gunicorn(config_path: str = "config/gunicorn.conf.py", **kwargs) -> Iter
         concurrent.futures.wait(
             [executor.submit(proc.join), executor.submit(event.wait)],
             timeout=60,
-            return_when=concurrent.futures.FIRST_COMPLETED
+            return_when=concurrent.futures.FIRST_COMPLETED,
         )
         # Can't use the context manager cause wait=False needs to be set.
         executor.shutdown(wait=False, cancel_futures=True)

Diff for: tests/test_integration.py

@@ -21,7 +21,6 @@ def run_code_in_snekbox(code: str) -> tuple[str, int]:
 
 
 class IntegrationTests(unittest.TestCase):
-
     def test_memory_limit_separate_per_process(self):
         """
         Each NsJail process should have its own memory limit.

Diff for: tests/test_main.py

@@ -12,30 +12,24 @@
 class ArgParseTests(unittest.TestCase):
     def test_parse_args(self):
         subtests = (
-            (
-                ["", "code"],
-                Namespace(code="code", nsjail_args=[], py_args=["-c"])
-            ),
+            (["", "code"], Namespace(code="code", nsjail_args=[], py_args=["-c"])),
             (
                 ["", "code", "--time_limit", "0"],
-                Namespace(code="code", nsjail_args=["--time_limit", "0"], py_args=["-c"])
+                Namespace(code="code", nsjail_args=["--time_limit", "0"], py_args=["-c"]),
             ),
             (
                 ["", "code", "---", "-m", "timeit"],
-                Namespace(code="code", nsjail_args=[], py_args=["-m", "timeit"])
+                Namespace(code="code", nsjail_args=[], py_args=["-m", "timeit"]),
             ),
             (
                 ["", "code", "--time_limit", "0", "---", "-m", "timeit"],
-                Namespace(code="code", nsjail_args=["--time_limit", "0"], py_args=["-m", "timeit"])
+                Namespace(code="code", nsjail_args=["--time_limit", "0"], py_args=["-m", "timeit"]),
             ),
             (
                 ["", "code", "--time_limit", "0", "---"],
-                Namespace(code="code", nsjail_args=["--time_limit", "0"], py_args=[])
+                Namespace(code="code", nsjail_args=["--time_limit", "0"], py_args=[]),
             ),
-            (
-                ["", "code", "---"],
-                Namespace(code="code", nsjail_args=[], py_args=[])
-            )
+            (["", "code", "---"], Namespace(code="code", nsjail_args=[], py_args=[])),
         )
 
         for argv, expected in subtests: