Deploying to gh-pages from @ 75f7636 🚀

dev/annotated.html

@@ -162,6 +162,7 @@
 <tr id="row_0_5_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_0_5_3_" class="arrow" onclick="dynsection.toggleFolder('0_5_3_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespaceformatron_1_1schemas_1_1schema.html" target="_self">schema</a></td><td class="desc">This module contains the <a class="el" href="classformatron_1_1schemas_1_1schema_1_1Schema.html" title="An abstract schema that describes some data.">Schema</a> abstract class and <a class="el" href="classformatron_1_1schemas_1_1schema_1_1FieldInfo.html">FieldInfo</a> abstract class </td></tr>
 <tr id="row_0_5_3_0_" class="odd"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classformatron_1_1schemas_1_1schema_1_1FieldInfo.html" target="_self">FieldInfo</a></td><td class="desc"></td></tr>
 <tr id="row_0_5_3_1_" class="even"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classformatron_1_1schemas_1_1schema_1_1Schema.html" target="_self">Schema</a></td><td class="desc">An abstract schema that describes some data </td></tr>
+<tr id="row_0_5_3_2_" class="odd"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classformatron_1_1schemas_1_1schema_1_1TypeWithMetadata.html" target="_self">TypeWithMetadata</a></td><td class="desc"></td></tr>
 </table>
 </div><!-- directory -->
 </div><!-- contents -->

dev/annotated_dup.js

@@ -52,7 +52,8 @@ var annotated_dup =
         ] ],
         [ "schema", "namespaceformatron_1_1schemas_1_1schema.html", [
           [ "FieldInfo", "classformatron_1_1schemas_1_1schema_1_1FieldInfo.html", "classformatron_1_1schemas_1_1schema_1_1FieldInfo" ],
-          [ "Schema", "classformatron_1_1schemas_1_1schema_1_1Schema.html", "classformatron_1_1schemas_1_1schema_1_1Schema" ]
+          [ "Schema", "classformatron_1_1schemas_1_1schema_1_1Schema.html", "classformatron_1_1schemas_1_1schema_1_1Schema" ],
+          [ "TypeWithMetadata", "classformatron_1_1schemas_1_1schema_1_1TypeWithMetadata.html", "classformatron_1_1schemas_1_1schema_1_1TypeWithMetadata" ]
         ] ]
       ] ]
     ] ]

dev/classes.html

@@ -121,7 +121,7 @@
   <div class="headertitle"><div class="title">Class Index</div></div>
 </div><!--header-->
 <div class="contents">
-<div class="qindex"><a class="qindex" href="#letter_C">C</a>&#160;|&#160;<a class="qindex" href="#letter_E">E</a>&#160;|&#160;<a class="qindex" href="#letter_F">F</a>&#160;|&#160;<a class="qindex" href="#letter_J">J</a>&#160;|&#160;<a class="qindex" href="#letter_L">L</a>&#160;|&#160;<a class="qindex" href="#letter_N">N</a>&#160;|&#160;<a class="qindex" href="#letter_P">P</a>&#160;|&#160;<a class="qindex" href="#letter_R">R</a>&#160;|&#160;<a class="qindex" href="#letter_S">S</a></div>
+<div class="qindex"><a class="qindex" href="#letter_C">C</a>&#160;|&#160;<a class="qindex" href="#letter_E">E</a>&#160;|&#160;<a class="qindex" href="#letter_F">F</a>&#160;|&#160;<a class="qindex" href="#letter_J">J</a>&#160;|&#160;<a class="qindex" href="#letter_L">L</a>&#160;|&#160;<a class="qindex" href="#letter_N">N</a>&#160;|&#160;<a class="qindex" href="#letter_P">P</a>&#160;|&#160;<a class="qindex" href="#letter_R">R</a>&#160;|&#160;<a class="qindex" href="#letter_S">S</a>&#160;|&#160;<a class="qindex" href="#letter_T">T</a></div>
 <div class="classindex">
 <dl class="classindex even">
 <dt class="alphachar"><a id="letter_C" name="letter_C">C</a></dt>
