duck.html.html_minify

Non-destructive HTML minifier — trims payload size without ever changing what the HTML displays or means. Built on Python’s stdlib HTMLParser so it handles real-world, occasionally malformed markup the way a browser would, rather than guessing with regex over the whole document.

Module Contents

Classes

InnerHTMLMinifier

Streams HTML through HTMLParser and reconstructs it with whitespace collapsed and comments stripped, while leaving tags, attributes, entities, and whitespace-sensitive content untouched.

Functions

minify_inner_html

Minifies an HTML string without changing how it renders.

Data

WHITESPACE_RUN
WHITESPACE_SENSITIVE_TAGS

API

class duck.html.html_minify.InnerHTMLMinifier(keep_comments: bool = False)

Bases: html.parser.HTMLParser

Streams HTML through HTMLParser and reconstructs it with whitespace collapsed and comments stripped, while leaving tags, attributes, entities, and whitespace-sensitive content untouched.

Non-destructive by design: nothing that could change how the HTML renders — attribute values, entity encoding, the content of

//<script>/<style>, or the one space that keeps
adjacent inline elements from merging — is ever altered.
<p class="rubric">Initialization</p>
<dl class="myst field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>keep_comments</strong> – When True, keeps every comment. When False
(the default), strips ordinary comments but always
keeps IE conditional comments (<code class="docutils literal notranslate"><span class="pre"><!--[if</span> <span class="pre">...]--></span></code> /
<code class="docutils literal notranslate"><span class="pre"><!--[endif]--></span></code>), since those change page behavior,
not just readability.</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="duck.html.html_minify.InnerHTMLMinifier.handle_charref">
<span class="sig-name descname"><span class="pre">handle_charref</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/duck/html/html_minify.html#InnerHTMLMinifier.handle_charref"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#duck.html.html_minify.InnerHTMLMinifier.handle_charref" title="Link to this definition">¶</a></dt>
<dd><p>Emits a numeric character reference exactly as encountered,
e.g. <code class="docutils literal notranslate"><span class="pre">&#39;</span></code>, without decoding or re-encoding it.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="duck.html.html_minify.InnerHTMLMinifier.handle_comment">
<span class="sig-name descname"><span class="pre">handle_comment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/duck/html/html_minify.html#InnerHTMLMinifier.handle_comment"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#duck.html.html_minify.InnerHTMLMinifier.handle_comment" title="Link to this definition">¶</a></dt>
<dd><p>Drops ordinary comments; always keeps IE conditional comments,
since those affect rendering, not just readability.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="duck.html.html_minify.InnerHTMLMinifier.handle_data">
<span class="sig-name descname"><span class="pre">handle_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/duck/html/html_minify.html#InnerHTMLMinifier.handle_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#duck.html.html_minify.InnerHTMLMinifier.handle_data" title="Link to this definition">¶</a></dt>
<dd><p>Emits text content, collapsing whitespace runs to a single
space unless inside a whitespace-sensitive tag.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="duck.html.html_minify.InnerHTMLMinifier.handle_decl">
<span class="sig-name descname"><span class="pre">handle_decl</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">decl</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/duck/html/html_minify.html#InnerHTMLMinifier.handle_decl"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#duck.html.html_minify.InnerHTMLMinifier.handle_decl" title="Link to this definition">¶</a></dt>
<dd><p>Emits a declaration (e.g. <code class="docutils literal notranslate"><span class="pre"><!DOCTYPE</span> <span class="pre">html></span></code>) exactly as written.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="duck.html.html_minify.InnerHTMLMinifier.handle_endtag">
<span class="sig-name descname"><span class="pre">handle_endtag</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/duck/html/html_minify.html#InnerHTMLMinifier.handle_endtag"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#duck.html.html_minify.InnerHTMLMinifier.handle_endtag" title="Link to this definition">¶</a></dt>
<dd><p>Emits the end tag, and leaves whitespace-preserving mode for
sensitive tags.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="duck.html.html_minify.InnerHTMLMinifier.handle_entityref">
<span class="sig-name descname"><span class="pre">handle_entityref</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/duck/html/html_minify.html#InnerHTMLMinifier.handle_entityref"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#duck.html.html_minify.InnerHTMLMinifier.handle_entityref" title="Link to this definition">¶</a></dt>
<dd><p>Emits a named entity reference exactly as encountered, e.g.
<code class="docutils literal notranslate"><span class="pre">&amp;</span></code>, without decoding or re-encoding it.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="duck.html.html_minify.InnerHTMLMinifier.handle_pi">
<span class="sig-name descname"><span class="pre">handle_pi</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/duck/html/html_minify.html#InnerHTMLMinifier.handle_pi"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#duck.html.html_minify.InnerHTMLMinifier.handle_pi" title="Link to this definition">¶</a></dt>
<dd><p>Emits a processing instruction exactly as written.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="duck.html.html_minify.InnerHTMLMinifier.handle_startendtag">
<span class="sig-name descname"><span class="pre">handle_startendtag</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attrs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/duck/html/html_minify.html#InnerHTMLMinifier.handle_startendtag"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#duck.html.html_minify.InnerHTMLMinifier.handle_startendtag" title="Link to this definition">¶</a></dt>
<dd><p>Emits a self-closed tag exactly as written.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="duck.html.html_minify.InnerHTMLMinifier.handle_starttag">
<span class="sig-name descname"><span class="pre">handle_starttag</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attrs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/duck/html/html_minify.html#InnerHTMLMinifier.handle_starttag"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#duck.html.html_minify.InnerHTMLMinifier.handle_starttag" title="Link to this definition">¶</a></dt>
<dd><p>Emits the start tag exactly as written, and enters
whitespace-preserving mode for sensitive tags.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="duck.html.html_minify.InnerHTMLMinifier.minify">
<span class="sig-name descname"><span class="pre">minify</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">html</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="../../_modules/duck/html/html_minify.html#InnerHTMLMinifier.minify"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#duck.html.html_minify.InnerHTMLMinifier.minify" title="Link to this definition">¶</a></dt>
<dd><p>Minifies a full HTML fragment.</p>
<dl class="myst field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>html</strong> – The HTML to minify.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The minified HTML.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="duck.html.html_minify.InnerHTMLMinifier.unknown_decl">
<span class="sig-name descname"><span class="pre">unknown_decl</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/duck/html/html_minify.html#InnerHTMLMinifier.unknown_decl"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#duck.html.html_minify.InnerHTMLMinifier.unknown_decl" title="Link to this definition">¶</a></dt>
<dd><p>Emits an unrecognized declaration (e.g. a CDATA section)
exactly as written, rather than dropping it.</p>
</dd></dl>

