From 760ea04f86daacc0a02872610718ec71834bfafe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alex=20N=C3=B8rgaard?= Date: Mon, 12 Jun 2023 10:51:47 +0100 Subject: [PATCH 1/8] fix typings and add typing and lint workflow --- .gitignore | 3 +++ core/__init__.py | 2 +- core/logger.py | 22 +++++++++++----------- core/utils.py | 4 ++-- 4 files changed, 17 insertions(+), 14 deletions(-) diff --git a/.gitignore b/.gitignore index c721254..efc88d4 100644 --- a/.gitignore +++ b/.gitignore @@ -161,3 +161,6 @@ cython_debug/ # Config config.toml + +# Poetry +poetry.lock diff --git a/core/__init__.py b/core/__init__.py index 66dda21..12aad2b 100644 --- a/core/__init__.py +++ b/core/__init__.py @@ -36,4 +36,4 @@ logger: logging.Logger = logging.getLogger() logger.addHandler(handler) -logger.setLevel(config['LOGGING']['level']) +logger.setLevel(config["LOGGING"]["level"]) diff --git a/core/logger.py b/core/logger.py index e02a680..9420fbb 100644 --- a/core/logger.py +++ b/core/logger.py @@ -38,20 +38,20 @@ class ColourFormatter(logging.Formatter): # 1 means bold, 2 means dim, 0 means reset, and 4 means underline. LEVEL_COLOURS = [ - (logging.DEBUG, '\x1b[42m'), - (logging.INFO, '\x1b[44m'), - (logging.WARNING, '\x1b[43m'), - (logging.ERROR, '\x1b[41m'), - (logging.CRITICAL, '\x1b[41m'), + (logging.DEBUG, "\x1b[42m"), + (logging.INFO, "\x1b[44m"), + (logging.WARNING, "\x1b[43m"), + (logging.ERROR, "\x1b[41m"), + (logging.CRITICAL, "\x1b[41m"), ] FORMATS = { level: logging.Formatter( - f'\x1b[40m[%(asctime)s] ' - f'\x1b[0m{colour}\x1b[30m[%(levelname)-8s]' - f'\x1b[0m\x1b[40m\x1b[37;2m %(name)-15s' - f'\x1b[0m: %(message)s', - '%Y-%m-%d %H:%M:%S', + f"\x1b[40m[%(asctime)s] " + f"\x1b[0m{colour}\x1b[30m[%(levelname)-8s]" + f"\x1b[0m\x1b[40m\x1b[37;2m %(name)-15s" + f"\x1b[0m: %(message)s", + "%Y-%m-%d %H:%M:%S", ) for level, colour in LEVEL_COLOURS } @@ -64,7 +64,7 @@ def format(self, record: logging.LogRecord) -> str: # Override the traceback to always print in red if record.exc_info: text = formatter.formatException(record.exc_info) - record.exc_text = f'\x1b[31m{text}\x1b[0m' + record.exc_text = f"\x1b[31m{text}\x1b[0m" output = formatter.format(record) diff --git a/core/utils.py b/core/utils.py index 0d53f4b..ffa9197 100644 --- a/core/utils.py +++ b/core/utils.py @@ -55,7 +55,7 @@ async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None: await request.app.database.add_log(request=request, response=response) -def route(path: str, /, *, methods: list[str] = ['GET'], prefix: bool = True) -> Callable[..., _Route]: +def route(path: str, /, *, methods: list[str] | None = ['GET'], prefix: bool = True) -> Callable[..., _Route]: """Decorator which allows a coroutine to be turned into a `starlette.routing.Route` inside a `core.View`. Parameters @@ -136,7 +136,7 @@ def name(self) -> str: return self.__class__.__name__.lower() def __repr__(self) -> str: - return f'View: name={self.__class__.__name__}, routes={self.__routes__}' + return f"View: name={self.__class__.__name__}, routes={self.__routes__}" def __getitem__(self, index: int) -> Route: return self.__routes__[index] From c4f1e5f875a4fbc2239b15273b28e0bff0a5dcc9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alex=20N=C3=B8rgaard?= Date: Mon, 12 Jun 2023 11:00:38 +0100 Subject: [PATCH 2/8] resolve single -> double quotes --- core/logger.py | 22 +++++++++++----------- core/utils.py | 8 ++++++-- 2 files changed, 17 insertions(+), 13 deletions(-) diff --git a/core/logger.py b/core/logger.py index 9420fbb..e02a680 100644 --- a/core/logger.py +++ b/core/logger.py @@ -38,20 +38,20 @@ class ColourFormatter(logging.Formatter): # 1 means bold, 2 means dim, 0 means reset, and 4 means underline. LEVEL_COLOURS = [ - (logging.DEBUG, "\x1b[42m"), - (logging.INFO, "\x1b[44m"), - (logging.WARNING, "\x1b[43m"), - (logging.ERROR, "\x1b[41m"), - (logging.CRITICAL, "\x1b[41m"), + (logging.DEBUG, '\x1b[42m'), + (logging.INFO, '\x1b[44m'), + (logging.WARNING, '\x1b[43m'), + (logging.ERROR, '\x1b[41m'), + (logging.CRITICAL, '\x1b[41m'), ] FORMATS = { level: logging.Formatter( - f"\x1b[40m[%(asctime)s] " - f"\x1b[0m{colour}\x1b[30m[%(levelname)-8s]" - f"\x1b[0m\x1b[40m\x1b[37;2m %(name)-15s" - f"\x1b[0m: %(message)s", - "%Y-%m-%d %H:%M:%S", + f'\x1b[40m[%(asctime)s] ' + f'\x1b[0m{colour}\x1b[30m[%(levelname)-8s]' + f'\x1b[0m\x1b[40m\x1b[37;2m %(name)-15s' + f'\x1b[0m: %(message)s', + '%Y-%m-%d %H:%M:%S', ) for level, colour in LEVEL_COLOURS } @@ -64,7 +64,7 @@ def format(self, record: logging.LogRecord) -> str: # Override the traceback to always print in red if record.exc_info: text = formatter.formatException(record.exc_info) - record.exc_text = f"\x1b[31m{text}\x1b[0m" + record.exc_text = f'\x1b[31m{text}\x1b[0m' output = formatter.format(record) diff --git a/core/utils.py b/core/utils.py index ffa9197..6da0b02 100644 --- a/core/utils.py +++ b/core/utils.py @@ -32,7 +32,11 @@ from starlette.types import Receive, Scope, Send -__all__ = ('route', 'View', 'Application') +__all__ = ( + 'route', + 'View', + 'Application', +) ResponseType: TypeAlias = Coroutine[Any, Any, Response] @@ -136,7 +140,7 @@ def name(self) -> str: return self.__class__.__name__.lower() def __repr__(self) -> str: - return f"View: name={self.__class__.__name__}, routes={self.__routes__}" + return f'View: name={self.__class__.__name__}, routes={self.__routes__}' def __getitem__(self, index: int) -> Route: return self.__routes__[index] From 1db3e26d87bc3ff9ce6c6d70b7b4cbc16ff35571 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alex=20N=C3=B8rgaard?= Date: Mon, 12 Jun 2023 11:00:59 +0100 Subject: [PATCH 3/8] missed incorrect type --- core/utils.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/utils.py b/core/utils.py index 6da0b02..779e7b6 100644 --- a/core/utils.py +++ b/core/utils.py @@ -59,7 +59,7 @@ async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None: await request.app.database.add_log(request=request, response=response) -def route(path: str, /, *, methods: list[str] | None = ['GET'], 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 From f5368b8b2e3dc70f11e3897b260e34474c95aca7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alex=20N=C3=B8rgaard?= Date: Mon, 12 Jun 2023 11:02:01 +0100 Subject: [PATCH 4/8] missed stragglers --- core/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/__init__.py b/core/__init__.py index 12aad2b..66dda21 100644 --- a/core/__init__.py +++ b/core/__init__.py @@ -36,4 +36,4 @@ logger: logging.Logger = logging.getLogger() logger.addHandler(handler) -logger.setLevel(config["LOGGING"]["level"]) +logger.setLevel(config['LOGGING']['level']) From f4ce0efa0df2522c898fdae01b9bc4578152bf2d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alex=20N=C3=B8rgaard?= Date: Mon, 12 Jun 2023 11:07:30 +0100 Subject: [PATCH 5/8] add lock file for version hashing --- .gitignore | 3 --- 1 file changed, 3 deletions(-) diff --git a/.gitignore b/.gitignore index efc88d4..c721254 100644 --- a/.gitignore +++ b/.gitignore @@ -161,6 +161,3 @@ cython_debug/ # Config config.toml - -# Poetry -poetry.lock From 51bb50498487b54557d6320d00b9de62838d0d90 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alex=20N=C3=B8rgaard?= Date: Tue, 13 Jun 2023 15:08:17 +0100 Subject: [PATCH 6/8] next typing sweep --- core/database/database.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/database/database.py b/core/database/database.py index 931a030..020b5c5 100644 --- a/core/database/database.py +++ b/core/database/database.py @@ -163,7 +163,7 @@ async def create_application(self, *, user_id: int, name: str, description: str) query: str = """ WITH create_application AS ( - INSERT INTO tokens(user_id, token_name, token_description, token) VALUES ($1, $2, $3, $4) RETURNING * + INSERT INTO tokens(user_id, token_name, token_description, token) VALUES ($1, $2, $3, $4) RETURNING * ) SELECT * FROM create_application JOIN users u ON u.uid = create_application.user_id From a7620b0bd7a4cf5e81c9f010bf825fa6d480ee53 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alex=20N=C3=B8rgaard?= Date: Tue, 13 Jun 2023 15:13:35 +0100 Subject: [PATCH 7/8] updated black rules --- core/database/models.py | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/core/database/models.py b/core/database/models.py index ba87f2f..5d9a34c 100644 --- a/core/database/models.py +++ b/core/database/models.py @@ -26,7 +26,11 @@ import asyncpg -__all__ = ('UserModel', 'ApplicationModel', 'LogModel') +__all__ = ( + 'UserModel', + 'ApplicationModel', + 'LogModel', +) class UserModel: @@ -69,7 +73,7 @@ def as_dict(self) -> dict[str, Any]: 'description': self.description, 'token': self.token, 'verified': self.verified, - 'invalid': self.invalid + 'invalid': self.invalid, } ) @@ -78,7 +82,6 @@ def as_dict(self) -> dict[str, Any]: class LogModel: def __init__(self, record: asyncpg.Record) -> None: - self.ip: str = record['ip'] self.uid: int | None = record['userid'] self.tid: int | None = record['appid'] From dc979bd29fbd29e386f2a1573f5f92c105f43c9f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alex=20N=C3=B8rgaard?= Date: Sun, 18 Jun 2023 18:06:29 +0100 Subject: [PATCH 8/8] quick syntax fixes --- api/middleware/auth.py | 1 - core/database/SCHEMA.sql | 2 +- core/database/database.py | 6 ++++-- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/api/middleware/auth.py b/api/middleware/auth.py index 1dfefc3..3072041 100644 --- a/api/middleware/auth.py +++ b/api/middleware/auth.py @@ -51,7 +51,6 @@ async def authenticate(self, conn: HTTPConnection) -> tuple[AuthCredentials, Use scopes: list[str] = [] # Check if the user is using a bearer token... - user: core.UserModel | core.ApplicationModel | None user = await self.app.database.fetch_user(bearer=auth) if user: diff --git a/core/database/SCHEMA.sql b/core/database/SCHEMA.sql index 3adfec4..7e52e6f 100644 --- a/core/database/SCHEMA.sql +++ b/core/database/SCHEMA.sql @@ -41,4 +41,4 @@ CREATE TABLE IF NOT EXISTS logs ( route TEXT NOT NULL, body TEXT, response_code INTEGER NOT NULL -); \ No newline at end of file +); diff --git a/core/database/database.py b/core/database/database.py index 020b5c5..7055e1c 100644 --- a/core/database/database.py +++ b/core/database/database.py @@ -53,8 +53,10 @@ async def __aexit__(self, *args: Any) -> None: async def setup(self) -> Self: logger.info('Setting up Database.') - self._pool = await asyncpg.create_pool(dsn=config['DATABASE']['dsn']) # type: ignore - assert self._pool + pool = await asyncpg.create_pool(dsn=config['DATABASE']['dsn']) + assert pool + + self._pool = pool async with self._pool.acquire() as connection: with open('core/database/SCHEMA.sql', 'r') as schema: