Fix typings and add typing and lint workflow (#1)

* fix typings and add typing and lint workflow

* resolve single -> double quotes

* missed incorrect type

* missed stragglers

* more stragglers

* add lock file for version hashing

Author: AbstractUmbra

.github/workflows/coverage_and_lint.yml

@@ -0,0 +1,84 @@
+name: Type Coverage and Linting
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+    types: [opened, reopened, synchronize]
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.x"]
+
+    name: "Type Coverage and Linting @ ${{ matrix.python-version }}"
+    steps:
+      - name: "Checkout Repository"
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: "Load cached poetry installation @ ${{ matrix.python-version }}"
+        id: cached-poetry
+        uses: actions/cache@v3
+        with:
+          path: ~/.local
+          key: poetry-0
+
+      - name: "Setup Poetry @ ${{ matrix.python-version }}"
+        if: steps.cached-poetry.outputs.cache-hit != 'true'
+        uses: snok/install-poetry@v1
+        with:
+          version: latest
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+          virtualenvs-path: .venv
+
+      - name: "Setup Python @ ${{ matrix.python-version }}"
+        id: setup-python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "${{ matrix.python-version }}"
+          cache: "poetry"
+
+      - name: "Load cached venv @ ${{ matrix.python-version }}"
+        id: cached-pip-wheels
+        uses: actions/cache@v3
+        with:
+          path: .venv/
+          key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
+
+      - name: "Install Python deps @ ${{ matrix.python-version }}"
+        if: ${{ steps.cached-pip-wheels.outputs.cache-hit != 'true' }}
+        id: install-deps
+        run: |
+          poetry install --no-interaction
+
+      - name: Activate venv @ ${{ matrix.python-version }}
+        run: |
+          echo "$(poetry env info --path)/bin" >> $GITHUB_PATH
+
+      - name: "Run Pyright @ ${{ matrix.python-version }}"
+        uses: jakebailey/pyright-action@v1
+        with:
+          warnings: false
+          no-comments: ${{ matrix.python-version != '3.x' }}
+
+      - name: Lint
+        if: ${{ always() && steps.install-deps.outcome == 'success' }}
+        uses: github/super-linter/slim@v4
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DEFAULT_BRANCH: main
+          VALIDATE_ALL_CODEBASE: false
+          VALIDATE_PYTHON_BLACK: true
+          VALIDATE_PYTHON_ISORT: true
+          LINTER_RULES_PATH: /
+          PYTHON_ISORT_CONFIG_FILE: pyproject.toml
+          PYTHON_BLACK_CONFIG_FILE: pyproject.toml

.gitignore

@@ -160,4 +160,4 @@ cython_debug/
 #.idea/
 
 # Config
-config.toml
+config.toml

core/__init__.py

@@ -21,14 +21,15 @@
 SOFTWARE.
 """
 import logging
+from typing import TextIO
 
 from .config import config
 from .logger import ColourFormatter
 from .utils import *
 
 
 # Setup root logging formatter...
-handler: logging.StreamHandler = logging.StreamHandler()
+handler: logging.StreamHandler[TextIO] = logging.StreamHandler()
 handler.setFormatter(ColourFormatter())
 
 logger: logging.Logger = logging.getLogger()

core/logger.py

@@ -4,7 +4,7 @@
 Copyright (c) 2015-present Rapptz
 
 Permission is hereby granted, free of charge, to any person obtaining a
-copy of this software and associated documentation files (the "Software"),
+copy of this software and associated documentation files (the 'Software'),
 to deal in the Software without restriction, including without limitation
 the rights to use, copy, modify, merge, publish, distribute, sublicense,
 and/or sell copies of the Software, and to permit persons to whom the
@@ -13,7 +13,7 @@
 The above copyright notice and this permission notice shall be included in
 all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS
 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
@@ -24,17 +24,16 @@
 import logging
 
 
-__all__ = ('ColourFormatter', )
+__all__ = ('ColourFormatter',)
 
 
 class ColourFormatter(logging.Formatter):
-
     # ANSI codes are a bit weird to decipher if you're unfamiliar with them, so here's a refresher
     # It starts off with a format like \x1b[XXXm where XXX is a semicolon separated list of commands
     # The important ones here relate to colour.
     # 30-37 are black, red, green, yellow, blue, magenta, cyan and white in that order
     # 40-47 are the same except for the background
-    # 90-97 are the same but "bright" foreground
+    # 90-97 are the same but 'bright' foreground
     # 100-107 are the same as the bright ones but for the background.
     # 1 means bold, 2 means dim, 0 means reset, and 4 means underline.
 
@@ -57,7 +56,7 @@ class ColourFormatter(logging.Formatter):
         for level, colour in LEVEL_COLOURS
     }
 
-    def format(self, record):
+    def format(self, record: logging.LogRecord) -> str:
         formatter = self.FORMATS.get(record.levelno)
         if formatter is None:
             formatter = self.FORMATS[logging.DEBUG]

core/utils.py

@@ -22,7 +22,8 @@
 """
 import asyncio
 import inspect
-from typing import Any, Awaitable, Callable, Iterator, Self
+from collections.abc import Callable, Coroutine, Iterator
+from typing import Any, Self, TypeAlias
 
 from starlette.requests import Request
 from starlette.responses import Response
@@ -35,12 +36,13 @@
     'View',
 )
 