@@ -150,6 +150,9 @@
 <dl class="classindex even">
 <dt class="alphachar"><a id="letter_S" name="letter_S">S</a></dt>
 <dd><a class="el" href="classformatron_1_1schemas_1_1schema_1_1Schema.html">Schema</a> (<a class="el" href="namespaceformatron_1_1schemas_1_1schema.html">formatron.schemas.schema</a>)</dd><dd><a class="el" href="classformatron_1_1extractor_1_1SubstringExtractor.html">SubstringExtractor</a> (<a class="el" href="namespaceformatron_1_1extractor.html">formatron.extractor</a>)</dd></dl>
+<dl class="classindex odd">
+<dt class="alphachar"><a id="letter_T" name="letter_T">T</a></dt>
+<dd><a class="el" href="classformatron_1_1schemas_1_1schema_1_1TypeWithMetadata.html">TypeWithMetadata</a> (<a class="el" href="namespaceformatron_1_1schemas_1_1schema.html">formatron.schemas.schema</a>)</dd></dl>
 </div>
 </div><!-- contents -->
 </div><!-- doc-content -->

dev/classformatron_1_1formats_1_1json_1_1JsonExtractor.html

@@ -180,7 +180,7 @@
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>An extractor that loads json data to an object from a string. </p>
 
-<p class="definition">Definition at line <a class="el" href="json_8py_source.html#l00252">252</a> of file <a class="el" href="json_8py_source.html">json.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="json_8py_source.html#l00282">282</a> of file <a class="el" href="json_8py_source.html">json.py</a>.</p>
 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 <a id="a7a51edd3cc7c24370c809d91e07771dc" name="a7a51edd3cc7c24370c809d91e07771dc"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a7a51edd3cc7c24370c809d91e07771dc">&#9670;&#160;</a></span>__init__()</h2>
@@ -221,11 +221,20 @@ <h2 class="memtitle"><span class="permalink"><a href="#a7a51edd3cc7c24370c809d91
 </pre> <div class="fragment"><div class="line">- bool</div>
 <div class="line">- int</div>
 <div class="line">- float</div>
-<div class="line">- string</div>
-<div class="line">- NoneType</div>
-<div class="line">- typing.Any</div>
+<div class="line">- str</div>
 </div><!-- fragment --><ul>
-<li>Subclasses of collections.abc.Mapping[str,T] and typing.Mapping[str,T] where T is a supported type,</li>
+<li>with min_length, max_length and pattern constraints<ul>
+<li>length is measured in UTF-8 character number</li>
+<li><em>Warning</em>: too large difference between min_length and max_length can lead to enormous memory consumption!</li>
+<li>pattern is mutually exclusive with min_length and max_length</li>
+<li>pattern will be compiled to a regular expression so all caveats of regular expressions apply</li>
+<li>pattern currently is automatically anchored at both ends <div class="fragment"><div class="line">- NoneType</div>
+<div class="line">- typing.Any</div>
+</div><!-- fragment --></li>
+</ul>
+</li>
+</ul>
+<p>Subclasses of collections.abc.Mapping[str,T] and typing.Mapping[str,T] where T is a supported type,</p><ul>
 <li>Subclasses of collections.abc.Sequence[T] and typing.Sequence[T] where T is a supported type.</li>
 <li>tuple[T1,T2,...] where T1,T2,... are supported types. The order, type and number of elements will be preserved.</li>
 <li>typing.Literal[x1,x2,...] where x1, x2, ... are instances of int, string, bool or NoneType, or another typing.Literal[y1,y2,...]</li>
@@ -243,7 +252,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a7a51edd3cc7c24370c809d91
 
 <p>Reimplemented from <a class="el" href="classformatron_1_1extractor_1_1NonterminalExtractor.html#a45c14f79c14b539837ebdd26c3b5567b">formatron.extractor.NonterminalExtractor</a>.</p>
 
-<p class="definition">Definition at line <a class="el" href="json_8py_source.html#l00279">279</a> of file <a class="el" href="json_8py_source.html">json.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="json_8py_source.html#l00317">317</a> of file <a class="el" href="json_8py_source.html">json.py</a>.</p>
 
 </div>
 </div>
