aboutsummaryrefslogtreecommitdiff
path: root/gn_auth/auth/db/protocols.py
blob: 9d953cdaacf426d14dbe55a6c8f30d683afc351e (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
"""Common Database connection protocols."""
from typing import Any, Protocol

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

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

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

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

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