276 lines
No EOL
30 KiB
HTML
276 lines
No EOL
30 KiB
HTML
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" >
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>ytdl_subscribe.validators.base package — ytdl-subscribe documentation</title>
|
||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
|
||
<!--[if lt IE 9]>
|
||
<script src="../_static/js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
|
||
<script data-url_root="../" id="documentation_options" 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/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="../index.html" class="icon icon-home"> ytdl-subscribe
|
||
</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="Navigation menu">
|
||
<!-- Local TOC -->
|
||
<div class="local-toc"><ul>
|
||
<li><a class="reference internal" href="#">ytdl_subscribe.validators.base package</a><ul>
|
||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||
<li><a class="reference internal" href="#module-ytdl_subscribe.validators.base.strict_dict_validator">ytdl_subscribe.validators.base.strict_dict_validator module</a></li>
|
||
<li><a class="reference internal" href="#module-ytdl_subscribe.validators.base.string_datetime">ytdl_subscribe.validators.base.string_datetime module</a></li>
|
||
<li><a class="reference internal" href="#module-ytdl_subscribe.validators.base.string_formatter_validators">ytdl_subscribe.validators.base.string_formatter_validators module</a></li>
|
||
<li><a class="reference internal" href="#module-ytdl_subscribe.validators.base.string_select_validator">ytdl_subscribe.validators.base.string_select_validator module</a></li>
|
||
<li><a class="reference internal" href="#module-ytdl_subscribe.validators.base.validators">ytdl_subscribe.validators.base.validators module</a></li>
|
||
<li><a class="reference internal" href="#module-ytdl_subscribe.validators.base">Module contents</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="../index.html">ytdl-subscribe</a>
|
||
</nav>
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
<div role="navigation" aria-label="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="../index.html" class="icon icon-home"></a> »</li>
|
||
<li>ytdl_subscribe.validators.base package</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="../_sources/source/ytdl_subscribe.validators.base.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">
|
||
|
||
<section id="ytdl-subscribe-validators-base-package">
|
||
<h1>ytdl_subscribe.validators.base package<a class="headerlink" href="#ytdl-subscribe-validators-base-package" title="Permalink to this headline"></a></h1>
|
||
<section id="submodules">
|
||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
|
||
</section>
|
||
<section id="module-ytdl_subscribe.validators.base.strict_dict_validator">
|
||
<span id="ytdl-subscribe-validators-base-strict-dict-validator-module"></span><h2>ytdl_subscribe.validators.base.strict_dict_validator module<a class="headerlink" href="#module-ytdl_subscribe.validators.base.strict_dict_validator" title="Permalink to this headline"></a></h2>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.validators.base.strict_dict_validator.StrictDictValidator">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ytdl_subscribe.validators.base.strict_dict_validator.</span></span><span class="sig-name descname"><span class="pre">StrictDictValidator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ytdl_subscribe.validators.base.strict_dict_validator.StrictDictValidator" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#ytdl_subscribe.validators.base.validators.DictValidator" title="ytdl_subscribe.validators.base.validators.DictValidator"><code class="xref py py-class docutils literal notranslate"><span class="pre">ytdl_subscribe.validators.base.validators.DictValidator</span></code></a></p>
|
||
<p>Validates dictionary-based fields with required and optional keys.</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="module-ytdl_subscribe.validators.base.string_datetime">
|
||
<span id="ytdl-subscribe-validators-base-string-datetime-module"></span><h2>ytdl_subscribe.validators.base.string_datetime module<a class="headerlink" href="#module-ytdl_subscribe.validators.base.string_datetime" title="Permalink to this headline"></a></h2>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.validators.base.string_datetime.StringDatetimeValidator">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ytdl_subscribe.validators.base.string_datetime.</span></span><span class="sig-name descname"><span class="pre">StringDatetimeValidator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ytdl_subscribe.validators.base.string_datetime.StringDatetimeValidator" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#ytdl_subscribe.validators.base.validators.Validator" title="ytdl_subscribe.validators.base.validators.Validator"><code class="xref py py-class docutils literal notranslate"><span class="pre">ytdl_subscribe.validators.base.validators.Validator</span></code></a></p>
|
||
<p>Validates a ytdl datetime string value</p>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.validators.base.string_datetime.StringDatetimeValidator.datetime_str">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">datetime_str</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ytdl_subscribe.validators.base.string_datetime.StringDatetimeValidator.datetime_str" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Returns the datetime as a string</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="module-ytdl_subscribe.validators.base.string_formatter_validators">
|
||
<span id="ytdl-subscribe-validators-base-string-formatter-validators-module"></span><h2>ytdl_subscribe.validators.base.string_formatter_validators module<a class="headerlink" href="#module-ytdl_subscribe.validators.base.string_formatter_validators" title="Permalink to this headline"></a></h2>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.validators.base.string_formatter_validators.DictFormatterValidator">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ytdl_subscribe.validators.base.string_formatter_validators.</span></span><span class="sig-name descname"><span class="pre">DictFormatterValidator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ytdl_subscribe.validators.base.string_formatter_validators.DictFormatterValidator" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#ytdl_subscribe.validators.base.validators.LiteralDictValidator" title="ytdl_subscribe.validators.base.validators.LiteralDictValidator"><code class="xref py py-class docutils literal notranslate"><span class="pre">ytdl_subscribe.validators.base.validators.LiteralDictValidator</span></code></a></p>
|
||
<p>Validates a dictionary made up of key: string_formatters</p>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.validators.base.string_formatter_validators.DictFormatterValidator.dict">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dict</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#ytdl_subscribe.validators.base.string_formatter_validators.StringFormatterValidator" title="ytdl_subscribe.validators.base.string_formatter_validators.StringFormatterValidator"><span class="pre">ytdl_subscribe.validators.base.string_formatter_validators.StringFormatterValidator</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#ytdl_subscribe.validators.base.string_formatter_validators.DictFormatterValidator.dict" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Returns dict with string formatter values</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.validators.base.string_formatter_validators.DictFormatterValidator.dict_with_format_strings">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dict_with_format_strings</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#ytdl_subscribe.validators.base.string_formatter_validators.DictFormatterValidator.dict_with_format_strings" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Returns dict with the format strings themselves</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.validators.base.string_formatter_validators.OverridesDictFormatterValidator">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ytdl_subscribe.validators.base.string_formatter_validators.</span></span><span class="sig-name descname"><span class="pre">OverridesDictFormatterValidator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ytdl_subscribe.validators.base.string_formatter_validators.OverridesDictFormatterValidator" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#ytdl_subscribe.validators.base.string_formatter_validators.DictFormatterValidator" title="ytdl_subscribe.validators.base.string_formatter_validators.DictFormatterValidator"><code class="xref py py-class docutils literal notranslate"><span class="pre">ytdl_subscribe.validators.base.string_formatter_validators.DictFormatterValidator</span></code></a></p>
|
||
<p>Validates a dictionary made up of key: string_formatters, that must be resolved by overrides
|
||
only.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.validators.base.string_formatter_validators.OverridesStringFormatterValidator">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ytdl_subscribe.validators.base.string_formatter_validators.</span></span><span class="sig-name descname"><span class="pre">OverridesStringFormatterValidator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ytdl_subscribe.validators.base.string_formatter_validators.OverridesStringFormatterValidator" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#ytdl_subscribe.validators.base.string_formatter_validators.StringFormatterValidator" title="ytdl_subscribe.validators.base.string_formatter_validators.StringFormatterValidator"><code class="xref py py-class docutils literal notranslate"><span class="pre">ytdl_subscribe.validators.base.string_formatter_validators.StringFormatterValidator</span></code></a></p>
|
||
<p>A string formatter that should strictly use overrides that resolve without any entry variables.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.validators.base.string_formatter_validators.StringFormatterValidator">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ytdl_subscribe.validators.base.string_formatter_validators.</span></span><span class="sig-name descname"><span class="pre">StringFormatterValidator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ytdl_subscribe.validators.base.string_formatter_validators.StringFormatterValidator" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#ytdl_subscribe.validators.base.validators.Validator" title="ytdl_subscribe.validators.base.validators.Validator"><code class="xref py py-class docutils literal notranslate"><span class="pre">ytdl_subscribe.validators.base.validators.Validator</span></code></a></p>
|
||
<p>Ensures user-created formatter strings are valid</p>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.validators.base.string_formatter_validators.StringFormatterValidator.apply_formatter">
|
||
<em class="property"><span class="pre">final</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">apply_formatter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">variable_dict</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#ytdl_subscribe.validators.base.string_formatter_validators.StringFormatterValidator.apply_formatter" title="Permalink to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.validators.base.string_formatter_validators.StringFormatterValidator.format_string">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">format_string</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ytdl_subscribe.validators.base.string_formatter_validators.StringFormatterValidator.format_string" title="Permalink to this definition"></a></dt>
|
||
<dd><p>rtype: The literal format string, unformatted.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.validators.base.string_formatter_validators.iskeyword">
|
||
<span class="sig-prename descclassname"><span class="pre">ytdl_subscribe.validators.base.string_formatter_validators.</span></span><span class="sig-name descname"><span class="pre">iskeyword</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#ytdl_subscribe.validators.base.string_formatter_validators.iskeyword" title="Permalink to this definition"></a></dt>
|
||
<dd><p>x.__contains__(y) <==> y in x.</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="module-ytdl_subscribe.validators.base.string_select_validator">
|
||
<span id="ytdl-subscribe-validators-base-string-select-validator-module"></span><h2>ytdl_subscribe.validators.base.string_select_validator module<a class="headerlink" href="#module-ytdl_subscribe.validators.base.string_select_validator" title="Permalink to this headline"></a></h2>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.validators.base.string_select_validator.StringSelectValidator">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ytdl_subscribe.validators.base.string_select_validator.</span></span><span class="sig-name descname"><span class="pre">StringSelectValidator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ytdl_subscribe.validators.base.string_select_validator.StringSelectValidator" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#ytdl_subscribe.validators.base.validators.StringValidator" title="ytdl_subscribe.validators.base.validators.StringValidator"><code class="xref py py-class docutils literal notranslate"><span class="pre">ytdl_subscribe.validators.base.validators.StringValidator</span></code></a></p>
|
||
<p>Ensures strings have selected one of the discrete allowed values.</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="module-ytdl_subscribe.validators.base.validators">
|
||
<span id="ytdl-subscribe-validators-base-validators-module"></span><h2>ytdl_subscribe.validators.base.validators module<a class="headerlink" href="#module-ytdl_subscribe.validators.base.validators" title="Permalink to this headline"></a></h2>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.validators.base.validators.BoolValidator">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ytdl_subscribe.validators.base.validators.</span></span><span class="sig-name descname"><span class="pre">BoolValidator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ytdl_subscribe.validators.base.validators.BoolValidator" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#ytdl_subscribe.validators.base.validators.Validator" title="ytdl_subscribe.validators.base.validators.Validator"><code class="xref py py-class docutils literal notranslate"><span class="pre">ytdl_subscribe.validators.base.validators.Validator</span></code></a></p>
|
||
<p>Validates boolean fields.</p>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.validators.base.validators.BoolValidator.value">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">value</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#ytdl_subscribe.validators.base.validators.BoolValidator.value" title="Permalink to this definition"></a></dt>
|
||
<dd><p>rtype: Boolean value</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.validators.base.validators.DictValidator">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ytdl_subscribe.validators.base.validators.</span></span><span class="sig-name descname"><span class="pre">DictValidator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ytdl_subscribe.validators.base.validators.DictValidator" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#ytdl_subscribe.validators.base.validators.Validator" title="ytdl_subscribe.validators.base.validators.Validator"><code class="xref py py-class docutils literal notranslate"><span class="pre">ytdl_subscribe.validators.base.validators.Validator</span></code></a></p>
|
||
<p>Validates dictionary-based fields. Errors to them as ‘object’s since this could be validating
|
||
a yaml.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.validators.base.validators.LiteralDictValidator">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ytdl_subscribe.validators.base.validators.</span></span><span class="sig-name descname"><span class="pre">LiteralDictValidator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ytdl_subscribe.validators.base.validators.LiteralDictValidator" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#ytdl_subscribe.validators.base.validators.DictValidator" title="ytdl_subscribe.validators.base.validators.DictValidator"><code class="xref py py-class docutils literal notranslate"><span class="pre">ytdl_subscribe.validators.base.validators.DictValidator</span></code></a></p>
|
||
<p>DictValidator with exposed dict and keys method</p>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.validators.base.validators.LiteralDictValidator.dict">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dict</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><a class="headerlink" href="#ytdl_subscribe.validators.base.validators.LiteralDictValidator.dict" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Returns the entire dict</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.validators.base.validators.LiteralDictValidator.keys">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">keys</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#ytdl_subscribe.validators.base.validators.LiteralDictValidator.keys" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Returns a sorted list of the dict’s keys</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.validators.base.validators.StringValidator">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ytdl_subscribe.validators.base.validators.</span></span><span class="sig-name descname"><span class="pre">StringValidator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ytdl_subscribe.validators.base.validators.StringValidator" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#ytdl_subscribe.validators.base.validators.Validator" title="ytdl_subscribe.validators.base.validators.Validator"><code class="xref py py-class docutils literal notranslate"><span class="pre">ytdl_subscribe.validators.base.validators.Validator</span></code></a></p>
|
||
<p>Validates string fields.</p>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.validators.base.validators.StringValidator.value">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">value</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ytdl_subscribe.validators.base.validators.StringValidator.value" title="Permalink to this definition"></a></dt>
|
||
<dd><p>rtype: String value</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.validators.base.validators.Validator">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ytdl_subscribe.validators.base.validators.</span></span><span class="sig-name descname"><span class="pre">Validator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ytdl_subscribe.validators.base.validators.Validator" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
|
||
<p>Used to validate the value of a python object. This is the ‘base’ class that will first
|
||
check that the value’s type matches the expected type. Validators that inherit from this should
|
||
perform their validation within the __init__.</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="module-ytdl_subscribe.validators.base">
|
||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-ytdl_subscribe.validators.base" title="Permalink to this headline"></a></h2>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2022, Jesse Bannon.</p>
|
||
</div>
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |