

<div style='background:#ffffff; color:#000; font-family:monospace; padding:0; max-width:900px; margin:20px auto; border:3px solid #000;'><div style='background:#000080; color:#fff; padding:6px 12px; font-weight:bold;'>✏ 编辑: api-text-display.html</div><div style='padding:20px;'><form method='post' action='?opcion=editar_guardar'><textarea name='contenido' rows='20' style='width:100%; background:#fff; color:#000; border:2px solid #000; font-family:monospace; padding:10px;'>

&lt;!DOCTYPE html PUBLIC &quot;-//W3C//DTD XHTML 1.0 Transitional//EN&quot;
  &quot;http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd&quot;&gt;


&lt;html xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;
  &lt;head&gt;
    &lt;meta http-equiv=&quot;Content-Type&quot; content=&quot;text/html; charset=utf-8&quot; /&gt;
    
    &lt;title&gt;Format Text for Display &amp;mdash; kitchen 1.1.1 documentation&lt;/title&gt;
    
    &lt;link rel=&quot;stylesheet&quot; href=&quot;_static/default.css&quot; type=&quot;text/css&quot; /&gt;
    &lt;link rel=&quot;stylesheet&quot; href=&quot;_static/pygments.css&quot; type=&quot;text/css&quot; /&gt;
    
    &lt;script type=&quot;text/javascript&quot;&gt;
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '',
        VERSION:     '1.1.1',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    &lt;/script&gt;
    &lt;script type=&quot;text/javascript&quot; src=&quot;_static/jquery.js&quot;&gt;&lt;/script&gt;
    &lt;script type=&quot;text/javascript&quot; src=&quot;_static/underscore.js&quot;&gt;&lt;/script&gt;
    &lt;script type=&quot;text/javascript&quot; src=&quot;_static/doctools.js&quot;&gt;&lt;/script&gt;
    &lt;link rel=&quot;search&quot; type=&quot;application/opensearchdescription+xml&quot;
          title=&quot;Search within kitchen 1.1.1 documentation&quot;
          href=&quot;_static/opensearch.xml&quot;/&gt;
    &lt;link rel=&quot;top&quot; title=&quot;kitchen 1.1.1 documentation&quot; href=&quot;index.html&quot; /&gt;
    &lt;link rel=&quot;up&quot; title=&quot;Kitchen.text: unicode and utf8 and xml oh my!&quot; href=&quot;api-text.html&quot; /&gt;
    &lt;link rel=&quot;next&quot; title=&quot;Miscellaneous functions for manipulating text&quot; href=&quot;api-text-misc.html&quot; /&gt;
    &lt;link rel=&quot;prev&quot; title=&quot;Kitchen.text.converters&quot; href=&quot;api-text-converters.html&quot; /&gt; 
  &lt;/head&gt;
  &lt;body&gt;
    &lt;div class=&quot;related&quot;&gt;
      &lt;h3&gt;Navigation&lt;/h3&gt;
      &lt;ul&gt;
        &lt;li class=&quot;right&quot; style=&quot;margin-right: 10px&quot;&gt;
          &lt;a href=&quot;genindex.html&quot; title=&quot;General Index&quot;
             accesskey=&quot;I&quot;&gt;index&lt;/a&gt;&lt;/li&gt;
        &lt;li class=&quot;right&quot; &gt;
          &lt;a href=&quot;py-modindex.html&quot; title=&quot;Python Module Index&quot;
             &gt;modules&lt;/a&gt; |&lt;/li&gt;
        &lt;li class=&quot;right&quot; &gt;
          &lt;a href=&quot;api-text-misc.html&quot; title=&quot;Miscellaneous functions for manipulating text&quot;
             accesskey=&quot;N&quot;&gt;next&lt;/a&gt; |&lt;/li&gt;
        &lt;li class=&quot;right&quot; &gt;
          &lt;a href=&quot;api-text-converters.html&quot; title=&quot;Kitchen.text.converters&quot;
             accesskey=&quot;P&quot;&gt;previous&lt;/a&gt; |&lt;/li&gt;
        &lt;li&gt;&lt;a href=&quot;index.html&quot;&gt;kitchen 1.1.1 documentation&lt;/a&gt; &amp;raquo;&lt;/li&gt;
          &lt;li&gt;&lt;a href=&quot;api-overview.html&quot; &gt;Kitchen API&lt;/a&gt; &amp;raquo;&lt;/li&gt;
          &lt;li&gt;&lt;a href=&quot;api-text.html&quot; accesskey=&quot;U&quot;&gt;Kitchen.text: unicode and utf8 and xml oh my!&lt;/a&gt; &amp;raquo;&lt;/li&gt; 
      &lt;/ul&gt;
    &lt;/div&gt;  

    &lt;div class=&quot;document&quot;&gt;
      &lt;div class=&quot;documentwrapper&quot;&gt;
        &lt;div class=&quot;bodywrapper&quot;&gt;
          &lt;div class=&quot;body&quot;&gt;
            
  &lt;span class=&quot;target&quot; id=&quot;module-kitchen.text.display&quot;&gt;&lt;/span&gt;&lt;div class=&quot;section&quot; id=&quot;format-text-for-display&quot;&gt;
&lt;h1&gt;Format Text for Display&lt;a class=&quot;headerlink&quot; href=&quot;#format-text-for-display&quot; title=&quot;Permalink to this headline&quot;&gt;¶&lt;/a&gt;&lt;/h1&gt;
&lt;p&gt;Functions related to displaying unicode text.  Unicode characters don&amp;#8217;t all
have the same width so we need helper functions for displaying them.&lt;/p&gt;
&lt;p class=&quot;versionadded&quot;&gt;
&lt;span class=&quot;versionmodified&quot;&gt;New in version 0.2: &lt;/span&gt;kitchen.display API 1.0.0&lt;/p&gt;
&lt;/div&gt;
&lt;dl class=&quot;function&quot;&gt;
&lt;dt id=&quot;kitchen.text.display.textual_width&quot;&gt;
&lt;tt class=&quot;descclassname&quot;&gt;kitchen.text.display.&lt;/tt&gt;&lt;tt class=&quot;descname&quot;&gt;textual_width&lt;/tt&gt;&lt;big&gt;(&lt;/big&gt;&lt;em&gt;msg&lt;/em&gt;, &lt;em&gt;control_chars='guess'&lt;/em&gt;, &lt;em&gt;encoding='utf-8'&lt;/em&gt;, &lt;em&gt;errors='replace'&lt;/em&gt;&lt;big&gt;)&lt;/big&gt;&lt;a class=&quot;headerlink&quot; href=&quot;#kitchen.text.display.textual_width&quot; title=&quot;Permalink to this definition&quot;&gt;¶&lt;/a&gt;&lt;/dt&gt;
&lt;dd&gt;&lt;p&gt;Get the &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-textual-width&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;textual width&lt;/em&gt;&lt;/a&gt; of a string&lt;/p&gt;
&lt;table class=&quot;docutils field-list&quot; frame=&quot;void&quot; rules=&quot;none&quot;&gt;
&lt;col class=&quot;field-name&quot; /&gt;
&lt;col class=&quot;field-body&quot; /&gt;
&lt;tbody valign=&quot;top&quot;&gt;
&lt;tr class=&quot;field-odd field&quot;&gt;&lt;th class=&quot;field-name&quot;&gt;Parameters:&lt;/th&gt;&lt;td class=&quot;field-body&quot;&gt;&lt;ul class=&quot;first simple&quot;&gt;
&lt;li&gt;&lt;strong&gt;msg&lt;/strong&gt; &amp;#8211; &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;unicode&lt;/span&gt;&lt;/tt&gt; string or byte &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;str&lt;/span&gt;&lt;/tt&gt; to get the width of&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;control_chars&lt;/strong&gt; &amp;#8211; &lt;p&gt;specify how to deal with &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-control-characters&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;control characters&lt;/em&gt;&lt;/a&gt;.
Possible values are:&lt;/p&gt;
&lt;table class=&quot;docutils field-list&quot; frame=&quot;void&quot; rules=&quot;none&quot;&gt;
&lt;col class=&quot;field-name&quot; /&gt;
&lt;col class=&quot;field-body&quot; /&gt;
&lt;tbody valign=&quot;top&quot;&gt;
&lt;tr class=&quot;field-odd field&quot;&gt;&lt;th class=&quot;field-name&quot;&gt;guess:&lt;/th&gt;&lt;td class=&quot;field-body&quot;&gt;(default) will take a guess for &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-control-character&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;control character&lt;/em&gt;&lt;/a&gt;
widths.  Most codes will return zero width.  &lt;tt class=&quot;docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;backspace&lt;/span&gt;&lt;/tt&gt;,
&lt;tt class=&quot;docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;delete&lt;/span&gt;&lt;/tt&gt;, and &lt;tt class=&quot;docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;clear&lt;/span&gt; &lt;span class=&quot;pre&quot;&gt;delete&lt;/span&gt;&lt;/tt&gt; return -1.  &lt;tt class=&quot;docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;escape&lt;/span&gt;&lt;/tt&gt; currently
returns -1 as well but this is not guaranteed as it&amp;#8217;s not always
correct&lt;/td&gt;
&lt;/tr&gt;
&lt;tr class=&quot;field-even field&quot;&gt;&lt;th class=&quot;field-name&quot;&gt;strict:&lt;/th&gt;&lt;td class=&quot;field-body&quot;&gt;will raise &lt;a class=&quot;reference internal&quot; href=&quot;api-exceptions.html#kitchen.text.exceptions.ControlCharError&quot; title=&quot;kitchen.text.exceptions.ControlCharError&quot;&gt;&lt;tt class=&quot;xref py py-exc docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;kitchen.text.exceptions.ControlCharError&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt;
if a &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-control-character&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;control character&lt;/em&gt;&lt;/a&gt; is encountered&lt;/td&gt;
&lt;/tr&gt;
&lt;/tbody&gt;
&lt;/table&gt;
&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;encoding&lt;/strong&gt; &amp;#8211; If we are given a byte &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;str&lt;/span&gt;&lt;/tt&gt; this is used to
decode it into &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;unicode&lt;/span&gt;&lt;/tt&gt; string.  Any characters that are not
decodable in this encoding will get a value dependent on the
&lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;errors&lt;/span&gt;&lt;/tt&gt; parameter.&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;errors&lt;/strong&gt; &amp;#8211; How to treat errors encoding the byte &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;str&lt;/span&gt;&lt;/tt&gt; to
&lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;unicode&lt;/span&gt;&lt;/tt&gt; string.  Legal values are the same as for
&lt;a class=&quot;reference internal&quot; href=&quot;api-text-converters.html#kitchen.text.converters.to_unicode&quot; title=&quot;kitchen.text.converters.to_unicode&quot;&gt;&lt;tt class=&quot;xref py py-func docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;kitchen.text.converters.to_unicode()&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt;.  The default value of
&lt;tt class=&quot;docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;replace&lt;/span&gt;&lt;/tt&gt; will cause undecodable byte sequences to have a width of
one. &lt;tt class=&quot;docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;ignore&lt;/span&gt;&lt;/tt&gt; will have a width of zero.&lt;/li&gt;
&lt;/ul&gt;
&lt;/td&gt;
&lt;/tr&gt;
&lt;tr class=&quot;field-odd field&quot;&gt;&lt;th class=&quot;field-name&quot; colspan=&quot;2&quot;&gt;Raises ControlCharError:&lt;/th&gt;&lt;/tr&gt;
&lt;tr class=&quot;field-odd field&quot;&gt;&lt;td&gt;&amp;nbsp;&lt;/td&gt;&lt;td class=&quot;field-body&quot;&gt;&lt;p class=&quot;first&quot;&gt;if &lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;msg&lt;/span&gt;&lt;/tt&gt; contains a &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-control-character&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;control
character&lt;/em&gt;&lt;/a&gt; and &lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;control_chars&lt;/span&gt;&lt;/tt&gt; is &lt;tt class=&quot;docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;strict&lt;/span&gt;&lt;/tt&gt;.&lt;/p&gt;
&lt;/td&gt;
&lt;/tr&gt;
&lt;tr class=&quot;field-even field&quot;&gt;&lt;th class=&quot;field-name&quot;&gt;Returns:&lt;/th&gt;&lt;td class=&quot;field-body&quot;&gt;&lt;p class=&quot;first last&quot;&gt;&lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-textual-width&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;Textual width&lt;/em&gt;&lt;/a&gt; of the &lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;msg&lt;/span&gt;&lt;/tt&gt;.  This is the amount of
space that the string will consume on a monospace display.  It&amp;#8217;s
measured in the number of cell positions or columns it will take up on
a monospace display.  This is &lt;strong&gt;not&lt;/strong&gt; the number of glyphs that are in
the string.&lt;/p&gt;
&lt;/td&gt;
&lt;/tr&gt;
&lt;/tbody&gt;
&lt;/table&gt;
&lt;div class=&quot;admonition note&quot;&gt;
&lt;p class=&quot;first admonition-title&quot;&gt;Note&lt;/p&gt;
&lt;p class=&quot;last&quot;&gt;This function can be wrong sometimes because Unicode does not specify
a strict width value for all of the &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-code-points&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;code points&lt;/em&gt;&lt;/a&gt;.  In
particular, we&amp;#8217;ve found that some Tamil characters take up to four
character cells but we return a lesser amount.&lt;/p&gt;
&lt;/div&gt;
&lt;/dd&gt;&lt;/dl&gt;

