python-rdflib-doc 4.1.2-3 / usr / share / doc / python-rdflib-doc / html / _modules / rdflib / plugins / parsers / pyRdfa / transform.html

This file is indexed.

/usr/share/doc/python-rdflib-doc/html/_modules/rdflib/plugins/parsers/pyRdfa/transform.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
<!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.transform &mdash; 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> &raquo;</li>
          <li><a href="../../../../index.html" >Module code</a> &raquo;</li>
          <li><a href="../pyRdfa.html" accesskey="U">rdflib.plugins.parsers.pyRdfa</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <h1>Source code for rdflib.plugins.parsers.pyRdfa.transform</h1><div class="highlight"><pre>
<span class="c"># -*- coding: utf-8 -*-</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd">Transformer sub-package for the pyRdfa package. It contains modules with transformer functions; each may be</span>
<span class="sd">invoked by pyRdfa to transform the dom tree before the &quot;real&quot; RDfa processing.</span>

<span class="sd">@summary: RDFa Transformer package</span>
<span class="sd">@requires: U{RDFLib package&lt;http://rdflib.net&gt;}</span>
<span class="sd">@organization: U{World Wide Web Consortium&lt;http://www.w3.org&gt;}</span>
<span class="sd">@author: U{Ivan Herman&lt;a href=&quot;http://www.w3.org/People/Ivan/&quot;&gt;}</span>
<span class="sd">@license: This software is available for use under the</span>
<span class="sd">U{W3C® SOFTWARE NOTICE AND LICENSE&lt;href=&quot;http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231&quot;&gt;}</span>
<span class="sd">&quot;&quot;&quot;</span>

<span class="sd">&quot;&quot;&quot;</span>
<span class="sd">$Id: __init__.py,v 1.8 2012/06/12 11:47:19 ivan Exp $</span>
<span class="sd">$Date: 2012/06/12 11:47:19 $</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="n">__version__</span> <span class="o">=</span> <span class="s">&quot;3.0&quot;</span>

<span class="c"># Here are the transfomer functions that are to be performed for all RDFa files, no matter what</span>

<div class="viewcode-block" id="top_about"><a class="viewcode-back" href="../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.transform.html#rdflib.plugins.parsers.pyRdfa.transform.top_about">[docs]</a><span class="k">def</span> <span class="nf">top_about</span><span class="p">(</span><span class="n">root</span><span class="p">,</span> <span class="n">options</span><span class="p">,</span> <span class="n">state</span><span class="p">)</span> <span class="p">:</span>
	<span class="sd">&quot;&quot;&quot;</span>
<span class="sd">	@param root: a DOM node for the top level element</span>
<span class="sd">	@param options: invocation options</span>
<span class="sd">	@type options: L{Options&lt;pyRdfa.options&gt;}</span>
<span class="sd">	@param state: top level execution state</span>
<span class="sd">	@type state: L{State&lt;pyRdfa.state&gt;}</span>
<span class="sd">	&quot;&quot;&quot;</span>
	<span class="k">def</span> <span class="nf">set_about</span><span class="p">(</span><span class="n">node</span><span class="p">)</span> <span class="p">:</span>
		<span class="k">if</span> <span class="n">has_one_of_attributes</span><span class="p">(</span><span class="n">node</span><span class="p">,</span> <span class="s">&quot;rel&quot;</span><span class="p">,</span> <span class="s">&quot;rev&quot;</span><span class="p">)</span> <span class="p">:</span>
			<span class="k">if</span> <span class="ow">not</span> <span class="n">has_one_of_attributes</span><span class="p">(</span><span class="n">top</span><span class="p">,</span> <span class="s">&quot;about&quot;</span><span class="p">,</span> <span class="s">&quot;src&quot;</span><span class="p">)</span> <span class="p">:</span>
				<span class="n">node</span><span class="o">.</span><span class="n">setAttribute</span><span class="p">(</span><span class="s">&quot;about&quot;</span><span class="p">,</span><span class="s">&quot;&quot;</span><span class="p">)</span>
		<span class="k">else</span> <span class="p">:</span>
			<span class="k">if</span> <span class="ow">not</span> <span class="n">has_one_of_attributes</span><span class="p">(</span><span class="n">node</span><span class="p">,</span> <span class="s">&quot;href&quot;</span><span class="p">,</span> <span class="s">&quot;resource&quot;</span><span class="p">,</span> <span class="s">&quot;about&quot;</span><span class="p">,</span> <span class="s">&quot;src&quot;</span><span class="p">)</span> <span class="p">:</span>
				<span class="n">node</span><span class="o">.</span><span class="n">setAttribute</span><span class="p">(</span><span class="s">&quot;about&quot;</span><span class="p">,</span><span class="s">&quot;&quot;</span><span class="p">)</span>
	
	<span class="kn">from</span> <span class="nn">..host</span> <span class="kn">import</span> <span class="n">HostLanguage</span>
	<span class="kn">from</span> <span class="nn">..utils</span> <span class="kn">import</span> <span class="n">has_one_of_attributes</span>
		
	<span class="k">if</span> <span class="ow">not</span> <span class="n">has_one_of_attributes</span><span class="p">(</span><span class="n">root</span><span class="p">,</span> <span class="s">&quot;about&quot;</span><span class="p">)</span> <span class="p">:</span>
		<span class="c"># The situation is a bit complicated: if a @resource is present without anything else, then it sets</span>
		<span class="c"># the subject, ie, should be accepted...</span>
		<span class="k">if</span> <span class="n">has_one_of_attributes</span><span class="p">(</span><span class="n">root</span><span class="p">,</span> <span class="s">&quot;resource&quot;</span><span class="p">,</span> <span class="s">&quot;href&quot;</span><span class="p">,</span> <span class="s">&quot;src&quot;</span><span class="p">)</span> <span class="p">:</span>
			<span class="k">if</span> <span class="n">has_one_of_attributes</span><span class="p">(</span><span class="n">root</span><span class="p">,</span> <span class="s">&quot;rel&quot;</span><span class="p">,</span> <span class="s">&quot;rev&quot;</span><span class="p">,</span><span class="s">&quot;property&quot;</span><span class="p">)</span> <span class="p">:</span>
				<span class="n">root</span><span class="o">.</span><span class="n">setAttribute</span><span class="p">(</span><span class="s">&quot;about&quot;</span><span class="p">,</span><span class="s">&quot;&quot;</span><span class="p">)</span>
		<span class="k">else</span> <span class="p">:</span>
			<span class="n">root</span><span class="o">.</span><span class="n">setAttribute</span><span class="p">(</span><span class="s">&quot;about&quot;</span><span class="p">,</span><span class="s">&quot;&quot;</span><span class="p">)</span>
		
	<span class="k">if</span> <span class="n">options</span><span class="o">.</span><span class="n">host_language</span> <span class="ow">in</span> <span class="p">[</span> <span class="n">HostLanguage</span><span class="o">.</span><span class="n">xhtml</span><span class="p">,</span> <span class="n">HostLanguage</span><span class="o">.</span><span class="n">html5</span><span class="p">,</span> <span class="n">HostLanguage</span><span class="o">.</span><span class="n">xhtml5</span> <span class="p">]</span> <span class="p">:</span>
		<span class="k">if</span> <span class="n">state</span><span class="o">.</span><span class="n">rdfa_version</span> <span class="o">&gt;=</span> <span class="s">&quot;1.1&quot;</span> <span class="p">:</span>
			<span class="k">pass</span>
		<span class="k">else</span> <span class="p">:</span>
			<span class="k">for</span> <span class="n">top</span> <span class="ow">in</span> <span class="n">root</span><span class="o">.</span><span class="n">getElementsByTagName</span><span class="p">(</span><span class="s">&quot;head&quot;</span><span class="p">)</span> <span class="p">:</span>
				<span class="k">if</span> <span class="ow">not</span> <span class="n">has_one_of_attributes</span><span class="p">(</span><span class="n">top</span><span class="p">,</span> <span class="s">&quot;href&quot;</span><span class="p">,</span> <span class="s">&quot;resource&quot;</span><span class="p">,</span> <span class="s">&quot;about&quot;</span><span class="p">,</span> <span class="s">&quot;src&quot;</span><span class="p">)</span> <span class="p">:</span>
					<span class="n">set_about</span><span class="p">(</span><span class="n">top</span><span class="p">)</span>
			<span class="k">for</span> <span class="n">top</span> <span class="ow">in</span> <span class="n">root</span><span class="o">.</span><span class="n">getElementsByTagName</span><span class="p">(</span><span class="s">&quot;body&quot;</span><span class="p">)</span> <span class="p">:</span>
				<span class="k">if</span> <span class="ow">not</span> <span class="n">has_one_of_attributes</span><span class="p">(</span><span class="n">top</span><span class="p">,</span> <span class="s">&quot;href&quot;</span><span class="p">,</span> <span class="s">&quot;resource&quot;</span><span class="p">,</span> <span class="s">&quot;about&quot;</span><span class="p">,</span> <span class="s">&quot;src&quot;</span><span class="p">)</span> <span class="p">:</span>
					<span class="n">set_about</span><span class="p">(</span><span class="n">top</span><span class="p">)</span>

</div>
<div class="viewcode-block" id="empty_safe_curie"><a class="viewcode-back" href="../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.transform.html#rdflib.plugins.parsers.pyRdfa.transform.empty_safe_curie">[docs]</a><span class="k">def</span> <span class="nf">empty_safe_curie</span><span class="p">(</span><span class="n">node</span><span class="p">,</span> <span class="n">options</span><span class="p">,</span> <span class="n">state</span><span class="p">)</span> <span class="p">:</span>
	<span class="sd">&quot;&quot;&quot;</span>
<span class="sd">	Remove the attributes whose value is an empty safe curie. It also adds an &#39;artificial&#39; flag, ie, an</span>
<span class="sd">	attribute (called &#39;emptysc&#39;) into the node to signal that there _is_ an attribute with an ignored</span>
<span class="sd">	safe curie value. The name of the attribute is &#39;about_pruned&#39; or &#39;resource_pruned&#39;.</span>
<span class="sd">	</span>
<span class="sd">	@param node: a DOM node for the top level element</span>
<span class="sd">	@param options: invocation options</span>
<span class="sd">	@type options: L{Options&lt;pyRdfa.options&gt;}</span>
<span class="sd">	@param state: top level execution state</span>
<span class="sd">	@type state: L{State&lt;pyRdfa.state&gt;}</span>
<span class="sd">	&quot;&quot;&quot;</span>
	<span class="k">def</span> <span class="nf">prune_safe_curie</span><span class="p">(</span><span class="n">node</span><span class="p">,</span><span class="n">name</span><span class="p">)</span> <span class="p">:</span>
		<span class="k">if</span> <span class="n">node</span><span class="o">.</span><span class="n">hasAttribute</span><span class="p">(</span><span class="n">name</span><span class="p">)</span> <span class="p">:</span>
			<span class="n">av</span> <span class="o">=</span> <span class="n">node</span><span class="o">.</span><span class="n">getAttribute</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
			<span class="k">if</span> <span class="n">av</span> <span class="o">==</span> <span class="s">&#39;[]&#39;</span> <span class="p">:</span>
				<span class="n">node</span><span class="o">.</span><span class="n">removeAttribute</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
				<span class="n">node</span><span class="o">.</span><span class="n">setAttribute</span><span class="p">(</span><span class="n">name</span><span class="o">+</span><span class="s">&#39;_pruned&#39;</span><span class="p">,</span><span class="s">&#39;&#39;</span><span class="p">)</span>
				<span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Attribute @</span><span class="si">%s</span><span class="s"> uses an empty safe CURIE; the attribute is ignored&quot;</span> <span class="o">%</span> <span class="n">name</span>
				<span class="n">options</span><span class="o">.</span><span class="n">add_warning</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">node</span><span class="o">=</span><span class="n">node</span><span class="p">)</span>
				
	<span class="n">prune_safe_curie</span><span class="p">(</span><span class="n">node</span><span class="p">,</span> <span class="s">&quot;about&quot;</span><span class="p">)</span>
	<span class="n">prune_safe_curie</span><span class="p">(</span><span class="n">node</span><span class="p">,</span> <span class="s">&quot;resource&quot;</span><span class="p">)</span>
	<span class="k">for</span> <span class="n">n</span> <span class="ow">in</span> <span class="n">node</span><span class="o">.</span><span class="n">childNodes</span> <span class="p">:</span>
		<span class="k">if</span> <span class="n">n</span><span class="o">.</span><span class="n">nodeType</span> <span class="o">==</span> <span class="n">node</span><span class="o">.</span><span class="n">ELEMENT_NODE</span> <span class="p">:</span>
			<span class="n">empty_safe_curie</span><span class="p">(</span><span class="n">n</span><span class="p">,</span> <span class="n">options</span><span class="p">,</span> <span class="n">state</span><span class="p">)</span>
			</div>
<div class="viewcode-block" id="vocab_for_role"><a class="viewcode-back" href="../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.transform.html#rdflib.plugins.parsers.pyRdfa.transform.vocab_for_role">[docs]</a><span class="k">def</span> <span class="nf">vocab_for_role</span><span class="p">(</span><span class="n">node</span><span class="p">,</span> <span class="n">options</span><span class="p">,</span> <span class="n">state</span><span class="p">)</span> <span class="p">:</span>
	<span class="sd">&quot;&quot;&quot;</span>
<span class="sd">	The value of the @role attribute (defined separately in the U{Role Attribute Specification Lite&lt;http://www.w3.org/TR/role-attribute/#using-role-in-conjunction-with-rdfa&gt;}) should be as if a @vocab value to the</span>
<span class="sd">	XHTML vocabulary was defined for it. This method turns all terms in role attributes into full URI-s, so that</span>
<span class="sd">	this would not be an issue for the run-time.</span>
<span class="sd">	</span>
<span class="sd">	@param node: a DOM node for the top level element</span>
<span class="sd">	@param options: invocation options</span>
<span class="sd">	@type options: L{Options&lt;pyRdfa.options&gt;}</span>
<span class="sd">	@param state: top level execution state</span>
<span class="sd">	@type state: L{State&lt;pyRdfa.state&gt;}</span>
<span class="sd">	&quot;&quot;&quot;</span>
	<span class="kn">from</span> <span class="nn">..termorcurie</span> <span class="kn">import</span> <span class="n">termname</span><span class="p">,</span> <span class="n">XHTML_URI</span>
	
	<span class="k">def</span> <span class="nf">handle_role</span><span class="p">(</span><span class="n">node</span><span class="p">)</span> <span class="p">:</span>
		<span class="k">if</span> <span class="n">node</span><span class="o">.</span><span class="n">hasAttribute</span><span class="p">(</span><span class="s">&quot;role&quot;</span><span class="p">)</span> <span class="p">:</span>
			<span class="n">old_values</span> <span class="o">=</span> <span class="n">node</span><span class="o">.</span><span class="n">getAttribute</span><span class="p">(</span><span class="s">&quot;role&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">split</span><span class="p">()</span>
			<span class="n">new_values</span> <span class="o">=</span> <span class="s">&quot;&quot;</span>
			<span class="k">for</span> <span class="n">val</span> <span class="ow">in</span> <span class="n">old_values</span> <span class="p">:</span>
				<span class="k">if</span> <span class="n">termname</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">val</span><span class="p">)</span> <span class="p">:</span>
					<span class="n">new_values</span> <span class="o">+=</span> <span class="n">XHTML_URI</span> <span class="o">+</span> <span class="n">val</span> <span class="o">+</span> <span class="s">&#39; &#39;</span>
				<span class="k">else</span> <span class="p">:</span>
					<span class="n">new_values</span> <span class="o">+=</span> <span class="n">val</span> <span class="o">+</span> <span class="s">&#39; &#39;</span>
			<span class="n">node</span><span class="o">.</span><span class="n">setAttribute</span><span class="p">(</span><span class="s">&quot;role&quot;</span><span class="p">,</span> <span class="n">new_values</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span>

	<span class="n">handle_role</span><span class="p">(</span><span class="n">node</span><span class="p">)</span>
	<span class="k">for</span> <span class="n">n</span> <span class="ow">in</span> <span class="n">node</span><span class="o">.</span><span class="n">childNodes</span> <span class="p">:</span>
		<span class="k">if</span> <span class="n">n</span><span class="o">.</span><span class="n">nodeType</span> <span class="o">==</span> <span class="n">node</span><span class="o">.</span><span class="n">ELEMENT_NODE</span> <span class="p">:</span>
			<span class="n">vocab_for_role</span><span class="p">(</span><span class="n">n</span><span class="p">,</span> <span class="n">options</span><span class="p">,</span> <span class="n">state</span><span class="p">)</span>
	
</pre></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> &raquo;</li>
          <li><a href="../../../../index.html" >Module code</a> &raquo;</li>
          <li><a href="../pyRdfa.html" >rdflib.plugins.parsers.pyRdfa</a> &raquo;</li> 
      </ul>
    </div>
<div class="footer">
    &copy; 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>

APT Browse - Built by Thomas Orozco.