@@ -278,7 +287,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a6ad701c17988fe32b164135e
 
 <p>Reimplemented from <a class="el" href="classformatron_1_1extractor_1_1Extractor.html#a9efb2a75cf5fc5e0919c235aa1435469">formatron.extractor.Extractor</a>.</p>
 
-<p class="definition">Definition at line <a class="el" href="json_8py_source.html#l00293">293</a> of file <a class="el" href="json_8py_source.html">json.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="json_8py_source.html#l00331">331</a> of file <a class="el" href="json_8py_source.html">json.py</a>.</p>
 
 </div>
 </div>
@@ -299,7 +308,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ace660f78408893ab8fb7facd
 
 <p>Reimplemented from <a class="el" href="classformatron_1_1extractor_1_1Extractor.html#ae9abcfb6c5bae5b352de8a97f94be049">formatron.extractor.Extractor</a>.</p>
 
-<p class="definition">Definition at line <a class="el" href="json_8py_source.html#l00347">347</a> of file <a class="el" href="json_8py_source.html">json.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="json_8py_source.html#l00385">385</a> of file <a class="el" href="json_8py_source.html">json.py</a>.</p>
 
 </div>
 </div>
@@ -324,7 +333,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aecf88428e414da080f11ed0a
 </table>
 </div><div class="memdoc">
 
-<p class="definition">Definition at line <a class="el" href="json_8py_source.html#l00283">283</a> of file <a class="el" href="json_8py_source.html">json.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="json_8py_source.html#l00321">321</a> of file <a class="el" href="json_8py_source.html">json.py</a>.</p>
 
 </div>
 </div>
@@ -348,7 +357,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a2e72d806c8dffc0136231b81
 </table>
 </div><div class="memdoc">
 
-<p class="definition">Definition at line <a class="el" href="json_8py_source.html#l00282">282</a> of file <a class="el" href="json_8py_source.html">json.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="json_8py_source.html#l00320">320</a> of file <a class="el" href="json_8py_source.html">json.py</a>.</p>
 
 </div>
 </div>

dev/classformatron_1_1schemas_1_1pydantic_1_1ClassSchema.html

@@ -151,7 +151,7 @@
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>A wrapper for pydantic BaseModel that implements the Schema interface. </p>
 
-<p class="definition">Definition at line <a class="el" href="pydantic_8py_source.html#l00063">63</a> of file <a class="el" href="pydantic_8py_source.html">pydantic.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="pydantic_8py_source.html#l00072">72</a> of file <a class="el" href="pydantic_8py_source.html">pydantic.py</a>.</p>
 </div><h2 class="groupheader">Member Function Documentation</h2>
 <a id="add30bb5902bbfd8ff4fa17f197994442" name="add30bb5902bbfd8ff4fa17f197994442"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#add30bb5902bbfd8ff4fa17f197994442">&#9670;&#160;</a></span>fields()</h2>
@@ -172,7 +172,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#add30bb5902bbfd8ff4fa17f1
 
 <p>Reimplemented from <a class="el" href="classformatron_1_1schemas_1_1schema_1_1Schema.html#a98d77a5645545d440b91126926d1aeb8">formatron.schemas.schema.Schema</a>.</p>
 
-<p class="definition">Definition at line <a class="el" href="pydantic_8py_source.html#l00074">74</a> of file <a class="el" href="pydantic_8py_source.html">pydantic.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="pydantic_8py_source.html#l00083">83</a> of file <a class="el" href="pydantic_8py_source.html">pydantic.py</a>.</p>
 
 </div>
 </div>
@@ -199,7 +199,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aec269b72011e216e8f5fefdf
 
 <p>Reimplemented from <a class="el" href="classformatron_1_1schemas_1_1schema_1_1Schema.html#a8c45239aaa45574add14fa72fbdf16dc">formatron.schemas.schema.Schema</a>.</p>
 