</dd></dl>

<dl class="py data">
<dt class="sig sig-object py" id="duck.html.html_minify.WHITESPACE_RUN">
<span class="sig-prename descclassname"><span class="pre">duck.html.html_minify.</span></span><span class="sig-name descname"><span class="pre">WHITESPACE_RUN</span></span><a class="headerlink" href="#duck.html.html_minify.WHITESPACE_RUN" title="Link to this definition">¶</a></dt>
<dd><p>‘compile(…)’</p>
</dd></dl>

<dl class="py data">
<dt class="sig sig-object py" id="duck.html.html_minify.WHITESPACE_SENSITIVE_TAGS">
<span class="sig-prename descclassname"><span class="pre">duck.html.html_minify.</span></span><span class="sig-name descname"><span class="pre">WHITESPACE_SENSITIVE_TAGS</span></span><a class="headerlink" href="#duck.html.html_minify.WHITESPACE_SENSITIVE_TAGS" title="Link to this definition">¶</a></dt>
<dd><p>‘frozenset(…)’</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="duck.html.html_minify.minify_inner_html">
<span class="sig-prename descclassname"><span class="pre">duck.html.html_minify.</span></span><span class="sig-name descname"><span class="pre">minify_inner_html</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">html</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keep_comments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="../../_modules/duck/html/html_minify.html#minify_inner_html"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#duck.html.html_minify.minify_inner_html" title="Link to this definition">¶</a></dt>
<dd><p>Minifies an HTML string without changing how it renders.</p>
<p>Collapses runs of whitespace in ordinary text to a single space,
strips comments (except IE conditional comments), and leaves tags,
attributes, entities, and the content of <pre>, <textarea>,</p>
<script>, and <style> completely untouched.

