deploy: 9a83d96

jcrist · Dec 13, 2023 · 6cb7b4a · 6cb7b4a
1 parent 45a58be
commit 6cb7b4a
Show file tree

Hide file tree

Showing 28 changed files with 103 additions and 53 deletions.
diff --git a/_sources/benchmarks.rst.txt b/_sources/benchmarks.rst.txt
@@ -519,10 +519,10 @@ smaller on disk.
         {"label": "simdjson", "encode": 0.00123421613499886, "decode": 0.0007710835699999734},
     ];
     var results_msgpack = [
-        {"label": "msgspec structs", "encode": 0.0001536652545000834, "decode": 0.0003513430250004603},
-        {"label": "msgspec", "encode": 0.00012540720800006966, "decode": 0.00048454183800095054},
-        {"label": "msgpack", "encode": 0.00040564010999878517, "decode": 0.0008212748599999031},
-        {"label": "ormsgpack", "encode": 0.0001669060230001378, "decode": 0.000755966658000034},
+        {"label": "msgspec structs", "encode": 0.00011157811949942698, "decode": 0.000347989668000082},
+        {"label": "msgspec", "encode": 0.00012483930500002316, "decode": 0.000487175850001222},
+        {"label": "msgpack", "encode": 0.00040346372400017574, "decode": 0.0007988804240012541},
+        {"label": "ormsgpack", "encode": 0.00016052370499983226, "decode": 0.0007458347079991654}
     ];
     buildPlot('#bench-validate', results_valid, "Benchmark - JSON Serialization & Validation");
     buildMemPlot('#bench-validate-memory', results_valid, "Benchmark - Serialization & Validation");

diff --git a/_sources/changelog.rst.txt b/_sources/changelog.rst.txt
@@ -3,6 +3,30 @@ Changelog
 
 .. currentmodule:: msgspec
 
+Version 0.18.5 (2023-12-12)
+---------------------------
+
+- Support unhashable ``Annotated`` metadata in `msgspec.inspect.type_info`
+  (:pr:`566`).
+- Fix bug preventing decoding dataclasses/attrs types with default values and
+  ``slots=True, frozen=True`` (:pr:`569`).
+- Support passing parametrized generic struct types to `msgspec.structs.fields`
+  (:pr:`571`).
+- Validate ``str`` constraints on dict keys when decoding msgpack (:pr:`577`).
+- Support ``UUID`` subclasses as inputs to `msgspec.convert` (:pr:`592`).
+- Call ``__eq__`` from generated ``__ne__`` if user defines manual ``__eq__``
+  method on a ``Struct`` type (:pr:`593`).
+- Include the ``Struct`` type in the generated hash (:pr:`595`).
+- Add a ``cache_hash`` struct option (:pr:`596`).
+- Fix a bug around caching of dataclass type info when dealing with subclasses
+  of dataclasses (:pr:`599`).
+- Add `msgspec.structs.force_setattr` (:pr:`600`).
+- Support custom dict key types in JSON encoder and decoder (:pr:`602`).
+- Include ``dict`` key constraints in generated JSON schema via the
+  ``propertyNames`` field (:pr:`604`).
+- Add a ``schema_hook`` for generating JSON schemas for custom types (:pr:`605`).
+- Add support for Python 3.12's ``type`` aliases (:pr:`606`).
+
 Version 0.18.4 (2023-10-04)
 ---------------------------
 

diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -159,6 +159,7 @@ few:
 
     why.rst
     install.rst
+    benchmarks.rst
 
 .. toctree::
     :hidden:
@@ -188,6 +189,5 @@ few:
     :caption: Reference
 
     api.rst
-    benchmarks.rst
     examples/index.rst
     changelog.rst
diff --git a/api.html b/api.html
@@ -3,7 +3,7 @@
   <head><meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
-<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Benchmarks" href="benchmarks.html" /><link rel="prev" title="Performance Tips" href="perf-tips.html" />
+<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Examples" href="examples/index.html" /><link rel="prev" title="Performance Tips" href="perf-tips.html" />
 
     <!-- Generated with Sphinx 7.1.2 and Furo 2023.09.10 -->
         <title>API Docs</title>
@@ -195,6 +195,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="why.html">Why msgspec?</a></li>
 <li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="benchmarks.html">Benchmarks</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">User Guide</span></p>
 <ul>
@@ -215,7 +216,6 @@
 <p class="caption" role="heading"><span class="caption-text">Reference</span></p>
 <ul class="current">
 <li class="toctree-l1 current current-page"><a class="current reference internal" href="#">API Docs</a></li>
-<li class="toctree-l1"><a class="reference internal" href="benchmarks.html">Benchmarks</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="examples/index.html">Examples</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Examples</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="examples/geojson.html">GeoJSON</a></li>
 <li class="toctree-l2"><a class="reference internal" href="examples/asyncio-kv.html">Asyncio TCP Key-Value Server</a></li>
@@ -2000,12 +2000,12 @@ <h2>Exceptions<a class="headerlink" href="#exceptions" title="Permalink to this
       <footer>
 
         <div class="related-pages">
-          <a class="next-page" href="benchmarks.html">
+          <a class="next-page" href="examples/index.html">
               <div class="page-info">
                 <div class="context">
                   <span>Next</span>
                 </div>
-                <div class="title">Benchmarks</div>
+                <div class="title">Examples</div>
               </div>
               <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
             </a>

diff --git a/benchmarks.html b/benchmarks.html
@@ -3,7 +3,7 @@
   <head><meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
-<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Examples" href="examples/index.html" /><link rel="prev" title="API Docs" href="api.html" />
+<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Usage" href="usage.html" /><link rel="prev" title="Installation" href="install.html" />
 
     <!-- Generated with Sphinx 7.1.2 and Furo 2023.09.10 -->
         <title>Benchmarks</title>
@@ -192,9 +192,10 @@
 </form>
 <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
   <p class="caption" role="heading"><span class="caption-text">Overview</span></p>
-<ul>
+<ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="why.html">Why msgspec?</a></li>
 <li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
+<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Benchmarks</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">User Guide</span></p>
 <ul>
@@ -213,9 +214,8 @@
 <li class="toctree-l1"><a class="reference internal" href="perf-tips.html">Performance Tips</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Reference</span></p>
-<ul class="current">
+<ul>
 <li class="toctree-l1"><a class="reference internal" href="api.html">API Docs</a></li>
-<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Benchmarks</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="examples/index.html">Examples</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Examples</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="examples/geojson.html">GeoJSON</a></li>
 <li class="toctree-l2"><a class="reference internal" href="examples/asyncio-kv.html">Asyncio TCP Key-Value Server</a></li>
@@ -805,10 +805,10 @@ <h2>JSON Serialization - Large Data<a class="headerlink" href="#json-serializati
     {"label": "simdjson", "encode": 0.00123421613499886, "decode": 0.0007710835699999734},
 ];
 var results_msgpack = [
-    {"label": "msgspec structs", "encode": 0.0001536652545000834, "decode": 0.0003513430250004603},
-    {"label": "msgspec", "encode": 0.00012540720800006966, "decode": 0.00048454183800095054},
-    {"label": "msgpack", "encode": 0.00040564010999878517, "decode": 0.0008212748599999031},
-    {"label": "ormsgpack", "encode": 0.0001669060230001378, "decode": 0.000755966658000034},
+    {"label": "msgspec structs", "encode": 0.00011157811949942698, "decode": 0.000347989668000082},
+    {"label": "msgspec", "encode": 0.00012483930500002316, "decode": 0.000487175850001222},
+    {"label": "msgpack", "encode": 0.00040346372400017574, "decode": 0.0007988804240012541},
+    {"label": "ormsgpack", "encode": 0.00016052370499983226, "decode": 0.0007458347079991654}
 ];
 buildPlot('#bench-validate', results_valid, "Benchmark - JSON Serialization & Validation");
 buildMemPlot('#bench-validate-memory', results_valid, "Benchmark - Serialization & Validation");
@@ -822,23 +822,23 @@ <h2>JSON Serialization - Large Data<a class="headerlink" href="#json-serializati
       <footer>
 
         <div class="related-pages">
