Add linting both as a workflow and locally using pre-commit hooks

Author: SylteA

.dockerignore

@@ -137,4 +137,4 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
-postgres/
+postgres/

.github/workflows/lint-and-test.yml

@@ -0,0 +1,51 @@
+name: Lint & Test
+
+on:
+  push:
+    branches:
+      - rewrite
+  pull_request:
+
+
+jobs:
+  lint-and-test:
+    runs-on: ubuntu-latest
+    env:
+      # Hide the graphical elements from pipenv's output
+      PIPENV_HIDE_EMOJIS: 1
+      PIPENV_NOSPIN: 1
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Set up Python3.8
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      - name: Install dependencies
+        run: |
+          pip install pipenv
+          pipenv install --dev --system --deploy
+
+      - name: Run pre-commit hooks.
+        run: SKIP=flake8; pre-commit run --all-files
+
+      # Thanks pydis!
+      # Run flake8 and have it format the linting errors in the format of
+      # the GitHub Workflow command to register error annotations. This
+      # means that our flake8 output is automatically added as an error
+      # annotation to both the run result and in the "Files" tab of a
+      # pull request.
+      #
+      # Format used:
+      # ::error file={filename},line={line},col={col}::{message}
+      - name: Run flake8
+        run: "flake8 \
+        --format='::error file=%(path)s,line=%(row)d,col=%(col)d::\
+        [flake8] %(code)s: %(text)s'"
+
+      - name: Run pytest
+        run: |
+          pytest

.gitignore

@@ -137,4 +137,4 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
-postgres/
+postgres/

.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+repos:
+  - repo: local
+    hooks:
+      - id: black
+        name: black
+        entry: black --check .
+        language: system
+        types: [python]
+
+      - id: flake8
+        name: Flake8
+        entry: flake8
+        language: system
+        types: [python]
+        require_serial: true
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.5.0
+    hooks:
+      - id: check-json
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: check-merge-conflict
+      - id: mixed-line-ending
+        args: [--fix=lf]
+      - id: trailing-whitespace
+        args: [--markdown-linebreak-ext=md]

Dockerfile

@@ -12,4 +12,4 @@ RUN pip install -U pipenv
 RUN pipenv install --system --deploy
 
 # Run the API.
-CMD python launch.py runserver --host 0.0.0.0 --port 5000 --initdb
+CMD python launch.py runserver --host 0.0.0.0 --port 5000 --initdb

LICENCE

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

Pipfile

@@ -15,6 +15,7 @@ postdb = "*"
 pyjwt = "*"
 aiohttp = "*"
 uvloop = {markers = "platform_system == 'linux'", version = "*"}
+pytest-asyncio = "*"
 
 [requires]
 python_version = "3.8"
@@ -23,3 +24,5 @@ python_version = "3.8"
 allow_prereleases = true
 
 [scripts]
+precommit = "pre-commit install"
+lint = "pre-commit run --all-files"

Pipfile.lock

@@ -1 +1,3 @@
 from .app import app
+
+__all__ = ("app",)

api/__init__.py

@@ -1,4 +1,4 @@
-from quart import Quart, exceptions, jsonify, request
+from quart import Quart, exceptions, jsonify
 from datetime import datetime, date
 from aiohttp import ClientSession
 from typing import Any, Optional
@@ -58,6 +58,12 @@ async def startup(self) -> None:
 app = cors(app, allow_origin="*")  # TODO: Restrict the origin(s) in production.
 
 
+@app.route("/")
+async def index():
+    """Index endpoint used for testing."""
+    return jsonify({"status": "OK"})
+
+
 @app.errorhandler(500)
 async def error_500(error: BaseException):
     """

api/app.py

@@ -1,8 +1,8 @@
+from typing import List, Type
 from postDB import Model
-from typing import List
 
 
 from .user import User
 
 
-models_ordered: List[Model] = []
+models_ordered: List[Type[Model]] = [User]

api/models/__init__.py

@@ -31,6 +31,17 @@ class User(Model):
     avatar = Column(types.String(), nullable=True)
     type = Column(types.String(), default="USER")
 
+    @classmethod
+    async def fetch(cls, id: Union[str, int]) -> Optional["User"]:
+        """Fetch a user with the given ID."""
+        query = "SELECT * FROM users WHERE id = $1"
+        user = await cls.pool.fetchrow(query, int(id))
+
+        if user is not None:
+            user = cls(**user)
+
+        return user
+
     @classmethod
     async def create(
         cls,
@@ -61,17 +72,6 @@ async def create(
 
         return cls(**record)
 
-    @classmethod
-    async def fetch(cls, id: Union[str, int]) -> Optional["User"]:
-        """Fetch a user with the given ID."""
-        query = "SELECT * FROM users WHERE id = $1"
-        user = await cls.pool.fetchrow(query, int(id))
-
-        if user is not None:
-            user = cls(**user)
-
-        return user
-
     @property
     def created_at(self) -> datetime:
         """Returns """

api/models/user.py

@@ -17,7 +17,7 @@
 
 
 try:
-    import uvloop  # noqa
+    import uvloop
 except ModuleNotFoundError:
     loop = asyncio.new_event_loop()
 else:
@@ -118,7 +118,7 @@ async def safe_create_tables(verbose: bool = False) -> None:
 
     for model in models_ordered:
         await model.create_table(verbose=verbose)
-        log.info("Created table %s" % type(model).__tablename__)
+        log.info("Created table %s" % model.__tablename__)
 
 
 @app.cli.command(name="initdb")

launch.py

@@ -0,0 +1,15 @@
+from api import app as quart_app
+
+from quart.testing import QuartClient
+import pytest
+
+
+@pytest.fixture(name="app")
+def _test_app() -> QuartClient:
+    return quart_app.test_client()
+
+
+@pytest.mark.asyncio
+async def test_index(app: QuartClient):
+    response = await app.get("/")
+    assert response.status_code == 200

tests/__init__.py

@@ -0,0 +1,3 @@
+[flake8]
+max-line-length=120
+import-order-style=pycharm

tests/test_index.py

@@ -1,3 +1,5 @@
 from .middleware import TokenAuthMiddleware
 from .time import snowflake_time
 from .request import Request
+
+__all__ = ("TokenAuthMiddleware", "snowflake_time", "Request")