govin
13e5fc2cc1
Three tables behind the template configuration feature:
section_field the reusable heading library (name, level, font size,
colour)
paper_template a named outline (name, abstract)
template_field the join, and the only home of display order (sort)
The field library is deliberately flat. A `parent_id` would tie a level-2
heading to exactly one level-1 heading, and the point of the feature is that
a field such as "Background" can sit under both "1. Introduction" and
"2. Related Work" — and in any number of templates, at a different position
in each. Hierarchy is expressed only by `level`, which is a rendering hint.
Display order lives entirely in `template_field.sort`. The order fields were
picked in is never stored, so selecting fields out of order and assigning
sorts renders in sort order. Two consequences are intentional and documented
on the model: repeats are allowed (no unique constraint on template+field)
and ties are legal (broken by insertion order, so the ordering is total).
Templates reference library fields rather than copying them, so renaming or
restyling a field updates every template that places it.
TiDB parses FOREIGN KEY and then ignores it, so the constraints are declared
for documentation and the integrity is enforced in the application layer:
deleting a field still in use is refused with the field names, creating a
template against a missing field is refused, and deleting a template removes
its join rows through the ORM's delete-orphan cascade.
Also normalises font_color to #RRGGBB on write (accepting rgb() and
shorthand) and emits font_size as a JSON number rather than pydantic's
default Decimal string.
scripts/seed.py is idempotent and fills the library with a standard academic
outline plus three starter templates.
119 lines
3.8 KiB
Python
119 lines
3.8 KiB
Python
"""Data access for the reusable section-field library (字段管理)."""
|
|
|
|
from collections.abc import Sequence
|
|
|
|
from sqlalchemy import Select, func, select
|
|
from sqlalchemy.orm import Session
|
|
|
|
from app.crud.filters import LIKE_ESCAPE, like_pattern
|
|
from app.models import SectionField, TemplateField
|
|
from app.schemas.section_field import SectionFieldCreate, SectionFieldUpdate
|
|
|
|
|
|
def _conditions(keyword: str | None, level: int | None) -> list:
|
|
"""Translate the list filters into SQLAlchemy predicates."""
|
|
conditions = []
|
|
if keyword:
|
|
conditions.append(
|
|
SectionField.name.like(like_pattern(keyword), escape=LIKE_ESCAPE)
|
|
)
|
|
if level is not None:
|
|
conditions.append(SectionField.level == level)
|
|
return conditions
|
|
|
|
|
|
def _ordered(stmt: Select) -> Select:
|
|
"""Apply the library's canonical browse order.
|
|
|
|
Grouped by ``level`` first so the picker reads as an outline, then by
|
|
insertion order so a field stays where the user put it. Deliberately *not*
|
|
ordered by ``name``: names carry hand-written numbering ("1.", "10.",
|
|
"2."), and string ordering would scramble it.
|
|
"""
|
|
return stmt.order_by(SectionField.level.asc(), SectionField.id.asc())
|
|
|
|
|
|
def list_fields(
|
|
db: Session,
|
|
*,
|
|
keyword: str | None = None,
|
|
level: int | None = None,
|
|
page: int = 1,
|
|
page_size: int = 20,
|
|
) -> tuple[list[SectionField], int]:
|
|
"""Return one page of the field library, plus the unpaged total."""
|
|
conditions = _conditions(keyword, level)
|
|
|
|
total = db.scalar(
|
|
select(func.count(SectionField.id)).where(*conditions)
|
|
) or 0
|
|
|
|
stmt = _ordered(
|
|
select(SectionField)
|
|
.where(*conditions)
|
|
.offset((page - 1) * page_size)
|
|
.limit(page_size)
|
|
)
|
|
return list(db.scalars(stmt).all()), total
|
|
|
|
|
|
def get(db: Session, field_id: int) -> SectionField | None:
|
|
"""Return one field, or ``None``."""
|
|
return db.get(SectionField, field_id)
|
|
|
|
|
|
def get_many(db: Session, field_ids: Sequence[int]) -> list[SectionField]:
|
|
"""Return every field whose id is in ``field_ids`` (missing ids ignored)."""
|
|
if not field_ids:
|
|
return []
|
|
stmt = select(SectionField).where(SectionField.id.in_(list(field_ids)))
|
|
return list(db.scalars(stmt).all())
|
|
|
|
|
|
def usage_counts(db: Session, field_ids: Sequence[int]) -> dict[int, int]:
|
|
"""Count how many *distinct templates* place each field.
|
|
|
|
Drives the refusal message when a field in use is deleted. ``DISTINCT``
|
|
matters because one template may legitimately place the same field twice.
|
|
"""
|
|
if not field_ids:
|
|
return {}
|
|
stmt = (
|
|
select(
|
|
TemplateField.field_id,
|
|
func.count(func.distinct(TemplateField.template_id)),
|
|
)
|
|
.where(TemplateField.field_id.in_(list(field_ids)))
|
|
.group_by(TemplateField.field_id)
|
|
)
|
|
return {field_id: count for field_id, count in db.execute(stmt).all()}
|
|
|
|
|
|
def create(db: Session, data: SectionFieldCreate) -> SectionField:
|
|
"""Insert a field."""
|
|
field = SectionField(**data.model_dump())
|
|
db.add(field)
|
|
db.commit()
|
|
db.refresh(field)
|
|
return field
|
|
|
|
|
|
def update(db: Session, field: SectionField, data: SectionFieldUpdate) -> SectionField:
|
|
"""Apply a partial update to a field.
|
|
|
|
``exclude_unset`` is what makes PATCH semantics work: a key the client did
|
|
not send leaves the column alone, while an explicit ``null`` — which the
|
|
schemas reject for every nullable-typed column here — would not.
|
|
"""
|
|
for key, value in data.model_dump(exclude_unset=True).items():
|
|
setattr(field, key, value)
|
|
db.commit()
|
|
db.refresh(field)
|
|
return field
|
|
|
|
|
|
def delete(db: Session, field: SectionField) -> None:
|
|
"""Delete a field. Callers must check :func:`usage_counts` first."""
|
|
db.delete(field)
|
|
db.commit()
|