-          <a class="next-page" href="examples/index.html">
+          <a class="next-page" href="usage.html">
               <div class="page-info">
                 <div class="context">
                   <span>Next</span>
                 </div>
-                <div class="title">Examples</div>
+                <div class="title">Usage</div>
               </div>
               <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
             </a>
-          <a class="prev-page" href="api.html">
+          <a class="prev-page" href="install.html">
               <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
               <div class="page-info">
                 <div class="context">
                   <span>Previous</span>
                 </div>
 
-                <div class="title">API Docs</div>
+                <div class="title">Installation</div>
 
               </div>
             </a>

diff --git a/changelog.html b/changelog.html
@@ -195,6 +195,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="why.html">Why msgspec?</a></li>
 <li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="benchmarks.html">Benchmarks</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">User Guide</span></p>
 <ul>
@@ -215,7 +216,6 @@
 <p class="caption" role="heading"><span class="caption-text">Reference</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="api.html">API Docs</a></li>
-<li class="toctree-l1"><a class="reference internal" href="benchmarks.html">Benchmarks</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="examples/index.html">Examples</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Examples</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="examples/geojson.html">GeoJSON</a></li>
 <li class="toctree-l2"><a class="reference internal" href="examples/asyncio-kv.html">Asyncio TCP Key-Value Server</a></li>
@@ -261,6 +261,31 @@
         <article role="main">
           <section id="changelog">
 <h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this heading">#</a></h1>