-<p class="definition">Definition at line <a class="el" href="pydantic_8py_source.html#l00093">93</a> of file <a class="el" href="pydantic_8py_source.html">pydantic.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="pydantic_8py_source.html#l00102">102</a> of file <a class="el" href="pydantic_8py_source.html">pydantic.py</a>.</p>
 
 </div>
 </div>

dev/classformatron_1_1schemas_1_1pydantic_1_1FieldInfo-members.html

@@ -127,9 +127,10 @@
   <tr class="even"><td class="entry"><a class="el" href="classformatron_1_1schemas_1_1pydantic_1_1FieldInfo.html#a4a5a010c6acef15f8fe2d4318223696b">__init__</a>(self, pydantic.fields.FieldInfo field)</td><td class="entry"><a class="el" href="classformatron_1_1schemas_1_1pydantic_1_1FieldInfo.html">formatron.schemas.pydantic.FieldInfo</a></td><td class="entry"></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="classformatron_1_1schemas_1_1pydantic_1_1FieldInfo.html#ad291e8df78d045d3364bc6a17582b416">__repr__</a>(self)</td><td class="entry"><a class="el" href="classformatron_1_1schemas_1_1pydantic_1_1FieldInfo.html">formatron.schemas.pydantic.FieldInfo</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classformatron_1_1schemas_1_1pydantic_1_1FieldInfo.html#a49ac1734cddfadc1b7721f57775890a6">__str__</a>(self)</td><td class="entry"><a class="el" href="classformatron_1_1schemas_1_1pydantic_1_1FieldInfo.html">formatron.schemas.pydantic.FieldInfo</a></td><td class="entry"></td></tr>
-  <tr class="odd"><td class="entry"><a class="el" href="classformatron_1_1schemas_1_1pydantic_1_1FieldInfo.html#abb92e2d49fec513432cced795bd853e2">_field</a></td><td class="entry"><a class="el" href="classformatron_1_1schemas_1_1pydantic_1_1FieldInfo.html">formatron.schemas.pydantic.FieldInfo</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classformatron_1_1schemas_1_1pydantic_1_1FieldInfo.html#ac9e5af7e4cb356a450e9e48f3af24cfe">annotation</a>(self)</td><td class="entry"><a class="el" href="classformatron_1_1schemas_1_1pydantic_1_1FieldInfo.html">formatron.schemas.pydantic.FieldInfo</a></td><td class="entry"></td></tr>
-  <tr class="odd"><td class="entry"><a class="el" href="classformatron_1_1schemas_1_1pydantic_1_1FieldInfo.html#aeae1e2e12ad15628c69d896fae9aa477">required</a>(self)</td><td class="entry"><a class="el" href="classformatron_1_1schemas_1_1pydantic_1_1FieldInfo.html">formatron.schemas.pydantic.FieldInfo</a></td><td class="entry"></td></tr>
+  <tr class="odd"><td class="entry"><a class="el" href="classformatron_1_1schemas_1_1pydantic_1_1FieldInfo.html#aab00d20e817e3ea9fc15295a94e8242b">_annotation</a></td><td class="entry"><a class="el" href="classformatron_1_1schemas_1_1pydantic_1_1FieldInfo.html">formatron.schemas.pydantic.FieldInfo</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classformatron_1_1schemas_1_1pydantic_1_1FieldInfo.html#abb92e2d49fec513432cced795bd853e2">_field</a></td><td class="entry"><a class="el" href="classformatron_1_1schemas_1_1pydantic_1_1FieldInfo.html">formatron.schemas.pydantic.FieldInfo</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
+  <tr class="odd"><td class="entry"><a class="el" href="classformatron_1_1schemas_1_1pydantic_1_1FieldInfo.html#ac9e5af7e4cb356a450e9e48f3af24cfe">annotation</a>(self)</td><td class="entry"><a class="el" href="classformatron_1_1schemas_1_1pydantic_1_1FieldInfo.html">formatron.schemas.pydantic.FieldInfo</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classformatron_1_1schemas_1_1pydantic_1_1FieldInfo.html#aeae1e2e12ad15628c69d896fae9aa477">required</a>(self)</td><td class="entry"><a class="el" href="classformatron_1_1schemas_1_1pydantic_1_1FieldInfo.html">formatron.schemas.pydantic.FieldInfo</a></td><td class="entry"></td></tr>
 </table></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->

