~gary/python-openid/python-openid-2.2.1-patched

<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="openid.consumer.html_parse-module.html" target="_top">no frames</a>]</font></td></tr>

</table></td>

</tr></table>

<h2 class="module">Module openid.consumer.html_parse</h2>

This module implements a VERY limited parser that finds <link>

tags in the head of HTML or XHTML documents and parses out their

attributes according to the OpenID spec. It is a liberal parser, but it

requires these things from the data in order to work:

<ul>

<li>

There must be an open <html> tag

</li>

<li>

There must be an open <head> tag inside of the <html>

tag

</li>

<li>

Only <link>s that are found inside of the <head> tag

are parsed (this is by design)

</li>

<li>

The parser follows the OpenID specification in resolving the

attributes of the link tags. This means that the attributes DO NOT

get resolved as they would by an XML or HTML parser. In particular,

only certain entities get replaced, and href attributes do not get

resolved relative to a base URL.

</li>

</ul>

From http://openid.net/specs.bml#linkrel:

<ul>

<li>

The openid.server URL MUST be an absolute URL. OpenID consumers

MUST NOT attempt to resolve relative URLs.

</li>

<li>

The openid.server URL MUST NOT include entities other than

&amp;, &lt;, &gt;, and &quot;.

</li>

</ul>

<p>The parser ignores SGML comments and <![CDATA[blocks]]>. Both

kinds of quoting are allowed for attributes.</p>

The parser deals with invalid markup in these ways:

<ul>

<li>

Tag names are not case-sensitive

</li>

<li>

The <html> tag is accepted even when it is not at the top

level

</li>

<li>

The <head> tag is accepted even when it is not a direct

child of the <html> tag, but a <html> tag must be an

ancestor of the <head> tag

</li>

<li>

children of the <head> tag, but a <head> tag must be an

ancestor of the <link> tag

100

</li>

101

<li>

102

If there is no closing tag for an open <html> or

103

<head> tag, the remainder of the document is viewed as being

104

inside of the tag. If there is no closing tag for a <link> tag,

105

the link tag is treated as a short tag. Exceptions to this rule are

106

that <html> closes <html> and <body> or

107

<head> closes <head>

108

</li>

109

<li>

110

Attributes of the <link> tag are not required to be

111

quoted.

112

</li>

113

<li>

114

In the case of duplicated attribute names, the attribute coming

115

last in the tag will be the value returned.

116

</li>

117

<li>

118

Any text that does not parse as an attribute within a link tag

119

will be ignored. (e.g. <link pumpkin rel='openid.server' />

120

will ignore pumpkin)

121

</li>

122

<li>

123

If there are more than one <html> or <head> tag, the

124

parser only looks inside of the first one.

125

</li>

126

<li>

127

The contents of <script> tags are ignored entirely, except

128

unclosed <script> tags. Unclosed <script> tags are

129

ignored.

130

</li>

131

<li>

132

Any other invalid markup is ignored, including unclosed SGML

133

comments and unclosed <![CDATA[blocks.

134

</li>

135

</ul>

136

<hr/>

137

138

139

140

141

<th colspan="2">Function Summary</th></tr>

142

<tr><td align="right" valign="top" width="15%"><font size="-1"> [[(type(html), type(html))]]

143

</font></td>

144

<td><code><span class="summary-sig"><a href="openid.consumer.html_parse-module.html#parseLinkAttrs" class="summary-sig-name"><code>parseLinkAttrs</code></a>(<span class=summary-sig-arg>html</span>)</span></code>

145

<br />

146

Find all link tags in a string representing a HTML document and return

147

a list of their attributes.</td></tr>

148

</table><br />

149

150

151

152

153

154

<th colspan="2">Function Details</th></tr>

155

</table>

156

157

158

159

<h3><span class="sig"><span class="sig-name">parseLinkAttrs</span>(<span class=sig-arg>html</span>)</span>

160

</h3>

161

Find all link tags in a string representing a HTML document and

162

return a list of their attributes.

163

164

<dl><dt><b>Parameters:</b></dt>

165

<dd><code><b>html</b></code> -

166

the text to parse

167

168

(type=str or unicode)</i>

169

</dd>

170

</dl>

171

<dl><dt><b>Returns:</b></dt>

172

<dd>

173

A list of dictionaries of attributes, one for each link

174

tag

175

176

(type=[[(type(html), type(html))]])</i>

177

</dd>

178

</dl>

179

</dd></dl>

180

</td></tr></table>

181

<br />

182

183

184

185

186

187

188

<th class="navbar">   <a class="navbar" href="trees.html">Trees</a>   </th>

189

<th class="navbar">   <a class="navbar" href="indices.html">Index</a>   </th>

190

191

192

193

194

195

<a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a>

196

</p></th></tr></table>

197

</th>

198

</tr>

199

</table>

200

201

202

<tr>

203

<td align="left"><font size="-2">Generated by Epydoc 2.1 on Mon Sep 10 13:00:12 2007</font></td>

204

<td align="right"><a href="http://epydoc.sourceforge.net"

205

><font size="-2">http://epydoc.sf.net</font></a></td>

206

</tr>

207

</table>

208

</body>

209

</html>

Older »