DHBW/TelegramAktienBot
1
0
Fork 0
Code Issues 6 Pull Requests 26 Actions Packages Projects Releases Wiki Activity
e0d4cd074c
TelegramAktienBot/documentation/telegram_bot/helper_functions.html

220 lines
13 KiB
HTML
Raw Normal View History

added documentation
2022-05-12 11:30:56 +00:00
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>telegram_bot.helper_functions API documentation</title>
<meta name="description" content="script for helper functions for bot related stuff" />
Update dependency 10up-sanitize.css to v13
2022-09-18 11:05:35 +00:00
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
Update dependency highlight.js to v11.7.0
2022-11-24 08:35:53 +00:00
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/styles/github.min.css" crossorigin>
added documentation
2022-05-12 11:30:56 +00:00
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
Update dependency highlight.js to v11.7.0
2022-11-24 08:35:53 +00:00
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/highlight.min.js" integrity="sha512-bgHRAiTjGrzHzLyKOnpFvaEpGzJet3z4tZnXGjpsCcqOnAH6VGUx9frc5bcIhKTVLEiCO6vEhNAgx5jtLUYrfA==" crossorigin></script>
added documentation
2022-05-12 11:30:56 +00:00
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>telegram_bot.helper_functions</code></h1>
</header>
<section id="section-intro">
<p>script for helper functions for bot related stuff</p>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">&#34;&#34;&#34;
script for helper functions for bot related stuff
&#34;&#34;&#34;
__author__ = &#34;Florian Kellermann, Linus Eickhoff&#34;
__date__ = &#34;10.05.2022&#34;
__version__ = &#34;1.0.0&#34;
__license__ = &#34;None&#34;
def contains_markdownv1_symbols(text):
&#34;&#34;&#34; checks if text contains markdown symbols
:type text: string
:param text: text to check
:return: true if text contains markdown symbols
:rtype: bool
&#34;&#34;&#34;
if text.find(&#34;_&#34;) != -1 or text.find(&#34;*&#34;) != -1 or text.find(&#34;`&#34;) != -1: # check if text contains relevant markdown symbols
return True
return False
def make_markdown_proof(text): # used to avoid errors related to markdown parsemode for telegram messaging
&#34;&#34;&#34; makes text markdown proof
:type text: string
:param text: text to make markdown proof
:return: markdown proof text
:rtype: string
&#34;&#34;&#34;
text = str(text)
text = text.replace(&#34;_&#34;, &#34;\\_&#34;) # replace _ with \_ because \ is used as escape character in markdown, double escape is needed because \ is also a escape character in strings
text = text.replace(&#34;*&#34;, &#34;\\*&#34;)
text = text.replace(&#34;`&#34;, &#34;\\`&#34;)
text = text.replace(&#34;[&#34;, &#34;\\[&#34;)
text = text.replace(&#34;]&#34;, &#34;\\]&#34;)
text = text.replace(&#34;(&#34;, &#34;\\(&#34;)
text = text.replace(&#34;)&#34;, &#34;\\)&#34;)
text = text.replace(&#34;#&#34;, &#34;\\#&#34;)
text = text.replace(&#34;+&#34;, &#34;\\+&#34;)
text = text.replace(&#34;-&#34;, &#34;\\-&#34;)
text = text.replace(&#34;!&#34;, &#34;\\!&#34;)
text = text.replace(&#34;.&#34;, &#34;\\.&#34;)
text = text.replace(&#34;?&#34;, &#34;\\?&#34;)
text = text.replace(&#34;/&#34;, &#34;\\/&#34;)
text = text.replace(&#34;~&#34;, &#34;\\~&#34;)
text = text.replace(&#34;|&#34;, &#34;\\|&#34;)
text = text.replace(&#34;&lt;&#34;, &#34;\\&lt;&#34;)
text = text.replace(&#34;&gt;&#34;, &#34;\\&gt;&#34;)
text = text.replace(&#34;&amp;&#34;, &#34;\\&amp;&#34;)
text = text.replace(&#34;^&#34;, &#34;\\^&#34;)
text = text.replace(&#34;$&#34;, &#34;\\$&#34;)
text = text.replace(&#34;%&#34;, &#34;\\%&#34;)
text = text.replace(&#34;=&#34;, &#34;\\=&#34;)
text = text.replace(&#34;@&#34;, &#34;\\@&#34;)
return text
if __name__ == &#39;__main__&#39;:
print(&#34;this is a module for helper functions for the bot and should not be run directly&#34;)
print(make_markdown_proof(&#34;_test_&#34;))
text = make_markdown_proof(&#34;_test_&#34;)
print(f&#34;{text}&#34;)</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="telegram_bot.helper_functions.contains_markdownv1_symbols"><code class="name flex">
<span>def <span class="ident">contains_markdownv1_symbols</span></span>(<span>text)</span>
</code></dt>
<dd>
<div class="desc"><p>checks if text contains markdown symbols
:type text: string</p>
<p>:param text: text to check</p>
<p>:return: true if text contains markdown symbols</p>
<p>:rtype: bool</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def contains_markdownv1_symbols(text):
&#34;&#34;&#34; checks if text contains markdown symbols
:type text: string
:param text: text to check
:return: true if text contains markdown symbols
:rtype: bool
&#34;&#34;&#34;
if text.find(&#34;_&#34;) != -1 or text.find(&#34;*&#34;) != -1 or text.find(&#34;`&#34;) != -1: # check if text contains relevant markdown symbols
return True
return False</code></pre>
</details>
</dd>
<dt id="telegram_bot.helper_functions.make_markdown_proof"><code class="name flex">
<span>def <span class="ident">make_markdown_proof</span></span>(<span>text)</span>
</code></dt>
<dd>
<div class="desc"><p>makes text markdown proof
:type text: string</p>
<p>:param text: text to make markdown proof</p>
<p>:return: markdown proof text</p>
<p>:rtype: string</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def make_markdown_proof(text): # used to avoid errors related to markdown parsemode for telegram messaging
&#34;&#34;&#34; makes text markdown proof
:type text: string
:param text: text to make markdown proof
:return: markdown proof text
:rtype: string
&#34;&#34;&#34;
text = str(text)
text = text.replace(&#34;_&#34;, &#34;\\_&#34;) # replace _ with \_ because \ is used as escape character in markdown, double escape is needed because \ is also a escape character in strings
text = text.replace(&#34;*&#34;, &#34;\\*&#34;)
text = text.replace(&#34;`&#34;, &#34;\\`&#34;)
text = text.replace(&#34;[&#34;, &#34;\\[&#34;)
text = text.replace(&#34;]&#34;, &#34;\\]&#34;)
text = text.replace(&#34;(&#34;, &#34;\\(&#34;)
text = text.replace(&#34;)&#34;, &#34;\\)&#34;)
text = text.replace(&#34;#&#34;, &#34;\\#&#34;)
text = text.replace(&#34;+&#34;, &#34;\\+&#34;)
text = text.replace(&#34;-&#34;, &#34;\\-&#34;)
text = text.replace(&#34;!&#34;, &#34;\\!&#34;)
text = text.replace(&#34;.&#34;, &#34;\\.&#34;)
text = text.replace(&#34;?&#34;, &#34;\\?&#34;)
text = text.replace(&#34;/&#34;, &#34;\\/&#34;)
text = text.replace(&#34;~&#34;, &#34;\\~&#34;)
text = text.replace(&#34;|&#34;, &#34;\\|&#34;)
text = text.replace(&#34;&lt;&#34;, &#34;\\&lt;&#34;)
text = text.replace(&#34;&gt;&#34;, &#34;\\&gt;&#34;)
text = text.replace(&#34;&amp;&#34;, &#34;\\&amp;&#34;)
text = text.replace(&#34;^&#34;, &#34;\\^&#34;)
text = text.replace(&#34;$&#34;, &#34;\\$&#34;)
text = text.replace(&#34;%&#34;, &#34;\\%&#34;)
text = text.replace(&#34;=&#34;, &#34;\\=&#34;)
text = text.replace(&#34;@&#34;, &#34;\\@&#34;)
return text</code></pre>
</details>
</dd>
</dl>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="telegram_bot" href="index.html">telegram_bot</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="telegram_bot.helper_functions.contains_markdownv1_symbols" href="#telegram_bot.helper_functions.contains_markdownv1_symbols">contains_markdownv1_symbols</a></code></li>
<li><code><a title="telegram_bot.helper_functions.make_markdown_proof" href="#telegram_bot.helper_functions.make_markdown_proof">make_markdown_proof</a></code></li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
</body>
</html>
Reference in New Issue Copy Permalink