dev/classformatron_1_1schemas_1_1pydantic_1_1FieldInfo.html

@@ -143,6 +143,8 @@
 Protected Attributes</h2></td></tr>
 <tr class="memitem:abb92e2d49fec513432cced795bd853e2" id="r_abb92e2d49fec513432cced795bd853e2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abb92e2d49fec513432cced795bd853e2">_field</a></td></tr>
 <tr class="separator:abb92e2d49fec513432cced795bd853e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aab00d20e817e3ea9fc15295a94e8242b" id="r_aab00d20e817e3ea9fc15295a94e8242b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aab00d20e817e3ea9fc15295a94e8242b">_annotation</a></td></tr>
+<tr class="separator:aab00d20e817e3ea9fc15295a94e8242b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader">Properties</h2></td></tr>
 <tr class="memitem:ac9e5af7e4cb356a450e9e48f3af24cfe" id="r_ac9e5af7e4cb356a450e9e48f3af24cfe"><td class="memItemLeft" align="right" valign="top">typing.Type[typing.Any]|None&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac9e5af7e4cb356a450e9e48f3af24cfe">annotation</a> (self)</td></tr>
@@ -196,7 +198,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ad291e8df78d045d3364bc6a1
       </table>
 </div><div class="memdoc">
 
-<p class="definition">Definition at line <a class="el" href="pydantic_8py_source.html#l00053">53</a> of file <a class="el" href="pydantic_8py_source.html">pydantic.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="pydantic_8py_source.html#l00062">62</a> of file <a class="el" href="pydantic_8py_source.html">pydantic.py</a>.</p>
 
 </div>
 </div>
@@ -215,7 +217,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a49ac1734cddfadc1b7721f57
       </table>
 </div><div class="memdoc">
 
-<p class="definition">Definition at line <a class="el" href="pydantic_8py_source.html#l00056">56</a> of file <a class="el" href="pydantic_8py_source.html">pydantic.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="pydantic_8py_source.html#l00065">65</a> of file <a class="el" href="pydantic_8py_source.html">pydantic.py</a>.</p>
 
 </div>
 </div>
@@ -234,7 +236,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ac9e5af7e4cb356a450e9e48f
       </table>
 </div><div class="memdoc">
 
-<p class="definition">Definition at line <a class="el" href="pydantic_8py_source.html#l00035">35</a> of file <a class="el" href="pydantic_8py_source.html">pydantic.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="pydantic_8py_source.html#l00044">44</a> of file <a class="el" href="pydantic_8py_source.html">pydantic.py</a>.</p>
 
 </div>
 </div>
@@ -253,11 +255,35 @@ <h2 class="memtitle"><span class="permalink"><a href="#aeae1e2e12ad15628c69d896f
       </table>
 </div><div class="memdoc">
 
-<p class="definition">Definition at line <a class="el" href="pydantic_8py_source.html#l00048">48</a> of file <a class="el" href="pydantic_8py_source.html">pydantic.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="pydantic_8py_source.html#l00057">57</a> of file <a class="el" href="pydantic_8py_source.html">pydantic.py</a>.</p>
 
 </div>
 </div>
 <h2 class="groupheader">Member Data Documentation</h2>
+<a id="aab00d20e817e3ea9fc15295a94e8242b" name="aab00d20e817e3ea9fc15295a94e8242b"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aab00d20e817e3ea9fc15295a94e8242b">&#9670;&#160;</a></span>_annotation</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">formatron.schemas.pydantic.FieldInfo._annotation</td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="pydantic_8py_source.html#l00026">26</a> of file <a class="el" href="pydantic_8py_source.html">pydantic.py</a>.</p>
+
+</div>
+</div>
 <a id="abb92e2d49fec513432cced795bd853e2" name="abb92e2d49fec513432cced795bd853e2"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#abb92e2d49fec513432cced795bd853e2">&#9670;&#160;</a></span>_field</h2>