ytdl-sub/docs/_html/source/ytdl_subscribe.validators.html
2022-04-13 07:47:33 +00:00

212 lines
No EOL
17 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 package &mdash; 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 package</a><ul>
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-ytdl_subscribe.validators.exceptions">ytdl_subscribe.validators.exceptions module</a></li>
<li><a class="reference internal" href="#module-ytdl_subscribe.validators">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> &raquo;</li>
<li>ytdl_subscribe.validators package</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/source/ytdl_subscribe.validators.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-package">
<h1>ytdl_subscribe.validators package<a class="headerlink" href="#ytdl-subscribe-validators-package" title="Permalink to this headline"></a></h1>
<section id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="ytdl_subscribe.validators.base.html">ytdl_subscribe.validators.base package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="ytdl_subscribe.validators.base.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="ytdl_subscribe.validators.base.html#module-ytdl_subscribe.validators.base.strict_dict_validator">ytdl_subscribe.validators.base.strict_dict_validator module</a></li>
<li class="toctree-l2"><a class="reference internal" href="ytdl_subscribe.validators.base.html#module-ytdl_subscribe.validators.base.string_datetime">ytdl_subscribe.validators.base.string_datetime module</a></li>
<li class="toctree-l2"><a class="reference internal" href="ytdl_subscribe.validators.base.html#module-ytdl_subscribe.validators.base.string_formatter_validators">ytdl_subscribe.validators.base.string_formatter_validators module</a></li>
<li class="toctree-l2"><a class="reference internal" href="ytdl_subscribe.validators.base.html#module-ytdl_subscribe.validators.base.string_select_validator">ytdl_subscribe.validators.base.string_select_validator module</a></li>
<li class="toctree-l2"><a class="reference internal" href="ytdl_subscribe.validators.base.html#module-ytdl_subscribe.validators.base.validators">ytdl_subscribe.validators.base.validators module</a></li>
<li class="toctree-l2"><a class="reference internal" href="ytdl_subscribe.validators.base.html#module-ytdl_subscribe.validators.base">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="ytdl_subscribe.validators.config.html">ytdl_subscribe.validators.config package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="ytdl_subscribe.validators.config.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="ytdl_subscribe.validators.config.config_options.html">ytdl_subscribe.validators.config.config_options package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="ytdl_subscribe.validators.config.config_options.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="ytdl_subscribe.validators.config.config_options.html#module-ytdl_subscribe.validators.config.config_options.config_options_validator">ytdl_subscribe.validators.config.config_options.config_options_validator module</a></li>
<li class="toctree-l4"><a class="reference internal" href="ytdl_subscribe.validators.config.config_options.html#module-ytdl_subscribe.validators.config.config_options">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="ytdl_subscribe.validators.config.metadata_options.html">ytdl_subscribe.validators.config.metadata_options package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="ytdl_subscribe.validators.config.metadata_options.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="ytdl_subscribe.validators.config.metadata_options.html#module-ytdl_subscribe.validators.config.metadata_options.id3_validator">ytdl_subscribe.validators.config.metadata_options.id3_validator module</a></li>
<li class="toctree-l4"><a class="reference internal" href="ytdl_subscribe.validators.config.metadata_options.html#module-ytdl_subscribe.validators.config.metadata_options.metadata_options_validator">ytdl_subscribe.validators.config.metadata_options.metadata_options_validator module</a></li>
<li class="toctree-l4"><a class="reference internal" href="ytdl_subscribe.validators.config.metadata_options.html#module-ytdl_subscribe.validators.config.metadata_options.nfo_validator">ytdl_subscribe.validators.config.metadata_options.nfo_validator module</a></li>
<li class="toctree-l4"><a class="reference internal" href="ytdl_subscribe.validators.config.metadata_options.html#module-ytdl_subscribe.validators.config.metadata_options">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="ytdl_subscribe.validators.config.output_options.html">ytdl_subscribe.validators.config.output_options package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="ytdl_subscribe.validators.config.output_options.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="ytdl_subscribe.validators.config.output_options.html#module-ytdl_subscribe.validators.config.output_options.output_options_validator">ytdl_subscribe.validators.config.output_options.output_options_validator module</a></li>
<li class="toctree-l4"><a class="reference internal" href="ytdl_subscribe.validators.config.output_options.html#module-ytdl_subscribe.validators.config.output_options">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="ytdl_subscribe.validators.config.overrides.html">ytdl_subscribe.validators.config.overrides package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="ytdl_subscribe.validators.config.overrides.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="ytdl_subscribe.validators.config.overrides.html#module-ytdl_subscribe.validators.config.overrides.overrides_validator">ytdl_subscribe.validators.config.overrides.overrides_validator module</a></li>
<li class="toctree-l4"><a class="reference internal" href="ytdl_subscribe.validators.config.overrides.html#module-ytdl_subscribe.validators.config.overrides">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="ytdl_subscribe.validators.config.source_options.html">ytdl_subscribe.validators.config.source_options package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="ytdl_subscribe.validators.config.source_options.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="ytdl_subscribe.validators.config.source_options.html#module-ytdl_subscribe.validators.config.source_options.download_strategy_validators">ytdl_subscribe.validators.config.source_options.download_strategy_validators module</a></li>
<li class="toctree-l4"><a class="reference internal" href="ytdl_subscribe.validators.config.source_options.html#module-ytdl_subscribe.validators.config.source_options.mixins">ytdl_subscribe.validators.config.source_options.mixins module</a></li>
<li class="toctree-l4"><a class="reference internal" href="ytdl_subscribe.validators.config.source_options.html#module-ytdl_subscribe.validators.config.source_options.soundcloud_validators">ytdl_subscribe.validators.config.source_options.soundcloud_validators module</a></li>
<li class="toctree-l4"><a class="reference internal" href="ytdl_subscribe.validators.config.source_options.html#module-ytdl_subscribe.validators.config.source_options.source_validators">ytdl_subscribe.validators.config.source_options.source_validators module</a></li>
<li class="toctree-l4"><a class="reference internal" href="ytdl_subscribe.validators.config.source_options.html#module-ytdl_subscribe.validators.config.source_options.youtube_validators">ytdl_subscribe.validators.config.source_options.youtube_validators module</a></li>
<li class="toctree-l4"><a class="reference internal" href="ytdl_subscribe.validators.config.source_options.html#module-ytdl_subscribe.validators.config.source_options">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="ytdl_subscribe.validators.config.ytdl_options.html">ytdl_subscribe.validators.config.ytdl_options package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="ytdl_subscribe.validators.config.ytdl_options.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="ytdl_subscribe.validators.config.ytdl_options.html#module-ytdl_subscribe.validators.config.ytdl_options.ytdl_options_validator">ytdl_subscribe.validators.config.ytdl_options.ytdl_options_validator module</a></li>
<li class="toctree-l4"><a class="reference internal" href="ytdl_subscribe.validators.config.ytdl_options.html#module-ytdl_subscribe.validators.config.ytdl_options">Module contents</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="ytdl_subscribe.validators.config.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="ytdl_subscribe.validators.config.html#module-ytdl_subscribe.validators.config.config_file_validator">ytdl_subscribe.validators.config.config_file_validator module</a></li>
<li class="toctree-l2"><a class="reference internal" href="ytdl_subscribe.validators.config.html#module-ytdl_subscribe.validators.config.preset_validator">ytdl_subscribe.validators.config.preset_validator module</a></li>
<li class="toctree-l2"><a class="reference internal" href="ytdl_subscribe.validators.config.html#module-ytdl_subscribe.validators.config.subscription_validator">ytdl_subscribe.validators.config.subscription_validator module</a></li>
<li class="toctree-l2"><a class="reference internal" href="ytdl_subscribe.validators.config.html#module-ytdl_subscribe.validators.config">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</section>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</section>
<section id="module-ytdl_subscribe.validators.exceptions">
<span id="ytdl-subscribe-validators-exceptions-module"></span><h2>ytdl_subscribe.validators.exceptions module<a class="headerlink" href="#module-ytdl_subscribe.validators.exceptions" title="Permalink to this headline"></a></h2>
<dl class="py exception">
<dt class="sig sig-object py" id="ytdl_subscribe.validators.exceptions.DownloadArchiveException">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ytdl_subscribe.validators.exceptions.</span></span><span class="sig-name descname"><span class="pre">DownloadArchiveException</span></span><a class="headerlink" href="#ytdl_subscribe.validators.exceptions.DownloadArchiveException" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ValueError</span></code></p>
<p>Any user or file errors caused by download archive or mapping files</p>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="ytdl_subscribe.validators.exceptions.StringFormattingException">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ytdl_subscribe.validators.exceptions.</span></span><span class="sig-name descname"><span class="pre">StringFormattingException</span></span><a class="headerlink" href="#ytdl_subscribe.validators.exceptions.StringFormattingException" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#ytdl_subscribe.validators.exceptions.ValidationException" title="ytdl_subscribe.validators.exceptions.ValidationException"><code class="xref py py-class docutils literal notranslate"><span class="pre">ytdl_subscribe.validators.exceptions.ValidationException</span></code></a></p>
<p>Tried to format a string but failed due to user misconfigured variables</p>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="ytdl_subscribe.validators.exceptions.StringFormattingVariableNotFoundException">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ytdl_subscribe.validators.exceptions.</span></span><span class="sig-name descname"><span class="pre">StringFormattingVariableNotFoundException</span></span><a class="headerlink" href="#ytdl_subscribe.validators.exceptions.StringFormattingVariableNotFoundException" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#ytdl_subscribe.validators.exceptions.StringFormattingException" title="ytdl_subscribe.validators.exceptions.StringFormattingException"><code class="xref py py-class docutils literal notranslate"><span class="pre">ytdl_subscribe.validators.exceptions.StringFormattingException</span></code></a></p>
<p>Tried to format a string but the variable was not found</p>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="ytdl_subscribe.validators.exceptions.ValidationException">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ytdl_subscribe.validators.exceptions.</span></span><span class="sig-name descname"><span class="pre">ValidationException</span></span><a class="headerlink" href="#ytdl_subscribe.validators.exceptions.ValidationException" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ValueError</span></code></p>
<p>Any user-caused configuration error should result in this error</p>
</dd></dl>
</section>
<section id="module-ytdl_subscribe.validators">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-ytdl_subscribe.validators" title="Permalink to this headline"></a></h2>
</section>
</section>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; 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>