+ResponseType: TypeAlias = Coroutine[Any, Any, Response]
 
-class _Route:
 
-    def __init__(self, **kwargs) -> None:
+class _Route:
+    def __init__(self, **kwargs: Any) -> None:
         self._path: str = kwargs['path']
-        self._coro: Callable[[Any, Request], Awaitable[Response]] = kwargs['coro']
+        self._coro: Callable[[Any, Request], ResponseType] = kwargs['coro']
         self._methods: list[str] = kwargs['methods']
         self._prefix: bool = kwargs['prefix']
 
@@ -53,31 +55,29 @@ async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
         await response(scope, receive, send)
 
 
-def route(path: str, /, *, methods: list[str] | None = None, prefix: bool = True) -> Callable[..., _Route]:
+def route(path: str, /, *, methods: list[str] = ['GET'], prefix: bool = True) -> Callable[..., _Route]:
     """Decorator which allows a coroutine to be turned into a `starlette.routing.Route` inside a `core.View`.
 
     Parameters
     ----------
     path: str
         The path to this route. By default, the path is prefixed with the View class name.
     methods: list[str]
-        The allowed methods for this route. If this is None, this route will default to 'GET'. Defaults to None.
+        The allowed methods for this route. Defaults to ``['GET']``.
     prefix: bool
         Whether the route path should be prefixed with the View class name. Defaults to True.
     """
 
-    if methods is None:
-        methods = ['GET']
-
-    def decorator(coro: Callable[[Any, Request], Awaitable[Response]]) -> _Route:
+    def decorator(coro: Callable[[Any, Request], ResponseType]) -> _Route:
         if not asyncio.iscoroutinefunction(coro):
-            raise RuntimeError('Route must be a coroutine function.')
+            raise RuntimeError('Route callback must be a coroutine function.')
 
-        disallowed: list[str] = ["get", "post", "put", "patch", "delete", "options"]
+        disallowed: list[str] = ['get', 'post', 'put', 'patch', 'delete', 'options']
         if coro.__name__.lower() in disallowed:
-            raise ValueError(f'Route coroutine must not be named any: {", ".join(disallowed)}')
+            raise ValueError(f'Route callback function must not be named any: {", ".join(disallowed)}')
 
         return _Route(path=path, coro=coro, methods=methods, prefix=prefix)
+
     return decorator
 
 
@@ -106,9 +106,9 @@ async def hello_endpoint(self, request: Request) -> Response:
 
     __routes__: list[Route]
 
-    def __new__(cls, *args, **kwargs) -> Self:
-        self: Self = super().__new__(cls)
-        name: str = cls.__name__
+    def __new__(cls, *args: Any, **kwargs: Any) -> Self:
+        self = super().__new__(cls)
+        name = cls.__name__
 
         self.__routes__ = []
 
@@ -125,12 +125,9 @@ def __new__(cls, *args, **kwargs) -> Self:
                 # Due to the way Starlette works, this allows us to have schema documentation...
                 setattr(member, method, member._coro)
 
-            self.__routes__.append(Route(
-                path=path,
-                endpoint=member,
-                methods=member._methods,
-                name=f'{name}.{member._coro.__name__}'
-            ))
+            self.__routes__.append(
+                Route(path=path, endpoint=member, methods=member._methods, name=f'{name}.{member._coro.__name__}')
+            )
 
         return self
 
@@ -143,5 +140,5 @@ def __getitem__(self, index: int) -> Route:
     def __len__(self) -> int:
         return len(self.__routes__)
 
-    def __iter__(self) -> Iterator:
+    def __iter__(self) -> Iterator[Route]:
         return iter(self.__routes__)