aboutsummaryrefslogtreecommitdiff
path: root/gn3/auth/db.py
blob: b74f3418322805fdaf92e40b9a04a990e4df64d8 (about) (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
"""Handle connection to auth database."""
import sqlite3
import contextlib
from typing import Any, Callable, Iterator, Protocol

import traceback

from flask import current_app as app

class DbConnection(Protocol):
    """Type annotation for a generic database connection object."""
    def cursor(self) -> Any:
        """A cursor object"""
        ...

    def commit(self) -> Any:
        """Commit the transaction."""
        ...

    def rollback(self) -> Any:
        """Rollback the transaction."""
        ...

class DbCursor(Protocol):
    """Type annotation for a generic database cursor object."""
    def execute(self, *args, **kwargs) -> Any:
        """Execute a single query"""
        ...

    def executemany(self, *args, **kwargs) -> Any:
        """
        Execute parameterized SQL statement sql against all parameter sequences
        or mappings found in the sequence parameters.
        """
        ...

    def fetchone(self, *args, **kwargs):
        """Fetch single result if present, or `None`."""
        ...

    def fetchmany(self, *args, **kwargs):
        """Fetch many results if present or `None`."""
        ...

    def fetchall(self, *args, **kwargs):
        """Fetch all results if present or `None`."""
        ...

@contextlib.contextmanager
def connection(db_path: str, row_factory: Callable = sqlite3.Row) -> Iterator[DbConnection]:
    """Create the connection to the auth database."""
    conn = sqlite3.connect(db_path)
    conn.row_factory = row_factory
    conn.execute("PRAGMA foreign_keys = ON")
    try:
        yield conn
    except sqlite3.Error as exc:
        conn.rollback()
        app.logger.debug(traceback.format_exc())
        raise exc
    finally:
        conn.commit()
        conn.close()

@contextlib.contextmanager
def cursor(conn: DbConnection) -> Iterator[DbCursor]:
    """Get a cursor from the given connection to the auth database."""
    cur = conn.cursor()
    try:
        yield cur
    except sqlite3.Error as exc:
        conn.rollback()
        app.logger.debug(traceback.format_exc())
        raise exc
    finally:
        conn.commit()
        cur.close()