Python enum usage with SQLAlchemy and JSON serialization

<p>I am using Python Enum classes for status fields in my application and need them to work with SQLAlchemy (stored as strings), with Pydantic validation, and with JSON serialization without a custom encoder.</p>

<p>str-based Enums for maximum compatibility:</p> <div class="highlight"><pre><span></span><code><span class="kn">import</span><span class="w"> </span><span class="nn">enum</span><span class="o">,</span><span class="w"> </span><span class="nn">json</span> <span class="kn">from</span><span class="w"> </span><span class="nn">sqlalchemy</span><span class="w"> </span><span class="kn">import</span> <span class="n">String</span> <span class="kn">from</span><span class="w"> </span><span class="nn">sqlalchemy.orm</span><span class="w"> </span><span class="kn">import</span> <span class="n">mapped_column</span><span class="p">,</span> <span class="n">Mapped</span> <span class="kn">from</span><span class="w"> </span><span class="nn">pydantic</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseModel</span> <span class="c1"># str enum -- value IS the string</span> <span class="k">class</span><span class="w"> </span><span class="nc">TraceStatus</span><span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">enum</span><span class="o">.</span><span class="n">Enum</span><span class="p">):</span> <span class="n">pending</span> <span class="o">=</span> <span class="s1">'pending'</span> <span class="n">validated</span> <span class="o">=</span> <span class="s1">'validated'</span> <span class="k">class</span><span class="w"> </span><span class="nc">VoteType</span><span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">enum</span><span class="o">.</span><span class="n">Enum</span><span class="p">):</span> <span class="n">confirmed</span> <span class="o">=</span> <span class="s1">'confirmed'</span> <span class="n">disputed</span> <span class="o">=</span> <span class="s1">'disputed'</span> <span class="c1"># SQLAlchemy -- store as String:</span> <span class="k">class</span><span class="w"> </span><span class="nc">Trace</span><span class="p">(</span><span class="n">Base</span><span class="p">):</span> <span class="n">status</span><span class="p">:</span> <span class="n">Mapped</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="n">mapped_column</span><span class="p">(</span><span class="n">String</span><span class="p">(</span><span class="mi">20</span><span class="p">),</span> <span class="n">default</span><span class="o">=</span><span class="n">TraceStatus</span><span class="o">.</span><span class="n">pending</span><span class="p">)</span> <span class="c1"># Works in queries with both enum and string:</span> <span class="n">stmt</span> <span class="o">=</span> <span class="n">select</span><span class="p">(</span><span class="n">Trace</span><span class="p">)</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">Trace</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="n">TraceStatus</span><span class="o">.</span><span class="n">validated</span><span class="p">)</span> <span class="n">stmt</span> <span class="o">=</span> <span class="n">select</span><span class="p">(</span><span class="n">Trace</span><span class="p">)</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">Trace</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="s1">'validated'</span><span class="p">)</span> <span class="c1"># Also works</span> <span class="c1"># Pydantic -- validates and serializes as string:</span> <span class="k">class</span><span class="w"> </span><span class="nc">TraceResponse</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span> <span class="n">status</span><span class="p">:</span> <span class="n">TraceStatus</span> <span class="c1"># Accepts 'validated' or TraceStatus.validated</span> <span class="c1"># JSON -- serializes as value (no custom encoder needed):</span> <span class="n">status</span> <span class="o">=</span> <span class="n">TraceStatus</span><span class="o">.</span><span class="n">validated</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">({</span><span class="s1">'status'</span><span class="p">:</span> <span class="n">status</span><span class="p">})</span> <span class="c1"># -&gt; '{"status": "validated"}'</span> <span class="c1"># State transition validation:</span> <span class="n">ALLOWED_TRANSITIONS</span> <span class="o">=</span> <span class="p">{</span> <span class="n">TraceStatus</span><span class="o">.</span><span class="n">pending</span><span class="p">:</span> <span class="p">{</span><span class="n">TraceStatus</span><span class="o">.</span><span class="n">validated</span><span class="p">},</span> <span class="p">}</span> <span class="k">def</span><span class="w"> </span><span class="nf">is_valid_transition</span><span class="p">(</span><span class="n">current</span><span class="p">:</span> <span class="n">TraceStatus</span><span class="p">,</span> <span class="n">new</span><span class="p">:</span> <span class="n">TraceStatus</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span> <span class="k">return</span> <span class="n">new</span> <span class="ow">in</span> <span class="n">ALLOWED_TRANSITIONS</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">current</span><span class="p">,</span> <span class="nb">set</span><span class="p">())</span> </code></pre></div> <p>Key points: - str + enum.Enum means instances ARE strings -- no .value access needed - Store as String column not Enum -- avoids PostgreSQL ENUM migration complexity - Pydantic coerces string input to enum value automatically - json.dumps works without a custom encoder for str enums</p>