+<section id="version-0-18-5-2023-12-12">
+<h2>Version 0.18.5 (2023-12-12)<a class="headerlink" href="#version-0-18-5-2023-12-12" title="Permalink to this heading">#</a></h2>
+<ul class="simple">
+<li><p>Support unhashable <code class="docutils literal notranslate"><span class="pre">Annotated</span></code> metadata in <a class="reference internal" href="api.html#msgspec.inspect.type_info" title="msgspec.inspect.type_info"><code class="xref py py-obj docutils literal notranslate"><span class="pre">msgspec.inspect.type_info</span></code></a>
+(<a class="reference external" href="https://github.com/jcrist/msgspec/pull/566">PR #566</a>).</p></li>
+<li><p>Fix bug preventing decoding dataclasses/attrs types with default values and
+<code class="docutils literal notranslate"><span class="pre">slots=True,</span> <span class="pre">frozen=True</span></code> (<a class="reference external" href="https://github.com/jcrist/msgspec/pull/569">PR #569</a>).</p></li>
+<li><p>Support passing parametrized generic struct types to <a class="reference internal" href="api.html#msgspec.structs.fields" title="msgspec.structs.fields"><code class="xref py py-obj docutils literal notranslate"><span class="pre">msgspec.structs.fields</span></code></a>
+(<a class="reference external" href="https://github.com/jcrist/msgspec/pull/571">PR #571</a>).</p></li>
+<li><p>Validate <code class="docutils literal notranslate"><span class="pre">str</span></code> constraints on dict keys when decoding msgpack (<a class="reference external" href="https://github.com/jcrist/msgspec/pull/577">PR #577</a>).</p></li>
+<li><p>Support <code class="docutils literal notranslate"><span class="pre">UUID</span></code> subclasses 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> (<a class="reference external" href="https://github.com/jcrist/msgspec/pull/592">PR #592</a>).</p></li>
+<li><p>Call <code class="docutils literal notranslate"><span class="pre">__eq__</span></code> from generated <code class="docutils literal notranslate"><span class="pre">__ne__</span></code> if user defines manual <code class="docutils literal notranslate"><span class="pre">__eq__</span></code>
+method on a <code class="docutils literal notranslate"><span class="pre">Struct</span></code> type (<a class="reference external" href="https://github.com/jcrist/msgspec/pull/593">PR #593</a>).</p></li>
+<li><p>Include the <code class="docutils literal notranslate"><span class="pre">Struct</span></code> type in the generated hash (<a class="reference external" href="https://github.com/jcrist/msgspec/pull/595">PR #595</a>).</p></li>
+<li><p>Add a <code class="docutils literal notranslate"><span class="pre">cache_hash</span></code> struct option (<a class="reference external" href="https://github.com/jcrist/msgspec/pull/596">PR #596</a>).</p></li>
+<li><p>Fix a bug around caching of dataclass type info when dealing with subclasses
+of dataclasses (<a class="reference external" href="https://github.com/jcrist/msgspec/pull/599">PR #599</a>).</p></li>
+<li><p>Add <a class="reference internal" href="api.html#msgspec.structs.force_setattr" title="msgspec.structs.force_setattr"><code class="xref py py-obj docutils literal notranslate"><span class="pre">msgspec.structs.force_setattr</span></code></a> (<a class="reference external" href="https://github.com/jcrist/msgspec/pull/600">PR #600</a>).</p></li>
+<li><p>Support custom dict key types in JSON encoder and decoder (<a class="reference external" href="https://github.com/jcrist/msgspec/pull/602">PR #602</a>).</p></li>
+<li><p>Include <code class="docutils literal notranslate"><span class="pre">dict</span></code> key constraints in generated JSON schema via the
+<code class="docutils literal notranslate"><span class="pre">propertyNames</span></code> field (<a class="reference external" href="https://github.com/jcrist/msgspec/pull/604">PR #604</a>).</p></li>
+<li><p>Add a <code class="docutils literal notranslate"><span class="pre">schema_hook</span></code> for generating JSON schemas for custom types (<a class="reference external" href="https://github.com/jcrist/msgspec/pull/605">PR #605</a>).</p></li>
+<li><p>Add support for Python 3.12’s <code class="docutils literal notranslate"><span class="pre">type</span></code> aliases (<a class="reference external" href="https://github.com/jcrist/msgspec/pull/606">PR #606</a>).</p></li>
+</ul>
+</section>
 <section id="version-0-18-4-2023-10-04">
 <h2>Version 0.18.4 (2023-10-04)<a class="headerlink" href="#version-0-18-4-2023-10-04" title="Permalink to this heading">#</a></h2>
 <ul class="simple">
@@ -825,6 +850,7 @@ <h2>Version 0.1.0 (2021-02-23)<a class="headerlink" href="#version-0-1-0-2021-02
           <div class="toc-tree">
             <ul>
 <li><a class="reference internal" href="#">Changelog</a><ul>
+<li><a class="reference internal" href="#version-0-18-5-2023-12-12">Version 0.18.5 (2023-12-12)</a></li>
 <li><a class="reference internal" href="#version-0-18-4-2023-10-04">Version 0.18.4 (2023-10-04)</a></li>
 <li><a class="reference internal" href="#version-0-18-3-2023-10-03">Version 0.18.3 (2023-10-03)</a></li>
 <li><a class="reference internal" href="#version-0-18-2-2023-08-26">Version 0.18.2 (2023-08-26)</a></li>

diff --git a/constraints.html b/constraints.html
@@ -195,6 +195,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="why.html">Why msgspec?</a></li>
 <li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="benchmarks.html">Benchmarks</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">User Guide</span></p>
 <ul class="current">
@@ -215,7 +216,6 @@
 <p class="caption" role="heading"><span class="caption-text">Reference</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="api.html">API Docs</a></li>
-<li class="toctree-l1"><a class="reference internal" href="benchmarks.html">Benchmarks</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="examples/index.html">Examples</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Examples</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="examples/geojson.html">GeoJSON</a></li>
 <li class="toctree-l2"><a class="reference internal" href="examples/asyncio-kv.html">Asyncio TCP Key-Value Server</a></li>

diff --git a/converters.html b/converters.html
@@ -195,6 +195,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="why.html">Why msgspec?</a></li>
 <li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="benchmarks.html">Benchmarks</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">User Guide</span></p>
 <ul class="current">
@@ -215,7 +216,6 @@
 <p class="caption" role="heading"><span class="caption-text">Reference</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="api.html">API Docs</a></li>
-<li class="toctree-l1"><a class="reference internal" href="benchmarks.html">Benchmarks</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="examples/index.html">Examples</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Examples</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="examples/geojson.html">GeoJSON</a></li>
 <li class="toctree-l2"><a class="reference internal" href="examples/asyncio-kv.html">Asyncio TCP Key-Value Server</a></li>