Update docs for #605

yukinarit · Oct 28, 2024 · 770811f · 770811f
1 parent a794a7b
commit 770811f
Show file tree

Hide file tree

Showing 11 changed files with 1,636 additions and 1,542 deletions.
diff --git a/api/search.js b/api/search.js
diff --git a/api/serde.html b/api/serde.html
diff --git a/api/serde/de.html b/api/serde/de.html
diff --git a/guide/en/class-attributes.html b/guide/en/class-attributes.html
@@ -305,6 +305,19 @@ <h3 id="serialize_class_var"><a class="header" href="#serialize_class_var"><stro
 <div class="footnote-definition" id="1"><sup class="footnote-definition-label">1</sup>
 <p><a href="https://docs.python.org/3/library/dataclasses.html#dataclasses.fields">dataclasses.fields</a></p>
 </div>
+<h3 id="deny_unknown_fields"><a class="header" href="#deny_unknown_fields"><strong><code>deny_unknown_fields</code></strong></a></h3>
+<p>New in v0.22.0, the <code>deny_unknown_fields</code> option in the pyserde decorator allows you to enforce strict field validation during deserialization. When this option is enabled, any fields in the input data that are not defined in the target class will cause deserialization to fail with a <code>SerdeError</code>.</p>
+<p>Consider the following example:</p>
+<pre><code class="language-python">@serde(deny_unknown_fields=True)
+class Foo:
+    a: int
+    b: str
+</code></pre>
+<p>With <code>deny_unknown_fields=True</code>, attempting to deserialize data containing fields beyond those defined (a and b in this case) will raise an error. For instance:</p>
+<pre><code>from_json(Foo, '{"a": 10, "b": "foo", "c": 100.0, "d": true}')
+</code></pre>
+<p>This will raise a <code>SerdeError</code> since fields c and d are not recognized members of Foo.</p>
+<p>See <a href="https://github.com/yukinarit/pyserde/blob/main/examples/deny_unknown_fields.py">examples/deny_unknown_fields.py</a> for complete example.</p>
 
                     </main>
 

diff --git a/guide/en/print.html b/guide/en/print.html
@@ -776,6 +776,19 @@ <h3 id="serialize_class_var"><a class="header" href="#serialize_class_var"><stro
 <div class="footnote-definition" id="1"><sup class="footnote-definition-label">1</sup>
 <p><a href="https://docs.python.org/3/library/dataclasses.html#dataclasses.fields">dataclasses.fields</a></p>
 </div>
+<h3 id="deny_unknown_fields"><a class="header" href="#deny_unknown_fields"><strong><code>deny_unknown_fields</code></strong></a></h3>
+<p>New in v0.22.0, the <code>deny_unknown_fields</code> option in the pyserde decorator allows you to enforce strict field validation during deserialization. When this option is enabled, any fields in the input data that are not defined in the target class will cause deserialization to fail with a <code>SerdeError</code>.</p>
+<p>Consider the following example:</p>
+<pre><code class="language-python">@serde(deny_unknown_fields=True)
+class Foo:
+    a: int
+    b: str
+</code></pre>
+<p>With <code>deny_unknown_fields=True</code>, attempting to deserialize data containing fields beyond those defined (a and b in this case) will raise an error. For instance:</p>
+<pre><code>from_json(Foo, '{"a": 10, "b": "foo", "c": 100.0, "d": true}')
+</code></pre>
+<p>This will raise a <code>SerdeError</code> since fields c and d are not recognized members of Foo.</p>
+<p>See <a href="https://github.com/yukinarit/pyserde/blob/main/examples/deny_unknown_fields.py">examples/deny_unknown_fields.py</a> for complete example.</p>
 <div style="break-before: page; page-break-before: always;"></div><h1 id="field-attributes"><a class="header" href="#field-attributes">Field Attributes</a></h1>
 <p>Field attributes are options to customize (de)serialization behaviour for a field of a dataclass.</p>
 <h2 id="attributes-offered-by-dataclasses-1"><a class="header" href="#attributes-offered-by-dataclasses-1">Attributes offered by dataclasses</a></h2>

diff --git a/guide/en/searchindex.js b/guide/en/searchindex.js
diff --git a/guide/en/searchindex.json b/guide/en/searchindex.json
diff --git a/guide/ja/class-attributes.html b/guide/ja/class-attributes.html
@@ -316,10 +316,23 @@ <h3 id="serialize_class_var"><a class="header" href="#serialize_class_var"><stro
 class Foo:
     a: ClassVar[int] = 10
 </code></pre>
