<spanid="evennia-utils-text2html"></span><h1>evennia.utils.text2html<aclass="headerlink"href="#module-evennia.utils.text2html"title="Permalink to this headline">¶</a></h1>
<p>ANSI -> html converter</p>
<p>Credit for original idea and implementation
goes to Muhammad Alkarouri and his
snippet #577349 on <aclass="reference external"href="http://code.activestate.com">http://code.activestate.com</a>.</p>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.utils.text2html.</code><codeclass="sig-name descname">TextToHTMLparser</code><aclass="reference internal"href="../_modules/evennia/utils/text2html.html#TextToHTMLparser"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">tabstop</code><emclass="property"> = 4</em><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.tabstop"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">hilite</code><emclass="property"> = '\x1b[1m'</em><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.hilite"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">unhilite</code><emclass="property"> = '\x1b[22m'</em><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.unhilite"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">normal</code><emclass="property"> = '\x1b[0m'</em><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.normal"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">underline</code><emclass="property"> = '\x1b[4m'</em><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.underline"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">blink</code><emclass="property"> = '\x1b[5m'</em><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.blink"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">inverse</code><emclass="property"> = '\x1b[7m'</em><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.inverse"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">fgstop</code><emclass="property"> = '(?:\x1b\\[1m|\x1b\\[22m){0,1}\x1b\\[3[0-8].*?m|\x1b\\[0m|$'</em><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.fgstop"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">bgstop</code><emclass="property"> = '(?:\x1b\\[1m|\x1b\\[22m){0,1}\x1b\\[4[0-8].*?m|\x1b\\[0m|$'</em><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.bgstop"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">bgfgstop</code><emclass="property"> = '(?:\x1b\\[1m|\x1b\\[22m){0,1}\x1b\\[4[0-8].*?m|\x1b\\[0m(\\s*)(?:\x1b\\[1m|\x1b\\[22m){0,1}\x1b\\[3[0-8].*?m|\x1b\\[0m|$'</em><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.bgfgstop"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">fgstart</code><emclass="property"> = '((?:\x1b\\[1m|\x1b\\[22m){0,1}\x1b\\[3[0-8].*?m)'</em><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.fgstart"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">bgstart</code><emclass="property"> = '((?:\x1b\\[1m|\x1b\\[22m){0,1}\x1b\\[4[0-8].*?m)'</em><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.bgstart"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">bgfgstart</code><emclass="property"> = '((?:\x1b\\[1m|\x1b\\[22m){0,1}\x1b\\[4[0-8].*?m)(\\s*)((?:\x1b\\[1m|\x1b\\[22m){0,1}\x1b\\[[3-4][0-8].*?m){0,1}'</em><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.bgfgstart"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">re_fgs</code><emclass="property"> = re.compile('((?:\x1b\\[1m|\x1b\\[22m){0,1}\x1b\\[3[0-8].*?m)(.*?)(?=(?:\x1b\\[1m|\x1b\\[22m){0,1}\x1b\\[3[0-8].*?m|\x1b\\[0m|$)')</em><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.re_fgs"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">re_bgs</code><emclass="property"> = re.compile('((?:\x1b\\[1m|\x1b\\[22m){0,1}\x1b\\[4[0-8].*?m)(.*?)(?=(?:\x1b\\[1m|\x1b\\[22m){0,1}\x1b\\[4[0-8].*?m|\x1b\\[0m|$)')</em><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.re_bgs"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">re_bgfg</code><emclass="property"> = re.compile('((?:\x1b\\[1m|\x1b\\[22m){0,1}\x1b\\[4[0-8].*?m)(\\s*)((?:\x1b\\[1m|\x1b\\[22m){0,1}\x1b\\[[3-4][0-8].*?m){0,1}(.*?)(?=(?:\x1b\\[1m|\x1b\\[22m){0,1}\x1b\\[4[0-8].*?m|\x1b\\[0m(\\s*)(?:\x1b\\[1m|\x1b\)</em><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.re_bgfg"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">re_normal</code><emclass="property"> = re.compile('\x1b\\[0m')</em><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.re_normal"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">re_hilite</code><emclass="property"> = re.compile('(?:\x1b\\[1m)(.*)(?=(?:\x1b\\[1m|\x1b\\[22m){0,1}\x1b\\[3[0-8].*?m|\x1b\\[0m|$|(?:\x1b\\[1m|\x1b\\[22m){0,1}\x1b\\[4[0-8].*?m|\x1b\\[0m|$)')</em><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.re_hilite"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">re_unhilite</code><emclass="property"> = re.compile('(?:\x1b\\[22m)(.*)(?=(?:\x1b\\[1m|\x1b\\[22m){0,1}\x1b\\[3[0-8].*?m|\x1b\\[0m|$|(?:\x1b\\[1m|\x1b\\[22m){0,1}\x1b\\[4[0-8].*?m|\x1b\\[0m|$)')</em><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.re_unhilite"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">re_uline</code><emclass="property"> = re.compile('(?:\x1b\\[4m)(.*?)(?=(?:\x1b\\[1m|\x1b\\[22m){0,1}\x1b\\[3[0-8].*?m|\x1b\\[0m|$|(?:\x1b\\[1m|\x1b\\[22m){0,1}\x1b\\[4[0-8].*?m|\x1b\\[0m|$)')</em><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.re_uline"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">re_blink</code><emclass="property"> = re.compile('(?:\x1b\\[5m)(.*?)(?=(?:\x1b\\[1m|\x1b\\[22m){0,1}\x1b\\[3[0-8].*?m|\x1b\\[0m|$|(?:\x1b\\[1m|\x1b\\[22m){0,1}\x1b\\[4[0-8].*?m|\x1b\\[0m|$)')</em><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.re_blink"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">re_inverse</code><emclass="property"> = re.compile('(?:\x1b\\[7m)(.*?)(?=(?:\x1b\\[1m|\x1b\\[22m){0,1}\x1b\\[3[0-8].*?m|\x1b\\[0m|$|(?:\x1b\\[1m|\x1b\\[22m){0,1}\x1b\\[4[0-8].*?m|\x1b\\[0m|$)')</em><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.re_inverse"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">re_string</code><emclass="property"> = re.compile('(?P<htmlchars>[<&>])|(?P<tab>[\\t]+)|(?P<space> +)|(?P<spacestart>^ )|(?P<lineend>\\r\\n|\\r|\\n)', re.IGNORECASE|re.MULTILINE|re.DOTALL)</em><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.re_string"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">re_dblspace</code><emclass="property"> = re.compile(' {2,}', re.MULTILINE)</em><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.re_dblspace"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">re_url</code><emclass="property"> = re.compile('(?<!=")((?:ftp|www|https?)\\W+(?:(?!\\.(?:\\s|$)|&\\w+;)[^"\\\',;$*^\\\\(){}<>\\[\\]\\s])+)(\\.(?:\\s|$)|&\\w+;|)')</em><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.re_url"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">re_mxplink</code><emclass="property"> = re.compile('\\|lc(.*?)\\|lt(.*?)\\|le', re.DOTALL)</em><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.re_mxplink"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">re_mxpurl</code><emclass="property"> = re.compile('\\|lu(.*?)\\|lt(.*?)\\|le', re.DOTALL)</em><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.re_mxpurl"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">re_color</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">text</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/text2html.html#TextToHTMLparser.re_color"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.re_color"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">re_bold</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">text</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/text2html.html#TextToHTMLparser.re_bold"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.re_bold"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">re_underline</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">text</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/text2html.html#TextToHTMLparser.re_underline"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.re_underline"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">re_blinking</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">text</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/text2html.html#TextToHTMLparser.re_blinking"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.re_blinking"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">re_inversing</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">text</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/text2html.html#TextToHTMLparser.re_inversing"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.re_inversing"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">remove_bells</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">text</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/text2html.html#TextToHTMLparser.remove_bells"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.remove_bells"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">remove_backspaces</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">text</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/text2html.html#TextToHTMLparser.remove_backspaces"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.remove_backspaces"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">convert_linebreaks</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">text</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/text2html.html#TextToHTMLparser.convert_linebreaks"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.convert_linebreaks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">convert_urls</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">text</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/text2html.html#TextToHTMLparser.convert_urls"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.convert_urls"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">re_double_space</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">text</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/text2html.html#TextToHTMLparser.re_double_space"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.re_double_space"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">sub_mxp_links</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">match</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/text2html.html#TextToHTMLparser.sub_mxp_links"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.sub_mxp_links"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">sub_mxp_urls</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">match</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/text2html.html#TextToHTMLparser.sub_mxp_urls"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.sub_mxp_urls"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">sub_text</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">match</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/text2html.html#TextToHTMLparser.sub_text"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.sub_text"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">sub_dblspace</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">match</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/text2html.html#TextToHTMLparser.sub_dblspace"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.sub_dblspace"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">parse</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">text</span></em>, <emclass="sig-param"><spanclass="n">strip_ansi</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/text2html.html#TextToHTMLparser.parse"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.utils.text2html.TextToHTMLparser.parse"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-prename descclassname">evennia.utils.text2html.</code><codeclass="sig-name descname">parse_html</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em>, <emclass="sig-param">strip_ansi=False</em>, <emclass="sig-param">parser=<evennia.utils.text2html.TextToHTMLparser object></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/text2html.html#parse_html"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.utils.text2html.parse_html"title="Permalink to this definition">¶</a></dt>
<dd><p>Parses a string, replace ANSI markup with html</p>