1
<?xml version="1.0" encoding="iso-8859-1"?>
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
"DTD/xhtml1-transitional.dtd">
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
<title>openid.yadis.accept</title>
7
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
12
<!-- =========== START OF NAVBAR =========== -->
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
15
<th class="navbar"> <a class="navbar" href="openid-module.html">Home</a> </th>
16
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
17
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
18
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
19
<th class="navbar" align="right" width="100%">
20
<table border="0" cellpadding="0" cellspacing="0">
21
<tr><th class="navbar" align="center">
23
<a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a>
24
</p></th></tr></table>
28
<table width="100%" cellpadding="0" cellspacing="0">
31
<font size="-1"><b class="breadcrumbs">
32
<a href="openid-module.html">Package openid</a> ::
33
<a href="openid.yadis-module.html">Package yadis</a> ::
37
<td><table cellpadding="0" cellspacing="0">
38
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="openid.yadis.accept-module.html" target="_top">no frames</a>]</font></td></tr>
42
<!-- =========== START OF MODULE DESCRIPTION =========== -->
43
<h2 class="module">Module openid.yadis.accept</h2>
45
Functions for generating and parsing HTTP Accept: headers for
46
supporting server-directed content negotiation.
49
<!-- =========== START OF FUNCTION SUMMARY =========== -->
50
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
51
<tr bgcolor="#70b0f0" class="summary">
52
<th colspan="2">Function Summary</th></tr>
53
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
54
<td><code><span class="summary-sig"><a href="openid.yadis.accept-module.html#generateAcceptHeader" class="summary-sig-name"><code>generateAcceptHeader</code></a>(<span class="summary-sig-vararg">*elements</span>)</span></code>
56
Generate an accept header value</td></tr>
57
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
58
<td><code><span class="summary-sig"><a href="openid.yadis.accept-module.html#getAcceptable" class="summary-sig-name"><code>getAcceptable</code></a>(<span class=summary-sig-arg>accept_header</span>,
59
<span class=summary-sig-arg>have_types</span>)</span></code>
61
Parse the accept header and return a list of available types in
62
preferred order.</td></tr>
63
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
64
<td><code><span class="summary-sig"><a href="openid.yadis.accept-module.html#matchTypes" class="summary-sig-name"><code>matchTypes</code></a>(<span class=summary-sig-arg>accept_types</span>,
65
<span class=summary-sig-arg>have_types</span>)</span></code>
67
Given the result of parsing an Accept: header, and the available MIME
68
types, return the acceptable types with their quality markdowns.</td></tr>
69
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
70
<td><code><span class="summary-sig"><a href="openid.yadis.accept-module.html#parseAcceptHeader" class="summary-sig-name"><code>parseAcceptHeader</code></a>(<span class=summary-sig-arg>value</span>)</span></code>
72
Parse an accept header, ignoring any accept-extensions</td></tr>
76
<!-- =========== START OF FUNCTION DETAILS =========== -->
77
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
78
<tr bgcolor="#70b0f0" class="details">
79
<th colspan="2">Function Details</th></tr>
82
<a name="generateAcceptHeader"></a>
83
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
84
<h3><span class="sig"><span class="sig-name">generateAcceptHeader</span>(<span class="sig-vararg">*elements</span>)</span>
86
<p>Generate an accept header value</p>
87
[str or (str, float)] -> str
92
<a name="getAcceptable"></a>
93
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
94
<h3><span class="sig"><span class="sig-name">getAcceptable</span>(<span class=sig-arg>accept_header</span>,
95
<span class=sig-arg>have_types</span>)</span>
97
<p>Parse the accept header and return a list of available types in
98
preferred order. If a type is unacceptable, it will not be in the
100
<p>This is a convenience wrapper around matchTypes and
101
parseAcceptHeader.</p>
102
(str, [str]) -> [str]
107
<a name="matchTypes"></a>
108
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
109
<h3><span class="sig"><span class="sig-name">matchTypes</span>(<span class=sig-arg>accept_types</span>,
110
<span class=sig-arg>have_types</span>)</span>
112
<p>Given the result of parsing an Accept: header, and the available
113
MIME types, return the acceptable types with their quality
116
<pre class="doctestblock">
117
<span class="py-src"><span class="py-prompt">>>> </span>acceptable = parseAcceptHeader(<span class="py-string">'text/html, text/plain; q=0.5'</span>)
118
<span class="py-prompt">>>> </span>matchTypes(acceptable, [<span class="py-string">'text/plain'</span>, <span class="py-string">'text/html'</span>, <span class="py-string">'image/jpeg'</span>])</span>
119
<span class="py-output">[('text/html', 1.0), ('text/plain', 0.5)]</span></pre>
120
Type signature: ([(str, str, float)], [str]) -> [(str,
126
<a name="parseAcceptHeader"></a>
127
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
128
<h3><span class="sig"><span class="sig-name">parseAcceptHeader</span>(<span class=sig-arg>value</span>)</span>
130
<p>Parse an accept header, ignoring any accept-extensions</p>
131
<p>returns a list of tuples containing main MIME type, MIME subtype,
132
and quality markdown.</p>
133
str -> [(str, str, float)]
140
<!-- =========== START OF NAVBAR =========== -->
141
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
143
<th class="navbar"> <a class="navbar" href="openid-module.html">Home</a> </th>
144
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
145
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
146
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
147
<th class="navbar" align="right" width="100%">
148
<table border="0" cellpadding="0" cellspacing="0">
149
<tr><th class="navbar" align="center">
151
<a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a>
152
</p></th></tr></table>
157
<table border="0" cellpadding="0" cellspacing="0" width="100%">
159
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Mon Sep 10 13:00:12 2007</font></td>
160
<td align="right"><a href="http://epydoc.sourceforge.net"
161
><font size="-2">http://epydoc.sf.net</font></a></td>
added
removed
doc/openid.yadis.accept-module.html