:param html: The HTML to minify.
:param keep_comments: When True, keeps every comment instead of
                      stripping ordinary ones.

:returns: The minified HTML. Empty or non-string input is returned as-is.
</dd></dl>

</section>
</section>
</section>

    </div><div class="flex justify-between items-center pt-6 mt-12 border-t border-border gap-4">
    <div class="mr-auto">
      <a href="duck.html.components.video.html"
         class="inline-flex items-center justify-center rounded-md text-sm font-medium transition-colors border border-input hover:bg-accent hover:text-accent-foreground py-2 px-4">
        <svg xmlns="http://www.w3.org/2000/svg"
             width="24"
             height="24"
             viewBox="0 0 24 24"
             fill="none"
             stroke="currentColor"
             stroke-width="2"
             stroke-linecap="round"
             stroke-linejoin="round"
             class="mr-2 h-4 w-4">
          <polyline points="15 18 9 12 15 6"></polyline>
        </svg>
        duck.html.components.video
      </a>
    </div>
    <div class="ml-auto">
      <a href="duck.http.html"
         class="inline-flex items-center justify-center rounded-md text-sm font-medium transition-colors border border-input hover:bg-accent hover:text-accent-foreground py-2 px-4">
        duck.http
        <svg xmlns="http://www.w3.org/2000/svg"
             width="24"
             height="24"
             viewBox="0 0 24 24"
             fill="none"
             stroke="currentColor"
             stroke-width="2"
             stroke-linecap="round"
             stroke-linejoin="round"
             class="ml-2 h-4 w-4">
          <polyline points="9 18 15 12 9 6"></polyline>
        </svg>
      </a>
    </div>
</div></div><aside id="right-sidebar" class="hidden text-sm xl:block">
  <div class="sticky top-16 -mt-10 max-h-[calc(100vh-5rem)] h-full overflow-y-auto pt-6 space-y-2"><p class="font-medium">On this page</p>
    <ul>
