diff options
| author | Cody Logan <clpo13@gmail.com> | 2020-08-05 17:21:45 -0700 |
|---|---|---|
| committer | Cody Logan <clpo13@gmail.com> | 2020-08-05 17:22:41 -0700 |
| commit | 52e72221bf65d118bc323866243f3fdbd2589c58 (patch) | |
| tree | 52eda1955e56b2323b6988819cbf4dbc9a3e9136 /source/alphanum.html | |
| parent | e06712a3618f095dc47df9a39da63f4e916ec35a (diff) | |
| download | alphanum-52e72221bf65d118bc323866243f3fdbd2589c58.tar.gz alphanum-52e72221bf65d118bc323866243f3fdbd2589c58.zip | |
Initialize gh-pages
Diffstat (limited to 'source/alphanum.html')
| -rw-r--r-- | source/alphanum.html | 257 |
1 files changed, 257 insertions, 0 deletions
diff --git a/source/alphanum.html b/source/alphanum.html new file mode 100644 index 0000000..6b49faa --- /dev/null +++ b/source/alphanum.html @@ -0,0 +1,257 @@ + + +<!DOCTYPE html> +<html class="writer-html5" lang="en" > +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>alphanum package — alphanum 0.2.0 documentation</title> + + + + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + + + + + + + + <!--[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 src="../_static/jquery.js"></script> + <script src="../_static/underscore.js"></script> + <script src="../_static/doctools.js"></script> + <script 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" /> + <link rel="prev" title="alphanum" href="modules.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="../index.html" class="icon icon-home" alt="Documentation Home"> alphanum + + + + </a> + + + + + + + +<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"> + + + + + + + <p class="caption"><span class="caption-text">Contents:</span></p> +<ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="modules.html">alphanum</a><ul class="current"> +<li class="toctree-l2 current"><a class="current reference internal" href="#">alphanum package</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li> +<li class="toctree-l3"><a class="reference internal" href="#module-alphanum.alphanum">alphanum.alphanum module</a></li> +<li class="toctree-l3"><a class="reference internal" href="#module-alphanum">Module contents</a></li> +</ul> +</li> +</ul> +</li> +</ul> + + + + </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="../index.html">alphanum</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="../index.html" class="icon icon-home"></a> »</li> + + <li><a href="modules.html">alphanum</a> »</li> + + <li>alphanum package</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/source/alphanum.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"> + + <div class="section" id="alphanum-package"> +<h1>alphanum package<a class="headerlink" href="#alphanum-package" title="Permalink to this headline">¶</a></h1> +<div class="section" id="submodules"> +<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> +</div> +<div class="section" id="module-alphanum.alphanum"> +<span id="alphanum-alphanum-module"></span><h2>alphanum.alphanum module<a class="headerlink" href="#module-alphanum.alphanum" title="Permalink to this headline">¶</a></h2> +<dl class="py function"> +<dt id="alphanum.alphanum.generate"> +<code class="sig-prename descclassname">alphanum.alphanum.</code><code class="sig-name descname">generate</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">length</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.8)">int</a></span> <span class="o">=</span> <span class="default_value">1</span></em><span class="sig-paren">)</span> → <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)">str</a><a class="reference internal" href="../_modules/alphanum/alphanum.html#generate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#alphanum.alphanum.generate" title="Permalink to this definition">¶</a></dt> +<dd><p>Generates a random string of alphanumeric characters of the given length. +If no length is specified, a single character is returned.</p> +<p>On Python 3.5, this string is pseudo-randomly generated using +<a class="reference external" href="https://docs.python.org/3/library/random.html#module-random" title="(in Python v3.8)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">random</span></code></a>. With 3.6 and later, the randomness is generated with +<a class="reference external" href="https://docs.python.org/3/library/secrets.html#module-secrets" title="(in Python v3.8)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">secrets</span></code></a>, making the randomization cryptographically strong.</p> +<dl class="field-list simple"> +<dt class="field-odd">Parameters</dt> +<dd class="field-odd"><p><strong>length</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code></a>, optional) – Desired string length. Defaults to 1.</p> +</dd> +<dt class="field-even">Returns</dt> +<dd class="field-even"><p>A pseudo-random alphanumeric string.</p> +</dd> +<dt class="field-odd">Return type</dt> +<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)">str</a></p> +</dd> +</dl> +<p class="rubric">Examples</p> +<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">alphanum</span><span class="o">.</span><span class="n">generate</span><span class="p">())</span> +<span class="go">'G'</span> +<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">alphanum</span><span class="o">.</span><span class="n">generate</span><span class="p">(</span><span class="mi">10</span><span class="p">))</span> +<span class="go">'a93jfDjdA0'</span> +</pre></div> +</div> +</dd></dl> + +</div> +<div class="section" id="module-alphanum"> +<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-alphanum" title="Permalink to this headline">¶</a></h2> +</div> +</div> + + + </div> + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + + <a href="modules.html" class="btn btn-neutral float-left" title="alphanum" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + + © Copyright 2020, Cody Logan + + </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> + + </div> + </div> + + </section> + + </div> + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file |