-<p>完全な例については、<a href="https://github.com/yukinarit/pyserde/blob/main/examples/class_var.py">examples/class_var.py</a> を参照してください。</p>
+<p>完全な例については、<a href="https://github.com/yukinarit/pyserde/blob/main/examples/class_var.py">examples/class_var.py</a>を参照してください。</p>
 <div class="footnote-definition" id="1"><sup class="footnote-definition-label">1</sup>
 <p><a href="https://docs.python.org/3/library/dataclasses.html#dataclasses.fields">dataclasses.fields</a></p>
 </div>
+<h3 id="deny_unknown_fields"><a class="header" href="#deny_unknown_fields"><strong><code>deny_unknown_fields</code></strong></a></h3>
+<p>バージョン0.22.0で新規追加。 pyserdeデコレータの<code>deny_unknown_fields</code>オプションはデシリアライズ時のより厳格なフィールドチェックを制御できます。このオプションをTrueにするとデシリアライズ時に宣言されていないフィールドが見つかると<code>SerdeError</code>を投げることができます。</p>
+<p>以下の例を考えてください。</p>
+<pre><code class="language-python">@serde(deny_unknown_fields=True)
+class Foo:
+    a: int
+    b: str
+</code></pre>
+<p><code>deny_unknown_fields=True</code>が指定されていると、 宣言されているフィールド(この場合aとb)以外がインプットにあると例外を投げます。例えば、</p>
+<pre><code>from_json(Foo, '{"a": 10, "b": "foo", "c": 100.0, "d": true}')
+</code></pre>
+<p>上記のコードはフィールドcとdという宣言されていないフィールドがあるためエラーとなります。</p>
+<p>完全な例については、<a href="https://github.com/yukinarit/pyserde/blob/main/examples/deny_unknown_fields.py">examples/deny_unknown_fields.py</a>を参照してください。</p>
 
                     </main>
 

diff --git a/guide/ja/print.html b/guide/ja/print.html
@@ -820,10 +820,23 @@ <h3 id="serialize_class_var"><a class="header" href="#serialize_class_var"><stro
 class Foo:
     a: ClassVar[int] = 10
 </code></pre>
-<p>完全な例については、<a href="https://github.com/yukinarit/pyserde/blob/main/examples/class_var.py">examples/class_var.py</a> を参照してください。</p>
+<p>完全な例については、<a href="https://github.com/yukinarit/pyserde/blob/main/examples/class_var.py">examples/class_var.py</a>を参照してください。</p>
 <div class="footnote-definition" id="1"><sup class="footnote-definition-label">1</sup>
 <p><a href="https://docs.python.org/3/library/dataclasses.html#dataclasses.fields">dataclasses.fields</a></p>
 </div>
+<h3 id="deny_unknown_fields"><a class="header" href="#deny_unknown_fields"><strong><code>deny_unknown_fields</code></strong></a></h3>
+<p>バージョン0.22.0で新規追加。 pyserdeデコレータの<code>deny_unknown_fields</code>オプションはデシリアライズ時のより厳格なフィールドチェックを制御できます。このオプションをTrueにするとデシリアライズ時に宣言されていないフィールドが見つかると<code>SerdeError</code>を投げることができます。</p>
+<p>以下の例を考えてください。</p>
+<pre><code class="language-python">@serde(deny_unknown_fields=True)
+class Foo:
+    a: int
+    b: str
+</code></pre>
+<p><code>deny_unknown_fields=True</code>が指定されていると、 宣言されているフィールド(この場合aとb)以外がインプットにあると例外を投げます。例えば、</p>
+<pre><code>from_json(Foo, '{"a": 10, "b": "foo", "c": 100.0, "d": true}')
+</code></pre>
+<p>上記のコードはフィールドcとdという宣言されていないフィールドがあるためエラーとなります。</p>
+<p>完全な例については、<a href="https://github.com/yukinarit/pyserde/blob/main/examples/deny_unknown_fields.py">examples/deny_unknown_fields.py</a>を参照してください。</p>
 <div style="break-before: page; page-break-before: always;"></div><h1 id="field-attributes"><a class="header" href="#field-attributes">Field Attributes</a></h1>
 <p>フィールド属性は、データクラスのフィールドの（デ）シリアライズ動作をカスタマイズするためのオプションです。</p>
 <h2 id="dataclassesによって提供される属性"><a class="header" href="#dataclassesによって提供される属性">dataclassesによって提供される属性</a></h2>

diff --git a/guide/ja/searchindex.js b/guide/ja/searchindex.js
diff --git a/guide/ja/searchindex.json b/guide/ja/searchindex.json