2020-01-26 15:04:49 +01:00
2021-01-01 20:37:08 +01:00
<!DOCTYPE html>
< html class = "writer-html4" lang = "en" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< title > Welcome to stringtools’ s documentation! — stringtools documentation< / title >
< link rel = "stylesheet" href = "_static/css/theme.css" type = "text/css" / >
< link rel = "stylesheet" href = "_static/pygments.css" type = "text/css" / >
2020-01-26 15:04:49 +01:00
2021-01-01 20:37:08 +01:00
<!-- [if lt IE 9]>
< script src = "_static/js/html5shiv.min.js" > < / script >
<![endif]-->
< script type = "text/javascript" id = "documentation_options" data-url_root = "./" src = "_static/documentation_options.js" > < / script >
< script type = "text/javascript" src = "_static/jquery.js" > < / script >
< script type = "text/javascript" src = "_static/underscore.js" > < / script >
< script type = "text/javascript" src = "_static/doctools.js" > < / script >
< script type = "text/javascript" src = "_static/language_data.js" > < / script >
< script type = "text/javascript" src = "_static/js/theme.js" > < / script >
< link rel = "index" title = "Index" href = "genindex.html" / >
< link rel = "search" title = "Search" href = "search.html" / >
< / head >
< body class = "wy-body-for-nav" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
< div class = "wy-side-nav-search" >
< a href = "#" class = "icon icon-home" alt = "Documentation Home" > stringtools
< / a >
2020-01-26 15:04:49 +01:00
2021-01-01 20:37:08 +01:00
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" / >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
< / div >
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
<!-- Local TOC -->
< div class = "local-toc" > < ul >
< li > < a class = "reference internal" href = "#" > Welcome to stringtools’ s documentation!< / a > < ul >
< li > < a class = "reference internal" href = "#stringtools-stringtools" > stringtools (Stringtools)< / a > < / li >
< li > < a class = "reference internal" href = "#csp-carriage-return-seperation-protocol" > csp (Carriage-Return seperation protocol)< / a > < / li >
< li > < a class = "reference internal" href = "#stp-serial-transfer-protocol" > stp (Serial transfer protocol)< / a > < / li >
< / ul >
< / li >
< li > < a class = "reference internal" href = "#indices-and-tables" > Indices and tables< / a > < / li >
< / ul >
< / div >
< / div >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
< a href = "#" > stringtools< / a >
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
< li > < a href = "#" class = "icon icon-home" > < / a > » < / li >
< li > Welcome to stringtools’ s documentation!< / li >
< li class = "wy-breadcrumbs-aside" >
< a href = "_sources/index.rst.txt" rel = "nofollow" > View page source< / a >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
2020-01-26 15:04:49 +01:00
< div class = "section" id = "module-stringtools" >
< span id = "welcome-to-stringtools-s-documentation" > < / span > < h1 > Welcome to stringtools’ s documentation!< a class = "headerlink" href = "#module-stringtools" title = "Permalink to this headline" > ¶< / a > < / h1 >
< div class = "section" id = "stringtools-stringtools" >
< h2 > stringtools (Stringtools)< a class = "headerlink" href = "#stringtools-stringtools" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > < strong > Author:< / strong > < / p >
< ul class = "simple" >
< li > Dirk Alders < < a class = "reference external" href = "mailto:sudo-dirk%40mount-mockery.de" > sudo-dirk< span > @ < / span > mount-mockery< span > . < / span > de< / a > > < / li >
< / ul >
< p > < strong > Description:< / strong > < / p >
< blockquote >
< div > This Module supports functionality around string operations.< / div > < / blockquote >
< p > < strong > Submodules:< / strong > < / p >
< ul class = "simple" >
2021-01-01 20:37:08 +01:00
< li > < a class = "reference internal" href = "#module-stringtools.csp" title = "stringtools.csp" > < code class = "xref py py-mod docutils literal notranslate" > < span class = "pre" > stringtools.csp< / span > < / code > < / a > < / li >
< li > < a class = "reference internal" href = "#module-stringtools.stp" title = "stringtools.stp" > < code class = "xref py py-mod docutils literal notranslate" > < span class = "pre" > stringtools.stp< / span > < / code > < / a > < / li >
< li > < a class = "reference internal" href = "#stringtools.gzip_compress" title = "stringtools.gzip_compress" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > gzip_compress()< / span > < / code > < / a > < / li >
< li > < a class = "reference internal" href = "#stringtools.gzip_extract" title = "stringtools.gzip_extract" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > gzip_extract()< / span > < / code > < / a > < / li >
< li > < a class = "reference internal" href = "#stringtools.hexlify" title = "stringtools.hexlify" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > hexlify()< / span > < / code > < / a > < / li >
2020-01-26 15:04:49 +01:00
< / ul >
< p > < strong > Unittest:< / strong > < / p >
< blockquote >
2021-01-01 20:37:08 +01:00
< div > See also the < a class = "reference download internal" download = "" href = "_downloads/412e50d5e5a6e9ca1556b611fbae3c9c/unittest.pdf" > < code class = "xref download docutils literal notranslate" > < span class = "pre" > unittest< / span > < / code > < / a > documentation.< / div > < / blockquote >
2020-01-26 15:04:49 +01:00
< p > < strong > Module Documentation:< / strong > < / p >
< dl class = "function" >
< dt id = "stringtools.gzip_compress" >
< code class = "descclassname" > stringtools.< / code > < code class = "descname" > gzip_compress< / code > < span class = "sig-paren" > (< / span > < em > s< / em > , < em > compresslevel=9< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#stringtools.gzip_compress" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Method to compress a stream of bytes.< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < ul class = "first simple" >
< li > < strong > s< / strong > (< em > str< / em > ) – The bytestream (string) to be compressed< / li >
< li > < strong > compresslevel< / strong > (< em > int< / em > ) – An optional compressionn level (default is 9)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > < p class = "first" > The compressed bytestream< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first last" > str< / p >
< / td >
< / tr >
< / tbody >
< / table >
< p > < strong > Example:< / strong > < / p >
2021-01-01 20:37:08 +01:00
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "kn" > import< / span > < span class = "nn" > stringtools< / span >
2020-01-26 15:04:49 +01:00
< span class = "kn" > import< / span > < span class = "nn" > report< / span >
2020-01-28 21:51:59 +01:00
< span class = "n" > report< / span > < span class = "o" > .< / span > < span class = "n" > stdoutLoggingConfigure< / span > < span class = "p" > (< / span > < span class = "n" > log_name_lvl< / span > < span class = "o" > =< / span > < span class = "p" > [(< / span > < span class = "n" > stringtools< / span > < span class = "o" > .< / span > < span class = "n" > logger_name< / span > < span class = "p" > ,< / span > < span class = "s1" > ' DEBUG' < / span > < span class = "p" > ),< / span > < span class = "p" > ])< / span >
< span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "n" > stringtools< / span > < span class = "o" > .< / span > < span class = "n" > hexlify< / span > < span class = "p" > (< / span > < span class = "n" > stringtools< / span > < span class = "o" > .< / span > < span class = "n" > gzip_compress< / span > < span class = "p" > (< / span > < span class = "mi" > 15< / span > < span class = "o" > *< / span > < span class = "sa" > b< / span > < span class = "s1" > ' < / span > < span class = "se" > \x00< / span > < span class = "s1" > ' < / span > < span class = "o" > +< / span > < span class = "mi" > 15< / span > < span class = "o" > *< / span > < span class = "sa" > b< / span > < span class = "s1" > ' < / span > < span class = "se" > \xff< / span > < span class = "s1" > ' < / span > < span class = "p" > )))< / span >
2020-01-26 15:04:49 +01:00
< / pre > < / div >
< / div >
< p > Will result to the following output:< / p >
2021-01-01 20:37:08 +01:00
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "mi" > 2020< / span > < span class = "o" > -< / span > < span class = "mi" > 01< / span > < span class = "o" > -< / span > < span class = "mi" > 28< / span > < span class = "mi" > 21< / span > < span class = "p" > :< / span > < span class = "mi" > 45< / span > < span class = "p" > :< / span > < span class = "mi" > 24< / span > < span class = "p" > ,< / span > < span class = "mi" > 558< / span > < span class = "p" > :< / span > < span class = "n" > STRINGTOOLS< / span > < span class = "o" > -< / span > < span class = "n" > DEBUG< / span > < span class = "o" > -< / span > < span class = "n" > GZIP< / span > < span class = "p" > :< / span > < span class = "n" > Finished< / span > < span class = "n" > to< / span > < span class = "n" > compress< / span > < span class = "n" > a< / span > < span class = "n" > string< / span > < span class = "p" > (< / span > < span class = "n" > compression_rate< / span > < span class = "o" > =< / span > < span class = "mf" > 0.867< / span > < span class = "p" > ,< / span > < span class = "n" > consumed_time< / span > < span class = "o" > =< / span > < span class = "mf" > 0.0< / span > < span class = "n" > s< / span > < span class = "p" > )< / span > < span class = "o" > .< / span >
2020-01-28 21:51:59 +01:00
< span class = "p" > (< / span > < span class = "mi" > 26< / span > < span class = "p" > ):< / span > < span class = "mi" > 1< / span > < span class = "n" > f< / span > < span class = "mi" > 8< / span > < span class = "n" > b< / span > < span class = "mi" > 08< / span > < span class = "mi" > 00< / span > < span class = "mi" > 64< / span > < span class = "mi" > 9< / span > < span class = "n" > d< / span > < span class = "mi" > 30< / span > < span class = "mi" > 5< / span > < span class = "n" > e< / span > < span class = "mi" > 02< / span > < span class = "n" > ff< / span > < span class = "mi" > 63< / span > < span class = "mi" > 60< / span > < span class = "mi" > 40< / span > < span class = "mi" > 01< / span > < span class = "n" > ff< / span > < span class = "mi" > 51< / span > < span class = "mi" > 01< / span > < span class = "mi" > 00< / span > < span class = "mi" > 2< / span > < span class = "n" > d< / span > < span class = "mi" > 8< / span > < span class = "n" > a< / span > < span class = "mi" > 7< / span > < span class = "n" > d< / span > < span class = "n" > de< / span > < span class = "mi" > 1< / span > < span class = "n" > e< / span > < span class = "mi" > 00< / span > < span class = "mi" > 00< / span > < span class = "mi" > 00< / span >
2020-01-26 15:04:49 +01:00
< / pre > < / div >
< / div >
< / dd > < / dl >
< dl class = "function" >
< dt id = "stringtools.gzip_extract" >
< code class = "descclassname" > stringtools.< / code > < code class = "descname" > gzip_extract< / code > < span class = "sig-paren" > (< / span > < em > s< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#stringtools.gzip_extract" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Method to extract data from a compress stream of bytes.< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > s< / strong > (< em > str< / em > ) – The compressed bytestream (string) to be extracted< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > The extracted data< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > str< / td >
< / tr >
< / tbody >
< / table >
< p > < strong > Example:< / strong > < / p >
2021-01-01 20:37:08 +01:00
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "kn" > import< / span > < span class = "nn" > stringtools< / span >
2020-01-26 15:04:49 +01:00
< span class = "kn" > import< / span > < span class = "nn" > report< / span >
2020-01-28 21:51:59 +01:00
< span class = "n" > report< / span > < span class = "o" > .< / span > < span class = "n" > stdoutLoggingConfigure< / span > < span class = "p" > (< / span > < span class = "n" > log_name_lvl< / span > < span class = "o" > =< / span > < span class = "p" > [(< / span > < span class = "n" > stringtools< / span > < span class = "o" > .< / span > < span class = "n" > logger_name< / span > < span class = "p" > ,< / span > < span class = "s1" > ' DEBUG' < / span > < span class = "p" > ),< / span > < span class = "p" > ])< / span >
< span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "n" > stringtools< / span > < span class = "o" > .< / span > < span class = "n" > hexlify< / span > < span class = "p" > (< / span > < span class = "n" > stringtools< / span > < span class = "o" > .< / span > < span class = "n" > gzip_extract< / span > < span class = "p" > (< / span > < span class = "sa" > b< / span > < span class = "s1" > ' < / span > < span class = "se" > \x1f\x8b\x08\x00\xd0\x82\xe5\x5c\x02\xff\x63\x60\x40\x01\xff\x51\x01\x00\x2d\x8a\x7d\xde\x1e\x00\x00\x00< / span > < span class = "s1" > ' < / span > < span class = "p" > )))< / span >
2020-01-26 15:04:49 +01:00
< / pre > < / div >
< / div >
< p > Will result to the following output:< / p >
2021-01-01 20:37:08 +01:00
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "mi" > 2020< / span > < span class = "o" > -< / span > < span class = "mi" > 01< / span > < span class = "o" > -< / span > < span class = "mi" > 28< / span > < span class = "mi" > 21< / span > < span class = "p" > :< / span > < span class = "mi" > 45< / span > < span class = "p" > :< / span > < span class = "mi" > 39< / span > < span class = "p" > ,< / span > < span class = "mi" > 899< / span > < span class = "p" > :< / span > < span class = "n" > STRINGTOOLS< / span > < span class = "o" > -< / span > < span class = "n" > DEBUG< / span > < span class = "o" > -< / span > < span class = "n" > GZIP< / span > < span class = "p" > :< / span > < span class = "n" > Finished< / span > < span class = "n" > to< / span > < span class = "n" > extract< / span > < span class = "n" > a< / span > < span class = "n" > string< / span > < span class = "p" > (< / span > < span class = "n" > compression_rate< / span > < span class = "o" > =< / span > < span class = "mf" > 0.867< / span > < span class = "p" > ,< / span > < span class = "n" > consumed_time< / span > < span class = "o" > =< / span > < span class = "mf" > 0.0< / span > < span class = "n" > s< / span > < span class = "p" > )< / span > < span class = "o" > .< / span >
2020-01-26 15:04:49 +01:00
< span class = "p" > (< / span > < span class = "mi" > 30< / span > < span class = "p" > ):< / span > < span class = "mi" > 00< / span > < span class = "mi" > 00< / span > < span class = "mi" > 00< / span > < span class = "mi" > 00< / span > < span class = "mi" > 00< / span > < span class = "mi" > 00< / span > < span class = "mi" > 00< / span > < span class = "mi" > 00< / span > < span class = "mi" > 00< / span > < span class = "mi" > 00< / span > < span class = "mi" > 00< / span > < span class = "mi" > 00< / span > < span class = "mi" > 00< / span > < span class = "mi" > 00< / span > < span class = "mi" > 00< / span > < span class = "n" > ff< / span > < span class = "n" > ff< / span > < span class = "n" > ff< / span > < span class = "n" > ff< / span > < span class = "n" > ff< / span > < span class = "n" > ff< / span > < span class = "n" > ff< / span > < span class = "n" > ff< / span > < span class = "n" > ff< / span > < span class = "n" > ff< / span > < span class = "n" > ff< / span > < span class = "n" > ff< / span > < span class = "n" > ff< / span > < span class = "n" > ff< / span > < span class = "n" > ff< / span >
< / pre > < / div >
< / div >
< / dd > < / dl >
< dl class = "function" >
< dt id = "stringtools.hexlify" >
< code class = "descclassname" > stringtools.< / code > < code class = "descname" > hexlify< / code > < span class = "sig-paren" > (< / span > < em > s< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#stringtools.hexlify" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Method to hexlify a string.< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > s< / strong > (< em > str< / em > ) – A string including the bytes to be hexlified.< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > The hexlified string< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > str< / td >
< / tr >
< / tbody >
< / table >
< p > < strong > Example:< / strong > < / p >
2021-01-01 20:37:08 +01:00
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "kn" > import< / span > < span class = "nn" > stringtools< / span >
2020-01-26 15:04:49 +01:00
< span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "n" > stringtools< / span > < span class = "o" > .< / span > < span class = "n" > hexlify< / span > < span class = "p" > (< / span > < span class = "sa" > b< / span > < span class = "s1" > ' A stringexample with non printable characters like < / span > < span class = "se" > \x12< / span > < span class = "s1" > ' < / span > < span class = "p" > ))< / span >
< / pre > < / div >
< / div >
< p > Will result to the following output:< / p >
2021-01-01 20:37:08 +01:00
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "p" > (< / span > < span class = "mi" > 52< / span > < span class = "p" > ):< / span > < span class = "mi" > 41< / span > < span class = "mi" > 20< / span > < span class = "mi" > 73< / span > < span class = "mi" > 74< / span > < span class = "mi" > 72< / span > < span class = "mi" > 69< / span > < span class = "mi" > 6< / span > < span class = "n" > e< / span > < span class = "mi" > 67< / span > < span class = "mi" > 65< / span > < span class = "mi" > 78< / span > < span class = "mi" > 61< / span > < span class = "mi" > 6< / span > < span class = "n" > d< / span > < span class = "mi" > 70< / span > < span class = "mi" > 6< / span > < span class = "n" > c< / span > < span class = "mi" > 65< / span > < span class = "mi" > 20< / span > < span class = "mi" > 77< / span > < span class = "mi" > 69< / span > < span class = "mi" > 74< / span > < span class = "mi" > 68< / span > < span class = "mi" > 20< / span > < span class = "mi" > 6< / span > < span class = "n" > e< / span > < span class = "mi" > 6< / span > < span class = "n" > f< / span > < span class = "mi" > 6< / span > < span class = "n" > e< / span > < span class = "mi" > 20< / span > < span class = "mi" > 70< / span > < span class = "mi" > 72< / span > < span class = "mi" > 69< / span > < span class = "mi" > 6< / span > < span class = "n" > e< / span > < span class = "mi" > 74< / span > < span class = "mi" > 61< / span > < span class = "mi" > 62< / span > < span class = "mi" > 6< / span > < span class = "n" > c< / span > < span class = "mi" > 65< / span > < span class = "mi" > 20< / span > < span class = "mi" > 63< / span > < span class = "mi" > 68< / span > < span class = "mi" > 61< / span > < span class = "mi" > 72< / span > < span class = "mi" > 61< / span > < span class = "mi" > 63< / span > < span class = "mi" > 74< / span > < span class = "mi" > 65< / span > < span class = "mi" > 72< / span > < span class = "mi" > 73< / span > < span class = "mi" > 20< / span > < span class = "mi" > 6< / span > < span class = "n" > c< / span > < span class = "mi" > 69< / span > < span class = "mi" > 6< / span > < span class = "n" > b< / span > < span class = "mi" > 65< / span > < span class = "mi" > 20< / span > < span class = "mi" > 12< / span >
2020-01-26 15:04:49 +01:00
< / pre > < / div >
< / div >
< / dd > < / dl >
< / div >
< span class = "target" id = "module-stringtools.csp" > < / span > < div class = "section" id = "csp-carriage-return-seperation-protocol" >
< h2 > csp (Carriage-Return seperation protocol)< a class = "headerlink" href = "#csp-carriage-return-seperation-protocol" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > < strong > Author:< / strong > < / p >
< ul class = "simple" >
< li > Dirk Alders < < a class = "reference external" href = "mailto:sudo-dirk%40mount-mockery.de" > sudo-dirk< span > @ < / span > mount-mockery< span > . < / span > de< / a > > < / li >
< / ul >
< p > < strong > Description:< / strong > < / p >
< blockquote >
2021-01-01 20:37:08 +01:00
< div > This module is a submodule of < a class = "reference internal" href = "#module-stringtools" title = "stringtools" > < code class = "xref py py-mod docutils literal notranslate" > < span class = "pre" > stringtools< / span > < / code > < / a > and creates an frame to transmit and receive messages via an serial interface.< / div > < / blockquote >
2020-01-26 15:04:49 +01:00
< p > < strong > Submodules:< / strong > < / p >
< ul class = "simple" >
2021-01-01 20:37:08 +01:00
< li > < a class = "reference internal" href = "#stringtools.csp.csp" title = "stringtools.csp.csp" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > stringtools.csp.csp< / span > < / code > < / a > < / li >
< li > < a class = "reference internal" href = "#stringtools.csp.build_frame" title = "stringtools.csp.build_frame" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > stringtools.csp.build_frame()< / span > < / code > < / a > < / li >
2020-01-26 15:04:49 +01:00
< / ul >
< dl class = "function" >
< dt id = "stringtools.csp.build_frame" >
2021-01-01 20:37:08 +01:00
< code class = "descclassname" > stringtools.csp.< / code > < code class = "descname" > build_frame< / code > < span class = "sig-paren" > (< / span > < em > msg< / em > , < em > seperator=b'\n'< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#stringtools.csp.build_frame" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-26 15:04:49 +01:00
< dd > < p > This Method builds an “csp-frame” to be transfered via a stream.< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > data< / strong > (< em > str< / em > ) – A String (Bytes) to be framed< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > The “csp-framed” message to be sent< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > str< / td >
< / tr >
< / tbody >
< / table >
< p > < strong > Example:< / strong > < / p >
2021-01-01 20:37:08 +01:00
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "kn" > import< / span > < span class = "nn" > stringtools< / span >
2020-01-26 15:04:49 +01:00
< span class = "n" > data< / span > < span class = "o" > =< / span > < span class = "sa" > b< / span > < span class = "s1" > ' message' < / span >
< span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "n" > stringtools< / span > < span class = "o" > .< / span > < span class = "n" > hexlify< / span > < span class = "p" > (< / span > < span class = "n" > data< / span > < span class = "p" > ))< / span >
< span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "n" > stringtools< / span > < span class = "o" > .< / span > < span class = "n" > hexlify< / span > < span class = "p" > (< / span > < span class = "n" > stringtools< / span > < span class = "o" > .< / span > < span class = "n" > csp< / span > < span class = "o" > .< / span > < span class = "n" > build_frame< / span > < span class = "p" > (< / span > < span class = "n" > data< / span > < span class = "p" > )))< / span >
< / pre > < / div >
< / div >
< p > Will result to the following output:< / p >
2021-01-01 20:37:08 +01:00
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "p" > (< / span > < span class = "mi" > 7< / span > < span class = "p" > ):< / span > < span class = "mi" > 6< / span > < span class = "n" > d< / span > < span class = "mi" > 65< / span > < span class = "mi" > 73< / span > < span class = "mi" > 73< / span > < span class = "mi" > 61< / span > < span class = "mi" > 67< / span > < span class = "mi" > 65< / span >
2020-01-26 15:04:49 +01:00
< span class = "p" > (< / span > < span class = "mi" > 8< / span > < span class = "p" > ):< / span > < span class = "mi" > 6< / span > < span class = "n" > d< / span > < span class = "mi" > 65< / span > < span class = "mi" > 73< / span > < span class = "mi" > 73< / span > < span class = "mi" > 61< / span > < span class = "mi" > 67< / span > < span class = "mi" > 65< / span > < span class = "mi" > 0< / span > < span class = "n" > a< / span >
< / pre > < / div >
< / div >
< / dd > < / dl >
< dl class = "class" >
< dt id = "stringtools.csp.csp" >
2021-01-01 20:37:08 +01:00
< em class = "property" > class < / em > < code class = "descclassname" > stringtools.csp.< / code > < code class = "descname" > csp< / code > < span class = "sig-paren" > (< / span > < em > seperator=b'n'< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#stringtools.csp.csp" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-26 15:04:49 +01:00
< dd > < p > This class extracts messages from an “csp-stream”.< / p >
< p > < strong > Example:< / strong > < / p >
2021-01-01 20:37:08 +01:00
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "kn" > import< / span > < span class = "nn" > report< / span >
2020-01-26 15:04:49 +01:00
< span class = "kn" > import< / span > < span class = "nn" > stringtools< / span >
2020-01-28 21:51:59 +01:00
< span class = "n" > report< / span > < span class = "o" > .< / span > < span class = "n" > stdoutLoggingConfigure< / span > < span class = "p" > (< / span > < span class = "n" > log_name_lvl< / span > < span class = "o" > =< / span > < span class = "p" > [(< / span > < span class = "n" > stringtools< / span > < span class = "o" > .< / span > < span class = "n" > logger_name< / span > < span class = "p" > ,< / span > < span class = "s1" > ' DEBUG' < / span > < span class = "p" > ),< / span > < span class = "p" > ])< / span >
2020-01-26 15:04:49 +01:00
< span class = "n" > s< / span > < span class = "o" > =< / span > < span class = "n" > stringtools< / span > < span class = "o" > .< / span > < span class = "n" > csp< / span > < span class = "o" > .< / span > < span class = "n" > csp< / span > < span class = "p" > ()< / span >
< span class = "k" > for< / span > < span class = "n" > byte< / span > < span class = "ow" > in< / span > < span class = "sa" > b< / span > < span class = "s1" > ' message< / span > < span class = "se" > \n< / span > < span class = "s1" > ' < / span > < span class = "p" > :< / span >
2020-01-28 21:51:59 +01:00
< span class = "n" > data< / span > < span class = "o" > =< / span > < span class = "n" > s< / span > < span class = "o" > .< / span > < span class = "n" > process< / span > < span class = "p" > (< / span > < span class = "nb" > bytes< / span > < span class = "p" > ([< / span > < span class = "n" > byte< / span > < span class = "p" > ]))< / span >
< span class = "k" > if< / span > < span class = "nb" > len< / span > < span class = "p" > (< / span > < span class = "n" > data< / span > < span class = "p" > )< / span > < span class = "o" > > < / span > < span class = "mi" > 0< / span > < span class = "p" > :< / span >
2020-01-26 15:04:49 +01:00
< span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "n" > data< / span > < span class = "p" > )< / span >
< / pre > < / div >
< / div >
< p > Will result to the following output:< / p >
2021-01-01 20:37:08 +01:00
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "mi" > 2020< / span > < span class = "o" > -< / span > < span class = "mi" > 01< / span > < span class = "o" > -< / span > < span class = "mi" > 28< / span > < span class = "mi" > 21< / span > < span class = "p" > :< / span > < span class = "mi" > 31< / span > < span class = "p" > :< / span > < span class = "mi" > 22< / span > < span class = "p" > ,< / span > < span class = "mi" > 093< / span > < span class = "p" > :< / span > < span class = "n" > STRINGTOOLS< / span > < span class = "o" > -< / span > < span class = "n" > DEBUG< / span > < span class = "o" > -< / span > < span class = "n" > CSP< / span > < span class = "p" > :< / span > < span class = "n" > Leaving< / span > < span class = "n" > data< / span > < span class = "ow" > in< / span > < span class = "n" > buffer< / span > < span class = "p" > (< / span > < span class = "n" > to< / span > < span class = "n" > be< / span > < span class = "n" > processed< / span > < span class = "nb" > next< / span > < span class = "n" > time< / span > < span class = "p" > ):< / span > < span class = "p" > (< / span > < span class = "mi" > 5< / span > < span class = "p" > ):< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 6< / span > < span class = "n" > d< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span >
2020-01-28 21:51:59 +01:00
< span class = "mi" > 2020< / span > < span class = "o" > -< / span > < span class = "mi" > 01< / span > < span class = "o" > -< / span > < span class = "mi" > 28< / span > < span class = "mi" > 21< / span > < span class = "p" > :< / span > < span class = "mi" > 31< / span > < span class = "p" > :< / span > < span class = "mi" > 22< / span > < span class = "p" > ,< / span > < span class = "mi" > 094< / span > < span class = "p" > :< / span > < span class = "n" > STRINGTOOLS< / span > < span class = "o" > -< / span > < span class = "n" > DEBUG< / span > < span class = "o" > -< / span > < span class = "n" > CSP< / span > < span class = "p" > :< / span > < span class = "n" > Leaving< / span > < span class = "n" > data< / span > < span class = "ow" > in< / span > < span class = "n" > buffer< / span > < span class = "p" > (< / span > < span class = "n" > to< / span > < span class = "n" > be< / span > < span class = "n" > processed< / span > < span class = "nb" > next< / span > < span class = "n" > time< / span > < span class = "p" > ):< / span > < span class = "p" > (< / span > < span class = "mi" > 10< / span > < span class = "p" > ):< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 6< / span > < span class = "n" > d< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 65< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span >
< span class = "mi" > 2020< / span > < span class = "o" > -< / span > < span class = "mi" > 01< / span > < span class = "o" > -< / span > < span class = "mi" > 28< / span > < span class = "mi" > 21< / span > < span class = "p" > :< / span > < span class = "mi" > 31< / span > < span class = "p" > :< / span > < span class = "mi" > 22< / span > < span class = "p" > ,< / span > < span class = "mi" > 094< / span > < span class = "p" > :< / span > < span class = "n" > STRINGTOOLS< / span > < span class = "o" > -< / span > < span class = "n" > DEBUG< / span > < span class = "o" > -< / span > < span class = "n" > CSP< / span > < span class = "p" > :< / span > < span class = "n" > Leaving< / span > < span class = "n" > data< / span > < span class = "ow" > in< / span > < span class = "n" > buffer< / span > < span class = "p" > (< / span > < span class = "n" > to< / span > < span class = "n" > be< / span > < span class = "n" > processed< / span > < span class = "nb" > next< / span > < span class = "n" > time< / span > < span class = "p" > ):< / span > < span class = "p" > (< / span > < span class = "mi" > 15< / span > < span class = "p" > ):< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 6< / span > < span class = "n" > d< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 65< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 73< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span >
< span class = "mi" > 2020< / span > < span class = "o" > -< / span > < span class = "mi" > 01< / span > < span class = "o" > -< / span > < span class = "mi" > 28< / span > < span class = "mi" > 21< / span > < span class = "p" > :< / span > < span class = "mi" > 31< / span > < span class = "p" > :< / span > < span class = "mi" > 22< / span > < span class = "p" > ,< / span > < span class = "mi" > 095< / span > < span class = "p" > :< / span > < span class = "n" > STRINGTOOLS< / span > < span class = "o" > -< / span > < span class = "n" > DEBUG< / span > < span class = "o" > -< / span > < span class = "n" > CSP< / span > < span class = "p" > :< / span > < span class = "n" > Leaving< / span > < span class = "n" > data< / span > < span class = "ow" > in< / span > < span class = "n" > buffer< / span > < span class = "p" > (< / span > < span class = "n" > to< / span > < span class = "n" > be< / span > < span class = "n" > processed< / span > < span class = "nb" > next< / span > < span class = "n" > time< / span > < span class = "p" > ):< / span > < span class = "p" > (< / span > < span class = "mi" > 20< / span > < span class = "p" > ):< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 6< / span > < span class = "n" > d< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 65< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 73< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 73< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span >
< span class = "mi" > 2020< / span > < span class = "o" > -< / span > < span class = "mi" > 01< / span > < span class = "o" > -< / span > < span class = "mi" > 28< / span > < span class = "mi" > 21< / span > < span class = "p" > :< / span > < span class = "mi" > 31< / span > < span class = "p" > :< / span > < span class = "mi" > 22< / span > < span class = "p" > ,< / span > < span class = "mi" > 095< / span > < span class = "p" > :< / span > < span class = "n" > STRINGTOOLS< / span > < span class = "o" > -< / span > < span class = "n" > DEBUG< / span > < span class = "o" > -< / span > < span class = "n" > CSP< / span > < span class = "p" > :< / span > < span class = "n" > Leaving< / span > < span class = "n" > data< / span > < span class = "ow" > in< / span > < span class = "n" > buffer< / span > < span class = "p" > (< / span > < span class = "n" > to< / span > < span class = "n" > be< / span > < span class = "n" > processed< / span > < span class = "nb" > next< / span > < span class = "n" > time< / span > < span class = "p" > ):< / span > < span class = "p" > (< / span > < span class = "mi" > 25< / span > < span class = "p" > ):< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 6< / span > < span class = "n" > d< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 65< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 73< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 73< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 61< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span >
< span class = "mi" > 2020< / span > < span class = "o" > -< / span > < span class = "mi" > 01< / span > < span class = "o" > -< / span > < span class = "mi" > 28< / span > < span class = "mi" > 21< / span > < span class = "p" > :< / span > < span class = "mi" > 31< / span > < span class = "p" > :< / span > < span class = "mi" > 22< / span > < span class = "p" > ,< / span > < span class = "mi" > 095< / span > < span class = "p" > :< / span > < span class = "n" > STRINGTOOLS< / span > < span class = "o" > -< / span > < span class = "n" > DEBUG< / span > < span class = "o" > -< / span > < span class = "n" > CSP< / span > < span class = "p" > :< / span > < span class = "n" > Leaving< / span > < span class = "n" > data< / span > < span class = "ow" > in< / span > < span class = "n" > buffer< / span > < span class = "p" > (< / span > < span class = "n" > to< / span > < span class = "n" > be< / span > < span class = "n" > processed< / span > < span class = "nb" > next< / span > < span class = "n" > time< / span > < span class = "p" > ):< / span > < span class = "p" > (< / span > < span class = "mi" > 30< / span > < span class = "p" > ):< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 6< / span > < span class = "n" > d< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 65< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 73< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 73< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 61< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 67< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span >
< span class = "mi" > 2020< / span > < span class = "o" > -< / span > < span class = "mi" > 01< / span > < span class = "o" > -< / span > < span class = "mi" > 28< / span > < span class = "mi" > 21< / span > < span class = "p" > :< / span > < span class = "mi" > 31< / span > < span class = "p" > :< / span > < span class = "mi" > 22< / span > < span class = "p" > ,< / span > < span class = "mi" > 096< / span > < span class = "p" > :< / span > < span class = "n" > STRINGTOOLS< / span > < span class = "o" > -< / span > < span class = "n" > DEBUG< / span > < span class = "o" > -< / span > < span class = "n" > CSP< / span > < span class = "p" > :< / span > < span class = "n" > Leaving< / span > < span class = "n" > data< / span > < span class = "ow" > in< / span > < span class = "n" > buffer< / span > < span class = "p" > (< / span > < span class = "n" > to< / span > < span class = "n" > be< / span > < span class = "n" > processed< / span > < span class = "nb" > next< / span > < span class = "n" > time< / span > < span class = "p" > ):< / span > < span class = "p" > (< / span > < span class = "mi" > 35< / span > < span class = "p" > ):< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 6< / span > < span class = "n" > d< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 65< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 73< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 73< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 61< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 67< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 65< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span >
< span class = "mi" > 2020< / span > < span class = "o" > -< / span > < span class = "mi" > 01< / span > < span class = "o" > -< / span > < span class = "mi" > 28< / span > < span class = "mi" > 21< / span > < span class = "p" > :< / span > < span class = "mi" > 31< / span > < span class = "p" > :< / span > < span class = "mi" > 22< / span > < span class = "p" > ,< / span > < span class = "mi" > 096< / span > < span class = "p" > :< / span > < span class = "n" > STRINGTOOLS< / span > < span class = "o" > -< / span > < span class = "n" > DEBUG< / span > < span class = "o" > -< / span > < span class = "n" > CSP< / span > < span class = "p" > :< / span > < span class = "n" > Leaving< / span > < span class = "n" > data< / span > < span class = "ow" > in< / span > < span class = "n" > buffer< / span > < span class = "p" > (< / span > < span class = "n" > to< / span > < span class = "n" > be< / span > < span class = "n" > processed< / span > < span class = "nb" > next< / span > < span class = "n" > time< / span > < span class = "p" > ):< / span > < span class = "p" > (< / span > < span class = "mi" > 41< / span > < span class = "p" > ):< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 6< / span > < span class = "n" > d< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 65< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 73< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 73< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 61< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 67< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 65< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span > < span class = "mi" > 5< / span > < span class = "n" > b< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > c< / span > < span class = "mi" > 6< / span > < span class = "n" > e< / span > < span class = "mi" > 27< / span > < span class = "mi" > 5< / span > < span class = "n" > d< / span >
2020-01-26 15:04:49 +01:00
< / pre > < / div >
< / div >
< dl class = "method" >
< dt id = "stringtools.csp.csp.process" >
< code class = "descname" > process< / code > < span class = "sig-paren" > (< / span > < em > data< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#stringtools.csp.csp.process" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > This processes a byte out of a “stp-stream”.< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > data< / strong > (< em > bytes< / em > ) – A byte stream< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > A list of the extracted message(s)< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > list< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< / dd > < / dl >
< / div >
< span class = "target" id = "module-stringtools.stp" > < / span > < div class = "section" id = "stp-serial-transfer-protocol" >
< h2 > stp (Serial transfer protocol)< a class = "headerlink" href = "#stp-serial-transfer-protocol" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > < strong > Author:< / strong > < / p >
< ul class = "simple" >
< li > Dirk Alders < < a class = "reference external" href = "mailto:sudo-dirk%40mount-mockery.de" > sudo-dirk< span > @ < / span > mount-mockery< span > . < / span > de< / a > > < / li >
< / ul >
< p > < strong > Description:< / strong > < / p >
< blockquote >
2021-01-01 20:37:08 +01:00
< div > This module is a submodule of < a class = "reference internal" href = "#module-stringtools" title = "stringtools" > < code class = "xref py py-mod docutils literal notranslate" > < span class = "pre" > stringtools< / span > < / code > < / a > and creates an serial frame to transmit and receive messages via an serial interface.< / div > < / blockquote >
2020-01-26 15:04:49 +01:00
< p > < strong > Submodules:< / strong > < / p >
< ul class = "simple" >
2021-01-01 20:37:08 +01:00
< li > < a class = "reference internal" href = "#stringtools.stp.stp" title = "stringtools.stp.stp" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > stringtools.stp.stp< / span > < / code > < / a > < / li >
< li > < a class = "reference internal" href = "#stringtools.stp.build_frame" title = "stringtools.stp.build_frame" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > stringtools.stp.build_frame()< / span > < / code > < / a > < / li >
2020-01-26 15:04:49 +01:00
< / ul >
< dl class = "data" >
< dt id = "stringtools.stp.DATA_CLEAR_BUFFER" >
2021-01-01 20:37:08 +01:00
< code class = "descclassname" > stringtools.stp.< / code > < code class = "descname" > DATA_CLEAR_BUFFER< / code > < em class = "property" > = b'< '< / em > < a class = "headerlink" href = "#stringtools.stp.DATA_CLEAR_BUFFER" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-26 15:04:49 +01:00
< dd > < p > The clear buffer byte (‘ \x3a\x3c’ -> start of message)< / p >
< / dd > < / dl >
< dl class = "data" >
< dt id = "stringtools.stp.DATA_STORE_SYNC_VALUE" >
2021-01-01 20:37:08 +01:00
< code class = "descclassname" > stringtools.stp.< / code > < code class = "descname" > DATA_STORE_SYNC_VALUE< / code > < em class = "property" > = b'='< / em > < a class = "headerlink" href = "#stringtools.stp.DATA_STORE_SYNC_VALUE" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-26 15:04:49 +01:00
< dd > < p > The store sync value byte (‘ \x3a\x3d’ -> ‘ \x3a’ inside a message)< / p >
< / dd > < / dl >
< dl class = "data" >
< dt id = "stringtools.stp.DATA_SYNC" >
2021-01-01 20:37:08 +01:00
< code class = "descclassname" > stringtools.stp.< / code > < code class = "descname" > DATA_SYNC< / code > < em class = "property" > = b':'< / em > < a class = "headerlink" href = "#stringtools.stp.DATA_SYNC" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-26 15:04:49 +01:00
< dd > < p > The data sync byte< / p >
< / dd > < / dl >
< dl class = "data" >
< dt id = "stringtools.stp.DATA_VALID_MSG" >
2021-01-01 20:37:08 +01:00
< code class = "descclassname" > stringtools.stp.< / code > < code class = "descname" > DATA_VALID_MSG< / code > < em class = "property" > = b'> '< / em > < a class = "headerlink" href = "#stringtools.stp.DATA_VALID_MSG" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-26 15:04:49 +01:00
< dd > < p > The valid message byte (‘ \x3a\x3e’ -> end of message)< / p >
< / dd > < / dl >
< dl class = "data" >
< dt id = "stringtools.stp.STP_STATE_ESCAPE_1" >
< code class = "descclassname" > stringtools.stp.< / code > < code class = "descname" > STP_STATE_ESCAPE_1< / code > < em class = "property" > = 1< / em > < a class = "headerlink" href = "#stringtools.stp.STP_STATE_ESCAPE_1" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Escape 1 state definition (‘ \x3a\x3c’ found)< / p >
< / dd > < / dl >
< dl class = "data" >
< dt id = "stringtools.stp.STP_STATE_ESCAPE_2" >
< code class = "descclassname" > stringtools.stp.< / code > < code class = "descname" > STP_STATE_ESCAPE_2< / code > < em class = "property" > = 2< / em > < a class = "headerlink" href = "#stringtools.stp.STP_STATE_ESCAPE_2" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Escape 2 state definition (‘ \x3a’ found inside a message)< / p >
< / dd > < / dl >
< dl class = "data" >
< dt id = "stringtools.stp.STP_STATE_IDLE" >
< code class = "descclassname" > stringtools.stp.< / code > < code class = "descname" > STP_STATE_IDLE< / code > < em class = "property" > = 0< / em > < a class = "headerlink" href = "#stringtools.stp.STP_STATE_IDLE" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Idle state definition (default)< / p >
< / dd > < / dl >
< dl class = "data" >
< dt id = "stringtools.stp.STP_STATE_STORE_DATA" >
< code class = "descclassname" > stringtools.stp.< / code > < code class = "descname" > STP_STATE_STORE_DATA< / code > < em class = "property" > = 3< / em > < a class = "headerlink" href = "#stringtools.stp.STP_STATE_STORE_DATA" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Store data state definition (start of message found; data will be stored)< / p >
< / dd > < / dl >
< dl class = "function" >
< dt id = "stringtools.stp.build_frame" >
< code class = "descclassname" > stringtools.stp.< / code > < code class = "descname" > build_frame< / code > < span class = "sig-paren" > (< / span > < em > data< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#stringtools.stp.build_frame" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > This Method builds an “stp-frame” to be transfered via a stream.< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > data< / strong > (< em > str< / em > ) – A String (Bytes) to be framed< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > The “stp-framed” message to be sent< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > str< / td >
< / tr >
< / tbody >
< / table >
< p > < strong > Example:< / strong > < / p >
2021-01-01 20:37:08 +01:00
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "kn" > import< / span > < span class = "nn" > stringtools< / span >
2020-01-26 15:04:49 +01:00
2020-01-28 21:51:59 +01:00
< span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "nb" > repr< / span > < span class = "p" > (< / span > < span class = "n" > stringtools< / span > < span class = "o" > .< / span > < span class = "n" > stp< / span > < span class = "o" > .< / span > < span class = "n" > build_frame< / span > < span class = "p" > (< / span > < span class = "sa" > b< / span > < span class = "s1" > ' :message:' < / span > < span class = "p" > )))< / span >
2020-01-26 15:04:49 +01:00
< / pre > < / div >
< / div >
< p > Will result to the following output:< / p >
2021-01-01 20:37:08 +01:00
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "sa" > b< / span > < span class = "s1" > ' :< :=message:=:> ' < / span >
2020-01-26 15:04:49 +01:00
< / pre > < / div >
< / div >
< / dd > < / dl >
< dl class = "class" >
< dt id = "stringtools.stp.stp" >
< em class = "property" > class < / em > < code class = "descclassname" > stringtools.stp.< / code > < code class = "descname" > stp< / code > < a class = "headerlink" href = "#stringtools.stp.stp" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > This class extracts messages from an “stp-stream”.< / p >
< p > < strong > Example:< / strong > < / p >
2021-01-01 20:37:08 +01:00
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "kn" > import< / span > < span class = "nn" > report< / span >
2020-01-26 15:04:49 +01:00
< span class = "kn" > import< / span > < span class = "nn" > stringtools< / span >
2020-01-28 21:51:59 +01:00
< span class = "n" > report< / span > < span class = "o" > .< / span > < span class = "n" > stdoutLoggingConfigure< / span > < span class = "p" > (< / span > < span class = "n" > log_name_lvl< / span > < span class = "o" > =< / span > < span class = "p" > [(< / span > < span class = "n" > stringtools< / span > < span class = "o" > .< / span > < span class = "n" > logger_name< / span > < span class = "p" > ,< / span > < span class = "s1" > ' DEBUG' < / span > < span class = "p" > ),< / span > < span class = "p" > ])< / span >
2020-01-26 15:04:49 +01:00
< span class = "n" > s< / span > < span class = "o" > =< / span > < span class = "n" > stringtools< / span > < span class = "o" > .< / span > < span class = "n" > stp< / span > < span class = "o" > .< / span > < span class = "n" > stp< / span > < span class = "p" > ()< / span >
< span class = "k" > for< / span > < span class = "n" > byte< / span > < span class = "ow" > in< / span > < span class = "sa" > b< / span > < span class = "s1" > ' :< :=message:=:> ' < / span > < span class = "p" > :< / span >
2020-01-28 21:51:59 +01:00
< span class = "n" > data< / span > < span class = "o" > =< / span > < span class = "n" > s< / span > < span class = "o" > .< / span > < span class = "n" > process< / span > < span class = "p" > (< / span > < span class = "nb" > bytes< / span > < span class = "p" > ([< / span > < span class = "n" > byte< / span > < span class = "p" > ]))< / span >
< span class = "k" > if< / span > < span class = "nb" > len< / span > < span class = "p" > (< / span > < span class = "n" > data< / span > < span class = "p" > )< / span > < span class = "o" > > < / span > < span class = "mi" > 0< / span > < span class = "p" > :< / span >
2020-01-26 15:04:49 +01:00
< span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "n" > data< / span > < span class = "p" > )< / span >
< / pre > < / div >
< / div >
< p > Will result to the following output:< / p >
2021-01-01 20:37:08 +01:00
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "mi" > 2020< / span > < span class = "o" > -< / span > < span class = "mi" > 01< / span > < span class = "o" > -< / span > < span class = "mi" > 28< / span > < span class = "mi" > 21< / span > < span class = "p" > :< / span > < span class = "mi" > 38< / span > < span class = "p" > :< / span > < span class = "mi" > 27< / span > < span class = "p" > ,< / span > < span class = "mi" > 329< / span > < span class = "p" > :< / span > < span class = "n" > STRINGTOOLS< / span > < span class = "o" > -< / span > < span class = "n" > DEBUG< / span > < span class = "o" > -< / span > < span class = "n" > STP< / span > < span class = "p" > :< / span > < span class = "n" > data< / span > < span class = "n" > sync< / span > < span class = "p" > (< / span > < span class = "mi" > 3< / span > < span class = "n" > a< / span > < span class = "p" > )< / span > < span class = "n" > received< / span > < span class = "o" > => < / span > < span class = "n" > changing< / span > < span class = "n" > state< / span > < span class = "n" > STP_STATE_IDLE< / span > < span class = "o" > -> < / span > < span class = "n" > STP_STATE_ESCAPE_1< / span >
2020-01-28 21:51:59 +01:00
< span class = "mi" > 2020< / span > < span class = "o" > -< / span > < span class = "mi" > 01< / span > < span class = "o" > -< / span > < span class = "mi" > 28< / span > < span class = "mi" > 21< / span > < span class = "p" > :< / span > < span class = "mi" > 38< / span > < span class = "p" > :< / span > < span class = "mi" > 27< / span > < span class = "p" > ,< / span > < span class = "mi" > 329< / span > < span class = "p" > :< / span > < span class = "n" > STRINGTOOLS< / span > < span class = "o" > -< / span > < span class = "n" > DEBUG< / span > < span class = "o" > -< / span > < span class = "n" > STP< / span > < span class = "p" > :< / span > < span class = "n" > start< / span > < span class = "n" > pattern< / span > < span class = "p" > (< / span > < span class = "mi" > 3< / span > < span class = "n" > a< / span > < span class = "mi" > 3< / span > < span class = "n" > c< / span > < span class = "p" > )< / span > < span class = "n" > received< / span > < span class = "o" > => < / span > < span class = "n" > changing< / span > < span class = "n" > state< / span > < span class = "n" > STP_STATE_ESCAPE_1< / span > < span class = "o" > -> < / span > < span class = "n" > STP_STATE_STORE_DATA< / span >
< span class = "mi" > 2020< / span > < span class = "o" > -< / span > < span class = "mi" > 01< / span > < span class = "o" > -< / span > < span class = "mi" > 28< / span > < span class = "mi" > 21< / span > < span class = "p" > :< / span > < span class = "mi" > 38< / span > < span class = "p" > :< / span > < span class = "mi" > 27< / span > < span class = "p" > ,< / span > < span class = "mi" > 329< / span > < span class = "p" > :< / span > < span class = "n" > STRINGTOOLS< / span > < span class = "o" > -< / span > < span class = "n" > DEBUG< / span > < span class = "o" > -< / span > < span class = "n" > STP< / span > < span class = "p" > :< / span > < span class = "n" > data< / span > < span class = "n" > sync< / span > < span class = "p" > (< / span > < span class = "mi" > 3< / span > < span class = "n" > a< / span > < span class = "p" > )< / span > < span class = "n" > received< / span > < span class = "o" > => < / span > < span class = "n" > changing< / span > < span class = "n" > state< / span > < span class = "n" > STP_STATE_STORE_DATA< / span > < span class = "o" > -> < / span > < span class = "n" > STP_STATE_ESCAPE_2< / span >
< span class = "mi" > 2020< / span > < span class = "o" > -< / span > < span class = "mi" > 01< / span > < span class = "o" > -< / span > < span class = "mi" > 28< / span > < span class = "mi" > 21< / span > < span class = "p" > :< / span > < span class = "mi" > 38< / span > < span class = "p" > :< / span > < span class = "mi" > 27< / span > < span class = "p" > ,< / span > < span class = "mi" > 329< / span > < span class = "p" > :< / span > < span class = "n" > STRINGTOOLS< / span > < span class = "o" > -< / span > < span class = "n" > DEBUG< / span > < span class = "o" > -< / span > < span class = "n" > STP< / span > < span class = "p" > :< / span > < span class = "n" > store< / span > < span class = "n" > sync< / span > < span class = "n" > pattern< / span > < span class = "p" > (< / span > < span class = "mi" > 3< / span > < span class = "n" > a< / span > < span class = "mi" > 3< / span > < span class = "n" > d< / span > < span class = "p" > )< / span > < span class = "n" > received< / span > < span class = "o" > => < / span > < span class = "n" > changing< / span > < span class = "n" > state< / span > < span class = "n" > STP_STATE_ESCAPE_2< / span > < span class = "o" > -> < / span > < span class = "n" > STP_STATE_STORE_DATA< / span >
< span class = "mi" > 2020< / span > < span class = "o" > -< / span > < span class = "mi" > 01< / span > < span class = "o" > -< / span > < span class = "mi" > 28< / span > < span class = "mi" > 21< / span > < span class = "p" > :< / span > < span class = "mi" > 38< / span > < span class = "p" > :< / span > < span class = "mi" > 27< / span > < span class = "p" > ,< / span > < span class = "mi" > 329< / span > < span class = "p" > :< / span > < span class = "n" > STRINGTOOLS< / span > < span class = "o" > -< / span > < span class = "n" > DEBUG< / span > < span class = "o" > -< / span > < span class = "n" > STP< / span > < span class = "p" > :< / span > < span class = "n" > data< / span > < span class = "n" > sync< / span > < span class = "p" > (< / span > < span class = "mi" > 3< / span > < span class = "n" > a< / span > < span class = "p" > )< / span > < span class = "n" > received< / span > < span class = "o" > => < / span > < span class = "n" > changing< / span > < span class = "n" > state< / span > < span class = "n" > STP_STATE_STORE_DATA< / span > < span class = "o" > -> < / span > < span class = "n" > STP_STATE_ESCAPE_2< / span >
< span class = "mi" > 2020< / span > < span class = "o" > -< / span > < span class = "mi" > 01< / span > < span class = "o" > -< / span > < span class = "mi" > 28< / span > < span class = "mi" > 21< / span > < span class = "p" > :< / span > < span class = "mi" > 38< / span > < span class = "p" > :< / span > < span class = "mi" > 27< / span > < span class = "p" > ,< / span > < span class = "mi" > 329< / span > < span class = "p" > :< / span > < span class = "n" > STRINGTOOLS< / span > < span class = "o" > -< / span > < span class = "n" > DEBUG< / span > < span class = "o" > -< / span > < span class = "n" > STP< / span > < span class = "p" > :< / span > < span class = "n" > store< / span > < span class = "n" > sync< / span > < span class = "n" > pattern< / span > < span class = "p" > (< / span > < span class = "mi" > 3< / span > < span class = "n" > a< / span > < span class = "mi" > 3< / span > < span class = "n" > d< / span > < span class = "p" > )< / span > < span class = "n" > received< / span > < span class = "o" > => < / span > < span class = "n" > changing< / span > < span class = "n" > state< / span > < span class = "n" > STP_STATE_ESCAPE_2< / span > < span class = "o" > -> < / span > < span class = "n" > STP_STATE_STORE_DATA< / span >
< span class = "mi" > 2020< / span > < span class = "o" > -< / span > < span class = "mi" > 01< / span > < span class = "o" > -< / span > < span class = "mi" > 28< / span > < span class = "mi" > 21< / span > < span class = "p" > :< / span > < span class = "mi" > 38< / span > < span class = "p" > :< / span > < span class = "mi" > 27< / span > < span class = "p" > ,< / span > < span class = "mi" > 329< / span > < span class = "p" > :< / span > < span class = "n" > STRINGTOOLS< / span > < span class = "o" > -< / span > < span class = "n" > DEBUG< / span > < span class = "o" > -< / span > < span class = "n" > STP< / span > < span class = "p" > :< / span > < span class = "n" > data< / span > < span class = "n" > sync< / span > < span class = "p" > (< / span > < span class = "mi" > 3< / span > < span class = "n" > a< / span > < span class = "p" > )< / span > < span class = "n" > received< / span > < span class = "o" > => < / span > < span class = "n" > changing< / span > < span class = "n" > state< / span > < span class = "n" > STP_STATE_STORE_DATA< / span > < span class = "o" > -> < / span > < span class = "n" > STP_STATE_ESCAPE_2< / span >
< span class = "mi" > 2020< / span > < span class = "o" > -< / span > < span class = "mi" > 01< / span > < span class = "o" > -< / span > < span class = "mi" > 28< / span > < span class = "mi" > 21< / span > < span class = "p" > :< / span > < span class = "mi" > 38< / span > < span class = "p" > :< / span > < span class = "mi" > 27< / span > < span class = "p" > ,< / span > < span class = "mi" > 329< / span > < span class = "p" > :< / span > < span class = "n" > STRINGTOOLS< / span > < span class = "o" > -< / span > < span class = "n" > DEBUG< / span > < span class = "o" > -< / span > < span class = "n" > STP< / span > < span class = "p" > :< / span > < span class = "n" > end< / span > < span class = "n" > pattern< / span > < span class = "p" > (< / span > < span class = "mi" > 3< / span > < span class = "n" > a< / span > < span class = "mi" > 3< / span > < span class = "n" > e< / span > < span class = "p" > )< / span > < span class = "n" > received< / span > < span class = "o" > => < / span > < span class = "n" > storing< / span > < span class = "n" > message< / span > < span class = "ow" > and< / span > < span class = "n" > changing< / span > < span class = "n" > state< / span > < span class = "n" > STP_STATE_ESCAPE_2< / span > < span class = "o" > -> < / span > < span class = "n" > STP_STATE_IDLE< / span >
< span class = "mi" > 2020< / span > < span class = "o" > -< / span > < span class = "mi" > 01< / span > < span class = "o" > -< / span > < span class = "mi" > 28< / span > < span class = "mi" > 21< / span > < span class = "p" > :< / span > < span class = "mi" > 38< / span > < span class = "p" > :< / span > < span class = "mi" > 27< / span > < span class = "p" > ,< / span > < span class = "mi" > 329< / span > < span class = "p" > :< / span > < span class = "n" > STRINGTOOLS< / span > < span class = "o" > -< / span > < span class = "n" > INFO< / span > < span class = "o" > -< / span > < span class = "n" > STP< / span > < span class = "p" > :< / span > < span class = "n" > message< / span > < span class = "n" > identified< / span > < span class = "o" > -< / span > < span class = "p" > (< / span > < span class = "mi" > 9< / span > < span class = "p" > ):< / span > < span class = "mi" > 3< / span > < span class = "n" > a< / span > < span class = "mi" > 6< / span > < span class = "n" > d< / span > < span class = "mi" > 65< / span > < span class = "mi" > 73< / span > < span class = "mi" > 73< / span > < span class = "mi" > 61< / span > < span class = "mi" > 67< / span > < span class = "mi" > 65< / span > < span class = "mi" > 3< / span > < span class = "n" > a< / span >
< span class = "p" > [< / span > < span class = "sa" > b< / span > < span class = "s1" > ' :message:' < / span > < span class = "p" > ]< / span >
2020-01-26 15:04:49 +01:00
< / pre > < / div >
< / div >
< dl class = "method" >
< dt id = "stringtools.stp.stp.process" >
< code class = "descname" > process< / code > < span class = "sig-paren" > (< / span > < em > data< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#stringtools.stp.stp.process" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > This processes a byte out of a “stp-stream”.< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > data< / strong > (< em > bytes< / em > ) – A byte stream< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > The extracted message or None, if no message is identified yet< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > str< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< / dd > < / dl >
< / div >
< div class = "toctree-wrapper compound" >
< / div >
< / div >
< div class = "section" id = "indices-and-tables" >
< h1 > Indices and tables< a class = "headerlink" href = "#indices-and-tables" title = "Permalink to this headline" > ¶< / a > < / h1 >
< ul class = "simple" >
< li > < a class = "reference internal" href = "genindex.html" > < span class = "std std-ref" > Index< / span > < / a > < / li >
< li > < a class = "reference internal" href = "py-modindex.html" > < span class = "std std-ref" > Module Index< / span > < / a > < / li >
< li > < a class = "reference internal" href = "search.html" > < span class = "std std-ref" > Search Page< / span > < / a > < / li >
< / ul >
< / div >
2021-01-01 20:37:08 +01:00
< / div >
2020-01-26 15:04:49 +01:00
< / div >
2021-01-01 20:37:08 +01:00
< footer >
< hr / >
< div role = "contentinfo" >
< p >
© Copyright 2021, Dirk Alders
< / p >
< / div >
Built with < a href = "http://sphinx-doc.org/" > Sphinx< / a > using a
< a href = "https://github.com/rtfd/sphinx_rtd_theme" > theme< / a >
provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
< / footer >
2020-01-26 15:04:49 +01:00
< / div >
< / div >
2021-01-01 20:37:08 +01:00
< / section >
< / div >
2020-01-26 15:04:49 +01:00
2021-01-01 20:37:08 +01:00
< script type = "text/javascript" >
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
< / script >
2020-01-26 15:04:49 +01:00
2021-01-01 20:37:08 +01:00
< / body >
2020-01-26 15:04:49 +01:00
< / html >