infuanfu/teilchensammler-cli
2
0
Fork 0
Code Issues 3 Pull requests Releases 9 Packages 1 Activity

codestyle: add docstrings to helper functions

Browse source
This commit is contained in:
bronsen 2026-02-22 20:41:40 +01:00
parent 600b211d3c
commit 336eeb7af2
1 changed files with 16 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

16
src/teilchensammler_cli/models.py
View file

@ -82,7 +82,14 @@ async def make_teilchen_input(text: str) -> TeilchenCreate | None:
async def load_initial_data(engine) -> Sequence[Teilchen]: async def load_initial_data(engine) -> Sequence[Teilchen]:
"""Retrieve all Teilchen records from the database.
Args:
engine (sqlalchemy.Engine): the engine or connection or whatever
Returns:
List of Teilchen, potentially empty
"""
with Session(engine) as session: with Session(engine) as session:
statement = select( statement = select(
Teilchen.id, Teilchen.name, Teilchen.description, Teilchen.number, Teilchen.tags Teilchen.id, Teilchen.name, Teilchen.description, Teilchen.number, Teilchen.tags
@ -92,6 +99,15 @@ async def load_initial_data(engine) -> Sequence[Teilchen]:
async def add_to_database(tc: TeilchenCreate, engine) -> Teilchen: async def add_to_database(tc: TeilchenCreate, engine) -> Teilchen:
"""Add given data as a new record into the database.
Args:
engine (sqlalchemy.Engine): the engine or connection or whatever
tc: Teilchen data (no `id` yet)
Returns:
The newly created Teilchen (this time with `id`)
"""
with Session(engine) as session: with Session(engine) as session:
teilchen = Teilchen.model_validate(tc) teilchen = Teilchen.model_validate(tc)
session.add(teilchen) session.add(teilchen)