mirror of
https://github.com/jhd3197/ServerKit.git
synced 2026-10-28 15:47:50 +09:00
Juan Denis
6296887bad
Comments, docstrings and a few strings cited plan numbers ("plan 29
#9", "plan 86 §B2") from a git-ignored folder, so they pointed at
nothing; one reached users in a bottleneck hint. Code and frontend
strings are unchanged apart from those citations (checked by AST and
token comparison). A vhost still carrying the old asset comment reads
as undrifted, and a guard test keeps new citations out.
64 lines
2.6 KiB
Python
64 lines
2.6 KiB
Python
"""One implementation of the JSON-in-a-Text-column accessor pattern.
|
|
|
|
Dozens of models hand-roll the same pair over a ``db.Text`` column:
|
|
|
|
def get_details(self):
|
|
if self.details:
|
|
try:
|
|
return json.loads(self.details)
|
|
except (json.JSONDecodeError, TypeError):
|
|
return {}
|
|
return {}
|
|
|
|
Every hand-rolled copy is a place a fix has to be made N times — the exact
|
|
duplication this plan exists to remove. Models opt in by inheriting the mixin
|
|
and delegating:
|
|
|
|
class AuditLog(JsonColumnMixin, db.Model):
|
|
def get_details(self):
|
|
return self._json_read('details')
|
|
|
|
The per-model parts stay per-model: the accessor's *name* (``get_details`` vs
|
|
``get_metadata``), the *column* it reads, and its *default*. What is
|
|
consolidated is only the mechanics — empty-is-default, corrupt-is-default,
|
|
optional shape check, falsy-on-write.
|
|
|
|
Corrupt JSON reads as the default, never raises: a hand-edited or
|
|
partially-written row must not 500 every endpoint that serializes the model.
|
|
This is the tree-wide convention, which reversed the earlier
|
|
ruling that unprotected ``json.loads`` sites were out of scope: the sites that
|
|
used to let corrupt data raise were converted too, so a corrupt row now
|
|
degrades to the accessor's default instead of failing every request that
|
|
touches it. No model file hand-rolls ``json.loads`` any more (ratcheted by
|
|
``tests/test_models_json_one_door.py``).
|
|
"""
|
|
import json
|
|
|
|
_UNSET = object()
|
|
|
|
|
|
class JsonColumnMixin:
|
|
"""Helpers for models storing JSON in Text columns. See module docstring."""
|
|
|
|
def _json_read(self, column, default=_UNSET, expect=None):
|
|
"""Parsed JSON from *column*, or *default* (``{}`` when omitted) when
|
|
the column is empty, unparseable, or — when *expect* is given — valid
|
|
JSON of the wrong shape (a corrupt ``[]`` where a mapping belongs)."""
|
|
fallback = {} if default is _UNSET else default
|
|
raw = getattr(self, column)
|
|
if not raw:
|
|
return fallback
|
|
try:
|
|
value = json.loads(raw)
|
|
except (json.JSONDecodeError, TypeError):
|
|
return fallback
|
|
if expect is not None and not isinstance(value, expect):
|
|
return fallback
|
|
return value
|
|
|
|
def _json_write(self, column, value, falsy=None):
|
|
"""Serialize *value* into *column*; store *falsy* verbatim when *value*
|
|
is falsy (``None`` → NULL by default, ``'[]'``/``'{}'`` for columns
|
|
whose readers expect a container)."""
|
|
setattr(self, column, json.dumps(value) if value else falsy)
|