WIP - Pydantic v2 support (#1238)
* WIP * WIP - make test_model_definition tests pass * WIP - make test_model_methods pass * WIP - make whole test suit at least run - failing 49/443 tests * WIP fix part of the getting pydantic tests as types of fields are now kept in core schema and not on fieldsinfo * WIP fix validation in update by creating individual fields validators, failing 36/443 * WIP fix __pydantic_extra__ in intializing model, fix test related to pydantic config checks, failing 32/442 * WIP - fix enum schema in model_json_schema, failing 31/442 * WIP - fix copying through model, fix setting pydantic fields on through, fix default config and inheriting from it, failing 26/442 * WIP fix tests checking pydantic schema, fix excluding parent fields, failing 21/442 * WIP some missed files * WIP - fix validators inheritance and fix validators in generated pydantic, failing 17/442 * WIP - fix through models setting - only on reverse side of relation, but always on reverse side, failing 15/442 * WIP - fix through models setting - only on reverse side of relation, but always on reverse side, failing 15/442 * WIP - working on proper populating __dict__ for relations for new schema dumping, some work on openapi docs, failing 13/442 * WIP - remove property fields as pydantic has now computed_field on its own, failing 9/442 * WIP - fixes in docs, failing 8/442 * WIP - fix tests for largebinary schema, wrapped bytes fields fail in pydantic, will be fixed in pydantic-core, remaining is circural schema for related models, failing 6/442 * WIP - fix to pk only models in schemas * Getting test suites to pass (#1249) * wip, fixing tests * iteration, fixing some more tests * iteration, fixing some more tests * adhere to comments * adhere to comments * remove unnecessary dict call, re-add getattribute for testing * todo for reverse relationship * adhere to comments, remove prints * solve circular refs * all tests pass 🎉 * remove 3.7 from tests * add lint and type check jobs * reforat with ruff, fix jobs * rename jobs * fix imports * fix evaluate in py3.8 * partially fix coverage * fix coverage, add more tests * fix test ids * fix test ids * fix lint, fix docs, make docs fully working scripts, add test docs job * fix pyproject * pin py ver in test docs * change dir in test docs * fix pydantic warning hack * rm poetry call in test_docs * switch to pathlib in test docs * remove coverage req test docs * fix type check tests, fix part of types * fix/skip next part of types * fix next part of types * fix next part of types * fix coverage * fix coverage * fix type (bit dirty 🤷) * fix some code smells * change pre-commit * tweak workflows * remove no root from tests * switch to full python path by passing sys.executable * some small refactor in new base model, one sample test, change makefile * small refactors to reduce complexity of methods * temp add tests for prs against pydantic_v2 * remove all references to __fields__ * remove all references to construct, deprecate the method and update model_construct to be in line with pydantic * deprecate dict and add model_dump, todo switch to model_dict in calls * fix tests * change to union * change to union * change to model_dump and model_dump_json from dict and json deprecated methods, deprecate them in ormar too * finish switching dict() -> model_dump() * finish switching json() -> model_dump_json() * remove fully pydantic_only * switch to extra for payment card, change missed json calls * fix coverage - no more warnings internal * fix coverage - no more warnings internal - part 2 * split model_construct into own and pydantic parts * split determine pydantic field type * change to new field validators * fix benchmarks, add codspeed instead of pytest-benchmark, add action and gh workflow * restore pytest-benchmark * remove codspeed * pin pydantic version, restore codspeed * change on push to pydantic_v2 to trigger first one * Use lifespan function instead of event (#1259) * check return types * fix imports order, set warnings=False on json that passes the dict, fix unnecessary loop in one of the test * remove references to model's meta as it's now ormar config, rename related methods too * filter out pydantic serializer warnings * remove choices leftovers * remove leftovers after property_fields, keep only enough to exclude them in initialization * add migration guide * fix meta references * downgrade databases for now * Change line numbers in documentation (#1265) * proofread and fix the docs, part 1 * proofread and fix the docs for models * proofread and fix the docs for fields * proofread and fix the docs for relations * proofread and fix rest of the docs, add release notes for 0.20 * create tables in new docs src * cleanup old deps, uncomment docs publish on tag * fix import reorder --------- Co-authored-by: TouwaStar <30479449+TouwaStar@users.noreply.github.com> Co-authored-by: Goran Mekić <meka@tilda.center>
This commit is contained in:
collerek
3
examples/__init__.py
Normal file
3
examples/__init__.py
Normal file
@ -0,0 +1,3 @@
|
||||
from .utils import create_drop_database
|
||||
|
||||
__all__ = ["create_drop_database"]
|
||||
@ -1,47 +1,45 @@
|
||||
from contextlib import asynccontextmanager
|
||||
from typing import List, Optional
|
||||
|
||||
import databases
|
||||
import ormar
|
||||
import sqlalchemy
|
||||
import uvicorn
|
||||
from fastapi import FastAPI
|
||||
|
||||
import ormar
|
||||
DATABASE_URL = "sqlite:///test.db"
|
||||
|
||||
app = FastAPI()
|
||||
metadata = sqlalchemy.MetaData()
|
||||
database = databases.Database("sqlite:///test.db")
|
||||
app.state.database = database
|
||||
ormar_base_config = ormar.OrmarConfig(
|
||||
database=databases.Database(DATABASE_URL), metadata=sqlalchemy.MetaData()
|
||||
)
|
||||
|
||||
|
||||
@app.on_event("startup")
|
||||
async def startup() -> None:
|
||||
@asynccontextmanager
|
||||
async def lifespan(app: FastAPI):
|
||||
database_ = app.state.database
|
||||
if not database_.is_connected:
|
||||
await database_.connect()
|
||||
|
||||
|
||||
@app.on_event("shutdown")
|
||||
async def shutdown() -> None:
|
||||
yield
|
||||
database_ = app.state.database
|
||||
if database_.is_connected:
|
||||
await database_.disconnect()
|
||||
|
||||
|
||||
app = FastAPI(lifespan=lifespan)
|
||||
metadata = sqlalchemy.MetaData()
|
||||
database = databases.Database("sqlite:///test.db")
|
||||
app.state.database = database
|
||||
|
||||
|
||||
class Category(ormar.Model):
|
||||
class Meta:
|
||||
tablename = "categories"
|
||||
metadata = metadata
|
||||
database = database
|
||||
ormar_config = ormar_base_config.copy(tablename="categories")
|
||||
|
||||
id: int = ormar.Integer(primary_key=True)
|
||||
name: str = ormar.String(max_length=100)
|
||||
|
||||
|
||||
class Item(ormar.Model):
|
||||
class Meta:
|
||||
tablename = "items"
|
||||
metadata = metadata
|
||||
database = database
|
||||
ormar_config = ormar_base_config.copy(tablename="items")
|
||||
|
||||
id: int = ormar.Integer(primary_key=True)
|
||||
name: str = ormar.String(max_length=100)
|
||||
@ -69,7 +67,7 @@ async def create_category(category: Category):
|
||||
@app.put("/items/{item_id}")
|
||||
async def get_item(item_id: int, item: Item):
|
||||
item_db = await Item.objects.get(pk=item_id)
|
||||
return await item_db.update(**item.dict())
|
||||
return await item_db.update(**item.model_dump())
|
||||
|
||||
|
||||
@app.delete("/items/{item_id}")
|
||||
|
||||
@ -1,45 +1,40 @@
|
||||
from typing import Optional
|
||||
|
||||
import databases
|
||||
import pydantic
|
||||
|
||||
import ormar
|
||||
import pydantic
|
||||
import sqlalchemy
|
||||
|
||||
DATABASE_URL = "sqlite:///db.sqlite"
|
||||
database = databases.Database(DATABASE_URL)
|
||||
metadata = sqlalchemy.MetaData()
|
||||
|
||||
|
||||
# note that this step is optional -> all ormar cares is a internal
|
||||
# class with name Meta and proper parameters, but this way you do not
|
||||
# note that this step is optional -> all ormar cares is an individual
|
||||
# OrmarConfig for each of the models, but this way you do not
|
||||
# have to repeat the same parameters if you use only one database
|
||||
class BaseMeta(ormar.ModelMeta):
|
||||
metadata = metadata
|
||||
database = database
|
||||
|
||||
base_ormar_config = ormar.OrmarConfig(
|
||||
database=databases.Database(DATABASE_URL),
|
||||
metadata=sqlalchemy.MetaData(),
|
||||
engine=sqlalchemy.create_engine(DATABASE_URL),
|
||||
)
|
||||
|
||||
# Note that all type hints are optional
|
||||
# below is a perfectly valid model declaration
|
||||
# class Author(ormar.Model):
|
||||
# class Meta(BaseMeta):
|
||||
# tablename = "authors"
|
||||
# ormar_config = base_ormar_config.copy(tablename="authors")
|
||||
#
|
||||
# id = ormar.Integer(primary_key=True) # <= notice no field types
|
||||
# name = ormar.String(max_length=100)
|
||||
|
||||
|
||||
class Author(ormar.Model):
|
||||
class Meta(BaseMeta):
|
||||
tablename = "authors"
|
||||
ormar_config = base_ormar_config.copy()
|
||||
|
||||
id: int = ormar.Integer(primary_key=True)
|
||||
name: str = ormar.String(max_length=100)
|
||||
|
||||
|
||||
class Book(ormar.Model):
|
||||
class Meta(BaseMeta):
|
||||
tablename = "books"
|
||||
ormar_config = base_ormar_config.copy()
|
||||
|
||||
id: int = ormar.Integer(primary_key=True)
|
||||
author: Optional[Author] = ormar.ForeignKey(Author)
|
||||
@ -50,10 +45,9 @@ class Book(ormar.Model):
|
||||
# create the database
|
||||
# note that in production you should use migrations
|
||||
# note that this is not required if you connect to existing database
|
||||
engine = sqlalchemy.create_engine(DATABASE_URL)
|
||||
# just to be sure we clear the db before
|
||||
metadata.drop_all(engine)
|
||||
metadata.create_all(engine)
|
||||
base_ormar_config.metadata.drop_all(base_ormar_config.engine)
|
||||
base_ormar_config.metadata.create_all(base_ormar_config.engine)
|
||||
|
||||
|
||||
# all functions below are divided into functionality categories
|
||||
@ -381,7 +375,7 @@ async def raw_data():
|
||||
async def with_connect(function):
|
||||
# note that for any other backend than sqlite you actually need to
|
||||
# connect to the database to perform db operations
|
||||
async with database:
|
||||
async with base_ormar_config.database:
|
||||
await function()
|
||||
|
||||
# note that if you use framework like `fastapi` you shouldn't connect
|
||||
@ -411,4 +405,4 @@ for func in [
|
||||
asyncio.run(with_connect(func))
|
||||
|
||||
# drop the database tables
|
||||
metadata.drop_all(engine)
|
||||
base_ormar_config.metadata.drop_all(base_ormar_config.engine)
|
||||
|
||||
21
examples/utils.py
Normal file
21
examples/utils.py
Normal file
@ -0,0 +1,21 @@
|
||||
import functools
|
||||
|
||||
import ormar
|
||||
import sqlalchemy
|
||||
|
||||
|
||||
def create_drop_database(base_config: ormar.OrmarConfig) -> None:
|
||||
# create all tables in the database before execution
|
||||
# and drop them after, note that in production you should use migrations
|
||||
def wrapper(func):
|
||||
@functools.wraps(func)
|
||||
async def wrapped(*args):
|
||||
engine = sqlalchemy.create_engine(str(base_config.database.url))
|
||||
base_config.metadata.drop_all(engine)
|
||||
base_config.metadata.create_all(engine)
|
||||
await func(*args)
|
||||
base_config.metadata.drop_all(engine)
|
||||
|
||||
return wrapped
|
||||
|
||||
return wrapper
|
||||
Reference in New Issue
Block a user