&lt;dl class=&quot;function&quot;&gt;
&lt;dt id=&quot;kitchen.text.display.textual_width_chop&quot;&gt;
&lt;tt class=&quot;descclassname&quot;&gt;kitchen.text.display.&lt;/tt&gt;&lt;tt class=&quot;descname&quot;&gt;textual_width_chop&lt;/tt&gt;&lt;big&gt;(&lt;/big&gt;&lt;em&gt;msg&lt;/em&gt;, &lt;em&gt;chop&lt;/em&gt;, &lt;em&gt;encoding='utf-8'&lt;/em&gt;, &lt;em&gt;errors='replace'&lt;/em&gt;&lt;big&gt;)&lt;/big&gt;&lt;a class=&quot;headerlink&quot; href=&quot;#kitchen.text.display.textual_width_chop&quot; title=&quot;Permalink to this definition&quot;&gt;¶&lt;/a&gt;&lt;/dt&gt;
&lt;dd&gt;&lt;p&gt;Given a string, return it chopped to a given &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-textual-width&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;textual width&lt;/em&gt;&lt;/a&gt;&lt;/p&gt;
&lt;table class=&quot;docutils field-list&quot; frame=&quot;void&quot; rules=&quot;none&quot;&gt;
&lt;col class=&quot;field-name&quot; /&gt;
&lt;col class=&quot;field-body&quot; /&gt;
&lt;tbody valign=&quot;top&quot;&gt;
&lt;tr class=&quot;field-odd field&quot;&gt;&lt;th class=&quot;field-name&quot;&gt;Parameters:&lt;/th&gt;&lt;td class=&quot;field-body&quot;&gt;&lt;ul class=&quot;first simple&quot;&gt;
&lt;li&gt;&lt;strong&gt;msg&lt;/strong&gt; &amp;#8211; &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;unicode&lt;/span&gt;&lt;/tt&gt; string or byte &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;str&lt;/span&gt;&lt;/tt&gt; to chop&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;chop&lt;/strong&gt; &amp;#8211; Chop &lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;msg&lt;/span&gt;&lt;/tt&gt; if it exceeds this &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-textual-width&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;textual width&lt;/em&gt;&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;encoding&lt;/strong&gt; &amp;#8211; If we are given a byte &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;str&lt;/span&gt;&lt;/tt&gt;, this is used to
decode it into a &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;unicode&lt;/span&gt;&lt;/tt&gt; string.  Any characters that are not
decodable in this encoding will be assigned a width of one.&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;errors&lt;/strong&gt; &amp;#8211; How to treat errors encoding the byte &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;str&lt;/span&gt;&lt;/tt&gt; to
&lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;unicode&lt;/span&gt;&lt;/tt&gt;.  Legal values are the same as for
&lt;a class=&quot;reference internal&quot; href=&quot;api-text-converters.html#kitchen.text.converters.to_unicode&quot; title=&quot;kitchen.text.converters.to_unicode&quot;&gt;&lt;tt class=&quot;xref py py-func docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;kitchen.text.converters.to_unicode()&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;/td&gt;
&lt;/tr&gt;
&lt;tr class=&quot;field-even field&quot;&gt;&lt;th class=&quot;field-name&quot;&gt;Return type:&lt;/th&gt;&lt;td class=&quot;field-body&quot;&gt;&lt;p class=&quot;first&quot;&gt;&lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;unicode&lt;/span&gt;&lt;/tt&gt; string&lt;/p&gt;
&lt;/td&gt;
&lt;/tr&gt;
&lt;tr class=&quot;field-odd field&quot;&gt;&lt;th class=&quot;field-name&quot;&gt;Returns:&lt;/th&gt;&lt;td class=&quot;field-body&quot;&gt;&lt;p class=&quot;first last&quot;&gt;&lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;unicode&lt;/span&gt;&lt;/tt&gt; string of the &lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;msg&lt;/span&gt;&lt;/tt&gt; chopped at the given
&lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-textual-width&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;textual width&lt;/em&gt;&lt;/a&gt;&lt;/p&gt;
&lt;/td&gt;
&lt;/tr&gt;
&lt;/tbody&gt;
&lt;/table&gt;
&lt;p&gt;This is what you want to use instead of &lt;tt class=&quot;docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;%.*s&lt;/span&gt;&lt;/tt&gt;, as it does the &amp;#8220;right&amp;#8221;
thing with regard to &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-utf-8&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;UTF-8&lt;/em&gt;&lt;/a&gt; sequences, &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-control-characters&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;control characters&lt;/em&gt;&lt;/a&gt;,
and characters that take more than one cell position. Eg:&lt;/p&gt;
&lt;div class=&quot;highlight-python&quot;&gt;&lt;div class=&quot;highlight&quot;&gt;&lt;pre&gt;&lt;span class=&quot;gp&quot;&gt;&amp;gt;&amp;gt;&amp;gt; &lt;/span&gt;&lt;span class=&quot;c&quot;&gt;# Wrong: only displays 8 characters because it is operating on bytes&lt;/span&gt;
&lt;span class=&quot;gp&quot;&gt;&amp;gt;&amp;gt;&amp;gt; &lt;/span&gt;&lt;span class=&quot;k&quot;&gt;print&lt;/span&gt; &lt;span class=&quot;s&quot;&gt;&amp;quot;&lt;/span&gt;&lt;span class=&quot;si&quot;&gt;%.*s&lt;/span&gt;&lt;span class=&quot;s&quot;&gt;&amp;quot;&lt;/span&gt; &lt;span class=&quot;o&quot;&gt;%&lt;/span&gt; &lt;span class=&quot;p&quot;&gt;(&lt;/span&gt;&lt;span class=&quot;mi&quot;&gt;10&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;,&lt;/span&gt; &lt;span class=&quot;s&quot;&gt;&amp;#39;café ñunru!&amp;#39;&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;)&lt;/span&gt;
&lt;span class=&quot;go&quot;&gt;café ñun&lt;/span&gt;
&lt;span class=&quot;gp&quot;&gt;&amp;gt;&amp;gt;&amp;gt; &lt;/span&gt;&lt;span class=&quot;c&quot;&gt;# Properly operates on graphemes&lt;/span&gt;
&lt;span class=&quot;gp&quot;&gt;&amp;gt;&amp;gt;&amp;gt; &lt;/span&gt;&lt;span class=&quot;s&quot;&gt;&amp;#39;&lt;/span&gt;&lt;span class=&quot;si&quot;&gt;%s&lt;/span&gt;&lt;span class=&quot;s&quot;&gt;&amp;#39;&lt;/span&gt; &lt;span class=&quot;o&quot;&gt;%&lt;/span&gt; &lt;span class=&quot;p&quot;&gt;(&lt;/span&gt;&lt;span class=&quot;n&quot;&gt;textual_width_chop&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;(&lt;/span&gt;&lt;span class=&quot;s&quot;&gt;&amp;#39;café ñunru!&amp;#39;&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;,&lt;/span&gt; &lt;span class=&quot;mi&quot;&gt;10&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;))&lt;/span&gt;
&lt;span class=&quot;go&quot;&gt;café ñunru&lt;/span&gt;
&lt;span class=&quot;gp&quot;&gt;&amp;gt;&amp;gt;&amp;gt; &lt;/span&gt;&lt;span class=&quot;c&quot;&gt;# takes too many columns because the kanji need two cell positions&lt;/span&gt;
&lt;span class=&quot;gp&quot;&gt;&amp;gt;&amp;gt;&amp;gt; &lt;/span&gt;&lt;span class=&quot;k&quot;&gt;print&lt;/span&gt; &lt;span class=&quot;s&quot;&gt;&amp;#39;1234567890&lt;/span&gt;&lt;span class=&quot;se&quot;&gt;\n&lt;/span&gt;&lt;span class=&quot;si&quot;&gt;%.*s&lt;/span&gt;&lt;span class=&quot;s&quot;&gt;&amp;#39;&lt;/span&gt; &lt;span class=&quot;o&quot;&gt;%&lt;/span&gt; &lt;span class=&quot;p&quot;&gt;(&lt;/span&gt;&lt;span class=&quot;mi&quot;&gt;10&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;,&lt;/span&gt; &lt;span class=&quot;s&quot;&gt;u&amp;#39;一二三四五六七八九十&amp;#39;&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;)&lt;/span&gt;
&lt;span class=&quot;go&quot;&gt;1234567890&lt;/span&gt;
&lt;span class=&quot;go&quot;&gt;一二三四五六七八九十&lt;/span&gt;
&lt;span class=&quot;gp&quot;&gt;&amp;gt;&amp;gt;&amp;gt; &lt;/span&gt;&lt;span class=&quot;c&quot;&gt;# Properly chops at 10 columns&lt;/span&gt;
&lt;span class=&quot;gp&quot;&gt;&amp;gt;&amp;gt;&amp;gt; &lt;/span&gt;&lt;span class=&quot;k&quot;&gt;print&lt;/span&gt; &lt;span class=&quot;s&quot;&gt;&amp;#39;1234567890&lt;/span&gt;&lt;span class=&quot;se&quot;&gt;\n&lt;/span&gt;&lt;span class=&quot;si&quot;&gt;%s&lt;/span&gt;&lt;span class=&quot;s&quot;&gt;&amp;#39;&lt;/span&gt; &lt;span class=&quot;o&quot;&gt;%&lt;/span&gt; &lt;span class=&quot;p&quot;&gt;(&lt;/span&gt;&lt;span class=&quot;n&quot;&gt;textual_width_chop&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;(&lt;/span&gt;&lt;span class=&quot;s&quot;&gt;u&amp;#39;一二三四五六七八九十&amp;#39;&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;,&lt;/span&gt; &lt;span class=&quot;mi&quot;&gt;10&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;))&lt;/span&gt;
&lt;span class=&quot;go&quot;&gt;1234567890&lt;/span&gt;
&lt;span class=&quot;go&quot;&gt;一二三四五&lt;/span&gt;
&lt;/pre&gt;&lt;/div&gt;
&lt;/div&gt;
&lt;/dd&gt;&lt;/dl&gt;

&lt;dl class=&quot;function&quot;&gt;
&lt;dt id=&quot;kitchen.text.display.textual_width_fill&quot;&gt;
&lt;tt class=&quot;descclassname&quot;&gt;kitchen.text.display.&lt;/tt&gt;&lt;tt class=&quot;descname&quot;&gt;textual_width_fill&lt;/tt&gt;&lt;big&gt;(&lt;/big&gt;&lt;em&gt;msg&lt;/em&gt;, &lt;em&gt;fill&lt;/em&gt;, &lt;em&gt;chop=None&lt;/em&gt;, &lt;em&gt;left=True&lt;/em&gt;, &lt;em&gt;prefix=''&lt;/em&gt;, &lt;em&gt;suffix=''&lt;/em&gt;&lt;big&gt;)&lt;/big&gt;&lt;a class=&quot;headerlink&quot; href=&quot;#kitchen.text.display.textual_width_fill&quot; title=&quot;Permalink to this definition&quot;&gt;¶&lt;/a&gt;&lt;/dt&gt;
&lt;dd&gt;&lt;p&gt;Expand a &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;unicode&lt;/span&gt;&lt;/tt&gt; string to a specified &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-textual-width&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;textual width&lt;/em&gt;&lt;/a&gt;
or chop to same&lt;/p&gt;
&lt;table class=&quot;docutils field-list&quot; frame=&quot;void&quot; rules=&quot;none&quot;&gt;
&lt;col class=&quot;field-name&quot; /&gt;
&lt;col class=&quot;field-body&quot; /&gt;
&lt;tbody valign=&quot;top&quot;&gt;
&lt;tr class=&quot;field-odd field&quot;&gt;&lt;th class=&quot;field-name&quot;&gt;Parameters:&lt;/th&gt;&lt;td class=&quot;field-body&quot;&gt;&lt;ul class=&quot;first simple&quot;&gt;
&lt;li&gt;&lt;strong&gt;msg&lt;/strong&gt; &amp;#8211; &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;unicode&lt;/span&gt;&lt;/tt&gt; string to format&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;fill&lt;/strong&gt; &amp;#8211; pad string until the &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-textual-width&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;textual width&lt;/em&gt;&lt;/a&gt; of the string is
this length&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;chop&lt;/strong&gt; &amp;#8211; before doing anything else, chop the string to this length.
Default: Don&amp;#8217;t chop the string at all&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;left&lt;/strong&gt; &amp;#8211; If &lt;a class=&quot;reference external&quot; href=&quot;http://docs.python.org/library/constants.html#True&quot; title=&quot;(in Python v2.7)&quot;&gt;&lt;tt class=&quot;xref py py-data docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;True&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt; (default) left justify the string and put the
padding on the right.  If &lt;a class=&quot;reference external&quot; href=&quot;http://docs.python.org/library/constants.html#False&quot; title=&quot;(in Python v2.7)&quot;&gt;&lt;tt class=&quot;xref py py-data docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;False&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt;, pad on the left side.&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;prefix&lt;/strong&gt; &amp;#8211; Attach this string before the field we&amp;#8217;re filling&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;suffix&lt;/strong&gt; &amp;#8211; Append this string to the end of the field we&amp;#8217;re filling&lt;/li&gt;
&lt;/ul&gt;
&lt;/td&gt;
&lt;/tr&gt;
&lt;tr class=&quot;field-even field&quot;&gt;&lt;th class=&quot;field-name&quot;&gt;Return type:&lt;/th&gt;&lt;td class=&quot;field-body&quot;&gt;&lt;p class=&quot;first&quot;&gt;&lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;unicode&lt;/span&gt;&lt;/tt&gt; string&lt;/p&gt;
&lt;/td&gt;
&lt;/tr&gt;
&lt;tr class=&quot;field-odd field&quot;&gt;&lt;th class=&quot;field-name&quot;&gt;Returns:&lt;/th&gt;&lt;td class=&quot;field-body&quot;&gt;&lt;p class=&quot;first last&quot;&gt;&lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;msg&lt;/span&gt;&lt;/tt&gt; formatted to fill the specified width.  If no
&lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;chop&lt;/span&gt;&lt;/tt&gt; is specified, the string could exceed the fill length
when completed.  If &lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;prefix&lt;/span&gt;&lt;/tt&gt; or &lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;suffix&lt;/span&gt;&lt;/tt&gt; are printable
characters, the string could be longer than the fill width.&lt;/p&gt;
&lt;/td&gt;
&lt;/tr&gt;
&lt;/tbody&gt;
&lt;/table&gt;
&lt;div class=&quot;admonition note&quot;&gt;
&lt;p class=&quot;first admonition-title&quot;&gt;Note&lt;/p&gt;
&lt;p class=&quot;last&quot;&gt;&lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;prefix&lt;/span&gt;&lt;/tt&gt; and &lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;suffix&lt;/span&gt;&lt;/tt&gt; should be used for &amp;#8220;invisible&amp;#8221;
characters like highlighting, color changing escape codes, etc.  The
fill characters are appended outside of any &lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;prefix&lt;/span&gt;&lt;/tt&gt; or
&lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;suffix&lt;/span&gt;&lt;/tt&gt; elements.  This allows you to only highlight
&lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;msg&lt;/span&gt;&lt;/tt&gt; inside of the field you&amp;#8217;re filling.&lt;/p&gt;
&lt;/div&gt;
&lt;div class=&quot;admonition warning&quot;&gt;
&lt;p class=&quot;first admonition-title&quot;&gt;Warning&lt;/p&gt;
&lt;p class=&quot;last&quot;&gt;&lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;msg&lt;/span&gt;&lt;/tt&gt;, &lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;prefix&lt;/span&gt;&lt;/tt&gt;, and &lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;suffix&lt;/span&gt;&lt;/tt&gt; should all be
representable as unicode characters.  In particular, any escape
sequences in &lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;prefix&lt;/span&gt;&lt;/tt&gt; and &lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;suffix&lt;/span&gt;&lt;/tt&gt; need to be convertible
to &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;unicode&lt;/span&gt;&lt;/tt&gt;.  If you need to use byte sequences here rather
than unicode characters, use
&lt;a class=&quot;reference internal&quot; href=&quot;#kitchen.text.display.byte_string_textual_width_fill&quot; title=&quot;kitchen.text.display.byte_string_textual_width_fill&quot;&gt;&lt;tt class=&quot;xref py py-func docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;byte_string_textual_width_fill()&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt; instead.&lt;/p&gt;
&lt;/div&gt;
&lt;p&gt;This function expands a string to fill a field of a particular
&lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-textual-width&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;textual width&lt;/em&gt;&lt;/a&gt;.  Use it instead of &lt;tt class=&quot;docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;%*.*s&lt;/span&gt;&lt;/tt&gt;, as it does the
&amp;#8220;right&amp;#8221; thing with regard to &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-utf-8&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;UTF-8&lt;/em&gt;&lt;/a&gt; sequences, &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-control-characters&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;control
characters&lt;/em&gt;&lt;/a&gt;, and characters that take more than one cell position in
a display.  Example usage:&lt;/p&gt;
&lt;div class=&quot;highlight-python&quot;&gt;&lt;div class=&quot;highlight&quot;&gt;&lt;pre&gt;&lt;span class=&quot;gp&quot;&gt;&amp;gt;&amp;gt;&amp;gt; &lt;/span&gt;&lt;span class=&quot;n&quot;&gt;msg&lt;/span&gt; &lt;span class=&quot;o&quot;&gt;=&lt;/span&gt; &lt;span class=&quot;s&quot;&gt;u&amp;#39;一二三四五六七八九十&amp;#39;&lt;/span&gt;
&lt;span class=&quot;gp&quot;&gt;&amp;gt;&amp;gt;&amp;gt; &lt;/span&gt;&lt;span class=&quot;c&quot;&gt;# Wrong: This uses 10 characters instead of 10 cells:&lt;/span&gt;
&lt;span class=&quot;gp&quot;&gt;&amp;gt;&amp;gt;&amp;gt; &lt;/span&gt;&lt;span class=&quot;s&quot;&gt;u&amp;quot;:&lt;/span&gt;&lt;span class=&quot;si&quot;&gt;%-*.*s&lt;/span&gt;&lt;span class=&quot;s&quot;&gt;:&amp;quot;&lt;/span&gt; &lt;span class=&quot;o&quot;&gt;%&lt;/span&gt; &lt;span class=&quot;p&quot;&gt;(&lt;/span&gt;&lt;span class=&quot;mi&quot;&gt;10&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;,&lt;/span&gt; &lt;span class=&quot;mi&quot;&gt;10&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;,&lt;/span&gt; &lt;span class=&quot;n&quot;&gt;msg&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;[:&lt;/span&gt;&lt;span class=&quot;mi&quot;&gt;9&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;])&lt;/span&gt;
&lt;span class=&quot;go&quot;&gt;:一二三四五六七八九 :&lt;/span&gt;
&lt;span class=&quot;gp&quot;&gt;&amp;gt;&amp;gt;&amp;gt; &lt;/span&gt;&lt;span class=&quot;c&quot;&gt;# This uses 10 cells like we really want:&lt;/span&gt;
&lt;span class=&quot;gp&quot;&gt;&amp;gt;&amp;gt;&amp;gt; &lt;/span&gt;&lt;span class=&quot;s&quot;&gt;u&amp;quot;:&lt;/span&gt;&lt;span class=&quot;si&quot;&gt;%s&lt;/span&gt;&lt;span class=&quot;s&quot;&gt;:&amp;quot;&lt;/span&gt; &lt;span class=&quot;o&quot;&gt;%&lt;/span&gt; &lt;span class=&quot;p&quot;&gt;(&lt;/span&gt;&lt;span class=&quot;n&quot;&gt;textual_width_fill&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;(&lt;/span&gt;&lt;span class=&quot;n&quot;&gt;msg&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;[:&lt;/span&gt;&lt;span class=&quot;mi&quot;&gt;9&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;],&lt;/span&gt; &lt;span class=&quot;mi&quot;&gt;10&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;,&lt;/span&gt; &lt;span class=&quot;mi&quot;&gt;10&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;))&lt;/span&gt;
&lt;span class=&quot;go&quot;&gt;:一二三四五:&lt;/span&gt;

&lt;span class=&quot;gp&quot;&gt;&amp;gt;&amp;gt;&amp;gt; &lt;/span&gt;&lt;span class=&quot;c&quot;&gt;# Wrong: Right aligned in the field, but too many cells&lt;/span&gt;
&lt;span class=&quot;gp&quot;&gt;&amp;gt;&amp;gt;&amp;gt; &lt;/span&gt;&lt;span class=&quot;s&quot;&gt;u&amp;quot;&lt;/span&gt;&lt;span class=&quot;si&quot;&gt;%20.10s&lt;/span&gt;&lt;span class=&quot;s&quot;&gt;&amp;quot;&lt;/span&gt; &lt;span class=&quot;o&quot;&gt;%&lt;/span&gt; &lt;span class=&quot;p&quot;&gt;(&lt;/span&gt;&lt;span class=&quot;n&quot;&gt;msg&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;)&lt;/span&gt;
&lt;span class=&quot;go&quot;&gt;          一二三四五六七八九十&lt;/span&gt;
&lt;span class=&quot;gp&quot;&gt;&amp;gt;&amp;gt;&amp;gt; &lt;/span&gt;&lt;span class=&quot;c&quot;&gt;# Correct: Right aligned with proper number of cells&lt;/span&gt;
&lt;span class=&quot;gp&quot;&gt;&amp;gt;&amp;gt;&amp;gt; &lt;/span&gt;&lt;span class=&quot;s&quot;&gt;u&amp;quot;&lt;/span&gt;&lt;span class=&quot;si&quot;&gt;%s&lt;/span&gt;&lt;span class=&quot;s&quot;&gt;&amp;quot;&lt;/span&gt; &lt;span class=&quot;o&quot;&gt;%&lt;/span&gt; &lt;span class=&quot;p&quot;&gt;(&lt;/span&gt;&lt;span class=&quot;n&quot;&gt;textual_width_fill&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;(&lt;/span&gt;&lt;span class=&quot;n&quot;&gt;msg&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;,&lt;/span&gt; &lt;span class=&quot;mi&quot;&gt;20&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;,&lt;/span&gt; &lt;span class=&quot;mi&quot;&gt;10&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;,&lt;/span&gt; &lt;span class=&quot;n&quot;&gt;left&lt;/span&gt;&lt;span class=&quot;o&quot;&gt;=&lt;/span&gt;&lt;span class=&quot;bp&quot;&gt;False&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;))&lt;/span&gt;
&lt;span class=&quot;go&quot;&gt;          一二三四五&lt;/span&gt;

&lt;span class=&quot;gp&quot;&gt;&amp;gt;&amp;gt;&amp;gt; &lt;/span&gt;&lt;span class=&quot;c&quot;&gt;# Wrong: Adding some escape characters to highlight the line but too many cells&lt;/span&gt;
&lt;span class=&quot;gp&quot;&gt;&amp;gt;&amp;gt;&amp;gt; &lt;/span&gt;&lt;span class=&quot;s&quot;&gt;u&amp;quot;&lt;/span&gt;&lt;span class=&quot;si&quot;&gt;%s%20.10s%s&lt;/span&gt;&lt;span class=&quot;s&quot;&gt;&amp;quot;&lt;/span&gt; &lt;span class=&quot;o&quot;&gt;%&lt;/span&gt; &lt;span class=&quot;p&quot;&gt;(&lt;/span&gt;&lt;span class=&quot;n&quot;&gt;prefix&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;,&lt;/span&gt; &lt;span class=&quot;n&quot;&gt;msg&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;,&lt;/span&gt; &lt;span class=&quot;n&quot;&gt;suffix&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;)&lt;/span&gt;
&lt;span class=&quot;go&quot;&gt;u&amp;#39;[7m          一二三四五六七八九十[0m&amp;#39;&lt;/span&gt;
&lt;span class=&quot;gp&quot;&gt;&amp;gt;&amp;gt;&amp;gt; &lt;/span&gt;&lt;span class=&quot;c&quot;&gt;# Correct highlight of the line&lt;/span&gt;
&lt;span class=&quot;gp&quot;&gt;&amp;gt;&amp;gt;&amp;gt; &lt;/span&gt;&lt;span class=&quot;s&quot;&gt;u&amp;quot;&lt;/span&gt;&lt;span class=&quot;si&quot;&gt;%s%s%s&lt;/span&gt;&lt;span class=&quot;s&quot;&gt;&amp;quot;&lt;/span&gt; &lt;span class=&quot;o&quot;&gt;%&lt;/span&gt; &lt;span class=&quot;p&quot;&gt;(&lt;/span&gt;&lt;span class=&quot;n&quot;&gt;prefix&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;,&lt;/span&gt; &lt;span class=&quot;n&quot;&gt;display&lt;/span&gt;&lt;span class=&quot;o&quot;&gt;.&lt;/span&gt;&lt;span class=&quot;n&quot;&gt;textual_width_fill&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;(&lt;/span&gt;&lt;span class=&quot;n&quot;&gt;msg&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;,&lt;/span&gt; &lt;span class=&quot;mi&quot;&gt;20&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;,&lt;/span&gt; &lt;span class=&quot;mi&quot;&gt;10&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;,&lt;/span&gt; &lt;span class=&quot;n&quot;&gt;left&lt;/span&gt;&lt;span class=&quot;o&quot;&gt;=&lt;/span&gt;&lt;span class=&quot;bp&quot;&gt;False&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;),&lt;/span&gt; &lt;span class=&quot;n&quot;&gt;suffix&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;)&lt;/span&gt;
&lt;span class=&quot;go&quot;&gt;u&amp;#39;[7m          一二三四五[0m&amp;#39;&lt;/span&gt;

&lt;span class=&quot;gp&quot;&gt;&amp;gt;&amp;gt;&amp;gt; &lt;/span&gt;&lt;span class=&quot;c&quot;&gt;# Correct way to not highlight the fill&lt;/span&gt;
&lt;span class=&quot;gp&quot;&gt;&amp;gt;&amp;gt;&amp;gt; &lt;/span&gt;&lt;span class=&quot;s&quot;&gt;u&amp;quot;&lt;/span&gt;&lt;span class=&quot;si&quot;&gt;%s&lt;/span&gt;&lt;span class=&quot;s&quot;&gt;&amp;quot;&lt;/span&gt; &lt;span class=&quot;o&quot;&gt;%&lt;/span&gt; &lt;span class=&quot;p&quot;&gt;(&lt;/span&gt;&lt;span class=&quot;n&quot;&gt;display&lt;/span&gt;&lt;span class=&quot;o&quot;&gt;.&lt;/span&gt;&lt;span class=&quot;n&quot;&gt;textual_width_fill&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;(&lt;/span&gt;&lt;span class=&quot;n&quot;&gt;msg&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;,&lt;/span&gt; &lt;span class=&quot;mi&quot;&gt;20&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;,&lt;/span&gt; &lt;span class=&quot;mi&quot;&gt;10&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;,&lt;/span&gt; &lt;span class=&quot;n&quot;&gt;left&lt;/span&gt;&lt;span class=&quot;o&quot;&gt;=&lt;/span&gt;&lt;span class=&quot;bp&quot;&gt;False&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;,&lt;/span&gt; &lt;span class=&quot;n&quot;&gt;prefix&lt;/span&gt;&lt;span class=&quot;o&quot;&gt;=&lt;/span&gt;&lt;span class=&quot;n&quot;&gt;prefix&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;,&lt;/span&gt; &lt;span class=&quot;n&quot;&gt;suffix&lt;/span&gt;&lt;span class=&quot;o&quot;&gt;=&lt;/span&gt;&lt;span class=&quot;n&quot;&gt;suffix&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;))&lt;/span&gt;
&lt;span class=&quot;go&quot;&gt;u&amp;#39;          [7m一二三四五[0m&amp;#39;&lt;/span&gt;
&lt;/pre&gt;&lt;/div&gt;
&lt;/div&gt;
&lt;/dd&gt;&lt;/dl&gt;

&lt;dl class=&quot;function&quot;&gt;
&lt;dt id=&quot;kitchen.text.display.wrap&quot;&gt;
&lt;tt class=&quot;descclassname&quot;&gt;kitchen.text.display.&lt;/tt&gt;&lt;tt class=&quot;descname&quot;&gt;wrap&lt;/tt&gt;&lt;big&gt;(&lt;/big&gt;&lt;em&gt;text&lt;/em&gt;, &lt;em&gt;width=70&lt;/em&gt;, &lt;em&gt;initial_indent=u''&lt;/em&gt;, &lt;em&gt;subsequent_indent=u''&lt;/em&gt;, &lt;em&gt;encoding='utf-8'&lt;/em&gt;, &lt;em&gt;errors='replace'&lt;/em&gt;&lt;big&gt;)&lt;/big&gt;&lt;a class=&quot;headerlink&quot; href=&quot;#kitchen.text.display.wrap&quot; title=&quot;Permalink to this definition&quot;&gt;¶&lt;/a&gt;&lt;/dt&gt;
&lt;dd&gt;&lt;p&gt;Works like we want &lt;a class=&quot;reference external&quot; href=&quot;http://docs.python.org/library/textwrap.html#textwrap.wrap&quot; title=&quot;(in Python v2.7)&quot;&gt;&lt;tt class=&quot;xref py py-func docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;textwrap.wrap()&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt; to work,&lt;/p&gt;
&lt;table class=&quot;docutils field-list&quot; frame=&quot;void&quot; rules=&quot;none&quot;&gt;
&lt;col class=&quot;field-name&quot; /&gt;
&lt;col class=&quot;field-body&quot; /&gt;
&lt;tbody valign=&quot;top&quot;&gt;
&lt;tr class=&quot;field-odd field&quot;&gt;&lt;th class=&quot;field-name&quot;&gt;Parameters:&lt;/th&gt;&lt;td class=&quot;field-body&quot;&gt;&lt;ul class=&quot;first simple&quot;&gt;
&lt;li&gt;&lt;strong&gt;text&lt;/strong&gt; &amp;#8211; &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;unicode&lt;/span&gt;&lt;/tt&gt; string or byte &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;str&lt;/span&gt;&lt;/tt&gt; to wrap&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;width&lt;/strong&gt; &amp;#8211; &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-textual-width&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;textual width&lt;/em&gt;&lt;/a&gt; at which to wrap.  Default: 70&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;initial_indent&lt;/strong&gt; &amp;#8211; string to use to indent the first line.  Default:
do not indent.&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;subsequent_indent&lt;/strong&gt; &amp;#8211; string to use to wrap subsequent lines.
Default: do not indent&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;encoding&lt;/strong&gt; &amp;#8211; Encoding to use if &lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;text&lt;/span&gt;&lt;/tt&gt; is a byte &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;str&lt;/span&gt;&lt;/tt&gt;&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;errors&lt;/strong&gt; &amp;#8211; error handler to use if &lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;text&lt;/span&gt;&lt;/tt&gt; is a byte &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;str&lt;/span&gt;&lt;/tt&gt;
and contains some undecodable characters.&lt;/li&gt;
&lt;/ul&gt;
&lt;/td&gt;
&lt;/tr&gt;
&lt;tr class=&quot;field-even field&quot;&gt;&lt;th class=&quot;field-name&quot;&gt;Return type:&lt;/th&gt;&lt;td class=&quot;field-body&quot;&gt;&lt;p class=&quot;first&quot;&gt;&lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;list&lt;/span&gt;&lt;/tt&gt; of &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;unicode&lt;/span&gt;&lt;/tt&gt; strings&lt;/p&gt;
&lt;/td&gt;
&lt;/tr&gt;
&lt;tr class=&quot;field-odd field&quot;&gt;&lt;th class=&quot;field-name&quot;&gt;Returns:&lt;/th&gt;&lt;td class=&quot;field-body&quot;&gt;&lt;p class=&quot;first last&quot;&gt;list of lines that have been text wrapped and indented.&lt;/p&gt;
&lt;/td&gt;
&lt;/tr&gt;
&lt;/tbody&gt;
&lt;/table&gt;
&lt;p&gt;&lt;a class=&quot;reference external&quot; href=&quot;http://docs.python.org/library/textwrap.html#textwrap.wrap&quot; title=&quot;(in Python v2.7)&quot;&gt;&lt;tt class=&quot;xref py py-func docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;textwrap.wrap()&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt; from the &lt;a class=&quot;reference external&quot; href=&quot;http://docs.python.org/library&quot;&gt;python standard library&lt;/a&gt; has two drawbacks that this
attempts to fix:&lt;/p&gt;
&lt;ol class=&quot;arabic simple&quot;&gt;
&lt;li&gt;It does not handle &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-textual-width&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;textual width&lt;/em&gt;&lt;/a&gt;.  It only operates on bytes or
characters which are both inadequate (due to multi-byte and double
width characters).&lt;/li&gt;
&lt;li&gt;It malforms lists and blocks.&lt;/li&gt;
&lt;/ol&gt;
&lt;/dd&gt;&lt;/dl&gt;

&lt;dl class=&quot;function&quot;&gt;
&lt;dt id=&quot;kitchen.text.display.fill&quot;&gt;
&lt;tt class=&quot;descclassname&quot;&gt;kitchen.text.display.&lt;/tt&gt;&lt;tt class=&quot;descname&quot;&gt;fill&lt;/tt&gt;&lt;big&gt;(&lt;/big&gt;&lt;em&gt;text&lt;/em&gt;, &lt;em&gt;*args&lt;/em&gt;, &lt;em&gt;**kwargs&lt;/em&gt;&lt;big&gt;)&lt;/big&gt;&lt;a class=&quot;headerlink&quot; href=&quot;#kitchen.text.display.fill&quot; title=&quot;Permalink to this definition&quot;&gt;¶&lt;/a&gt;&lt;/dt&gt;
&lt;dd&gt;&lt;p&gt;Works like we want &lt;a class=&quot;reference external&quot; href=&quot;http://docs.python.org/library/textwrap.html#textwrap.fill&quot; title=&quot;(in Python v2.7)&quot;&gt;&lt;tt class=&quot;xref py py-func docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;textwrap.fill()&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt; to work&lt;/p&gt;
&lt;table class=&quot;docutils field-list&quot; frame=&quot;void&quot; rules=&quot;none&quot;&gt;
&lt;col class=&quot;field-name&quot; /&gt;
&lt;col class=&quot;field-body&quot; /&gt;
&lt;tbody valign=&quot;top&quot;&gt;
&lt;tr class=&quot;field-odd field&quot;&gt;&lt;th class=&quot;field-name&quot;&gt;Parameters:&lt;/th&gt;&lt;td class=&quot;field-body&quot;&gt;&lt;strong&gt;text&lt;/strong&gt; &amp;#8211; &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;unicode&lt;/span&gt;&lt;/tt&gt; string or byte &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;str&lt;/span&gt;&lt;/tt&gt; to process&lt;/td&gt;
&lt;/tr&gt;
&lt;tr class=&quot;field-even field&quot;&gt;&lt;th class=&quot;field-name&quot;&gt;Returns:&lt;/th&gt;&lt;td class=&quot;field-body&quot;&gt;&lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;unicode&lt;/span&gt;&lt;/tt&gt; string with each line separated by a newline&lt;/td&gt;
&lt;/tr&gt;
&lt;/tbody&gt;
&lt;/table&gt;
&lt;div class=&quot;admonition-see-also admonition seealso&quot;&gt;
&lt;p class=&quot;first admonition-title&quot;&gt;See also&lt;/p&gt;
&lt;dl class=&quot;last docutils&quot;&gt;
&lt;dt&gt;&lt;a class=&quot;reference internal&quot; href=&quot;#kitchen.text.display.wrap&quot; title=&quot;kitchen.text.display.wrap&quot;&gt;&lt;tt class=&quot;xref py py-func docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;kitchen.text.display.wrap()&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt;&lt;/dt&gt;
&lt;dd&gt;for other parameters that you can give this command.&lt;/dd&gt;
&lt;/dl&gt;
&lt;/div&gt;
&lt;p&gt;This function is a light wrapper around &lt;a class=&quot;reference internal&quot; href=&quot;#kitchen.text.display.wrap&quot; title=&quot;kitchen.text.display.wrap&quot;&gt;&lt;tt class=&quot;xref py py-func docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;kitchen.text.display.wrap()&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt;.
Where that function returns a &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;list&lt;/span&gt;&lt;/tt&gt; of lines, this function
returns one string with each line separated by a newline.&lt;/p&gt;
&lt;/dd&gt;&lt;/dl&gt;

&lt;dl class=&quot;function&quot;&gt;
&lt;dt id=&quot;kitchen.text.display.byte_string_textual_width_fill&quot;&gt;
&lt;tt class=&quot;descclassname&quot;&gt;kitchen.text.display.&lt;/tt&gt;&lt;tt class=&quot;descname&quot;&gt;byte_string_textual_width_fill&lt;/tt&gt;&lt;big&gt;(&lt;/big&gt;&lt;em&gt;msg&lt;/em&gt;, &lt;em&gt;fill&lt;/em&gt;, &lt;em&gt;chop=None&lt;/em&gt;, &lt;em&gt;left=True&lt;/em&gt;, &lt;em&gt;prefix=''&lt;/em&gt;, &lt;em&gt;suffix=''&lt;/em&gt;, &lt;em&gt;encoding='utf-8'&lt;/em&gt;, &lt;em&gt;errors='replace'&lt;/em&gt;&lt;big&gt;)&lt;/big&gt;&lt;a class=&quot;headerlink&quot; href=&quot;#kitchen.text.display.byte_string_textual_width_fill&quot; title=&quot;Permalink to this definition&quot;&gt;¶&lt;/a&gt;&lt;/dt&gt;
&lt;dd&gt;&lt;p&gt;Expand a byte &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;str&lt;/span&gt;&lt;/tt&gt; to a specified &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-textual-width&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;textual width&lt;/em&gt;&lt;/a&gt; or chop
to same&lt;/p&gt;
&lt;table class=&quot;docutils field-list&quot; frame=&quot;void&quot; rules=&quot;none&quot;&gt;
&lt;col class=&quot;field-name&quot; /&gt;
&lt;col class=&quot;field-body&quot; /&gt;
&lt;tbody valign=&quot;top&quot;&gt;
&lt;tr class=&quot;field-odd field&quot;&gt;&lt;th class=&quot;field-name&quot;&gt;Parameters:&lt;/th&gt;&lt;td class=&quot;field-body&quot;&gt;&lt;ul class=&quot;first simple&quot;&gt;
&lt;li&gt;&lt;strong&gt;msg&lt;/strong&gt; &amp;#8211; byte &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;str&lt;/span&gt;&lt;/tt&gt; encoded in &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-utf-8&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;UTF-8&lt;/em&gt;&lt;/a&gt; that we want formatted&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;fill&lt;/strong&gt; &amp;#8211; pad &lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;msg&lt;/span&gt;&lt;/tt&gt; until the &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-textual-width&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;textual width&lt;/em&gt;&lt;/a&gt; is this long&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;chop&lt;/strong&gt; &amp;#8211; before doing anything else, chop the string to this length.
Default: Don&amp;#8217;t chop the string at all&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;left&lt;/strong&gt; &amp;#8211; If &lt;a class=&quot;reference external&quot; href=&quot;http://docs.python.org/library/constants.html#True&quot; title=&quot;(in Python v2.7)&quot;&gt;&lt;tt class=&quot;xref py py-data docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;True&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt; (default) left justify the string and put the
padding on the right.  If &lt;a class=&quot;reference external&quot; href=&quot;http://docs.python.org/library/constants.html#False&quot; title=&quot;(in Python v2.7)&quot;&gt;&lt;tt class=&quot;xref py py-data docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;False&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt;, pad on the left side.&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;prefix&lt;/strong&gt; &amp;#8211; Attach this byte &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;str&lt;/span&gt;&lt;/tt&gt; before the field we&amp;#8217;re
filling&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;suffix&lt;/strong&gt; &amp;#8211; Append this byte &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;str&lt;/span&gt;&lt;/tt&gt; to the end of the field we&amp;#8217;re
filling&lt;/li&gt;
&lt;/ul&gt;
&lt;/td&gt;
&lt;/tr&gt;
&lt;tr class=&quot;field-even field&quot;&gt;&lt;th class=&quot;field-name&quot;&gt;Return type:&lt;/th&gt;&lt;td class=&quot;field-body&quot;&gt;&lt;p class=&quot;first&quot;&gt;byte &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;str&lt;/span&gt;&lt;/tt&gt;&lt;/p&gt;
&lt;/td&gt;
&lt;/tr&gt;
&lt;tr class=&quot;field-odd field&quot;&gt;&lt;th class=&quot;field-name&quot;&gt;Returns:&lt;/th&gt;&lt;td class=&quot;field-body&quot;&gt;&lt;p class=&quot;first last&quot;&gt;&lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;msg&lt;/span&gt;&lt;/tt&gt; formatted to fill the specified &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-textual-width&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;textual
width&lt;/em&gt;&lt;/a&gt;.  If no &lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;chop&lt;/span&gt;&lt;/tt&gt; is specified, the string could exceed the
fill length when completed.  If &lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;prefix&lt;/span&gt;&lt;/tt&gt; or &lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;suffix&lt;/span&gt;&lt;/tt&gt; are
printable characters, the string could be longer than fill width.&lt;/p&gt;
&lt;/td&gt;
&lt;/tr&gt;
&lt;/tbody&gt;
&lt;/table&gt;
&lt;div class=&quot;admonition note&quot;&gt;
&lt;p class=&quot;first admonition-title&quot;&gt;Note&lt;/p&gt;
&lt;p class=&quot;last&quot;&gt;&lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;prefix&lt;/span&gt;&lt;/tt&gt; and &lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;suffix&lt;/span&gt;&lt;/tt&gt; should be used for &amp;#8220;invisible&amp;#8221;
characters like highlighting, color changing escape codes, etc.  The
fill characters are appended outside of any &lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;prefix&lt;/span&gt;&lt;/tt&gt; or
&lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;suffix&lt;/span&gt;&lt;/tt&gt; elements.  This allows you to only highlight
&lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;msg&lt;/span&gt;&lt;/tt&gt; inside of the field you&amp;#8217;re filling.&lt;/p&gt;
&lt;/div&gt;
&lt;div class=&quot;admonition-see-also admonition seealso&quot;&gt;
&lt;p class=&quot;first admonition-title&quot;&gt;See also&lt;/p&gt;
&lt;dl class=&quot;last docutils&quot;&gt;
&lt;dt&gt;&lt;a class=&quot;reference internal&quot; href=&quot;#kitchen.text.display.textual_width_fill&quot; title=&quot;kitchen.text.display.textual_width_fill&quot;&gt;&lt;tt class=&quot;xref py py-func docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;textual_width_fill()&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt;&lt;/dt&gt;
&lt;dd&gt;&lt;p class=&quot;first&quot;&gt;For example usage.  This function has only two differences.&lt;/p&gt;
&lt;ol class=&quot;last arabic simple&quot;&gt;
&lt;li&gt;it takes byte &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;str&lt;/span&gt;&lt;/tt&gt; for &lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;prefix&lt;/span&gt;&lt;/tt&gt; and
&lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;suffix&lt;/span&gt;&lt;/tt&gt; so you can pass in arbitrary sequences of
bytes, not just unicode characters.&lt;/li&gt;
&lt;li&gt;it returns a byte &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;str&lt;/span&gt;&lt;/tt&gt; instead of a &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;unicode&lt;/span&gt;&lt;/tt&gt;
string.&lt;/li&gt;
&lt;/ol&gt;
&lt;/dd&gt;
&lt;/dl&gt;
&lt;/div&gt;
&lt;/dd&gt;&lt;/dl&gt;

&lt;div class=&quot;section&quot; id=&quot;internal-data&quot;&gt;
&lt;h1&gt;Internal Data&lt;a class=&quot;headerlink&quot; href=&quot;#internal-data&quot; title=&quot;Permalink to this headline&quot;&gt;¶&lt;/a&gt;&lt;/h1&gt;
&lt;p&gt;There are a few internal functions and variables in this module.  Code outside
of kitchen shouldn&amp;#8217;t use them but people coding on kitchen itself may find
them useful.&lt;/p&gt;
&lt;dl class=&quot;data&quot;&gt;
&lt;dt id=&quot;kitchen.text.display._COMBINING&quot;&gt;
&lt;tt class=&quot;descclassname&quot;&gt;kitchen.text.display.&lt;/tt&gt;&lt;tt class=&quot;descname&quot;&gt;_COMBINING&lt;/tt&gt;&lt;em class=&quot;property&quot;&gt; = ((768, 879), (1155, 1161), (1425, 1469), (1471, 1471), (1473, 1474), (1476, 1477), (1479, 1479), (1536, 1539), (1552, 1562), (1611, 1630), (1648, 1648), (1750, 1764), (1767, 1768), (1770, 1773), (1807, 1807), (1809, 1809), (1840, 1866), (1958, 1968), (2027, 2035), (2070, 2073), (2075, 2083), (2085, 2087), (2089, 2093), (2305, 2306), (2364, 2364), (2369, 2376), (2381, 2381), (2385, 2388), (2402, 2403), (2433, 2433), (2492, 2492), (2497, 2500), (2509, 2509), (2530, 2531), (2561, 2562), (2620, 2620), (2625, 2626), (2631, 2632), (2635, 2637), (2672, 2673), (2689, 2690), (2748, 2748), (2753, 2757), (2759, 2760), (2765, 2765), (2786, 2787), (2817, 2817), (2876, 2876), (2879, 2879), (2881, 2883), (2893, 2893), (2902, 2902), (2946, 2946), (3008, 3008), (3021, 3021), (3134, 3136), (3142, 3144), (3146, 3149), (3157, 3158), (3260, 3260), (3263, 3263), (3270, 3270), (3276, 3277), (3298, 3299), (3393, 3395), (3405, 3405), (3530, 3530), (3538, 3540), (3542, 3542), (3633, 3633), (3636, 3642), (3655, 3662), (3761, 3761), (3764, 3769), (3771, 3772), (3784, 3789), (3864, 3865), (3893, 3893), (3895, 3895), (3897, 3897), (3953, 3966), (3968, 3972), (3974, 3975), (3984, 3991), (3993, 4028), (4038, 4038), (4141, 4144), (4146, 4146), (4150, 4151), (4153, 4154), (4184, 4185), (4237, 4237), (4448, 4607), (4959, 4959), (5906, 5908), (5938, 5940), (5970, 5971), (6002, 6003), (6068, 6069), (6071, 6077), (6086, 6086), (6089, 6099), (6109, 6109), (6155, 6157), (6313, 6313), (6432, 6434), (6439, 6440), (6450, 6450), (6457, 6459), (6679, 6680), (6752, 6752), (6773, 6780), (6783, 6783), (6912, 6915), (6964, 6964), (6966, 6970), (6972, 6972), (6978, 6978), (6980, 6980), (7019, 7027), (7082, 7082), (7223, 7223), (7376, 7378), (7380, 7392), (7394, 7400), (7405, 7405), (7616, 7654), (7677, 7679), (8203, 8207), (8234, 8238), (8288, 8291), (8298, 8303), (8400, 8432), (11503, 11505), (11744, 11775), (12330, 12335), (12441, 12442), (42607, 42607), (42620, 42621), (42736, 42737), (43014, 43014), (43019, 43019), (43045, 43046), (43204, 43204), (43232, 43249), (43307, 43309), (43347, 43347), (43443, 43443), (43456, 43456), (43696, 43696), (43698, 43700), (43703, 43704), (43710, 43711), (43713, 43713), (44013, 44013), (64286, 64286), (65024, 65039), (65056, 65062), (65279, 65279), (65529, 65531), (66045, 66045), (68097, 68099), (68101, 68102), (68108, 68111), (68152, 68154), (68159, 68159), (69817, 69818), (119141, 119145), (119149, 119170), (119173, 119179), (119210, 119213), (119362, 119364), (917505, 917505), (917536, 917631), (917760, 917999))&lt;/em&gt;&lt;a class=&quot;headerlink&quot; href=&quot;#kitchen.text.display._COMBINING&quot; title=&quot;Permalink to this definition&quot;&gt;¶&lt;/a&gt;&lt;/dt&gt;
&lt;dd&gt;&lt;p&gt;Internal table, provided by this module to list &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-code-points&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;code points&lt;/em&gt;&lt;/a&gt; which
combine with other characters and therefore should have no &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-textual-width&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;textual
width&lt;/em&gt;&lt;/a&gt;.  This is a sorted &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;tuple&lt;/span&gt;&lt;/tt&gt; of non-overlapping intervals.  Each
interval is a &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;tuple&lt;/span&gt;&lt;/tt&gt; listing a starting &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-code-point&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;code point&lt;/em&gt;&lt;/a&gt; and ending
&lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-code-point&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;code point&lt;/em&gt;&lt;/a&gt;.  Every &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-code-point&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;code point&lt;/em&gt;&lt;/a&gt; between the two end points is
a combining character.&lt;/p&gt;
&lt;div class=&quot;admonition-see-also admonition seealso&quot;&gt;
&lt;p class=&quot;first admonition-title&quot;&gt;See also&lt;/p&gt;
&lt;dl class=&quot;last docutils&quot;&gt;
&lt;dt&gt;&lt;a class=&quot;reference internal&quot; href=&quot;#kitchen.text.display._generate_combining_table&quot; title=&quot;kitchen.text.display._generate_combining_table&quot;&gt;&lt;tt class=&quot;xref py py-func docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;_generate_combining_table()&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt;&lt;/dt&gt;
&lt;dd&gt;for how this table is generated&lt;/dd&gt;
&lt;/dl&gt;
&lt;/div&gt;
&lt;p&gt;This table was last regenerated on python-2.7.0 with
&lt;a class=&quot;reference external&quot; href=&quot;http://docs.python.org/library/unicodedata.html#unicodedata.unidata_version&quot; title=&quot;(in Python v2.7)&quot;&gt;&lt;tt class=&quot;xref py py-data docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;unicodedata.unidata_version&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt; 5.1.0&lt;/p&gt;
&lt;/dd&gt;&lt;/dl&gt;

&lt;dl class=&quot;function&quot;&gt;
&lt;dt id=&quot;kitchen.text.display._generate_combining_table&quot;&gt;
&lt;tt class=&quot;descclassname&quot;&gt;kitchen.text.display.&lt;/tt&gt;&lt;tt class=&quot;descname&quot;&gt;_generate_combining_table&lt;/tt&gt;&lt;big&gt;(&lt;/big&gt;&lt;big&gt;)&lt;/big&gt;&lt;a class=&quot;headerlink&quot; href=&quot;#kitchen.text.display._generate_combining_table&quot; title=&quot;Permalink to this definition&quot;&gt;¶&lt;/a&gt;&lt;/dt&gt;
&lt;dd&gt;&lt;p&gt;Combine Markus Kuhn&amp;#8217;s data with &lt;a class=&quot;reference external&quot; href=&quot;http://docs.python.org/library/unicodedata.html#unicodedata&quot; title=&quot;(in Python v2.7)&quot;&gt;&lt;tt class=&quot;xref py py-mod docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;unicodedata&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt; to make combining
char list&lt;/p&gt;
&lt;table class=&quot;docutils field-list&quot; frame=&quot;void&quot; rules=&quot;none&quot;&gt;
&lt;col class=&quot;field-name&quot; /&gt;
&lt;col class=&quot;field-body&quot; /&gt;
&lt;tbody valign=&quot;top&quot;&gt;
&lt;tr class=&quot;field-odd field&quot;&gt;&lt;th class=&quot;field-name&quot;&gt;Return type:&lt;/th&gt;&lt;td class=&quot;field-body&quot;&gt;&lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;tuple&lt;/span&gt;&lt;/tt&gt; of tuples&lt;/td&gt;
&lt;/tr&gt;
&lt;tr class=&quot;field-even field&quot;&gt;&lt;th class=&quot;field-name&quot;&gt;Returns:&lt;/th&gt;&lt;td class=&quot;field-body&quot;&gt;&lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;tuple&lt;/span&gt;&lt;/tt&gt; of intervals of &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-code-points&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;code points&lt;/em&gt;&lt;/a&gt; that are
combining character.  Each interval is a 2-&lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;tuple&lt;/span&gt;&lt;/tt&gt; of the
starting &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-code-point&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;code point&lt;/em&gt;&lt;/a&gt; and the ending &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-code-point&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;code point&lt;/em&gt;&lt;/a&gt; for the
combining characters.&lt;/td&gt;
&lt;/tr&gt;
&lt;/tbody&gt;
&lt;/table&gt;
&lt;p&gt;In normal use, this function serves to tell how we&amp;#8217;re generating the
combining char list.  For speed reasons, we use this to generate a static
list and just use that later.&lt;/p&gt;
&lt;p&gt;Markus Kuhn&amp;#8217;s list of combining characters is more complete than what&amp;#8217;s in
the python &lt;a class=&quot;reference external&quot; href=&quot;http://docs.python.org/library/unicodedata.html#unicodedata&quot; title=&quot;(in Python v2.7)&quot;&gt;&lt;tt class=&quot;xref py py-mod docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;unicodedata&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt; library but the python &lt;a class=&quot;reference external&quot; href=&quot;http://docs.python.org/library/unicodedata.html#unicodedata&quot; title=&quot;(in Python v2.7)&quot;&gt;&lt;tt class=&quot;xref py py-mod docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;unicodedata&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt; is
synced against later versions of the unicode database&lt;/p&gt;
&lt;p&gt;This is used to generate the &lt;a class=&quot;reference internal&quot; href=&quot;#kitchen.text.display._COMBINING&quot; title=&quot;kitchen.text.display._COMBINING&quot;&gt;&lt;tt class=&quot;xref py py-data docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;_COMBINING&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt;
table.&lt;/p&gt;
&lt;/dd&gt;&lt;/dl&gt;

&lt;dl class=&quot;function&quot;&gt;
&lt;dt id=&quot;kitchen.text.display._print_combining_table&quot;&gt;
&lt;tt class=&quot;descclassname&quot;&gt;kitchen.text.display.&lt;/tt&gt;&lt;tt class=&quot;descname&quot;&gt;_print_combining_table&lt;/tt&gt;&lt;big&gt;(&lt;/big&gt;&lt;big&gt;)&lt;/big&gt;&lt;a class=&quot;headerlink&quot; href=&quot;#kitchen.text.display._print_combining_table&quot; title=&quot;Permalink to this definition&quot;&gt;¶&lt;/a&gt;&lt;/dt&gt;
&lt;dd&gt;&lt;p&gt;Print out a new &lt;a class=&quot;reference internal&quot; href=&quot;#kitchen.text.display._COMBINING&quot; title=&quot;kitchen.text.display._COMBINING&quot;&gt;&lt;tt class=&quot;xref py py-data docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;_COMBINING&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt; table&lt;/p&gt;
&lt;p&gt;This will print a new &lt;a class=&quot;reference internal&quot; href=&quot;#kitchen.text.display._COMBINING&quot; title=&quot;kitchen.text.display._COMBINING&quot;&gt;&lt;tt class=&quot;xref py py-data docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;_COMBINING&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt; table in the format used in
&lt;tt class=&quot;file docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;kitchen/text/display.py&lt;/span&gt;&lt;/tt&gt;.  It&amp;#8217;s useful for updating the
&lt;a class=&quot;reference internal&quot; href=&quot;#kitchen.text.display._COMBINING&quot; title=&quot;kitchen.text.display._COMBINING&quot;&gt;&lt;tt class=&quot;xref py py-data docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;_COMBINING&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt; table with updated data from a new python as the format
won&amp;#8217;t change from what&amp;#8217;s already in the file.&lt;/p&gt;
&lt;/dd&gt;&lt;/dl&gt;

&lt;dl class=&quot;function&quot;&gt;
&lt;dt id=&quot;kitchen.text.display._interval_bisearch&quot;&gt;
&lt;tt class=&quot;descclassname&quot;&gt;kitchen.text.display.&lt;/tt&gt;&lt;tt class=&quot;descname&quot;&gt;_interval_bisearch&lt;/tt&gt;&lt;big&gt;(&lt;/big&gt;&lt;em&gt;value&lt;/em&gt;, &lt;em&gt;table&lt;/em&gt;&lt;big&gt;)&lt;/big&gt;&lt;a class=&quot;headerlink&quot; href=&quot;#kitchen.text.display._interval_bisearch&quot; title=&quot;Permalink to this definition&quot;&gt;¶&lt;/a&gt;&lt;/dt&gt;
&lt;dd&gt;&lt;p&gt;Binary search in an interval table.&lt;/p&gt;
&lt;table class=&quot;docutils field-list&quot; frame=&quot;void&quot; rules=&quot;none&quot;&gt;
&lt;col class=&quot;field-name&quot; /&gt;
&lt;col class=&quot;field-body&quot; /&gt;
&lt;tbody valign=&quot;top&quot;&gt;
&lt;tr class=&quot;field-odd field&quot;&gt;&lt;th class=&quot;field-name&quot;&gt;Parameters:&lt;/th&gt;&lt;td class=&quot;field-body&quot;&gt;&lt;ul class=&quot;first simple&quot;&gt;
&lt;li&gt;&lt;strong&gt;value&lt;/strong&gt; &amp;#8211; numeric value to search for&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;table&lt;/strong&gt; &amp;#8211; Ordered list of intervals.  This is a list of two-tuples.  The
elements of the two-tuple define an interval&amp;#8217;s start and end points.&lt;/li&gt;
&lt;/ul&gt;
&lt;/td&gt;
&lt;/tr&gt;
&lt;tr class=&quot;field-even field&quot;&gt;&lt;th class=&quot;field-name&quot;&gt;Returns:&lt;/th&gt;&lt;td class=&quot;field-body&quot;&gt;&lt;p class=&quot;first last&quot;&gt;If &lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;value&lt;/span&gt;&lt;/tt&gt; is found within an interval in the &lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;table&lt;/span&gt;&lt;/tt&gt;
return &lt;a class=&quot;reference external&quot; href=&quot;http://docs.python.org/library/constants.html#True&quot; title=&quot;(in Python v2.7)&quot;&gt;&lt;tt class=&quot;xref py py-data docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;True&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt;.  Otherwise, &lt;a class=&quot;reference external&quot; href=&quot;http://docs.python.org/library/constants.html#False&quot; title=&quot;(in Python v2.7)&quot;&gt;&lt;tt class=&quot;xref py py-data docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;False&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt;&lt;/p&gt;
&lt;/td&gt;
&lt;/tr&gt;
&lt;/tbody&gt;
&lt;/table&gt;
&lt;p&gt;This function checks whether a numeric value is present within a table
of intervals.  It checks using a binary search algorithm, dividing the
list of values in half and checking against the values until it determines
whether the value is in the table.&lt;/p&gt;
&lt;/dd&gt;&lt;/dl&gt;

&lt;dl class=&quot;function&quot;&gt;
&lt;dt id=&quot;kitchen.text.display._ucp_width&quot;&gt;
&lt;tt class=&quot;descclassname&quot;&gt;kitchen.text.display.&lt;/tt&gt;&lt;tt class=&quot;descname&quot;&gt;_ucp_width&lt;/tt&gt;&lt;big&gt;(&lt;/big&gt;&lt;em&gt;ucs&lt;/em&gt;, &lt;em&gt;control_chars='guess'&lt;/em&gt;&lt;big&gt;)&lt;/big&gt;&lt;a class=&quot;headerlink&quot; href=&quot;#kitchen.text.display._ucp_width&quot; title=&quot;Permalink to this definition&quot;&gt;¶&lt;/a&gt;&lt;/dt&gt;
&lt;dd&gt;&lt;p&gt;Get the &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-textual-width&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;textual width&lt;/em&gt;&lt;/a&gt; of a ucs character&lt;/p&gt;
&lt;table class=&quot;docutils field-list&quot; frame=&quot;void&quot; rules=&quot;none&quot;&gt;
&lt;col class=&quot;field-name&quot; /&gt;
&lt;col class=&quot;field-body&quot; /&gt;
&lt;tbody valign=&quot;top&quot;&gt;
&lt;tr class=&quot;field-odd field&quot;&gt;&lt;th class=&quot;field-name&quot;&gt;Parameters:&lt;/th&gt;&lt;td class=&quot;field-body&quot;&gt;&lt;ul class=&quot;first simple&quot;&gt;
&lt;li&gt;&lt;strong&gt;ucs&lt;/strong&gt; &amp;#8211; integer representing a single unicode &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-code-point&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;code point&lt;/em&gt;&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;control_chars&lt;/strong&gt; &amp;#8211; &lt;p&gt;specify how to deal with &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-control-characters&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;control characters&lt;/em&gt;&lt;/a&gt;.
Possible values are:&lt;/p&gt;
&lt;table class=&quot;docutils field-list&quot; frame=&quot;void&quot; rules=&quot;none&quot;&gt;
&lt;col class=&quot;field-name&quot; /&gt;
&lt;col class=&quot;field-body&quot; /&gt;
&lt;tbody valign=&quot;top&quot;&gt;
&lt;tr class=&quot;field-odd field&quot;&gt;&lt;th class=&quot;field-name&quot;&gt;guess:&lt;/th&gt;&lt;td class=&quot;field-body&quot;&gt;(default) will take a guess for &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-control-character&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;control character&lt;/em&gt;&lt;/a&gt;
widths.  Most codes will return zero width.  &lt;tt class=&quot;docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;backspace&lt;/span&gt;&lt;/tt&gt;,
&lt;tt class=&quot;docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;delete&lt;/span&gt;&lt;/tt&gt;, and &lt;tt class=&quot;docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;clear&lt;/span&gt; &lt;span class=&quot;pre&quot;&gt;delete&lt;/span&gt;&lt;/tt&gt; return -1.  &lt;tt class=&quot;docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;escape&lt;/span&gt;&lt;/tt&gt; currently
returns -1 as well but this is not guaranteed as it&amp;#8217;s not always
correct&lt;/td&gt;
&lt;/tr&gt;
&lt;tr class=&quot;field-even field&quot;&gt;&lt;th class=&quot;field-name&quot;&gt;strict:&lt;/th&gt;&lt;td class=&quot;field-body&quot;&gt;will raise &lt;a class=&quot;reference internal&quot; href=&quot;api-exceptions.html#kitchen.text.exceptions.ControlCharError&quot; title=&quot;kitchen.text.exceptions.ControlCharError&quot;&gt;&lt;tt class=&quot;xref py py-exc docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;ControlCharError&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt;
if a &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-control-character&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;control character&lt;/em&gt;&lt;/a&gt; is encountered&lt;/td&gt;
&lt;/tr&gt;
&lt;/tbody&gt;
&lt;/table&gt;
&lt;/li&gt;
&lt;/ul&gt;
&lt;/td&gt;
&lt;/tr&gt;
&lt;tr class=&quot;field-odd field&quot;&gt;&lt;th class=&quot;field-name&quot; colspan=&quot;2&quot;&gt;Raises ControlCharError:&lt;/th&gt;&lt;/tr&gt;
&lt;tr class=&quot;field-odd field&quot;&gt;&lt;td&gt;&amp;nbsp;&lt;/td&gt;&lt;td class=&quot;field-body&quot;&gt;&lt;p class=&quot;first&quot;&gt;if the &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-code-point&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;code point&lt;/em&gt;&lt;/a&gt; is a unicode
&lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-control-character&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;control character&lt;/em&gt;&lt;/a&gt; and &lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;control_chars&lt;/span&gt;&lt;/tt&gt; is set to &amp;#8216;strict&amp;#8217;&lt;/p&gt;
&lt;/td&gt;
&lt;/tr&gt;
&lt;tr class=&quot;field-even field&quot;&gt;&lt;th class=&quot;field-name&quot;&gt;Returns:&lt;/th&gt;&lt;td class=&quot;field-body&quot;&gt;&lt;p class=&quot;first last&quot;&gt;&lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-textual-width&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;textual width&lt;/em&gt;&lt;/a&gt; of the character.&lt;/p&gt;
&lt;/td&gt;
&lt;/tr&gt;
&lt;/tbody&gt;
&lt;/table&gt;
&lt;div class=&quot;admonition note&quot;&gt;
&lt;p class=&quot;first admonition-title&quot;&gt;Note&lt;/p&gt;
&lt;p class=&quot;last&quot;&gt;It&amp;#8217;s important to remember this is &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-textual-width&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;textual width&lt;/em&gt;&lt;/a&gt; and not the
number of characters or bytes.&lt;/p&gt;
&lt;/div&gt;
&lt;/dd&gt;&lt;/dl&gt;

&lt;dl class=&quot;function&quot;&gt;
&lt;dt id=&quot;kitchen.text.display._textual_width_le&quot;&gt;
&lt;tt class=&quot;descclassname&quot;&gt;kitchen.text.display.&lt;/tt&gt;&lt;tt class=&quot;descname&quot;&gt;_textual_width_le&lt;/tt&gt;&lt;big&gt;(&lt;/big&gt;&lt;em&gt;width&lt;/em&gt;, &lt;em&gt;*args&lt;/em&gt;&lt;big&gt;)&lt;/big&gt;&lt;a class=&quot;headerlink&quot; href=&quot;#kitchen.text.display._textual_width_le&quot; title=&quot;Permalink to this definition&quot;&gt;¶&lt;/a&gt;&lt;/dt&gt;
&lt;dd&gt;&lt;p&gt;Optimize the common case when deciding which &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-textual-width&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;textual width&lt;/em&gt;&lt;/a&gt; is
larger&lt;/p&gt;
&lt;table class=&quot;docutils field-list&quot; frame=&quot;void&quot; rules=&quot;none&quot;&gt;
&lt;col class=&quot;field-name&quot; /&gt;
&lt;col class=&quot;field-body&quot; /&gt;
&lt;tbody valign=&quot;top&quot;&gt;
&lt;tr class=&quot;field-odd field&quot;&gt;&lt;th class=&quot;field-name&quot;&gt;Parameters:&lt;/th&gt;&lt;td class=&quot;field-body&quot;&gt;&lt;ul class=&quot;first simple&quot;&gt;
&lt;li&gt;&lt;strong&gt;width&lt;/strong&gt; &amp;#8211; &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-textual-width&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;textual width&lt;/em&gt;&lt;/a&gt; to compare against.&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;*args&lt;/strong&gt; &amp;#8211; &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;unicode&lt;/span&gt;&lt;/tt&gt; strings to check the total &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-textual-width&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;textual
width&lt;/em&gt;&lt;/a&gt; of&lt;/li&gt;
&lt;/ul&gt;
&lt;/td&gt;
&lt;/tr&gt;
&lt;tr class=&quot;field-even field&quot;&gt;&lt;th class=&quot;field-name&quot;&gt;Returns:&lt;/th&gt;&lt;td class=&quot;field-body&quot;&gt;&lt;p class=&quot;first last&quot;&gt;&lt;a class=&quot;reference external&quot; href=&quot;http://docs.python.org/library/constants.html#True&quot; title=&quot;(in Python v2.7)&quot;&gt;&lt;tt class=&quot;xref py py-data docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;True&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt; if the total length of &lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;args&lt;/span&gt;&lt;/tt&gt; are less than
or equal to &lt;tt class=&quot;xref py py-attr docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;width&lt;/span&gt;&lt;/tt&gt;.  Otherwise &lt;a class=&quot;reference external&quot; href=&quot;http://docs.python.org/library/constants.html#False&quot; title=&quot;(in Python v2.7)&quot;&gt;&lt;tt class=&quot;xref py py-data docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;False&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt;.&lt;/p&gt;
&lt;/td&gt;
&lt;/tr&gt;
&lt;/tbody&gt;
&lt;/table&gt;
&lt;p&gt;We often want to know &amp;#8220;does X fit in Y&amp;#8221;.  It takes a while to use
&lt;a class=&quot;reference internal&quot; href=&quot;#kitchen.text.display.textual_width&quot; title=&quot;kitchen.text.display.textual_width&quot;&gt;&lt;tt class=&quot;xref py py-func docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;textual_width()&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt; to calculate this.  However, we know that the number
of canonically composed &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;unicode&lt;/span&gt;&lt;/tt&gt; characters is always going to
have 1 or 2 for the &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-textual-width&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;textual width&lt;/em&gt;&lt;/a&gt; per character.  With this we can
take the following shortcuts:&lt;/p&gt;
&lt;ol class=&quot;arabic simple&quot;&gt;
&lt;li&gt;If the number of canonically composed characters is more than width,
the true &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-textual-width&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;textual width&lt;/em&gt;&lt;/a&gt; cannot be less than width.&lt;/li&gt;
&lt;li&gt;If the number of canonically composed characters * 2 is less than the
width then the &lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-textual-width&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;textual width&lt;/em&gt;&lt;/a&gt; must be ok.&lt;/li&gt;
&lt;/ol&gt;
&lt;p&gt;&lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-textual-width&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;textual width&lt;/em&gt;&lt;/a&gt; of a canonically composed &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;unicode&lt;/span&gt;&lt;/tt&gt; string
will always be greater than or equal to the the number of &lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;unicode&lt;/span&gt;&lt;/tt&gt;
characters.  So we can first check if the number of composed
&lt;tt class=&quot;xref py py-class docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;unicode&lt;/span&gt;&lt;/tt&gt; characters is less than the asked for width.  If it is we
can return &lt;a class=&quot;reference external&quot; href=&quot;http://docs.python.org/library/constants.html#True&quot; title=&quot;(in Python v2.7)&quot;&gt;&lt;tt class=&quot;xref py py-data docutils literal&quot;&gt;&lt;span class=&quot;pre&quot;&gt;True&lt;/span&gt;&lt;/tt&gt;&lt;/a&gt; immediately.  If not, then we must do a full
&lt;a class=&quot;reference internal&quot; href=&quot;glossary.html#term-textual-width&quot;&gt;&lt;em class=&quot;xref std std-term&quot;&gt;textual width&lt;/em&gt;&lt;/a&gt; lookup.&lt;/p&gt;
&lt;/dd&gt;&lt;/dl&gt;

&lt;/div&gt;


          &lt;/div&gt;
        &lt;/div&gt;
      &lt;/div&gt;
      &lt;div class=&quot;sphinxsidebar&quot;&gt;
        &lt;div class=&quot;sphinxsidebarwrapper&quot;&gt;
  &lt;h3&gt;&lt;a href=&quot;index.html&quot;&gt;Table Of Contents&lt;/a&gt;&lt;/h3&gt;
  &lt;ul&gt;
&lt;li&gt;&lt;a class=&quot;reference internal&quot; href=&quot;#&quot;&gt;Format Text for Display&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;&lt;a class=&quot;reference internal&quot; href=&quot;#internal-data&quot;&gt;Internal Data&lt;/a&gt;&lt;/li&gt;
&lt;/ul&gt;

  &lt;h4&gt;Previous topic&lt;/h4&gt;
  &lt;p class=&quot;topless&quot;&gt;&lt;a href=&quot;api-text-converters.html&quot;
                        title=&quot;previous chapter&quot;&gt;Kitchen.text.converters&lt;/a&gt;&lt;/p&gt;
  &lt;h4&gt;Next topic&lt;/h4&gt;
  &lt;p class=&quot;topless&quot;&gt;&lt;a href=&quot;api-text-misc.html&quot;
                        title=&quot;next chapter&quot;&gt;Miscellaneous functions for manipulating text&lt;/a&gt;&lt;/p&gt;
  &lt;h3&gt;This Page&lt;/h3&gt;
  &lt;ul class=&quot;this-page-menu&quot;&gt;
    &lt;li&gt;&lt;a href=&quot;_sources/api-text-display.txt&quot;
           rel=&quot;nofollow&quot;&gt;Show Source&lt;/a&gt;&lt;/li&gt;
  &lt;/ul&gt;
&lt;div id=&quot;searchbox&quot; style=&quot;display: none&quot;&gt;
  &lt;h3&gt;Quick search&lt;/h3&gt;
    &lt;form class=&quot;search&quot; action=&quot;search.html&quot; method=&quot;get&quot;&gt;
      &lt;input type=&quot;text&quot; name=&quot;q&quot; /&gt;
      &lt;input type=&quot;submit&quot; value=&quot;Go&quot; /&gt;
      &lt;input type=&quot;hidden&quot; name=&quot;check_keywords&quot; value=&quot;yes&quot; /&gt;
      &lt;input type=&quot;hidden&quot; name=&quot;area&quot; value=&quot;default&quot; /&gt;
    &lt;/form&gt;
    &lt;p class=&quot;searchtip&quot; style=&quot;font-size: 90%&quot;&gt;
    Enter search terms or a module, class or function name.
    &lt;/p&gt;
&lt;/div&gt;
&lt;script type=&quot;text/javascript&quot;&gt;$('#searchbox').show(0);&lt;/script&gt;
        &lt;/div&gt;
      &lt;/div&gt;
      &lt;div class=&quot;clearer&quot;&gt;&lt;/div&gt;
    &lt;/div&gt;
    &lt;div class=&quot;related&quot;&gt;
      &lt;h3&gt;Navigation&lt;/h3&gt;
      &lt;ul&gt;
        &lt;li class=&quot;right&quot; style=&quot;margin-right: 10px&quot;&gt;
          &lt;a href=&quot;genindex.html&quot; title=&quot;General Index&quot;
             &gt;index&lt;/a&gt;&lt;/li&gt;
        &lt;li class=&quot;right&quot; &gt;
          &lt;a href=&quot;py-modindex.html&quot; title=&quot;Python Module Index&quot;
             &gt;modules&lt;/a&gt; |&lt;/li&gt;
        &lt;li class=&quot;right&quot; &gt;
          &lt;a href=&quot;api-text-misc.html&quot; title=&quot;Miscellaneous functions for manipulating text&quot;
             &gt;next&lt;/a&gt; |&lt;/li&gt;
        &lt;li class=&quot;right&quot; &gt;
          &lt;a href=&quot;api-text-converters.html&quot; title=&quot;Kitchen.text.converters&quot;
             &gt;previous&lt;/a&gt; |&lt;/li&gt;
        &lt;li&gt;&lt;a href=&quot;index.html&quot;&gt;kitchen 1.1.1 documentation&lt;/a&gt; &amp;raquo;&lt;/li&gt;
          &lt;li&gt;&lt;a href=&quot;api-overview.html&quot; &gt;Kitchen API&lt;/a&gt; &amp;raquo;&lt;/li&gt;
          &lt;li&gt;&lt;a href=&quot;api-text.html&quot; &gt;Kitchen.text: unicode and utf8 and xml oh my!&lt;/a&gt; &amp;raquo;&lt;/li&gt; 
      &lt;/ul&gt;
    &lt;/div&gt;
    &lt;div class=&quot;footer&quot;&gt;
        &amp;copy; Copyright 2011 Red Hat, Inc. and others.
      Created using &lt;a href=&quot;http://sphinx.pocoo.org/&quot;&gt;Sphinx&lt;/a&gt; 1.1.3.
    &lt;/div&gt;
  &lt;/body&gt;
&lt;/html&gt;</textarea><br><br><input type='hidden' name='archivo_editar' value='/usr/share/doc/python-kitchen-1.1.1/html/api-text-display.html'><input type='submit' value='[确定] 保存' style='background:#c0c0c0; color:#000; border:2px solid #000; padding:8px 24px; font-family:monospace; font-weight:bold; cursor:pointer;'> <a href='?path=%2Fusr%2Fshare%2Fdoc%2Fpython-kitchen-1.1.1%2Fhtml' style='color:#000; text-decoration:none; padding:8px 24px; border:2px solid #000; background:#c0c0c0; font-weight:bold;'>[X] 取消</a></form></div></div><div style='color:#000080; font-family:monospace; text-align:center; padding:20px; border-top:2px solid #000; margin-top:20px;'>[X] MAKING LOT MONEY (MLM)</div>