deploy: 3c487c1

Author: jcrist

_sources/schema-evolution.rst.txt

@@ -24,7 +24,7 @@ For example, suppose we had a `msgspec.Struct` type representing a user:
 
 .. code-block:: python
 
-    >>> import msgpsec
+    >>> import msgspec
 
     >>> from typing import Set, Optional
 
@@ -48,7 +48,7 @@ accomplish this, we add ``phone`` as an _optional_ field (defaulting to
     ...     email: Optional[str] = None
     ...     phone : Optional[str] = None
 
-Messages serialized using the new and old schemas can still be exchanged
+Messages serialized using both the old and new schemas can still be exchanged
 without error. If an old message is deserialized using the new schema, the
 missing fields all have default values that will be used. Likewise, if a new
 message is deserialized with the old schema the unknown new fields will be

api.html

@@ -752,7 +752,7 @@ <h2>Unset<a class="headerlink" href="#unset" title="Link to this heading">¶</a>
 in an object needs to be treated differently than one containing an explicit
 <code class="docutils literal notranslate"><span class="pre">None</span></code> value. In this case, you may use <code class="docutils literal notranslate"><span class="pre">UNSET</span></code> as the default value,
 rather than <code class="docutils literal notranslate"><span class="pre">None</span></code> when defining object schemas. This feature is supported
-for any <a class="reference internal" href="#msgspec.Struct" title="msgspec.Struct"><code class="xref py py-obj docutils literal notranslate"><span class="pre">msgspec.Struct</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/dataclasses.html#module-dataclasses" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dataclasses</span></code></a> or <a class="reference external" href="https://www.attrs.org/en/stable/api.html#module-attrs" title="(in attrs v24.2)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">attrs</span></code></a> types.</p>
+for any <a class="reference internal" href="#msgspec.Struct" title="msgspec.Struct"><code class="xref py py-obj docutils literal notranslate"><span class="pre">msgspec.Struct</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/dataclasses.html#module-dataclasses" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dataclasses</span></code></a> or <a class="reference external" href="https://www.attrs.org/en/stable/api.html#module-attrs" title="(in attrs v24.3)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">attrs</span></code></a> types.</p>
 <p class="rubric">Examples</p>
 <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">msgspec</span> <span class="kn">import</span> <span class="n">Struct</span><span class="p">,</span> <span class="n">UnsetType</span><span class="p">,</span> <span class="n">UNSET</span><span class="p">,</span> <span class="n">json</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="k">class</span> <span class="nc">Example</span><span class="p">(</span><span class="n">Struct</span><span class="p">):</span>
@@ -2083,7 +2083,7 @@ <h2>Inspect<a class="headerlink" href="#inspect" title="Link to this heading">¶
 <dl class="py class">
 <dt class="sig sig-object py" id="msgspec.inspect.DataclassType">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">msgspec.inspect.</span></span><span class="sig-name descname"><span class="pre">DataclassType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fields</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msgspec.inspect.DataclassType" title="Link to this definition">¶</a></dt>
-<dd><p>A type corresponding to a <a class="reference external" href="https://docs.python.org/3/library/dataclasses.html#module-dataclasses" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dataclasses</span></code></a> or <a class="reference external" href="https://www.attrs.org/en/stable/api.html#module-attrs" title="(in attrs v24.2)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">attrs</span></code></a> type.</p>
+<dd><p>A type corresponding to a <a class="reference external" href="https://docs.python.org/3/library/dataclasses.html#module-dataclasses" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dataclasses</span></code></a> or <a class="reference external" href="https://www.attrs.org/en/stable/api.html#module-attrs" title="(in attrs v24.3)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">attrs</span></code></a> type.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">

changelog.html

@@ -452,7 +452,7 @@ <h2>Version 0.16.0 (2023-06-12)<a class="headerlink" href="#version-0-16-0-2023-
 for this is converting ORM objects to <a class="reference internal" href="api.html#msgspec.Struct" title="msgspec.Struct"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Struct</span></code></a> or <a class="reference external" href="https://docs.python.org/3/library/dataclasses.html#module-dataclasses" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dataclasses</span></code></a> types
 (<a class="extlink-pr reference external" href="https://github.com/jcrist/msgspec/pull/419">PR #419</a>).</p></li>
 <li><p>Support passing generic <code class="docutils literal notranslate"><span class="pre">Mapping</span></code> objects as inputs to <a class="reference internal" href="api.html#msgspec.convert" title="msgspec.convert"><code class="xref py py-obj docutils literal notranslate"><span class="pre">msgspec.convert</span></code></a>.
-These may be coerced to <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code></a>/<a class="reference internal" href="api.html#msgspec.Struct" title="msgspec.Struct"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Struct</span></code></a>/<a class="reference external" href="https://docs.python.org/3/library/dataclasses.html#module-dataclasses" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dataclasses</span></code></a>/<a class="reference external" href="https://www.attrs.org/en/stable/api.html#module-attrs" title="(in attrs v24.2)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">attrs</span></code></a> types
+These may be coerced to <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code></a>/<a class="reference internal" href="api.html#msgspec.Struct" title="msgspec.Struct"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Struct</span></code></a>/<a class="reference external" href="https://docs.python.org/3/library/dataclasses.html#module-dataclasses" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dataclasses</span></code></a>/<a class="reference external" href="https://www.attrs.org/en/stable/api.html#module-attrs" title="(in attrs v24.3)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">attrs</span></code></a> types
 (<a class="extlink-pr reference external" href="https://github.com/jcrist/msgspec/pull/427">PR #427</a>).</p></li>
 <li><p>Add a new <code class="docutils literal notranslate"><span class="pre">strict</span></code> keyword argument to all <code class="docutils literal notranslate"><span class="pre">decode</span></code> functions,
 <code class="docutils literal notranslate"><span class="pre">Decoder</span></code> classes, as well as <a class="reference internal" href="api.html#msgspec.convert" title="msgspec.convert"><code class="xref py py-obj docutils literal notranslate"><span class="pre">msgspec.convert</span></code></a>. This defaults to <code class="docutils literal notranslate"><span class="pre">True</span></code>,

examples/edgedb.html

@@ -509,7 +509,7 @@ <h2>Converting Results to Structs<a class="headerlink" href="#converting-results
 </div>
 <p>We can then convert the <code class="docutils literal notranslate"><span class="pre">edgedb.Object</span></code> results into our <code class="docutils literal notranslate"><span class="pre">Struct</span></code> types
 using <a class="reference internal" href="../api.html#msgspec.convert" title="msgspec.convert"><code class="xref py py-obj docutils literal notranslate"><span class="pre">msgspec.convert</span></code></a>. Note that the same conversion process would work if
-<code class="docutils literal notranslate"><span class="pre">Person</span></code> or <code class="docutils literal notranslate"><span class="pre">Movie</span></code> were defined as <a class="reference external" href="https://docs.python.org/3/library/dataclasses.html#module-dataclasses" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dataclasses</span></code></a> or <a class="reference external" href="https://www.attrs.org/en/stable/api.html#module-attrs" title="(in attrs v24.2)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">attrs</span></code></a> types instead.</p>
+<code class="docutils literal notranslate"><span class="pre">Person</span></code> or <code class="docutils literal notranslate"><span class="pre">Movie</span></code> were defined as <a class="reference external" href="https://docs.python.org/3/library/dataclasses.html#module-dataclasses" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dataclasses</span></code></a> or <a class="reference external" href="https://www.attrs.org/en/stable/api.html#module-attrs" title="(in attrs v24.3)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">attrs</span></code></a> types instead.</p>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">msgspec</span><span class="o">.</span><span class="n">convert</span><span class="p">(</span><span class="n">dune</span><span class="p">,</span> <span class="n">Movie</span><span class="p">,</span> <span class="n">from_attributes</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
 <span class="go">Movie(title=&#39;Dune&#39;, actors=[Person(name=&#39;Timothée Chalamet&#39;), Person(name=&#39;Zendaya&#39;)])</span>
 </pre></div>

schema-evolution.html

@@ -330,7 +330,7 @@ <h1>Schema Evolution<a class="headerlink" href="#schema-evolution" title="Link t
 <a class="reference internal" href="extending.html#defining-extensions"><span class="std std-ref">extensions</span></a> (MessagePack only).</p></li>
 </ol>
 <p>For example, suppose we had a <a class="reference internal" href="api.html#msgspec.Struct" title="msgspec.Struct"><code class="xref py py-obj docutils literal notranslate"><span class="pre">msgspec.Struct</span></code></a> type representing a user:</p>
-<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">msgpsec</span>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">msgspec</span>
 
 <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Set</span><span class="p">,</span> <span class="n">Optional</span>
 
@@ -353,7 +353,7 @@ <h1>Schema Evolution<a class="headerlink" href="#schema-evolution" title="Link t
 <span class="gp">... </span>    <span class="n">phone</span> <span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
 </pre></div>
 </div>
-<p>Messages serialized using the new and old schemas can still be exchanged
+<p>Messages serialized using both the old and new schemas can still be exchanged
 without error. If an old message is deserialized using the new schema, the
 missing fields all have default values that will be used. Likewise, if a new
 message is deserialized with the old schema the unknown new fields will be

searchindex.js

@@ -1406,7 +1406,7 @@ <h2>Generic Types<a class="headerlink" href="#generic-types" title="Link to this
 <ul class="simple">
 <li><p><a class="reference internal" href="api.html#msgspec.Struct" title="msgspec.Struct"><code class="xref py py-obj docutils literal notranslate"><span class="pre">msgspec.Struct</span></code></a></p></li>
 <li><p><a class="reference external" href="https://docs.python.org/3/library/dataclasses.html#module-dataclasses" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dataclasses</span></code></a></p></li>
-<li><p><a class="reference external" href="https://www.attrs.org/en/stable/api.html#module-attrs" title="(in attrs v24.2)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">attrs</span></code></a></p></li>
+<li><p><a class="reference external" href="https://www.attrs.org/en/stable/api.html#module-attrs" title="(in attrs v24.3)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">attrs</span></code></a></p></li>
 <li><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.TypedDict" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">typing.TypedDict</span></code></a></p></li>
 <li><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.NamedTuple" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">typing.NamedTuple</span></code></a></p></li>
 </ul>