Files
bambuddy/backend/app/schemas/archive.py
T
maziggy 1e734fb7c6 fix(stats): cancelled prints get their own bucket; gauge denominator excludes them (#1390 follow-up)
Reporter (@IndividualGhost1905) saw Total: 20 / Success: 18 / Failed: 1
  and asked where the 20th print went. The Quick Stats endpoint counted
  status == "completed" → Successful and status == "failed" → Failed, but
  used a raw count(*) for Total Prints, so the four other PrintLogEntry
  statuses (aborted, stopped, cancelled, skipped) silently inflated the
  total without showing up in any breakdown row. The earlier #1390 round
  had committed a test locking in this exact behaviour
  ("uses total_prints as denominator so cancelled/stopped events count"),
  which was wrong: it conflated user intent with print quality.

  Three-bucket classification, applied across the whole stats surface
  and matching how the rest of the codebase already groups statuses
  (main.py:430, 1729; failure_analysis status filter):

    successful = completed
    failed     = failed + aborted    (printer-detected quality failures)
    cancelled  = stopped + cancelled + skipped  (user/queue stopped)

  Quick Stats endpoint returns the new cancelled_prints field;
  ArchiveStats.cancelled_prints defaults to 0 so older fixtures still
  parse. SuccessRateWidget gauge now divides by successful + failed
  only — a cancelled roll no longer drags the gauge down — and a
  Cancelled row appears in the breakdown so the missing prints don't
  silently vanish from Total Prints.

  Failure Analysis service applies the same denominator fix to both
  the headline failure_rate and the per-week trend, so a week with
  several cancellations and zero failures reads as 0% rather than
  a misleading "failed / total".

  i18n: new stats.cancelled key in all 9 locales with real
  translations (no English fallback), parity script clean.

  Tests: the existing 'uses total_prints as denominator' assertion
  is inverted to assert the new behaviour (40 / 20 / 35 → 67% gauge,
  Cancelled: 35 visible). The unchanged-display path (140 / 10 / 0
  → 93%) still holds since 140 / (140 + 10) = 93.33% rounds the
  same. 33 StatsPage tests + 6 backend stats/failure tests green.
2026-05-24 15:21:10 +02:00

243 lines
7.6 KiB
Python

from datetime import datetime
from pydantic import BaseModel, model_validator
class ArchiveBase(BaseModel):
print_name: str | None = None
is_favorite: bool | None = None
tags: str | None = None
notes: str | None = None
cost: float | None = None
failure_reason: str | None = None
quantity: int | None = None # Number of items printed
# User-defined link (Printables, Thingiverse, etc.)
external_url: str | None = None
class ArchiveUpdate(ArchiveBase):
printer_id: int | None = None
project_id: int | None = None
# Allow changing status (e.g., clearing failed flag)
status: str | None = None
class ArchiveDuplicate(BaseModel):
"""Reference to a duplicate archive."""
id: int
print_name: str | None
created_at: datetime
match_type: str # "exact" (hash match) or "similar" (name match)
class ArchiveResponse(BaseModel):
id: int
printer_id: int | None
project_id: int | None = None
project_name: str | None = None # Included for convenience
filename: str
file_path: str
file_size: int
content_hash: str | None
thumbnail_path: str | None
timelapse_path: str | None
source_3mf_path: str | None = None # Original project 3MF from slicer
f3d_path: str | None = None # Fusion 360 design file
# Duplicate detection
duplicates: list[ArchiveDuplicate] | None = None
duplicate_count: int = 0 # Quick count for list views
duplicate_sequence: int = 0 # 0 = original, 1+ = nth duplicate
original_archive_id: int | None = None # ID of the first/original archive
# Object count (computed from extra_data.printable_objects)
object_count: int | None = None
print_name: str | None
print_time_seconds: int | None # Estimated time from slicer
actual_time_seconds: int | None = None # Computed from started_at/completed_at
# Percentage: 100 = perfect, >100 = faster than estimated
time_accuracy: float | None = None
filament_used_grams: float | None
filament_type: str | None
filament_color: str | None
layer_height: float | None
total_layers: int | None = None
nozzle_diameter: float | None
bed_temperature: int | None
bed_type: str | None = None # e.g. "Cool Plate", "Textured PEI Plate" (from 3MF curr_bed_type)
nozzle_temperature: int | None
sliced_for_model: str | None = None # Printer model this file was sliced for
status: str
started_at: datetime | None
completed_at: datetime | None
extra_data: dict | None
makerworld_url: str | None
designer: str | None
# User-defined link (Printables, Thingiverse, etc.)
external_url: str | None = None
is_favorite: bool
tags: str | None
notes: str | None
cost: float | None
photos: list | None
failure_reason: str | None
quantity: int = 1 # Number of items printed
# Energy tracking
energy_kwh: float | None = None
energy_cost: float | None = None
created_at: datetime
# User tracking (Issue #206)
created_by_id: int | None = None
created_by_username: str | None = None
# Per-archive run aggregates (#1378). Computed from PrintLogEntry — one
# row per actual print event — so reprints contribute to these counters
# without overwriting the source archive's first-run data.
run_count: int = 0
last_run_at: datetime | None = None
total_filament_actual_grams: float | None = None
successful_run_count: int = 0
failed_run_count: int = 0
@model_validator(mode="after")
def compute_object_count(self) -> "ArchiveResponse":
"""Compute object_count from extra_data.printable_objects if not set."""
if self.object_count is None and self.extra_data:
printable_objects = self.extra_data.get("printable_objects")
if printable_objects and isinstance(printable_objects, dict):
self.object_count = len(printable_objects)
return self
class Config:
from_attributes = True
class ArchiveSlim(BaseModel):
"""Lightweight archive response for stats/dashboard widgets."""
printer_id: int | None
print_name: str | None
print_time_seconds: int | None
actual_time_seconds: int | None = None
filament_used_grams: float | None
filament_type: str | None
filament_color: str | None
status: str
started_at: datetime | None
completed_at: datetime | None
cost: float | None
quantity: int = 1
created_at: datetime
class Config:
from_attributes = True
class ArchiveStats(BaseModel):
total_prints: int
successful_prints: int
failed_prints: int
# User/system-stopped prints (PrintLogEntry.status in stopped/cancelled/
# skipped). Defaulted so older clients that don't send this field still
# validate against historical fixtures.
cancelled_prints: int = 0
total_print_time_hours: float
total_filament_grams: float
total_cost: float
prints_by_filament_type: dict
prints_by_printer: dict
# Time accuracy stats
# Average across all prints with data
average_time_accuracy: float | None = None
time_accuracy_by_printer: dict | None = None # Per-printer accuracy
# Energy stats
total_energy_kwh: float = 0.0
total_energy_cost: float = 0.0
# Set when the date-range query in "total consumption" mode is running on
# incomplete snapshot history — e.g. right after a fresh upgrade before the
# hourly snapshot loop has built up a baseline. Frontend shows a tooltip.
energy_data_warming_up: bool = False
class ProjectPageImage(BaseModel):
"""Image embedded in 3MF project page."""
name: str
path: str # Path within 3MF
url: str # API URL to fetch image
class ProjectPageResponse(BaseModel):
"""Project page data extracted from 3MF file."""
# Model info
title: str | None = None
description: str | None = None # HTML content
designer: str | None = None
designer_user_id: str | None = None
license: str | None = None
copyright: str | None = None
creation_date: str | None = None
modification_date: str | None = None
origin: str | None = None # "original" or "remix"
# Profile info
profile_title: str | None = None
profile_description: str | None = None
profile_cover: str | None = None
profile_user_id: str | None = None
profile_user_name: str | None = None
# MakerWorld info
design_model_id: str | None = None
design_profile_id: str | None = None
design_region: str | None = None
# Images
model_pictures: list[ProjectPageImage] = []
profile_pictures: list[ProjectPageImage] = []
thumbnails: list[ProjectPageImage] = []
class ProjectPageUpdate(BaseModel):
"""Update project page data in 3MF file."""
title: str | None = None
description: str | None = None
designer: str | None = None
license: str | None = None
copyright: str | None = None
profile_title: str | None = None
profile_description: str | None = None
class ReprintRequest(BaseModel):
"""Request body for reprinting an archive."""
# Plate selection for multi-plate 3MF files
# If not specified, auto-detects from file (legacy behavior for single-plate files)
plate_id: int | None = None
plate_name: str | None = None
# AMS slot mapping: list of tray IDs for each filament slot in the 3MF
# Global tray ID = (ams_id * 4) + slot_id, external = 254
ams_mapping: list[int] | None = None
# Print options
bed_levelling: bool = True
flow_cali: bool = False
vibration_cali: bool = True
layer_inspect: bool = False
timelapse: bool = False
use_ams: bool = True # Not exposed in UI, but needed for API