feat: Schlagwörter je Kategorie + auf-/zuklappbares Kategorie-Dropdown

- Manuelle Schlagwörter je Kategorie (Popup mit Chips, Doppelklick zum Bearbeiten)
- Treffer über Empfänger ODER Verwendungszweck; längstes Schlagwort gewinnt;
  Kind-Filter (Ausgabe/Einnahme); wirken nur bei künftigen Importen
- Lernende Korrektur-Erkennung: ab 5 Anwendungen und >= 1/3 Korrekturen
  erscheint eine Prüf-Meldung in den Einstellungen (Behalten/Entfernen)
- Neue CategorySelect-Komponente (Baum + Suche, per Portal) ersetzt die
  nativen optgroup-Selects in Buchungen und Import-Prüfansicht
- Migration 0006 (source/applied_count/overridden_count/confirmed, match_field any)
- Endpunkte, i18n DE/EN, Tests (test_keywords: 7 neu, gesamt 27 grün)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
Guido
2026-08-19 21:31:29 +02:00
co-authored by Claude Opus 4.8
parent f375fc5eaa
commit 37f64999cd
17 changed files with 1137 additions and 45 deletions
+18 -1
View File
@@ -94,6 +94,12 @@ class AmountMode(str, enum.Enum):
class MatchField(str, enum.Enum):
payee = "payee"
purpose = "purpose"
any = "any" # trifft, wenn das Muster im Empfänger ODER im Zweck vorkommt
class RuleSource(str, enum.Enum):
learned = "learned" # automatisch aus bestätigten Zuordnungen gelernt
manual = "manual" # vom Nutzer als Schlagwort angelegt
class ImportStatus(str, enum.Enum):
@@ -466,7 +472,13 @@ class ImportBatch(Base):
class CategorizationRule(Base):
"""Lernende Regel: Empfänger/Zweck enthält Muster -> Kategorie (oder Transfer)."""
"""Regel: Empfänger/Zweck enthält Muster -> Kategorie.
Zwei Quellen (``source``): ``learned`` wird beim Import automatisch aus
bestätigten Zuordnungen gelernt; ``manual`` legt der Nutzer als Schlagwort je
Kategorie an. ``applied_count``/``overridden_count`` zählen, wie oft die Regel
zutraf und wie oft ihr Vorschlag wegkorrigiert wurde – daraus wird ein
manuelles Schlagwort ggf. als „stimmt vielleicht nicht" markiert."""
__tablename__ = "categorization_rules"
@@ -479,8 +491,13 @@ class CategorizationRule(Base):
category_id: Mapped[int | None] = mapped_column(
ForeignKey("categories.id", ondelete="CASCADE"), nullable=True
)
source: Mapped[RuleSource] = mapped_column(_enum(RuleSource), nullable=False, default=RuleSource.learned)
priority: Mapped[int] = mapped_column(Integer, nullable=False, default=0)
hits: Mapped[int] = mapped_column(Integer, nullable=False, default=0)
applied_count: Mapped[int] = mapped_column(Integer, nullable=False, default=0)
overridden_count: Mapped[int] = mapped_column(Integer, nullable=False, default=0)
# „Behalten, nicht mehr fragen" – unterdrückt das Flaggen trotz Korrekturen.
confirmed: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False)
created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now)
__table_args__ = (
+161 -2
View File
@@ -3,12 +3,12 @@
Eine Kategorie erbt ihre Art (Einnahme/Ausgabe) von ihrer Gruppe.
"""
from fastapi import APIRouter, Depends, status
from fastapi import APIRouter, Depends, HTTPException, status
from sqlalchemy.orm import Session
from ..database import get_db
from ..deps import get_current_user, get_owned
from ..models import Category, CategoryGroup, User
from ..models import CategorizationRule, Category, CategoryGroup, MatchField, RuleSource, User
from ..schemas import (
CategoryCreate,
CategoryGroupCreate,
@@ -16,10 +16,20 @@ from ..schemas import (
CategoryGroupUpdate,
CategoryOut,
CategoryUpdate,
FlaggedKeywordOut,
KeywordCreate,
KeywordOut,
KeywordUpdate,
)
from ..services.csv_import import normalize_text
router = APIRouter(prefix="/categories", tags=["categories"])
# Ab wann ein manuelles Schlagwort als „stimmt vielleicht nicht" markiert wird:
# mindestens so viele Anwendungen UND mindestens dieser Anteil wegkorrigiert.
FLAG_MIN_APPLIED = 5
FLAG_RATIO_DEN = 3 # >= 1/3 (jede dritte)
def group_out(g: CategoryGroup) -> CategoryGroupOut:
cats = sorted(g.categories, key=lambda c: (c.position, c.name.lower()))
@@ -152,3 +162,152 @@ def delete_category(
cat = get_owned(db, Category, category_id, user)
db.delete(cat)
db.commit()
# --- Schlagwörter je Kategorie (manuelle Regeln, Feld = Empfänger ODER Zweck) ---
def _keyword_out(rule: CategorizationRule) -> KeywordOut:
return KeywordOut(id=rule.id, category_id=rule.category_id, word=rule.pattern)
def _owned_manual_rule(db: Session, rule_id: int, user: User) -> CategorizationRule:
rule = db.get(CategorizationRule, rule_id)
if rule is None or rule.owner_id != user.id or rule.source != RuleSource.manual:
raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail="Nicht gefunden")
return rule
@router.get("/keywords/flagged", response_model=list[FlaggedKeywordOut])
def list_flagged_keywords(db: Session = Depends(get_db), user: User = Depends(get_current_user)):
"""Manuelle Schlagwörter, die auffällig oft wegkorrigiert werden."""
rules = (
db.query(CategorizationRule)
.filter(
CategorizationRule.owner_id == user.id,
CategorizationRule.source == RuleSource.manual,
CategorizationRule.confirmed.is_(False),
CategorizationRule.applied_count >= FLAG_MIN_APPLIED,
CategorizationRule.overridden_count * FLAG_RATIO_DEN >= CategorizationRule.applied_count,
)
.order_by(CategorizationRule.overridden_count.desc())
.all()
)
names = {c.id: c.name for c in db.query(Category).filter(Category.owner_id == user.id)}
return [
FlaggedKeywordOut(
id=r.id, category_id=r.category_id, category_name=names.get(r.category_id, "?"),
word=r.pattern, applied_count=r.applied_count, overridden_count=r.overridden_count,
)
for r in rules
]
@router.post("/keywords/{rule_id}/confirm", status_code=status.HTTP_204_NO_CONTENT)
def confirm_keyword(rule_id: int, db: Session = Depends(get_db), user: User = Depends(get_current_user)):
"""„Behalten" – nicht mehr nachfragen, obwohl korrigiert wird."""
rule = _owned_manual_rule(db, rule_id, user)
rule.confirmed = True
db.commit()
@router.patch("/keywords/{rule_id}", response_model=KeywordOut)
def update_keyword(
rule_id: int,
payload: KeywordUpdate,
db: Session = Depends(get_db),
user: User = Depends(get_current_user),
):
"""Wort eines Schlagworts ändern (Inline-Bearbeitung im Popup). Da sich das
Muster ändert, werden die Korrektur-Zähler zurückgesetzt."""
rule = _owned_manual_rule(db, rule_id, user)
pattern = normalize_text(payload.word)[:255]
if not pattern:
raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST, detail="Leeres Schlagwort")
if pattern != rule.pattern:
clash = (
db.query(CategorizationRule)
.filter(
CategorizationRule.owner_id == user.id,
CategorizationRule.match_field == MatchField.any,
CategorizationRule.pattern == pattern,
CategorizationRule.id != rule.id,
)
.first()
)
if clash is not None:
other = db.get(Category, clash.category_id)
other_name = other.name if other else "?"
raise HTTPException(
status_code=status.HTTP_409_CONFLICT,
detail=f"Schlagwort ist bereits der Kategorie „{other_name}“ zugeordnet.",
)
rule.pattern = pattern
rule.applied_count = 0
rule.overridden_count = 0
rule.confirmed = False
db.commit()
db.refresh(rule)
return _keyword_out(rule)
@router.delete("/keywords/{rule_id}", status_code=status.HTTP_204_NO_CONTENT)
def delete_keyword(rule_id: int, db: Session = Depends(get_db), user: User = Depends(get_current_user)):
rule = _owned_manual_rule(db, rule_id, user)
db.delete(rule)
db.commit()
@router.get("/{category_id}/keywords", response_model=list[KeywordOut])
def list_keywords(category_id: int, db: Session = Depends(get_db), user: User = Depends(get_current_user)):
cat = get_owned(db, Category, category_id, user)
rules = (
db.query(CategorizationRule)
.filter(
CategorizationRule.owner_id == user.id,
CategorizationRule.source == RuleSource.manual,
CategorizationRule.category_id == cat.id,
)
.order_by(CategorizationRule.pattern)
.all()
)
return [_keyword_out(r) for r in rules]
@router.post("/{category_id}/keywords", response_model=KeywordOut, status_code=status.HTTP_201_CREATED)
def add_keyword(
category_id: int,
payload: KeywordCreate,
db: Session = Depends(get_db),
user: User = Depends(get_current_user),
):
cat = get_owned(db, Category, category_id, user)
pattern = normalize_text(payload.word)[:255]
if not pattern:
raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST, detail="Leeres Schlagwort")
existing = (
db.query(CategorizationRule)
.filter(
CategorizationRule.owner_id == user.id,
CategorizationRule.match_field == MatchField.any,
CategorizationRule.pattern == pattern,
)
.first()
)
if existing is not None:
if existing.category_id == cat.id:
return _keyword_out(existing) # schon vorhanden – unverändert zurück
other = db.get(Category, existing.category_id)
other_name = other.name if other else "?"
raise HTTPException(
status_code=status.HTTP_409_CONFLICT,
detail=f"Schlagwort ist bereits der Kategorie „{other_name}“ zugeordnet.",
)
rule = CategorizationRule(
owner_id=user.id, match_field=MatchField.any, pattern=pattern,
category_id=cat.id, source=RuleSource.manual, priority=10,
)
db.add(rule)
db.commit()
db.refresh(rule)
return _keyword_out(rule)
+26
View File
@@ -345,3 +345,29 @@ class ImportCommitIn(BaseModel):
template_id: int | None = None
filename: str = ""
rows: list[dict] = Field(default_factory=list)
# --- Schlagwörter (manuelle Kategorisierungs-Regeln) -----------------------
class KeywordCreate(BaseModel):
word: str = Field(min_length=1, max_length=255)
class KeywordUpdate(BaseModel):
word: str = Field(min_length=1, max_length=255)
class KeywordOut(BaseModel):
id: int
category_id: int
word: str
class FlaggedKeywordOut(BaseModel):
id: int
category_id: int
category_name: str
word: str
applied_count: int
overridden_count: int
+72 -15
View File
@@ -18,10 +18,12 @@ from ..models import (
BudgetTreatment,
CategorizationRule,
Category,
CategoryKind,
ImportBatch,
ImportStatus,
ImportTemplate,
MatchField,
RuleSource,
SAVINGS_ACCOUNT_TYPES,
Transaction,
TxnType,
@@ -143,14 +145,43 @@ def import_hash(account_id: int, d: date | None, amount_cents: int | None, payee
# --- Vorschau --------------------------------------------------------------
def _apply_rules(rules: list[CategorizationRule], payee: str, purpose: str) -> int | None:
def _rule_sort_key(rule: CategorizationRule) -> tuple:
"""Reihenfolge der Regelanwendung: längstes Schlagwort zuerst, dann manuelle
vor gelernten, dann höhere Priorität/mehr Treffer."""
return (
len(rule.pattern or ""),
1 if rule.source == RuleSource.manual else 0,
rule.priority,
rule.hits,
)
def _apply_rules(
rules: list[CategorizationRule],
payee: str,
purpose: str,
allowed_kind: CategoryKind | None,
cat_kind: dict[int, CategoryKind],
) -> tuple[int | None, int | None]:
"""Erste passende Regel -> (category_id, rule_id). Nur Kategorien, deren Art
(Einnahme/Ausgabe) zur Buchung passt, damit ein Ausgabe-Schlagwort keine
Einnahme falsch einordnet."""
p = normalize_text(payee)
z = normalize_text(purpose)
for rule in rules: # bereits nach Priorität sortiert
hay = p if rule.match_field == MatchField.payee else z
if rule.pattern and rule.pattern in hay and rule.category_id:
return rule.category_id
return None
for rule in rules: # bereits sortiert (längstes/​manuell zuerst)
if not rule.pattern or not rule.category_id:
continue
if allowed_kind is not None and cat_kind.get(rule.category_id) != allowed_kind:
continue
if rule.match_field == MatchField.payee:
hit = rule.pattern in p
elif rule.match_field == MatchField.purpose:
hit = rule.pattern in z
else: # any: Empfänger ODER Zweck
hit = rule.pattern in p or rule.pattern in z
if hit:
return rule.category_id, rule.id
return None, None
def parse_file_to_candidates(data: bytes, template: ImportTemplate) -> list[dict]:
@@ -200,12 +231,12 @@ def detect_rows(db: Session, user: User, account: Account, candidates: list[dict
):
idents[value_norm] = acc_id
rules = (
db.query(CategorizationRule)
.filter(CategorizationRule.owner_id == user.id)
.order_by(CategorizationRule.priority.desc(), CategorizationRule.hits.desc())
.all()
)
rules = db.query(CategorizationRule).filter(CategorizationRule.owner_id == user.id).all()
rules.sort(key=_rule_sort_key, reverse=True) # längstes/​manuell zuerst
cat_kind: dict[int, CategoryKind] = {
cid: kind
for cid, kind in db.query(Category.id, Category.type).filter(Category.owner_id == user.id)
}
existing = {
h[0]
for h in db.query(Transaction.import_hash).filter(
@@ -226,6 +257,7 @@ def detect_rows(db: Session, user: User, account: Account, candidates: list[dict
valid = d is not None and amount is not None and amount != 0
ttype = "expense" if (amount or 0) < 0 else "income"
category_id: int | None = None
matched_rule_id: int | None = None
to_account_id: int | None = None
other = idents.get(iban) if iban else None
@@ -233,7 +265,10 @@ def detect_rows(db: Session, user: User, account: Account, candidates: list[dict
ttype = "transfer"
to_account_id = other
else:
category_id = _apply_rules(rules, payee or "", purpose or "")
kind = CategoryKind.expense if ttype == "expense" else CategoryKind.income
category_id, matched_rule_id = _apply_rules(
rules, payee or "", purpose or "", kind, cat_kind
)
h = import_hash(account.id, d, amount, payee)
is_dup = h in existing or h in seen
@@ -249,6 +284,7 @@ def detect_rows(db: Session, user: User, account: Account, candidates: list[dict
"valid": valid,
"type": ttype,
"category_id": category_id,
"matched_rule_id": matched_rule_id,
"to_account_id": to_account_id,
"import_hash": h,
"is_duplicate": is_dup,
@@ -347,13 +383,34 @@ def _learn_rule(db: Session, user: User, row: dict) -> None:
if existing is None:
db.add(CategorizationRule(
owner_id=user.id, match_field=MatchField.payee, pattern=pattern,
category_id=cat, priority=1, hits=1,
category_id=cat, source=RuleSource.learned, priority=1, hits=1,
))
# Sichtbar machen (Session ist autoflush=False), damit dasselbe Muster ein
# zweites Mal im selben Import die vorhandene Regel findet statt zu doppeln.
db.flush()
else:
existing.category_id = cat
existing.hits += 1
def _track_and_learn(db: Session, user: User, row: dict) -> None:
"""Zählt für die zutreffende Regel Anwendung/Korrektur (Basis fürs Flaggen von
Schlagwörtern) und lernt anschließend Empfänger -> Kategorie weiter."""
rid = row.get("matched_rule_id")
final_cat = row.get("category_id")
matched_manual_kept = False
if rid:
rule = db.get(CategorizationRule, rid)
if rule is not None and rule.owner_id == user.id:
rule.applied_count = (rule.applied_count or 0) + 1
if final_cat != rule.category_id:
rule.overridden_count = (rule.overridden_count or 0) + 1
elif rule.source == RuleSource.manual:
matched_manual_kept = True # Schlagwort greift schon – nicht doppelt lernen
if not matched_manual_kept:
_learn_rule(db, user, row)
def commit_import(db: Session, user: User, account: Account, template_id: int | None, filename: str, rows: list[dict]) -> ImportBatch:
accounts = {a.id: a for a in db.query(Account).filter(Account.owner_id == user.id)}
batch = ImportBatch(
@@ -372,7 +429,7 @@ def commit_import(db: Session, user: User, account: Account, template_id: int |
if txn is None:
continue
db.add(txn)
_learn_rule(db, user, row)
_track_and_learn(db, user, row)
imported += 1
batch.imported_count = imported