<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> <title>11.19.2 Morsel Objects </title> <META NAME="description" CONTENT="11.19.2 Morsel Objects "> <META NAME="keywords" CONTENT="lib"> <META NAME="resource-type" CONTENT="document"> <META NAME="distribution" CONTENT="global"> <meta http-equiv="Content-Type" content="text/html; charset="> <link rel="STYLESHEET" href="lib.css"> <link rel="first" href="lib.html"> <link rel="contents" href="contents.html" title="Contents"> <link rel="index" href="genindex.html" title="Index"> <LINK REL="next" href="cookie-example.html"> <LINK REL="previous" href="cookie-objects.html"> <LINK REL="up" href="module-Cookie.html"> <LINK REL="next" href="cookie-example.html"> </head> <body> <DIV CLASS="navigation"> <table align="center" width="100%" cellpadding="0" cellspacing="2"> <tr> <td><A href="cookie-objects.html"><img src="../icons/previous.gif" border="0" height="32" alt="Previous Page" width="32"></A></td> <td><A href="module-Cookie.html"><img src="../icons/up.gif" border="0" height="32" alt="Up One Level" width="32"></A></td> <td><A href="cookie-example.html"><img src="../icons/next.gif" border="0" height="32" alt="Next Page" width="32"></A></td> <td align="center" width="100%">Python Library Reference</td> <td><A href="contents.html"><img src="../icons/contents.gif" border="0" height="32" alt="Contents" width="32"></A></td> <td><a href="modindex.html" title="Module Index"><img src="../icons/modules.gif" border="0" height="32" alt="Module Index" width="32"></a></td> <td><A href="genindex.html"><img src="../icons/index.gif" border="0" height="32" alt="Index" width="32"></A></td> </tr></table> <b class="navlabel">Previous:</b> <a class="sectref" href="cookie-objects.html">11.19.1 Cookie Objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="module-Cookie.html">11.19 Cookie </A> <b class="navlabel">Next:</b> <a class="sectref" href="cookie-example.html">11.19.3 Example</A> <br><hr> </DIV> <!--End of Navigation Panel--> <H2><A NAME="SECTION00131920000000000000000"> </A> <BR> 11.19.2 Morsel Objects </H2> <P> <dl><dt><b><span class="typelabel">class</span> <a name="l2h-2699"><tt class="class">Morsel</tt></a></b>() <dd> Abstract a key/value pair, which has some <a class="rfc" name="rfcref-63578" href="http://www.faqs.org/rfcs/rfc2109.html">RFC 2109</a> attributes. <P> Morsels are dictionary-like objects, whose set of keys is constant -- the valid <a class="rfc" name="rfcref-63580" href="http://www.faqs.org/rfcs/rfc2109.html">RFC 2109</a> attributes, which are <P> <UL> <LI><code>expires</code> </LI> <LI><code>path</code> </LI> <LI><code>comment</code> </LI> <LI><code>domain</code> </LI> <LI><code>max-age</code> </LI> <LI><code>secure</code> </LI> <LI><code>version</code> </LI> </UL> <P> The keys are case-insensitive. </dl> <P> <dl><dt><b><a name="l2h-2700"><tt class="member">value</tt></a></b> <dd> The value of the cookie. </dl> <P> <dl><dt><b><a name="l2h-2701"><tt class="member">coded_value</tt></a></b> <dd> The encoded value of the cookie -- this is what should be sent. </dl> <P> <dl><dt><b><a name="l2h-2702"><tt class="member">key</tt></a></b> <dd> The name of the cookie. </dl> <P> <dl><dt><b><a name="l2h-2703"><tt class="method">set</tt></a></b>(<var>key, value, coded_value</var>) <dd> Set the <var>key</var>, <var>value</var> and <var>coded_value</var> members. </dl> <P> <dl><dt><b><a name="l2h-2704"><tt class="method">isReservedKey</tt></a></b>(<var>K</var>) <dd> Whether <var>K</var> is a member of the set of keys of a <tt class="class">Morsel</tt>. </dl> <P> <dl><dt><b><a name="l2h-2705"><tt class="method">output</tt></a></b>(<big>[</big><var>attrs</var><big>[</big><var>, header</var><big>]</big><big>]</big>) <dd> Return a string representation of the Morsel, suitable to be sent as an HTTP header. By default, all the attributes are included, unless <var>attrs</var> is given, in which case it should be a list of attributes to use. <var>header</var> is by default <code>"Set-Cookie:"</code>. </dl> <P> <dl><dt><b><a name="l2h-2706"><tt class="method">js_output</tt></a></b>(<big>[</big><var>attrs</var><big>]</big>) <dd> Return an embeddable JavaScript snippet, which, if run on a browser which supports JavaScript, will act the same as if the HTTP header was sent. <P> The meaning for <var>attrs</var> is the same as in <tt class="method">output()</tt>. </dl> <P> <dl><dt><b><a name="l2h-2707"><tt class="method">OutputString</tt></a></b>(<big>[</big><var>attrs</var><big>]</big>) <dd> Return a string representing the Morsel, without any surrounding HTTP or JavaScript. <P> The meaning for <var>attrs</var> is the same as in <tt class="method">output()</tt>. </dl> <P> <DIV CLASS="navigation"> <p><hr> <table align="center" width="100%" cellpadding="0" cellspacing="2"> <tr> <td><A href="cookie-objects.html"><img src="../icons/previous.gif" border="0" height="32" alt="Previous Page" width="32"></A></td> <td><A href="module-Cookie.html"><img src="../icons/up.gif" border="0" height="32" alt="Up One Level" width="32"></A></td> <td><A href="cookie-example.html"><img src="../icons/next.gif" border="0" height="32" alt="Next Page" width="32"></A></td> <td align="center" width="100%">Python Library Reference</td> <td><A href="contents.html"><img src="../icons/contents.gif" border="0" height="32" alt="Contents" width="32"></A></td> <td><a href="modindex.html" title="Module Index"><img src="../icons/modules.gif" border="0" height="32" alt="Module Index" width="32"></a></td> <td><A href="genindex.html"><img src="../icons/index.gif" border="0" height="32" alt="Index" width="32"></A></td> </tr></table> <b class="navlabel">Previous:</b> <a class="sectref" href="cookie-objects.html">11.19.1 Cookie Objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="module-Cookie.html">11.19 Cookie </A> <b class="navlabel">Next:</b> <a class="sectref" href="cookie-example.html">11.19.3 Example</A> <hr> <span class="release-info">Release 2.2, documentation updated on December 21, 2001.</span> </DIV> <!--End of Navigation Panel--> <ADDRESS> See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. </ADDRESS> </BODY> </HTML>
