python-validictory-doc 0.8.3-2 / usr / share / doc / python-validictory-doc / html / validictory.html

This file is indexed.

/usr/share/doc/python-validictory-doc/html/validictory.html is in python-validictory-doc 0.8.3-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>validictory module &mdash; validictory 0.8.3 documentation</title>
    
    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '',
        VERSION:     '0.8.3',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </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>
    <link rel="top" title="validictory 0.8.3 documentation" href="index.html" />
    <link rel="next" title="validictory changelog" href="changelog.html" />
    <link rel="prev" title="Using validictory" href="usage.html" /> 
  </head>
  <body>
    <div class="related">
      <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="right" >
          <a href="changelog.html" title="validictory changelog"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="usage.html" title="Using validictory"
             accesskey="P">previous</a> |</li>
        <li><a href="index.html">validictory 0.8.3 documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="module-validictory">
<span id="validictory-module"></span><h1>validictory module<a class="headerlink" href="#module-validictory" title="Permalink to this headline"></a></h1>
<div class="section" id="validate">
<h2>validate<a class="headerlink" href="#validate" title="Permalink to this headline"></a></h2>
<dl class="function">
<dt id="validictory.validate">
<tt class="descclassname">validictory.</tt><tt class="descname">validate</tt><big>(</big><em>data</em>, <em>schema</em>, <em>validator_cls=&lt;class 'validictory.validator.SchemaValidator'&gt;</em>, <em>format_validators=None</em>, <em>required_by_default=True</em>, <em>blank_by_default=False</em><big>)</big><a class="headerlink" href="#validictory.validate" title="Permalink to this definition"></a></dt>
<dd><p>Validates a parsed json document against the provided schema. If an
error is found a <a class="reference internal" href="#validictory.ValidationError" title="validictory.ValidationError"><tt class="xref py py-class docutils literal"><span class="pre">ValidationError</span></tt></a> is raised.</p>
<p>If there is an issue in the schema a <a class="reference internal" href="#validictory.SchemaError" title="validictory.SchemaError"><tt class="xref py py-class docutils literal"><span class="pre">SchemaError</span></tt></a> will be raised.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>data</strong> &#8211; python data to validate</li>
<li><strong>schema</strong> &#8211; python dictionary representing the schema (see
<a href="#id1"><span class="problematic" id="id2">`schema format`_</span></a>)</li>
<li><strong>validator_cls</strong> &#8211; optional validator class (default is
<a class="reference internal" href="#validictory.SchemaValidator" title="validictory.SchemaValidator"><tt class="xref py py-class docutils literal"><span class="pre">SchemaValidator</span></tt></a>)</li>
<li><strong>format_validators</strong> &#8211; optional dictionary of custom format validators</li>
<li><strong>required_by_default</strong> &#8211; defaults to True, set to False to make
<tt class="docutils literal"><span class="pre">required</span></tt> schema attribute False by default.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</div>
<div class="section" id="schemavalidator">
<h2>SchemaValidator<a class="headerlink" href="#schemavalidator" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="validictory.SchemaValidator">
<em class="property">class </em><tt class="descclassname">validictory.</tt><tt class="descname">SchemaValidator</tt><big>(</big><em>format_validators=None</em>, <em>required_by_default=True</em>, <em>blank_by_default=False</em><big>)</big><a class="headerlink" href="#validictory.SchemaValidator" title="Permalink to this definition"></a></dt>
<dd><p>Validator largely based upon the JSON Schema proposal but useful for
validating arbitrary python data structures.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>format_validators</strong> &#8211; optional dictionary of custom format validators</li>
<li><strong>required_by_default</strong> &#8211; defaults to True, set to False to make
<tt class="docutils literal"><span class="pre">required</span></tt> schema attribute False by default.</li>
<li><strong>blank_by_default</strong> &#8211; defaults to False, set to True to make <tt class="docutils literal"><span class="pre">blank</span></tt>
schema attribute True by default.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</div>
<div class="section" id="exceptions">
<h2>Exceptions<a class="headerlink" href="#exceptions" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="validictory.ValidationError">
<em class="property">class </em><tt class="descclassname">validictory.</tt><tt class="descname">ValidationError</tt><a class="headerlink" href="#validictory.ValidationError" title="Permalink to this definition"></a></dt>
<dd><p>validation errors encountered during validation (subclass of
<tt class="xref py py-class docutils literal"><span class="pre">ValueError</span></tt>)</p>
</dd></dl>

<dl class="class">
<dt id="validictory.SchemaError">
<em class="property">class </em><tt class="descclassname">validictory.</tt><tt class="descname">SchemaError</tt><a class="headerlink" href="#validictory.SchemaError" title="Permalink to this definition"></a></dt>
<dd><p>errors encountered in processing a schema (subclass of <tt class="xref py py-class docutils literal"><span class="pre">ValueError</span></tt>)</p>
</dd></dl>

</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">validictory module</a><ul>
<li><a class="reference internal" href="#validate">validate</a></li>
<li><a class="reference internal" href="#schemavalidator">SchemaValidator</a></li>
<li><a class="reference internal" href="#exceptions">Exceptions</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="usage.html"
                        title="previous chapter">Using validictory</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="changelog.html"
                        title="next chapter">validictory changelog</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/validictory.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <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>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <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="right" >
          <a href="changelog.html" title="validictory changelog"
             >next</a> |</li>
        <li class="right" >
          <a href="usage.html" title="Using validictory"
             >previous</a> |</li>
        <li><a href="index.html">validictory 0.8.3 documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2011, James Turk.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
    </div>
  </body>
</html>

APT Browse - Built by Thomas Orozco.