{% set permalink = ("Link" if sphinx_version >= (7, 2) else 'Permalink') -%}
{% set heading = ("heading" if sphinx_version >= (5, 0) else 'headline') -%}
{% set sig_prename_tag=("span" if sphinx_version >= (4, 0) else 'code') -%}
{% set sig_object_class=(' class="sig sig-object py"' if sphinx_version >= (4, 0) else '') -%}
<!DOCTYPE html>
<html{% if sphinx_version >= (7, 2) %} data-content_root="./"{% endif %}{% if sphinx_version >= (5, 0) %} lang="en"{% endif %}>
 <head>
  <meta charset="utf-8"/>
  <meta content="width=device-width, initial-scale=1.0" name="viewport"/>
  {% if docutils_version[1] == 18 %}<meta content="Docutils 0.18.1: http://docutils.sourceforge.net/" name="generator"/>
  {% elif docutils_version[1] == 17 %}<meta content="Docutils 0.17.1: http://docutils.sourceforge.net/" name="generator"/>
  {% elif docutils_version[1] == 19 %}<meta content="Docutils 0.19: https://docutils.sourceforge.io/" name="generator"/>
  {% elif docutils_version[1] >= 20 %}<meta content="width=device-width, initial-scale=1" name="viewport"/>
  {% endif %}<title>
   sphinx-toolbox Demo - AutoTypedDict — Python  documentation
  </title>{% if sphinx_version >= (7, 2) %}
  <script src="_static/documentation_options.js?v=5929fcd5">{% else %}
  <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js{% if sphinx_version >= (7, 1) %}?v=b3ba4146{% endif %}">{% endif %}
  </script>{% if sphinx_version < (6, 0) %}
  <script src="_static/jquery.js">
  </script>
  <script src="_static/underscore.js">
  </script>{% if sphinx_version >= (5, 0) %}
  <script src="_static/_sphinx_javascript_frameworks_compat.js">
  </script>{% endif %}{% endif %}
  <script src="_static/doctools.js{% if sphinx_version >= (8, 1) %}?v=9bcbadda{% elif sphinx_version >= (7, 3) %}?v=9a2dae69{% elif sphinx_version >= (7, 1) %}?v=888ff710{% endif %}">
  </script>{% if sphinx_version >= (5, 2) %}
  <script src="_static/sphinx_highlight.js{% if sphinx_version >= (7, 2) %}?v=dc90522c{% elif sphinx_version >= (7, 1) %}?v=4825356b{% endif %}">
  </script>{% endif %}
  <script src="_static/sphinx_toolbox_installation.js">
  </script>
 </head>
 <body>
  <div class="document">
   <div class="documentwrapper">
    <div class="bodywrapper">
     <div class="body" role="main">
      <div class="section" id="module-autotypeddict_demo">
       <span id="sphinx-toolbox-demo-autotypeddict">
       </span>
       <h1>
        sphinx-toolbox Demo - AutoTypedDict
        <a class="headerlink" href="#module-autotypeddict_demo" title="{{ permalink }} to this {{ heading }}">
         ¶
        </a>
       </h1>
       <p>
        Demo of
        <code class="docutils literal notranslate">
         <span class="pre">
          ..
         </span>
         <span class="pre">
          autotypeddict::
         </span>
        </code>
       </p>
       <dl class="py class typeddict">
        <dt{{ sig_object_class }} id="autotypeddict_demo.Animal">
         <em class="property">
          typeddict
         </em>
         <{{ sig_prename_tag }} class="sig-prename descclassname">
          autotypeddict_demo.
         </{{ sig_prename_tag }}>
         <{{ sig_prename_tag }} class="sig-name descname">
          Animal
         </{{ sig_prename_tag }}>
         <a class="reference internal" href="_modules/autotypeddict_demo.html#Animal">
          <span class="viewcode-link">
           [source]
          </span>
         </a>
         <a class="headerlink" href="#autotypeddict_demo.Animal" title="Permalink to this definition">
          ¶
         </a>
        </dt>
        <dd>
         <p>
          Optional keys common to all animals.
         </p>
         <dl class="field-list simple">
          <dt class="field-odd">
           Required Keys{% if docutils_version >= (0, 18) %}
           <span class="colon">
            :
           </span>{% endif %}
          </dt>
          <dd class="field-odd">
           <ul class="simple">
            <li>
             <p>
              <strong>
               name
              </strong>
              (
              <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">
               <code class="xref py py-class docutils literal notranslate">
                <span class="pre">
                 str
                </span>
               </code>
              </a>
              ) – The name of the animal
             </p>
            </li>
           </ul>
          </dd>
          <dt class="field-even">
           Optional Keys{% if docutils_version >= (0, 18) %}
           <span class="colon">
            :
           </span>{% endif %}
          </dt>
          <dd class="field-even">
           <ul class="simple">
            <li>
             <p>
              <strong>
               voice
              </strong>
              (
              <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">
               <code class="xref py py-class docutils literal notranslate">
                <span class="pre">
                 str
                </span>
               </code>
              </a>
              ) – The animal’s voice.
             </p>
            </li>
           </ul>
          </dd>
         </dl>
        </dd>
       </dl>
       <dl class="py class typeddict">
        <dt{{ sig_object_class }} id="autotypeddict_demo.AquaticBird">
         <em class="property">
          typeddict
         </em>
         <{{ sig_prename_tag }} class="sig-prename descclassname">
          autotypeddict_demo.
         </{{ sig_prename_tag }}>
         <{{ sig_prename_tag }} class="sig-name descname">
          AquaticBird
         </{{ sig_prename_tag }}>
         <a class="reference internal" href="_modules/autotypeddict_demo.html#AquaticBird">
          <span class="viewcode-link">
           [source]
          </span>
         </a>
         <a class="headerlink" href="#autotypeddict_demo.AquaticBird" title="Permalink to this definition">
          ¶
         </a>
        </dt>
        <dd>
         <p>
          <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.TypedDict" title="(in Python v3.14)">
           <code class="xref py py-class docutils literal notranslate">
            <span class="pre">
             typing.TypedDict
            </span>
           </code>
          </a>
          .
         </p>
         <dl class="field-list simple">
          <dt class="field-odd">
           Required Keys{% if docutils_version >= (0, 18) %}
           <span class="colon">
            :
           </span>{% endif %}
          </dt>
          <dd class="field-odd">
           <ul class="simple">
            <li>
             <p>
              <strong>
               habitat
              </strong>
              (
              <a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)">
               <code class="xref py py-class docutils literal notranslate">
                <span class="pre">
                 float
                </span>
               </code>
              </a>
              ) – The bird’s habitat (e.g. lake, sea)
             </p>
            </li>
            <li>
             <p>
              <strong>
               name
              </strong>
              (
              <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">
               <code class="xref py py-class docutils literal notranslate">
                <span class="pre">
                 str
                </span>
               </code>
              </a>
              ) – The name of the animal
             </p>
            </li>
            <li>
             <p>
              <strong>
               egg_size
              </strong>
              (
              <a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)">
               <code class="xref py py-class docutils literal notranslate">
                <span class="pre">
                 float
                </span>
               </code>
              </a>
              ) – The size of the bird’s egg, in mm.
             </p>
            </li>
           </ul>
          </dd>
          <dt class="field-even">
           Optional Keys{% if docutils_version >= (0, 18) %}
           <span class="colon">
            :
           </span>{% endif %}
          </dt>
          <dd class="field-even">
           <ul class="simple">
            <li>
             <p>
              <strong>
               voice
              </strong>
              (
              <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">
               <code class="xref py py-class docutils literal notranslate">
                <span class="pre">
                 str
                </span>
               </code>
              </a>
              ) – The animal’s voice.
             </p>
            </li>
           </ul>
          </dd>
         </dl>
        </dd>
       </dl>
       <dl class="py class typeddict">
        <dt{{ sig_object_class }} id="autotypeddict_demo.Bird">
         <em class="property">
          typeddict
         </em>
         <{{ sig_prename_tag }} class="sig-prename descclassname">
          autotypeddict_demo.
         </{{ sig_prename_tag }}>
         <{{ sig_prename_tag }} class="sig-name descname">
          Bird
         </{{ sig_prename_tag }}>
         <a class="reference internal" href="_modules/autotypeddict_demo.html#Bird">
          <span class="viewcode-link">
           [source]
          </span>
         </a>
         <a class="headerlink" href="#autotypeddict_demo.Bird" title="Permalink to this definition">
          ¶
         </a>
        </dt>
        <dd>
         <p>
          A bird.
         </p>
         <dl class="field-list simple">
          <dt class="field-odd">
           Required Keys{% if docutils_version >= (0, 18) %}
           <span class="colon">
            :
           </span>{% endif %}
          </dt>
          <dd class="field-odd">
           <ul class="simple">
            <li>
             <p>
              <strong>
               egg_size
              </strong>
              (
              <a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)">
               <code class="xref py py-class docutils literal notranslate">
                <span class="pre">
                 float
                </span>
               </code>
              </a>
              ) – The size of the bird’s egg, in mm.
             </p>
            </li>
            <li>
             <p>
              <strong>
               name
              </strong>
              (
              <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">
               <code class="xref py py-class docutils literal notranslate">
                <span class="pre">
                 str
                </span>
               </code>
              </a>
              ) – The name of the animal
             </p>
            </li>
           </ul>
          </dd>
          <dt class="field-even">
           Optional Keys{% if docutils_version >= (0, 18) %}
           <span class="colon">
            :
           </span>{% endif %}
          </dt>
          <dd class="field-even">
           <ul class="simple">
            <li>
             <p>
              <strong>
               voice
              </strong>
              (
              <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">
               <code class="xref py py-class docutils literal notranslate">
                <span class="pre">
                 str
                </span>
               </code>
              </a>
              ) – The animal’s voice.
             </p>
            </li>
           </ul>
          </dd>
         </dl>
        </dd>
       </dl>
       <dl class="py class typeddict">
        <dt{{ sig_object_class }} id="autotypeddict_demo.Cat">
         <em class="property">
          typeddict
         </em>
         <{{ sig_prename_tag }} class="sig-prename descclassname">
          autotypeddict_demo.
         </{{ sig_prename_tag }}>
         <{{ sig_prename_tag }} class="sig-name descname">
          Cat
         </{{ sig_prename_tag }}>
         <a class="reference internal" href="_modules/autotypeddict_demo.html#Cat">
          <span class="viewcode-link">
           [source]
          </span>
         </a>
         <a class="headerlink" href="#autotypeddict_demo.Cat" title="Permalink to this definition">
          ¶
         </a>
        </dt>
        <dd>
         <p>
          A cat.
         </p>
         <dl class="field-list simple">
          <dt class="field-odd">
           Required Keys{% if docutils_version >= (0, 18) %}
           <span class="colon">
            :
           </span>{% endif %}
          </dt>
          <dd class="field-odd">
           <ul class="simple">
            <li>
             <p>
              <strong>
               fur_color
              </strong>
              (
              <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">
               <code class="xref py py-class docutils literal notranslate">
                <span class="pre">
                 str
                </span>
               </code>
              </a>
              ) – The colour of the cat’s fur.
             </p>
            </li>
            <li>
             <p>
              <strong>
               name
              </strong>
              (
              <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">
               <code class="xref py py-class docutils literal notranslate">
                <span class="pre">
                 str
                </span>
               </code>
              </a>
              ) – The name of the animal
             </p>
            </li>
           </ul>
          </dd>
          <dt class="field-even">
           Optional Keys{% if docutils_version >= (0, 18) %}
           <span class="colon">
            :
           </span>{% endif %}
          </dt>
          <dd class="field-even">
           <ul class="simple">
            <li>
             <p>
              <strong>
               voice
              </strong>
              (
              <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">
               <code class="xref py py-class docutils literal notranslate">
                <span class="pre">
                 str
                </span>
               </code>
              </a>
              ) – The animal’s voice.
             </p>
            </li>
           </ul>
          </dd>
         </dl>
        </dd>
       </dl>
       <dl class="py class typeddict">
        <dt{{ sig_object_class }} id="autotypeddict_demo.OldStyleAnimal">
         <em class="property">
          typeddict
         </em>
         <{{ sig_prename_tag }} class="sig-prename descclassname">
          autotypeddict_demo.
         </{{ sig_prename_tag }}>
         <{{ sig_prename_tag }} class="sig-name descname">
          OldStyleAnimal
         </{{ sig_prename_tag }}>
         <a class="headerlink" href="#autotypeddict_demo.OldStyleAnimal" title="Permalink to this definition">
          ¶
         </a>
        </dt>
        <dd>
         <p>
          Old style TypedDict for Python 2 and where keys aren’t valid Python identifiers.
         </p>
         <dl class="field-list simple">
          <dt class="field-odd">
           Optional Keys{% if docutils_version >= (0, 18) %}
           <span class="colon">
            :
           </span>{% endif %}
          </dt>
          <dd class="field-odd">
           <ul class="simple">
            <li>
             <p>
              <strong>
               animal-name
              </strong>
              (
              <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">
               <code class="xref py py-class docutils literal notranslate">
                <span class="pre">
                 str
                </span>
               </code>
              </a>
              )
             </p>
            </li>
            <li>
             <p>
              <strong>
               animal-voice
              </strong>
              (
              <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">
               <code class="xref py py-class docutils literal notranslate">
                <span class="pre">
                 str
                </span>
               </code>
              </a>
              )
             </p>
            </li>
           </ul>
          </dd>
         </dl>
        </dd>
       </dl>
       <dl class="py class typeddict">
        <dt{{ sig_object_class }} id="autotypeddict_demo.Movie">
         <em class="property">
          typeddict
         </em>
         <{{ sig_prename_tag }} class="sig-prename descclassname">
          autotypeddict_demo.
         </{{ sig_prename_tag }}>
         <{{ sig_prename_tag }} class="sig-name descname">
          Movie
         </{{ sig_prename_tag }}>
         <a class="reference internal" href="_modules/autotypeddict_demo.html#Movie">
          <span class="viewcode-link">
           [source]
          </span>
         </a>
         <a class="headerlink" href="#autotypeddict_demo.Movie" title="Permalink to this definition">
          ¶
         </a>
        </dt>
        <dd>
         <p>
          Represents a movie.
         </p>
         <dl class="field-list simple">
          <dt class="field-odd">
           Required Keys{% if docutils_version >= (0, 18) %}
           <span class="colon">
            :
           </span>{% endif %}
          </dt>
          <dd class="field-odd">
           <ul class="simple">
            <li>
             <p>
              <strong>
               name
              </strong>
              (
              <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">
               <code class="xref py py-class docutils literal notranslate">
                <span class="pre">
                 str
                </span>
               </code>
              </a>
              ) – The name of the animal
             </p>
            </li>
            <li>
             <p>
              <strong>
               year
              </strong>
              (
              <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">
               <code class="xref py py-class docutils literal notranslate">
                <span class="pre">
                 int
                </span>
               </code>
              </a>
              ) – The movie’s release year.
             </p>
            </li>
            <li>
             <p>
              <strong>
               based_on
              </strong>
              (
              <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">
               <code class="xref py py-class docutils literal notranslate">
                <span class="pre">
                 str
                </span>
               </code>
              </a>
              )
             </p>
            </li>
           </ul>
          </dd>
         </dl>
        </dd>
       </dl>
      </div>{% if sphinx_version >= (8, 1) %}
      <div class="clearer">
      </div>{% endif %}
     </div>
    </div>
   </div>
   <div class="clearer">
   </div>
  </div>
 </body>
</html>
