<!DOCTYPE html PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN">
<link rel=
"STYLESHEET" href=
"lib.css" type='text/css'
/>
<link rel=
"SHORTCUT ICON" href=
"../icons/pyfav.png" type=
"image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index'
/>
<link rel=
"first" href=
"lib.html" title='Python Library Reference'
/>
<link rel='contents' href='contents.html'
title=
"Contents" />
<link rel='index' href='genindex.html' title='Index'
/>
<link rel='last' href='about.html' title='About this document...'
/>
<link rel='help' href='about.html' title='About this document...'
/>
<link rel=
"next" href=
"cookie-example.html" />
<link rel=
"prev" href=
"cookie-objects.html" />
<link rel=
"parent" href=
"module-Cookie.html" />
<link rel=
"next" href=
"cookie-example.html" />
<meta name='aesop' content='information'
/>
<title>11.21.2 Morsel Objects
</title>
<div id='top-navigation-panel' xml:id='top-navigation-panel'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"11.21.1 Cookie Objects"
href=
"cookie-objects.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"11.21 Cookie "
href=
"module-Cookie.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"11.21.3 Example"
href=
"cookie-example.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"cookie-objects.html">11.21.1 Cookie Objects
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"module-Cookie.html">11.21 Cookie
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"cookie-example.html">11.21.3 Example
</A>
<!--End of Navigation Panel-->
<H2><A NAME=
"SECTION00132120000000000000000"></A><A NAME=
"morsel-objects"></A>
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><span class=
"typelabel">class
</span> <tt id='l2h-
3688' xml:id='l2h-
3688'
class=
"class">Morsel
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Abstract a key/value pair, which has some
<a class=
"rfc" id='rfcref-
90583' xml:id='rfcref-
90583'
href=
"http://www.faqs.org/rfcs/rfc2109.html">RFC
2109</a> attributes.
Morsels are dictionary-like objects, whose set of keys is constant --
the valid
<a class=
"rfc" id='rfcref-
90585' xml:id='rfcref-
90585'
href=
"http://www.faqs.org/rfcs/rfc2109.html">RFC
2109</a> attributes, which are
The keys are case-insensitive.
<dl><dt><b><tt id='l2h-
3689' xml:id='l2h-
3689'
class=
"member">value
</tt></b></dt>
<dl><dt><b><tt id='l2h-
3690' xml:id='l2h-
3690'
class=
"member">coded_value
</tt></b></dt>
The encoded value of the cookie -- this is what should be sent.
<dl><dt><b><tt id='l2h-
3691' xml:id='l2h-
3691'
class=
"member">key
</tt></b></dt>
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3692' xml:id='l2h-
3692'
class=
"method">set
</tt></b>(
</nobr></td>
<td><var>key, value, coded_value
</var>)
</td></tr></table></dt>
Set the
<var>key
</var>,
<var>value
</var> and
<var>coded_value
</var> members.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3693' xml:id='l2h-
3693'
class=
"method">isReservedKey
</tt></b>(
</nobr></td>
<td><var>K
</var>)
</td></tr></table></dt>
Whether
<var>K
</var> is a member of the set of keys of a
<tt class=
"class">Morsel
</tt>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3694' xml:id='l2h-
3694'
class=
"method">output
</tt></b>(
</nobr></td>
<td><var></var><big>[
</big><var>attrs
</var><big>[
</big><var>, header
</var><big>]
</big><var></var><big>]
</big><var></var>)
</td></tr></table></dt>
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><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3695' xml:id='l2h-
3695'
class=
"method">js_output
</tt></b>(
</nobr></td>
<td><var></var><big>[
</big><var>attrs
</var><big>]
</big><var></var>)
</td></tr></table></dt>
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.
The meaning for
<var>attrs
</var> is the same as in
<tt class=
"method">output()
</tt>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3696' xml:id='l2h-
3696'
class=
"method">OutputString
</tt></b>(
</nobr></td>
<td><var></var><big>[
</big><var>attrs
</var><big>]
</big><var></var>)
</td></tr></table></dt>
Return a string representing the Morsel, without any surrounding HTTP
The meaning for
<var>attrs
</var> is the same as in
<tt class=
"method">output()
</tt>.
<div class='online-navigation'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"11.21.1 Cookie Objects"
href=
"cookie-objects.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"11.21 Cookie "
href=
"module-Cookie.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"11.21.3 Example"
href=
"cookie-example.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"cookie-objects.html">11.21.1 Cookie Objects
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"module-Cookie.html">11.21 Cookie
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"cookie-example.html">11.21.3 Example
</A>
<span class=
"release-info">Release
2.4.2, documentation updated on
28 September
2005.
</span>
<!--End of Navigation Panel-->
See
<i><a href=
"about.html">About this document...
</a></i> for information on suggesting changes.