pydantic-db 0.1.5

SQL library agnostic data model framework

pydantic-db aims to be a database framework agnostic modeling library. Providing functionality to convert database result object(s) into pydantic model(s). The aim is not to provide an ORM, but to target users who prefer raw sql interactions over obfuscated ORM object built queries layers.

For those who prefer libraries like pypika to build their queries, this library can still provide a nice layer between raw query results and database models.

So long as the database library you are using returns result objects that can be converted to a dictionary, pydantic-db will ineract cleanly with your results. See unittests for examples with asyncpg, mysql-connector-python, psycopg2 and sqlite3.

Usage

All examples assumes the existence of underlying tables and data, they are not intended to run as is.

from_result

To convert a single result object into a model, use Model.from_result.

import sqlite3

from pydantic_db import Model


class User(Model):
    id: int
    name: str


db = sqlite3.connect(":memory:")
db.row_factory = sqlite3.Row

stmt = "SELECT * FROM my_user LIMIT 1"
cursor.execute(stmt)
r = cursor.fetchone()

user = User.from_result(r)

from_results

To convert a list of result objects into models, use Model.from_results.

import sqlite3

from pydantic_db import Model


class User(Model):
    id: int
    name: str


db = sqlite3.connect(":memory:")
db.row_factory = sqlite3.Row

stmt = "SELECT * FROM my_user"
cursor.execute(stmt)
results = cursor.fetchall()

users = User.from_results(results)

Nested models

For more complicated queries returning a nested object, models can be nested. To parse them automatically prefix query fields with name__ format prefixes.

Say we have a Vehicle table with a reference to an owner (User).

import sqlite3

from pydantic_db import Model


class User(Model):
    id: int
    name: str


class Vehicle(Model):
    id: int
    name: str
    owner: User

db = sqlite3.connect(":memory:")
db.row_factory = sqlite3.Row

stmt = """
SELECT
    v.id,
    v.name,
    u.id AS owner__id,
    u.name AS owner__name
FROM my_vehicle v
JOIN my_user u ON v.owner_id = u.id
"""
cursor.execute(stmt)
results = cursor.fetchall()

vehicles = Vehicle.from_results(results)

Optional nested models

When a nested model is optional i.e. user: User | None the library will check if there is an id field by default, and if that field is empty (None), it will nullify that field.

If your nested model contains a differently named primary key or some other field that can be relied on to detect that a query has not successfully joined, and so the nested model should be None. Override the _skip_prefix_fields class var.

class User(Model):
    primary_key: int
    name: str


class Vehicle(Model):
    _skip_prefix_fields = {"owner": "primary_key"}

    id: int
    name: str
    owner: User | None