python data_error ai_generated true

ValueError: Circular reference detected

ID: python/flask-jsonify-circular-reference

Also available as: JSON · Markdown · 中文
80%Fix Rate
85%Confidence
0Evidence
2024-03-15First Seen

Version Compatibility

VersionStatusIntroducedDeprecatedNotes
3.x active — — —

Root Cause

Attempting to serialize a Python object with circular references (e.g., self-referential ORM models or graph structures) using Flask's jsonify, which lacks a resolver for cycles.

generic

中文

使用Flask的jsonify序列化具有循环引用的Python对象（如自引用ORM模型或图结构）时，jsonify没有处理循环的解析器，导致抛出循环引用错误。

Workarounds

  1. 90% success 
    Use a custom JSON encoder that tracks visited objects, or convert to a serializable dict by breaking cycles first. Example: `def serialize(obj, seen=None): if id(obj) in seen: return None; seen.add(id(obj)); return {k: serialize(v, seen) for k, v in obj.__dict__.items()}`
  2. 85% success 
    Use a library like `flask-marshmallow` or `marshmallow` with `fields.Nested` and `exclude` to avoid cycles.

Dead Ends

Common approaches that don't work:

  1. 95% fail

    json.dumps with default=str only converts non-serializable objects to strings, but circular references cause infinite recursion before reaching that fallback.

  2. 90% fail

    Using Flask's app.json_encoder with a custom encoder does not automatically handle circular references; it still recurses infinitely unless explicitly checked.