Files
paper-doc/backend/app/models/template_title_placement.py
T
govin 199e328b48 refactor: call a heading a title, and its use a placement
`template_field_library` and `template_field` were one word apart and meant
opposite kinds of thing — a catalogue of rows versus one row — and neither name
said what a row actually is. Every row of the library is a **heading**: a piece
of text like 「1. Introduction」 with a level and typography, which is what the
reader sees at the top of a paragraph; and every row of the join table is that
heading *placed* in a template, `sort` included.

    template_field_library  -> template_title
    template_field          -> template_title_placement
    field_id (the column)   -> title_id
    TemplateFieldLibrary    -> TemplateTitle
    TemplateField           -> TemplateTitlePlacement

The join table keeps its own name rather than becoming `_link`, because it is
not a bare link: it carries `sort`, the only place display order is stored, and
it deliberately allows the same title twice in one template. `_link` would
describe two foreign keys and hide the column the ordering rule rests on.

Carried through every level, because a half-renamed layer is how the confusing
pair got there in the first place: HTTP paths (`/template-field-library` ->
`/template-titles`), the template payload (`fields`/`field_id` ->
`placements`/`title_id`, and `field_count` -> `placement_count`), the Pydantic
schemas, the CRUD modules, the seed script, the frontend API module and types,
and `docs/OVERVIEW.md`, which now states the naming rules outright.

Two deliberate exceptions:

* `paper_template_filed_sort` is untouched — it is a column of the paper module
  and is spelled as the feature was specified.
* The MCP tools keep their agent-facing names (`field_list`, `field_ids`, and
  the `fields`/`field_id` keys in their responses). Agents already call them by
  those names; the storage names they read underneath have changed.

The migration renames in place (data preserved: 4 templates, 45 titles, 63
placements) and is written to tolerate a database where part of it already ran,
which is not hypothetical — the first attempt renamed the tables and then failed
on the column, because Alembic's MySQL dialect wants an explicit type for
`alter_column` and will not rename a column without one. TiDB carries the
foreign key along with both the renamed table and the renamed column, rehearsed
against the cluster first, and it stays enforced.

Verified: seed re-runs clean, the paper smoke test's 45 checks and the MCP
smoke test's 47 pass, `vue-tsc` and the build are clean, and the UI was driven
in a headless browser through the template list, its preview drawer, the title
library page, the template form (which now posts `placements` with `title_id`)
and the paper document with no console errors.
2026-09-22 16:55:02 +08:00

74 lines
2.9 KiB
Python

"""The template <-> field join table (关联表), which owns the display order.
This table is the heart of the design. It carries exactly one piece of
information that belongs to neither side alone: ``sort`` — where this field
sits in *this* template.
Consequences worth stating explicitly, because they are the requirements:
* A field can appear in many templates, at a different position in each.
* A field can legitimately appear **more than once** in the same template
(e.g. a level-2 "Background" under both "1. Introduction" and
"2. Related Work"), so there is deliberately **no** unique constraint on
``(template_id, field_id)``. The UI warns about repeats; it does not forbid
them.
* The user picks fields in any order they like. Nothing about the selection
order is stored — readers order strictly by ``sort``, then by ``id`` as a
stable tie-breaker.
"""
from typing import TYPE_CHECKING
from sqlalchemy import ForeignKey, Index, Integer
from sqlalchemy.orm import Mapped, mapped_column, relationship
from app.db.base import Base
if TYPE_CHECKING: # pragma: no cover - typing only
from app.models.template import Template
from app.models.template_title import TemplateTitle
class TemplateTitlePlacement(Base):
"""One placement of one library title inside one template."""
__tablename__ = "template_title_placement"
__table_args__ = (
# Every read is "the placements of template X, in order", so the index
# covers both the filter and the sort.
Index("ix_template_title_placement_template_sort", "template_id", "sort"),
Index("ix_template_title_placement_title_id", "title_id"),
)
id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
template_id: Mapped[int] = mapped_column(
ForeignKey("template.id", ondelete="CASCADE"),
nullable=False,
)
#: ``RESTRICT``: a title still placed in a template must not vanish from
#: under it. The API checks this in Python too, so a refusal names the row
#: rather than surfacing a driver error.
title_id: Mapped[int] = mapped_column(
ForeignKey("template_title.id", ondelete="RESTRICT"),
nullable=False,
)
#: Display position within the template. Plain ascending integer — lower
#: sorts render first regardless of the title's ``level``.
sort: Mapped[int] = mapped_column(Integer, nullable=False, default=0)
template: Mapped["Template"] = relationship(back_populates="placements")
#: Eager-loaded because every template read needs the title's name and
#: typography; lazy loading would emit one query per row.
title: Mapped["TemplateTitle"] = relationship(lazy="joined")
def __repr__(self) -> str: # pragma: no cover - debugging aid
return (
f"<TemplateTitlePlacement template_id={self.template_id} "
f"title_id={self.title_id} sort={self.sort}>"
)