/usr/share/doc/python-rdflib-doc/html/_modules/rdflib/plugins/parsers/pyRdfa/options.html is in python-rdflib-doc 4.1.2-3.
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 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 | <!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>rdflib.plugins.parsers.pyRdfa.options — rdflib 4.1.2 documentation</title>
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"/>
<link rel="stylesheet" href="../../../../../_static/rtd.css" type="text/css" />
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../../../',
VERSION: '4.1.2',
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>
<script type="text/javascript" src="../../../../../../../../../../_static/searchtools.js"></script>
<link rel="top" title="rdflib 4.1.2 documentation" href="../../../../../index.html" />
<link rel="up" title="rdflib.plugins.parsers.pyRdfa" href="../pyRdfa.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><a href="../../../../../index.html">rdflib 4.1.2 documentation</a> »</li>
<li><a href="../../../../index.html" >Module code</a> »</li>
<li><a href="../pyRdfa.html" accesskey="U">rdflib.plugins.parsers.pyRdfa</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for rdflib.plugins.parsers.pyRdfa.options</h1><div class="highlight"><pre>
<span class="c"># -*- coding: utf-8 -*-</span>
<span class="sd">"""</span>
<span class="sd">L{Options} class: collect the possible options that govern the parsing possibilities. The module also includes the L{ProcessorGraph} class that handles the processor graph, per RDFa 1.1 (i.e., the graph containing errors and warnings). </span>
<span class="sd">@summary: RDFa parser (distiller)</span>
<span class="sd">@requires: U{RDFLib<http://rdflib.net>}</span>
<span class="sd">@organization: U{World Wide Web Consortium<http://www.w3.org>}</span>
<span class="sd">@author: U{Ivan Herman<a href="http://www.w3.org/People/Ivan/">}</span>
<span class="sd">@license: This software is available for use under the</span>
<span class="sd">U{W3C SOFTWARE NOTICE AND LICENSE<href="http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231">}</span>
<span class="sd">"""</span>
<span class="sd">"""</span>
<span class="sd">$Id: options.py,v 1.20 2013-10-16 11:48:54 ivan Exp $ $Date: 2013-10-16 11:48:54 $</span>
<span class="sd">"""</span>
<span class="kn">import</span> <span class="nn">sys</span><span class="o">,</span> <span class="nn">datetime</span>
<span class="kn">import</span> <span class="nn">rdflib</span>
<span class="kn">from</span> <span class="nn">rdflib</span> <span class="kn">import</span> <span class="n">URIRef</span>
<span class="kn">from</span> <span class="nn">rdflib</span> <span class="kn">import</span> <span class="n">Literal</span>
<span class="kn">from</span> <span class="nn">rdflib</span> <span class="kn">import</span> <span class="n">BNode</span>
<span class="kn">from</span> <span class="nn">rdflib</span> <span class="kn">import</span> <span class="n">Namespace</span>
<span class="k">if</span> <span class="n">rdflib</span><span class="o">.</span><span class="n">__version__</span> <span class="o">>=</span> <span class="s">"3.0.0"</span> <span class="p">:</span>
<span class="kn">from</span> <span class="nn">rdflib</span> <span class="kn">import</span> <span class="n">Graph</span>
<span class="kn">from</span> <span class="nn">rdflib</span> <span class="kn">import</span> <span class="n">RDF</span> <span class="k">as</span> <span class="n">ns_rdf</span>
<span class="kn">from</span> <span class="nn">rdflib</span> <span class="kn">import</span> <span class="n">RDFS</span> <span class="k">as</span> <span class="n">ns_rdfs</span>
<span class="k">else</span> <span class="p">:</span>
<span class="kn">from</span> <span class="nn">rdflib.Graph</span> <span class="kn">import</span> <span class="n">Graph</span>
<span class="kn">from</span> <span class="nn">rdflib.RDFS</span> <span class="kn">import</span> <span class="n">RDFSNS</span> <span class="k">as</span> <span class="n">ns_rdfs</span>
<span class="kn">from</span> <span class="nn">rdflib.RDF</span> <span class="kn">import</span> <span class="n">RDFNS</span> <span class="k">as</span> <span class="n">ns_rdf</span>
<span class="kn">from</span> <span class="nn">.host</span> <span class="kn">import</span> <span class="n">HostLanguage</span><span class="p">,</span> <span class="n">MediaTypes</span><span class="p">,</span> <span class="n">content_to_host_language</span><span class="p">,</span> <span class="n">predefined_1_0_rel</span><span class="p">,</span> <span class="n">require_embedded_rdf</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">ns_xsd</span><span class="p">,</span> <span class="n">ns_distill</span><span class="p">,</span> <span class="n">ns_rdfa</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">RDFA_Error</span><span class="p">,</span> <span class="n">RDFA_Warning</span><span class="p">,</span> <span class="n">RDFA_Info</span>
<span class="kn">from</span> <span class="nn">.transform.lite</span> <span class="kn">import</span> <span class="n">lite_prune</span>
<span class="n">ns_dc</span> <span class="o">=</span> <span class="n">Namespace</span><span class="p">(</span><span class="s">"http://purl.org/dc/terms/"</span><span class="p">)</span>
<span class="n">ns_ht</span> <span class="o">=</span> <span class="n">Namespace</span><span class="p">(</span><span class="s">"http://www.w3.org/2006/http#"</span><span class="p">)</span>
<div class="viewcode-block" id="ProcessorGraph"><a class="viewcode-back" href="../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.html#rdflib.plugins.parsers.pyRdfa.options.ProcessorGraph">[docs]</a><span class="k">class</span> <span class="nc">ProcessorGraph</span> <span class="p">:</span>
<span class="sd">"""Wrapper around the 'processor graph', ie, the (RDF) Graph containing the warnings,</span>
<span class="sd"> error messages, and informational messages.</span>
<span class="sd"> """</span>
<div class="viewcode-block" id="ProcessorGraph.__init__"><a class="viewcode-back" href="../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.html#rdflib.plugins.parsers.pyRdfa.options.ProcessorGraph.__init__">[docs]</a> <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="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">graph</span> <span class="o">=</span> <span class="n">Graph</span><span class="p">()</span>
</div>
<div class="viewcode-block" id="ProcessorGraph.add_triples"><a class="viewcode-back" href="../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.html#rdflib.plugins.parsers.pyRdfa.options.ProcessorGraph.add_triples">[docs]</a> <span class="k">def</span> <span class="nf">add_triples</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">msg</span><span class="p">,</span> <span class="n">top_class</span><span class="p">,</span> <span class="n">info_class</span><span class="p">,</span> <span class="n">context</span><span class="p">,</span> <span class="n">node</span><span class="p">)</span> <span class="p">:</span>
<span class="sd">"""</span>
<span class="sd"> Add an error structure to the processor graph: a bnode with a number of predicates. The structure</span>
<span class="sd"> follows U{the processor graph vocabulary<http://www.w3.org/2010/02/rdfa/wiki/Processor_Graph_Vocabulary>} as described</span>
<span class="sd"> on the RDFa WG Wiki page.</span>
<span class="sd"> </span>
<span class="sd"> @param msg: the core error message, added as an object to a dc:description</span>
<span class="sd"> @param top_class: Error, Warning, or Info; an explicit rdf:type added to the bnode</span>
<span class="sd"> @type top_class: URIRef</span>
<span class="sd"> @param info_class: An additional error class, added as an rdf:type to the bnode in case it is not None</span>
<span class="sd"> @type info_class: URIRef</span>
<span class="sd"> @param context: An additional information added, if not None, as an object with rdfa:context as a predicate</span>
<span class="sd"> @type context: either an URIRef or a URI String (an URIRef will be created in the second case)</span>
<span class="sd"> @param node: The node's element name that contains the error</span>
<span class="sd"> @type node: string</span>
<span class="sd"> @return: the bnode that serves as a subject for the errors. The caller may add additional information</span>
<span class="sd"> @rtype: BNode</span>
<span class="sd"> """</span>
<span class="c"># Lazy binding of relevant prefixes</span>
<span class="bp">self</span><span class="o">.</span><span class="n">graph</span><span class="o">.</span><span class="n">bind</span><span class="p">(</span><span class="s">"dcterms"</span><span class="p">,</span> <span class="n">ns_dc</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">graph</span><span class="o">.</span><span class="n">bind</span><span class="p">(</span><span class="s">"pyrdfa"</span><span class="p">,</span> <span class="n">ns_distill</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">graph</span><span class="o">.</span><span class="n">bind</span><span class="p">(</span><span class="s">"rdf"</span><span class="p">,</span> <span class="n">ns_rdf</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">graph</span><span class="o">.</span><span class="n">bind</span><span class="p">(</span><span class="s">"rdfa"</span><span class="p">,</span> <span class="n">ns_rdfa</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">graph</span><span class="o">.</span><span class="n">bind</span><span class="p">(</span><span class="s">"ht"</span><span class="p">,</span> <span class="n">ns_ht</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">graph</span><span class="o">.</span><span class="n">bind</span><span class="p">(</span><span class="s">"xsd"</span><span class="p">,</span> <span class="n">ns_xsd</span><span class="p">)</span>
<span class="c"># Python 3 foolproof way</span>
<span class="k">try</span> <span class="p">:</span>
<span class="n">is_context_string</span> <span class="o">=</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">context</span><span class="p">,</span> <span class="nb">basestring</span><span class="p">)</span>
<span class="k">except</span> <span class="p">:</span>
<span class="n">is_context_string</span> <span class="o">=</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">context</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span>
<span class="n">bnode</span> <span class="o">=</span> <span class="n">BNode</span><span class="p">()</span>
<span class="k">if</span> <span class="n">node</span> <span class="o">!=</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">try</span> <span class="p">:</span>
<span class="n">full_msg</span> <span class="o">=</span> <span class="s">"[In element '</span><span class="si">%s</span><span class="s">'] </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">node</span><span class="o">.</span><span class="n">nodeName</span><span class="p">,</span> <span class="n">msg</span><span class="p">)</span>
<span class="k">except</span> <span class="p">:</span>
<span class="n">full_msg</span> <span class="o">=</span> <span class="s">"[In element '</span><span class="si">%s</span><span class="s">'] </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">node</span><span class="p">,</span> <span class="n">msg</span><span class="p">)</span>
<span class="k">else</span> <span class="p">:</span>
<span class="n">full_msg</span> <span class="o">=</span> <span class="n">msg</span>
<span class="bp">self</span><span class="o">.</span><span class="n">graph</span><span class="o">.</span><span class="n">add</span><span class="p">((</span><span class="n">bnode</span><span class="p">,</span> <span class="n">ns_rdf</span><span class="p">[</span><span class="s">"type"</span><span class="p">],</span> <span class="n">top_class</span><span class="p">))</span>
<span class="k">if</span> <span class="n">info_class</span> <span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">graph</span><span class="o">.</span><span class="n">add</span><span class="p">((</span><span class="n">bnode</span><span class="p">,</span> <span class="n">ns_rdf</span><span class="p">[</span><span class="s">"type"</span><span class="p">],</span> <span class="n">info_class</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">graph</span><span class="o">.</span><span class="n">add</span><span class="p">((</span><span class="n">bnode</span><span class="p">,</span> <span class="n">ns_dc</span><span class="p">[</span><span class="s">"description"</span><span class="p">],</span> <span class="n">Literal</span><span class="p">(</span><span class="n">full_msg</span><span class="p">)))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">graph</span><span class="o">.</span><span class="n">add</span><span class="p">((</span><span class="n">bnode</span><span class="p">,</span> <span class="n">ns_dc</span><span class="p">[</span><span class="s">"date"</span><span class="p">],</span> <span class="n">Literal</span><span class="p">(</span><span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">utcnow</span><span class="p">()</span><span class="o">.</span><span class="n">isoformat</span><span class="p">(),</span><span class="n">datatype</span><span class="o">=</span><span class="n">ns_xsd</span><span class="p">[</span><span class="s">"dateTime"</span><span class="p">])))</span>
<span class="k">if</span> <span class="n">context</span> <span class="ow">and</span> <span class="p">(</span><span class="nb">isinstance</span><span class="p">(</span><span class="n">context</span><span class="p">,</span><span class="n">URIRef</span><span class="p">)</span> <span class="ow">or</span> <span class="n">is_context_string</span><span class="p">):</span>
<span class="n">htbnode</span> <span class="o">=</span> <span class="n">BNode</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">graph</span><span class="o">.</span><span class="n">add</span><span class="p">(</span> <span class="p">(</span><span class="n">bnode</span><span class="p">,</span> <span class="n">ns_rdfa</span><span class="p">[</span><span class="s">"context"</span><span class="p">],</span><span class="n">htbnode</span><span class="p">)</span> <span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">graph</span><span class="o">.</span><span class="n">add</span><span class="p">(</span> <span class="p">(</span><span class="n">htbnode</span><span class="p">,</span> <span class="n">ns_rdf</span><span class="p">[</span><span class="s">"type"</span><span class="p">],</span> <span class="n">ns_ht</span><span class="p">[</span><span class="s">"Request"</span><span class="p">])</span> <span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">graph</span><span class="o">.</span><span class="n">add</span><span class="p">(</span> <span class="p">(</span><span class="n">htbnode</span><span class="p">,</span> <span class="n">ns_ht</span><span class="p">[</span><span class="s">"requestURI"</span><span class="p">],</span> <span class="n">Literal</span><span class="p">(</span><span class="s">"</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">context</span><span class="p">))</span> <span class="p">)</span>
<span class="k">return</span> <span class="n">bnode</span>
</div>
<div class="viewcode-block" id="ProcessorGraph.add_http_context"><a class="viewcode-back" href="../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.html#rdflib.plugins.parsers.pyRdfa.options.ProcessorGraph.add_http_context">[docs]</a> <span class="k">def</span> <span class="nf">add_http_context</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">subj</span><span class="p">,</span> <span class="n">http_code</span><span class="p">)</span> <span class="p">:</span>
<span class="sd">"""</span>
<span class="sd"> Add an additional HTTP context to a message with subject in C{subj}, using the U{<http://www.w3.org/2006/http#>}</span>
<span class="sd"> vocabulary. Typically used to extend an error structure, as created by L{add_triples}.</span>
<span class="sd"> </span>
<span class="sd"> @param subj: an RDFLib resource, typically a blank node</span>
<span class="sd"> @param http_code: HTTP status code</span>
<span class="sd"> """</span>
<span class="n">bnode</span> <span class="o">=</span> <span class="n">BNode</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">graph</span><span class="o">.</span><span class="n">add</span><span class="p">((</span><span class="n">subj</span><span class="p">,</span> <span class="n">ns_rdfa</span><span class="p">[</span><span class="s">"context"</span><span class="p">],</span> <span class="n">bnode</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">graph</span><span class="o">.</span><span class="n">add</span><span class="p">((</span><span class="n">bnode</span><span class="p">,</span> <span class="n">ns_rdf</span><span class="p">[</span><span class="s">"type"</span><span class="p">],</span> <span class="n">ns_ht</span><span class="p">[</span><span class="s">"Response"</span><span class="p">]))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">graph</span><span class="o">.</span><span class="n">add</span><span class="p">((</span><span class="n">bnode</span><span class="p">,</span> <span class="n">ns_ht</span><span class="p">[</span><span class="s">"responseCode"</span><span class="p">],</span> <span class="n">URIRef</span><span class="p">(</span><span class="s">"http://www.w3.org/2006/http#</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">http_code</span><span class="p">)))</span>
</div></div>
<div class="viewcode-block" id="Options"><a class="viewcode-back" href="../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.html#rdflib.plugins.parsers.pyRdfa.options.Options">[docs]</a><span class="k">class</span> <span class="nc">Options</span> <span class="p">:</span>
<span class="sd">"""Settable options. An instance of this class is stored in</span>
<span class="sd"> the L{execution context<ExecutionContext>} of the parser.</span>
<span class="sd"> @ivar space_preserve: whether plain literals should preserve spaces at output or not</span>
<span class="sd"> @type space_preserve: Boolean</span>
<span class="sd"> </span>
<span class="sd"> @ivar output_default_graph: whether the 'default' graph should be returned to the user</span>
<span class="sd"> @type output_default_graph: Boolean</span>
<span class="sd"> </span>
<span class="sd"> @ivar output_processor_graph: whether the 'processor' graph should be returned to the user</span>
<span class="sd"> @type output_processor_graph: Boolean</span>
<span class="sd"> </span>
<span class="sd"> @ivar processor_graph: the 'processor' Graph</span>
<span class="sd"> @type processor_graph: L{ProcessorGraph}</span>
<span class="sd"> </span>
<span class="sd"> @ivar transformers: extra transformers</span>
<span class="sd"> @type transformers: list</span>
<span class="sd"> </span>
<span class="sd"> @ivar vocab_cache_report: whether the details of vocabulary file caching process should be reported as information (mainly for debug)</span>
<span class="sd"> @type vocab_cache_report: Boolean</span>
<span class="sd"> </span>
<span class="sd"> @ivar refresh_vocab_cache: whether the caching checks of vocabs should be by-passed, ie, if caches should be re-generated regardless of the stored date (important for vocab development)</span>
<span class="sd"> @type refresh_vocab_cache: Boolean</span>
<span class="sd"> </span>
<span class="sd"> @ivar embedded_rdf: whether embedded RDF (ie, turtle in an HTML script element or an RDF/XML content in SVG) should be extracted and added to the final graph. This is a non-standard option...</span>
<span class="sd"> @type embedded_rdf: Boolean</span>
<span class="sd"> </span>
<span class="sd"> @ivar vocab_expansion: whether the @vocab elements should be expanded and a mini-RDFS processing should be done on the merged graph</span>
<span class="sd"> @type vocab_expansion: Boolean</span>
<span class="sd"> </span>
<span class="sd"> @ivar vocab_cache: whether the system should use the vocabulary caching mechanism when expanding via the mini-RDFS, or should just fetch the graphs every time</span>
<span class="sd"> @type vocab_cache: Boolean</span>
<span class="sd"> </span>
<span class="sd"> @ivar host_language: the host language for the RDFa attributes. Default is HostLanguage.xhtml, but it can be HostLanguage.rdfa_core and HostLanguage.html5, or others...</span>
<span class="sd"> @type host_language: integer (logically: an enumeration)</span>
<span class="sd"> </span>
<span class="sd"> @ivar content_type: the content type of the host file. Default is None</span>
<span class="sd"> @type content_type: string (logically: an enumeration)</span>
<span class="sd"> </span>
<span class="sd"> @ivar add_informational_messages: whether informational messages should also be added to the processor graph, or only errors and warnings</span>
<span class="sd"> @ivar experimental_features: whether experimental features should be activated; that is a developer's option...</span>
<span class="sd"> @ivar check_lite: whether RDFa Lite should be checked, to generate warnings.</span>
<span class="sd"> """</span>
<div class="viewcode-block" id="Options.__init__"><a class="viewcode-back" href="../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.html#rdflib.plugins.parsers.pyRdfa.options.Options.__init__">[docs]</a> <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">output_default_graph</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
<span class="n">output_processor_graph</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
<span class="n">space_preserve</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
<span class="n">transformers</span> <span class="o">=</span> <span class="p">[],</span>
<span class="n">embedded_rdf</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
<span class="n">vocab_expansion</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
<span class="n">vocab_cache</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
<span class="n">vocab_cache_report</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
<span class="n">refresh_vocab_cache</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
<span class="n">add_informational_messages</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
<span class="n">check_lite</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
<span class="n">experimental_features</span> <span class="o">=</span> <span class="bp">False</span>
<span class="p">)</span> <span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">space_preserve</span> <span class="o">=</span> <span class="n">space_preserve</span>
<span class="bp">self</span><span class="o">.</span><span class="n">transformers</span> <span class="o">=</span> <span class="n">transformers</span>
<span class="bp">self</span><span class="o">.</span><span class="n">processor_graph</span> <span class="o">=</span> <span class="n">ProcessorGraph</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output_default_graph</span> <span class="o">=</span> <span class="n">output_default_graph</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output_processor_graph</span> <span class="o">=</span> <span class="n">output_processor_graph</span>
<span class="bp">self</span><span class="o">.</span><span class="n">host_language</span> <span class="o">=</span> <span class="n">HostLanguage</span><span class="o">.</span><span class="n">rdfa_core</span>
<span class="bp">self</span><span class="o">.</span><span class="n">vocab_cache_report</span> <span class="o">=</span> <span class="n">vocab_cache_report</span>
<span class="bp">self</span><span class="o">.</span><span class="n">refresh_vocab_cache</span> <span class="o">=</span> <span class="n">refresh_vocab_cache</span>
<span class="bp">self</span><span class="o">.</span><span class="n">embedded_rdf</span> <span class="o">=</span> <span class="n">embedded_rdf</span>
<span class="bp">self</span><span class="o">.</span><span class="n">vocab_expansion</span> <span class="o">=</span> <span class="n">vocab_expansion</span>
<span class="bp">self</span><span class="o">.</span><span class="n">vocab_cache</span> <span class="o">=</span> <span class="n">vocab_cache</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add_informational_messages</span> <span class="o">=</span> <span class="n">add_informational_messages</span>
<span class="bp">self</span><span class="o">.</span><span class="n">check_lite</span> <span class="o">=</span> <span class="n">check_lite</span>
<span class="k">if</span> <span class="n">check_lite</span> <span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">transformers</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">lite_prune</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">experimental_features</span> <span class="o">=</span> <span class="n">experimental_features</span>
</div>
<div class="viewcode-block" id="Options.set_host_language"><a class="viewcode-back" href="../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.html#rdflib.plugins.parsers.pyRdfa.options.Options.set_host_language">[docs]</a> <span class="k">def</span> <span class="nf">set_host_language</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">content_type</span><span class="p">)</span> <span class="p">:</span>
<span class="sd">"""</span>
<span class="sd"> Set the host language for processing, based on the recognized types. If this is not a recognized content type,</span>
<span class="sd"> it falls back to RDFa core (i.e., XML)</span>
<span class="sd"> @param content_type: content type</span>
<span class="sd"> @type content_type: string</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">content_type</span> <span class="ow">in</span> <span class="n">content_to_host_language</span> <span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">host_language</span> <span class="o">=</span> <span class="n">content_to_host_language</span><span class="p">[</span><span class="n">content_type</span><span class="p">]</span>
<span class="k">else</span> <span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">host_language</span> <span class="o">=</span> <span class="n">HostLanguage</span><span class="o">.</span><span class="n">rdfa_core</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">host_language</span> <span class="ow">in</span> <span class="n">require_embedded_rdf</span> <span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">embedded_rdf</span> <span class="o">=</span> <span class="bp">True</span>
</div>
<div class="viewcode-block" id="Options.__str__"><a class="viewcode-back" href="../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.html#rdflib.plugins.parsers.pyRdfa.options.Options.__str__">[docs]</a> <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="p">:</span>
<span class="n">retval</span> <span class="o">=</span> <span class="s">"""Current options:</span>
<span class="s"> preserve space : </span><span class="si">%s</span><span class="s"></span>
<span class="s"> output processor graph : </span><span class="si">%s</span><span class="s"></span>
<span class="s"> output default graph : </span><span class="si">%s</span><span class="s"></span>
<span class="s"> host language : </span><span class="si">%s</span><span class="s"></span>
<span class="s"> accept embedded RDF : </span><span class="si">%s</span><span class="s"></span>
<span class="s"> perfom semantic postprocessing : </span><span class="si">%s</span><span class="s"></span>
<span class="s"> cache vocabulary graphs : </span><span class="si">%s</span><span class="s"></span>
<span class="s"> """</span>
<span class="k">return</span> <span class="n">retval</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">space_preserve</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">output_processor_graph</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">output_default_graph</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">host_language</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">embedded_rdf</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">rdfa_sem</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">vocab_cache</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="Options.reset_processor_graph"><a class="viewcode-back" href="../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.html#rdflib.plugins.parsers.pyRdfa.options.Options.reset_processor_graph">[docs]</a> <span class="k">def</span> <span class="nf">reset_processor_graph</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Empty the processor graph. This is necessary if the same options is reused</span>
<span class="sd"> for several RDFa sources, and new error messages should be generated.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">processor_graph</span><span class="o">.</span><span class="n">graph</span><span class="o">.</span><span class="n">remove</span><span class="p">((</span><span class="bp">None</span><span class="p">,</span><span class="bp">None</span><span class="p">,</span><span class="bp">None</span><span class="p">))</span>
</div>
<div class="viewcode-block" id="Options.add_warning"><a class="viewcode-back" href="../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.html#rdflib.plugins.parsers.pyRdfa.options.Options.add_warning">[docs]</a> <span class="k">def</span> <span class="nf">add_warning</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">txt</span><span class="p">,</span> <span class="n">warning_type</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">context</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">node</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">buggy_value</span><span class="o">=</span><span class="bp">None</span><span class="p">)</span> <span class="p">:</span>
<span class="sd">"""Add a warning to the processor graph.</span>
<span class="sd"> @param txt: the warning text. </span>
<span class="sd"> @keyword warning_type: Warning Class</span>
<span class="sd"> @type warning_type: URIRef</span>
<span class="sd"> @keyword context: possible context to be added to the processor graph</span>
<span class="sd"> @type context: URIRef or String</span>
<span class="sd"> @keyword buggy_value: a special case when a 'term' is not recognized; no warning is generated for that case if the value is part of the 'usual' XHTML terms, because almost all RDFa file contains some of those and that would pollute the output</span>
<span class="sd"> @type buggy_value: String</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">warning_type</span> <span class="o">==</span> <span class="n">ns_rdfa</span><span class="p">[</span><span class="s">"UnresolvedTerm"</span><span class="p">]</span> <span class="ow">and</span> <span class="n">buggy_value</span> <span class="ow">in</span> <span class="n">predefined_1_0_rel</span> <span class="p">:</span>
<span class="k">return</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">processor_graph</span><span class="o">.</span><span class="n">add_triples</span><span class="p">(</span><span class="n">txt</span><span class="p">,</span> <span class="n">RDFA_Warning</span><span class="p">,</span> <span class="n">warning_type</span><span class="p">,</span> <span class="n">context</span><span class="p">,</span> <span class="n">node</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="Options.add_info"><a class="viewcode-back" href="../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.html#rdflib.plugins.parsers.pyRdfa.options.Options.add_info">[docs]</a> <span class="k">def</span> <span class="nf">add_info</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">txt</span><span class="p">,</span> <span class="n">info_type</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">context</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">node</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">buggy_value</span><span class="o">=</span><span class="bp">None</span><span class="p">)</span> <span class="p">:</span>
<span class="sd">"""Add an informational comment to the processor graph.</span>
<span class="sd"> @param txt: the information text. </span>
<span class="sd"> @keyword info_type: Info Class</span>
<span class="sd"> @type info_type: URIRef</span>
<span class="sd"> @keyword context: possible context to be added to the processor graph</span>
<span class="sd"> @type context: URIRef or String</span>
<span class="sd"> @keyword buggy_value: a special case when a 'term' is not recognized; no information is generated for that case if the value is part of the 'usual' XHTML terms, because almost all RDFa file contains some of those and that would pollute the output</span>
<span class="sd"> @type buggy_value: String</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">add_informational_messages</span> <span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">processor_graph</span><span class="o">.</span><span class="n">add_triples</span><span class="p">(</span><span class="n">txt</span><span class="p">,</span> <span class="n">RDFA_Info</span><span class="p">,</span> <span class="n">info_type</span><span class="p">,</span> <span class="n">context</span><span class="p">,</span> <span class="n">node</span><span class="p">)</span>
<span class="k">else</span> <span class="p">:</span>
<span class="k">return</span>
</div>
<div class="viewcode-block" id="Options.add_error"><a class="viewcode-back" href="../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.html#rdflib.plugins.parsers.pyRdfa.options.Options.add_error">[docs]</a> <span class="k">def</span> <span class="nf">add_error</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">txt</span><span class="p">,</span> <span class="n">err_type</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">context</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">node</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">buggy_value</span><span class="o">=</span><span class="bp">None</span><span class="p">)</span> <span class="p">:</span>
<span class="sd">"""Add an error to the processor graph.</span>
<span class="sd"> @param txt: the information text. </span>
<span class="sd"> @keyword err_type: Error Class</span>
<span class="sd"> @type err_type: URIRef</span>
<span class="sd"> @keyword context: possible context to be added to the processor graph</span>
<span class="sd"> @type context: URIRef or String</span>
<span class="sd"> @keyword buggy_value: a special case when a 'term' is not recognized; no error is generated for that case if the value is part of the 'usual' XHTML terms, because almost all RDFa file contains some of those and that would pollute the output</span>
<span class="sd"> @type buggy_value: String</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">processor_graph</span><span class="o">.</span><span class="n">add_triples</span><span class="p">(</span><span class="n">txt</span><span class="p">,</span> <span class="n">RDFA_Error</span><span class="p">,</span> <span class="n">err_type</span><span class="p">,</span> <span class="n">context</span><span class="p">,</span> <span class="n">node</span><span class="p">)</span>
</pre></div></div></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../../../../index.html">
<img class="logo" src="../../../../../_static/logo.svg" alt="Logo"/>
</a></p>
<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><a href="../../../../../index.html">rdflib 4.1.2 documentation</a> »</li>
<li><a href="../../../../index.html" >Module code</a> »</li>
<li><a href="../pyRdfa.html" >rdflib.plugins.parsers.pyRdfa</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2009 - 2013, RDFLib Team.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.2.2.
<br />Theme based on <a href="http://readthedocs.org/">Read The Docs</a>
</div>
</body>
</html>
|