<li><a class="reference internal" href="#module-contents">Module Contents</a><ul>
<li><a class="reference internal" href="#classes">Classes</a></li>
<li><a class="reference internal" href="#functions">Functions</a></li>
<li><a class="reference internal" href="#data">Data</a></li>
<li><a class="reference internal" href="#api">API</a><ul>
<li><a class="reference internal" href="#duck.html.html_minify.InnerHTMLMinifier"><code class="docutils literal notranslate"><span class="pre">InnerHTMLMinifier</span></code></a><ul>
<li><a class="reference internal" href="#duck.html.html_minify.InnerHTMLMinifier.handle_charref"><code class="docutils literal notranslate"><span class="pre">InnerHTMLMinifier.handle_charref()</span></code></a></li>
<li><a class="reference internal" href="#duck.html.html_minify.InnerHTMLMinifier.handle_comment"><code class="docutils literal notranslate"><span class="pre">InnerHTMLMinifier.handle_comment()</span></code></a></li>
<li><a class="reference internal" href="#duck.html.html_minify.InnerHTMLMinifier.handle_data"><code class="docutils literal notranslate"><span class="pre">InnerHTMLMinifier.handle_data()</span></code></a></li>
<li><a class="reference internal" href="#duck.html.html_minify.InnerHTMLMinifier.handle_decl"><code class="docutils literal notranslate"><span class="pre">InnerHTMLMinifier.handle_decl()</span></code></a></li>
<li><a class="reference internal" href="#duck.html.html_minify.InnerHTMLMinifier.handle_endtag"><code class="docutils literal notranslate"><span class="pre">InnerHTMLMinifier.handle_endtag()</span></code></a></li>
<li><a class="reference internal" href="#duck.html.html_minify.InnerHTMLMinifier.handle_entityref"><code class="docutils literal notranslate"><span class="pre">InnerHTMLMinifier.handle_entityref()</span></code></a></li>
<li><a class="reference internal" href="#duck.html.html_minify.InnerHTMLMinifier.handle_pi"><code class="docutils literal notranslate"><span class="pre">InnerHTMLMinifier.handle_pi()</span></code></a></li>
<li><a class="reference internal" href="#duck.html.html_minify.InnerHTMLMinifier.handle_startendtag"><code class="docutils literal notranslate"><span class="pre">InnerHTMLMinifier.handle_startendtag()</span></code></a></li>
<li><a class="reference internal" href="#duck.html.html_minify.InnerHTMLMinifier.handle_starttag"><code class="docutils literal notranslate"><span class="pre">InnerHTMLMinifier.handle_starttag()</span></code></a></li>
<li><a class="reference internal" href="#duck.html.html_minify.InnerHTMLMinifier.minify"><code class="docutils literal notranslate"><span class="pre">InnerHTMLMinifier.minify()</span></code></a></li>
<li><a class="reference internal" href="#duck.html.html_minify.InnerHTMLMinifier.unknown_decl"><code class="docutils literal notranslate"><span class="pre">InnerHTMLMinifier.unknown_decl()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#duck.html.html_minify.WHITESPACE_RUN"><code class="docutils literal notranslate"><span class="pre">WHITESPACE_RUN</span></code></a></li>
<li><a class="reference internal" href="#duck.html.html_minify.WHITESPACE_SENSITIVE_TAGS"><code class="docutils literal notranslate"><span class="pre">WHITESPACE_SENSITIVE_TAGS</span></code></a></li>
<li><a class="reference internal" href="#duck.html.html_minify.minify_inner_html"><code class="docutils literal notranslate"><span class="pre">minify_inner_html()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</aside>
          </main>
        </div>
      </div><footer class="py-6 border-t border-border md:py-0">
    <div class="container flex flex-col items-center justify-between gap-4 md:h-24 md:flex-row">
      <div class="flex flex-col items-center gap-4 px-8 md:flex-row md:gap-2 md:px-0">
        <p class="text-sm leading-loose text-center text-muted-foreground md:text-left">© 2026, Duck Framework Built with <a class="font-medium underline underline-offset-4"
    href="https://www.sphinx-doc.org"
    rel="noreferrer">Sphinx 8.2.3</a></p>
</div>
</div>
</footer>
    </div><button id="scrolltop"
        x-cloak
        @click="window.scrollTo({top: 0, behavior: 'smooth'})"
        class="fixed bottom-8 right-8 p-2 z-10 rounded-sm bg-gray-700 text-xs text-white transition-all duration-1000 hover:bg-gray-950 focus:bg-gray-950"
        :class="{'opacity-0 invisible' : !showScrollTop}"
>
  <svg xmlns="http://www.w3.org/2000/svg"
       height="14"
       viewBox="0 96 960 960"
       width="14"
       class="inline fill-current mb-[2px]"
       aria-hidden="true">
    <path d="M450 896V370L202 618l-42-42 320-320 320 320-42 42-248-248v526h-60Z" />
  </svg>
  Back to top
</button>
    
    <script src="../../_static/documentation_options.js?v=5929fcd5"></script>
    <script src="../../_static/doctools.js?v=9bcbadda"></script>
    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script defer="defer" src="../../_static/theme.js?v=5db23cf8"></script>
    <script src="../../_static/design-tabs.js?v=f930bc37"></script>
    <script src="../../_static/js/rtd_search_config.js"></script>
    <script src="../../_static/js/rtd_sphinx_search.min.js"></script>
    
</body>

</html>