Files
shopdb-flask/plugins/printers/models/model_supply.py
cproudlock f663cc5bbe Enforce plugin contract purity: single import surface via shopdb.api
Plugins were reaching into internal core paths (shopdb.core.models.*,
shopdb.extensions, shopdb.utils.*), coupling them to core's file layout and
violating the ADR-001 contract. Consolidate onto one versioned surface.

- shopdb.api: expand from 2 helpers to the full plugin import surface -
  db, cache; BaseModel, AuditMixin; core models (Asset, AssetType,
  AssetStatus, Vendor, Model, Communication, CommunicationType, Location,
  Setting, AuditLog, Application, AppVersion, OperatingSystem); response +
  pagination helpers; employee_connection. Documented in PLUGIN-HOOKS.md.
- Migrate all 22 plugin source files to import only from shopdb.api (plus
  shopdb.plugins.base for the ABC).
- Drop the printers plugin's legacy MachineType dependency: remove
  _ensure_legacy_machine_types and the seed_supplies machinetypeid lookup
  (Model.machinetypeid is nullable; printers carry type via PrinterType).
- Guard test test_plugins_only_import_contract_surface scans plugin source
  and fails on any core import outside shopdb.api / shopdb.plugins.base.
- Scaffold templates updated so generated plugins are contract-pure.
- Bump __contract_version__ 0.2.0 -> 0.3.0 (additive surface expansion;
  manifests pin <1.0.0 so they still satisfy).

145 tests pass, naming/style green, app factory boots all 6 plugins.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-26 16:45:06 -04:00

57 lines
2.0 KiB
Python

"""Model-to-supply mapping - data-driven toner/drum/waste part numbers.
Replaces the old hardcoded part-number table. Each row maps one printer
model to one supply part (a toner of a given color and capacity tier, or a
drum/waste/maintenance item). Lets new models and their toners be added
through the API/UI without a code change.
"""
from shopdb.api import db, BaseModel
# allowed values, surfaced to the UI via the /supplies/meta endpoint
SUPPLY_TYPES = ('toner', 'drum', 'waste', 'maintenance')
SUPPLY_COLORS = ('black', 'cyan', 'magenta', 'yellow', 'none')
CAPACITY_TIERS = ('standard', 'high', 'extrahigh', 'metered', 'dmo')
class ModelSupply(BaseModel):
"""One supply part belonging to one printer model."""
__tablename__ = 'modelsupplies'
modelsupplyid = db.Column(db.Integer, primary_key=True)
modelnumberid = db.Column(
db.Integer,
db.ForeignKey('models.modelnumberid'),
nullable=False,
)
# toner, drum, waste, maintenance
supplytype = db.Column(db.String(20), nullable=False, default='toner')
# black, cyan, magenta, yellow, or none (drum/waste have no color)
color = db.Column(db.String(20), nullable=False, default='none')
# standard, high, extrahigh, metered, dmo
capacitytier = db.Column(db.String(20), nullable=False, default='standard')
partnumber = db.Column(db.String(50), nullable=False)
marketingname = db.Column(db.String(120))
pageyield = db.Column(db.Integer, comment='Rated page yield at 5 percent coverage')
notes = db.Column(db.Text)
model = db.relationship('Model', backref='supplies')
# one part number per model, no duplicates
__table_args__ = (
db.UniqueConstraint('modelnumberid', 'partnumber', name='uq_modelsupply_part'),
)
def __repr__(self):
return f"<ModelSupply {self.partnumber} ({self.color}/{self.capacitytier})>"
def to_dict(self):
data = super().to_dict()
if self.model:
data['modelnumber'] = self.model.modelnumber
return data