<!doctype html> <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> <head> <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>sqlobject.constraints — SQLObject 3.7.0 documentation</title> <link rel="stylesheet" href="../../_static/bizstyle.css" type="text/css" /> <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> <script type="text/javascript" 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/bizstyle.js"></script> <link rel="index" title="Index" href="../../genindex.html" /> <link rel="search" title="Search" href="../../search.html" /> <meta name="viewport" content="width=device-width,initial-scale=1.0"> <!--[if lt IE 9]> <script type="text/javascript" src="_static/css3-mediaqueries.js"></script> <![endif]--> </head><body> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="../../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="nav-item nav-item-0"><a href="../../index.html">SQLObject 3.7.0 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li> </ul> </div> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> <div id="searchbox" style="display: none" role="search"> <h3>Quick search</h3> <div class="searchformwrapper"> <form class="search" action="../../search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body" role="main"> <h1>Source code for sqlobject.constraints</h1><div class="highlight"><pre> <span></span><span class="sd">"""</span> <span class="sd">Constraints</span> <span class="sd">"""</span> <span class="kn">from</span> <span class="nn">sqlobject.compat</span> <span class="k">import</span> <span class="n">PY2</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">PY2</span><span class="p">:</span> <span class="c1"># alias for python 3 compatability</span> <span class="n">long</span> <span class="o">=</span> <span class="nb">int</span> <div class="viewcode-block" id="BadValue"><a class="viewcode-back" href="../../api/sqlobject.constraints.html#sqlobject.constraints.BadValue">[docs]</a><span class="k">class</span> <span class="nc">BadValue</span><span class="p">(</span><span class="ne">ValueError</span><span class="p">):</span> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">desc</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">col</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span> <span class="bp">self</span><span class="o">.</span><span class="n">desc</span> <span class="o">=</span> <span class="n">desc</span> <span class="bp">self</span><span class="o">.</span><span class="n">col</span> <span class="o">=</span> <span class="n">col</span> <span class="c1"># I want these objects to be garbage-collectable, so</span> <span class="c1"># I just keep their repr:</span> <span class="bp">self</span><span class="o">.</span><span class="n">obj</span> <span class="o">=</span> <span class="nb">repr</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">value</span> <span class="o">=</span> <span class="nb">repr</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="n">fullDesc</span> <span class="o">=</span> <span class="s2">"</span><span class="si">%s</span><span class="s2">.</span><span class="si">%s</span><span class="s2"> </span><span class="si">%s</span><span class="s2"> (you gave: </span><span class="si">%s</span><span class="s2">)"</span> \ <span class="o">%</span> <span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">col</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">desc</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> <span class="ne">ValueError</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fullDesc</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">)</span> </div> <div class="viewcode-block" id="isString"><a class="viewcode-back" href="../../api/sqlobject.constraints.html#sqlobject.constraints.isString">[docs]</a><span class="k">def</span> <span class="nf">isString</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">col</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span> <span class="k">raise</span> <span class="n">BadValue</span><span class="p">(</span><span class="s2">"only allows strings"</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">col</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> </div> <div class="viewcode-block" id="notNull"><a class="viewcode-back" href="../../api/sqlobject.constraints.html#sqlobject.constraints.notNull">[docs]</a><span class="k">def</span> <span class="nf">notNull</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">col</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> <span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> <span class="k">raise</span> <span class="n">BadValue</span><span class="p">(</span><span class="s2">"is defined NOT NULL"</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">col</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> </div> <div class="viewcode-block" id="isInt"><a class="viewcode-back" href="../../api/sqlobject.constraints.html#sqlobject.constraints.isInt">[docs]</a><span class="k">def</span> <span class="nf">isInt</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">col</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="p">(</span><span class="nb">int</span><span class="p">,</span> <span class="n">long</span><span class="p">)):</span> <span class="k">raise</span> <span class="n">BadValue</span><span class="p">(</span><span class="s2">"only allows integers"</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">col</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> </div> <div class="viewcode-block" id="isFloat"><a class="viewcode-back" href="../../api/sqlobject.constraints.html#sqlobject.constraints.isFloat">[docs]</a><span class="k">def</span> <span class="nf">isFloat</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">col</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="p">(</span><span class="nb">int</span><span class="p">,</span> <span class="n">long</span><span class="p">,</span> <span class="nb">float</span><span class="p">)):</span> <span class="k">raise</span> <span class="n">BadValue</span><span class="p">(</span><span class="s2">"only allows floating point numbers"</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">col</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> </div> <div class="viewcode-block" id="isBool"><a class="viewcode-back" href="../../api/sqlobject.constraints.html#sqlobject.constraints.isBool">[docs]</a><span class="k">def</span> <span class="nf">isBool</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">col</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">bool</span><span class="p">):</span> <span class="k">raise</span> <span class="n">BadValue</span><span class="p">(</span><span class="s2">"only allows booleans"</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">col</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> </div> <div class="viewcode-block" id="InList"><a class="viewcode-back" href="../../api/sqlobject.constraints.html#sqlobject.constraints.InList">[docs]</a><span class="k">class</span> <span class="nc">InList</span><span class="p">:</span> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">l</span><span class="p">):</span> <span class="bp">self</span><span class="o">.</span><span class="n">list</span> <span class="o">=</span> <span class="n">l</span> <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">col</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> <span class="k">if</span> <span class="n">value</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">list</span><span class="p">:</span> <span class="k">raise</span> <span class="n">BadValue</span><span class="p">(</span><span class="s2">"accepts only values in </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">list</span><span class="p">),</span> <span class="n">obj</span><span class="p">,</span> <span class="n">col</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> </div> <div class="viewcode-block" id="MaxLength"><a class="viewcode-back" href="../../api/sqlobject.constraints.html#sqlobject.constraints.MaxLength">[docs]</a><span class="k">class</span> <span class="nc">MaxLength</span><span class="p">:</span> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">length</span><span class="p">):</span> <span class="bp">self</span><span class="o">.</span><span class="n">length</span> <span class="o">=</span> <span class="n">length</span> <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">col</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> <span class="k">try</span><span class="p">:</span> <span class="n">length</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="k">except</span> <span class="ne">TypeError</span><span class="p">:</span> <span class="k">raise</span> <span class="n">BadValue</span><span class="p">(</span><span class="s2">"object does not have a length"</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">col</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> <span class="k">if</span> <span class="n">length</span> <span class="o">></span> <span class="bp">self</span><span class="o">.</span><span class="n">length</span><span class="p">:</span> <span class="k">raise</span> <span class="n">BadValue</span><span class="p">(</span><span class="s2">"must be shorter in length than </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">length</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">col</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> </pre></div></div> </div> </div> </div> <div class="clearer"></div> </div> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="../../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="nav-item nav-item-0"><a href="../../index.html">SQLObject 3.7.0 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li> </ul> </div> <div class="footer" role="contentinfo"> © Copyright 2004-2018, Ian Bicking and contributors. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.4. </div> </body> </html>