| |
- UserDict.UserDict(MiscUtils.NamedValueAccess.NamedValueAccess)
-
- BaseCookie
-
- SerialCookie
- SimpleCookie
- SmartCookie
- exceptions.Exception(exceptions.BaseException)
-
- CookieError
class BaseCookie(UserDict.UserDict) |
|
# At long last, here is the cookie class.
# Using this class is almost just like using a dictionary.
# See this module's docstring for example usage. |
|
- Method resolution order:
- BaseCookie
- UserDict.UserDict
- MiscUtils.NamedValueAccess.NamedValueAccess
Methods defined here:
- __init__(self, input=None)
- __repr__(self)
- __setitem__(self, key, value)
- Dictionary style assignment.
- __str__ = output(self, attrs=None, header='Set-Cookie:', sep='\n')
- js_output(self, attrs=None)
- Return a string suitable for JavaScript.
- load(self, rawdata)
- Load cookies frmo raw data.
Load cookies from a string (presumably HTTP_COOKIE) or
from a dictionary. Loading cookies from a dictionary 'd'
is equivalent to calling:
map(Cookie.__setitem__, d.keys(), d.values())
- output(self, attrs=None, header='Set-Cookie:', sep='\n')
- Return a string suitable for HTTP.
- value_decode(self, val)
- real_value, coded_value = value_decode(STRING)
Called prior to setting a cookie's value from the network
representation. The VALUE is the value read from HTTP
header.
Override this function to modify the behavior of cookies.
- value_encode(self, val)
- real_value, coded_value = value_encode(VALUE)
Called prior to setting a cookie's value from the dictionary
representation. The VALUE is the value being assigned.
Override this function to modify the behavior of cookies.
Methods inherited from UserDict.UserDict:
- __cmp__(self, dict)
- __contains__(self, key)
- __delitem__(self, key)
- __getitem__(self, key)
- __len__(self)
- clear(self)
- copy(self)
- get(self, key, failobj=None)
- hasValueForKey = _UserDict_hasValueForKey(self, key)
- has_key(self, key)
- items(self)
- iteritems(self)
- iterkeys(self)
- itervalues(self)
- keys(self)
- pop(self, key, *args)
- popitem(self)
- setdefault(self, key, failobj=None)
- update(*args, **kwargs)
- valueForKey = _UserDict_valueForKey(self, key, default=<class MiscUtils.NoDefault>)
- values(self)
Class methods inherited from UserDict.UserDict:
- fromkeys(cls, iterable, value=None) from __builtin__.classobj
Data and other attributes inherited from UserDict.UserDict:
- __hash__ = None
Methods inherited from MiscUtils.NamedValueAccess.NamedValueAccess:
- handleUnknownSetKey(self, key)
- hasValueForName(self, keysString)
- Check whether name is available.
- resetKeyBindings(self)
- Rest all key bindings, releasing alreaedy referenced values.
- setValueForKey(self, key, value)
- Set value for a given key.
Suppose key is 'foo'.
This method sets the value with the following precedence:
1. Public attributes before private attributes
2. Methods before non-methods
More specifically, this method then uses one of the following:
@@ 2000-03-04 ce: fill in
... or invokes handleUnknownSetKey().
- valueForKeySequence(self, listOfKeys, default=None)
- Get the value for the given list of keys.
- valueForName(self, keysString, default=None)
- Get the value for the given keysString.
This is the more advanced version of valueForKey(), which can only
handle single names. This method can handle
'foo', 'foo1.foo2', 'a.b.c.d', etc.
It will traverse dictionaries if needed.
- valueForUnknownKey(self, key, default)
- valuesForNames(self, keys, default=None, defaults=None, forgive=0, includeNames=0)
- Get all values for given names.
Returns a list of values that match the given keys, each of which is
passed through valueForName() and so could be of the form 'a.b.c'.
keys and defaults are sequences.
default is any kind of object.
forgive and includeNames are flags.
If default is not None, then it is substituted when a key is not found.
Otherwise, if defaults is not None, then its corresponding/parallel
value for the current key is substituted when a key is not found.
Otherwise, if forgive is true, then unknown keys simply don't produce
any values.
Otherwise, if default and defaults are None, and forgive is false,
then the unknown keys will probably raise an exception through
self.valueForUnknownKey() although that method can always return
a final, default value.
if keys is None, then None is returned.
If keys is an empty list, then None is returned.
Often these last four arguments are specified by key.
Examples:
names = ['origin.x', 'origin.y', 'size.width', 'size.height']
obj.valuesForNames(names)
obj.valuesForNames(names, default=0.0)
obj.valuesForNames(names, defaults=[0.0, 0.0, 100.0, 100.0])
obj.valuesForNames(names, forgive=0)
@@ 2000-03-04 ce: includeNames is only supported when forgive=1.
It should be supported for the other cases.
It should be documented.
It should be included in the test cases.
|
Cookie = class SmartCookie(BaseCookie) |
|
SmartCookie
SmartCookie supports arbitrary objects as cookie values. If the
object is a string, then it is quoted. If the object is not a
string, however, then SmartCookie will use cPickle to serialize
the object into a string representation.
Note: Large cookie values add overhead because they must be
retransmitted on every HTTP transaction.
Note: HTTP has a 2k limit on the size of a cookie. This class
does not check for this limit, so be careful!!! |
|
- Method resolution order:
- SmartCookie
- BaseCookie
- UserDict.UserDict
- MiscUtils.NamedValueAccess.NamedValueAccess
Methods defined here:
- value_decode(self, val)
- value_encode(self, val)
Methods inherited from BaseCookie:
- __init__(self, input=None)
- __repr__(self)
- __setitem__(self, key, value)
- Dictionary style assignment.
- __str__ = output(self, attrs=None, header='Set-Cookie:', sep='\n')
- Return a string suitable for HTTP.
- js_output(self, attrs=None)
- Return a string suitable for JavaScript.
- load(self, rawdata)
- Load cookies frmo raw data.
Load cookies from a string (presumably HTTP_COOKIE) or
from a dictionary. Loading cookies from a dictionary 'd'
is equivalent to calling:
map(Cookie.__setitem__, d.keys(), d.values())
- output(self, attrs=None, header='Set-Cookie:', sep='\n')
- Return a string suitable for HTTP.
Methods inherited from UserDict.UserDict:
- __cmp__(self, dict)
- __contains__(self, key)
- __delitem__(self, key)
- __getitem__(self, key)
- __len__(self)
- clear(self)
- copy(self)
- get(self, key, failobj=None)
- hasValueForKey = _UserDict_hasValueForKey(self, key)
- has_key(self, key)
- items(self)
- iteritems(self)
- iterkeys(self)
- itervalues(self)
- keys(self)
- pop(self, key, *args)
- popitem(self)
- setdefault(self, key, failobj=None)
- update(*args, **kwargs)
- valueForKey = _UserDict_valueForKey(self, key, default=<class MiscUtils.NoDefault>)
- values(self)
Class methods inherited from UserDict.UserDict:
- fromkeys(cls, iterable, value=None) from __builtin__.classobj
Data and other attributes inherited from UserDict.UserDict:
- __hash__ = None
Methods inherited from MiscUtils.NamedValueAccess.NamedValueAccess:
- handleUnknownSetKey(self, key)
- hasValueForName(self, keysString)
- Check whether name is available.
- resetKeyBindings(self)
- Rest all key bindings, releasing alreaedy referenced values.
- setValueForKey(self, key, value)
- Set value for a given key.
Suppose key is 'foo'.
This method sets the value with the following precedence:
1. Public attributes before private attributes
2. Methods before non-methods
More specifically, this method then uses one of the following:
@@ 2000-03-04 ce: fill in
... or invokes handleUnknownSetKey().
- valueForKeySequence(self, listOfKeys, default=None)
- Get the value for the given list of keys.
- valueForName(self, keysString, default=None)
- Get the value for the given keysString.
This is the more advanced version of valueForKey(), which can only
handle single names. This method can handle
'foo', 'foo1.foo2', 'a.b.c.d', etc.
It will traverse dictionaries if needed.
- valueForUnknownKey(self, key, default)
- valuesForNames(self, keys, default=None, defaults=None, forgive=0, includeNames=0)
- Get all values for given names.
Returns a list of values that match the given keys, each of which is
passed through valueForName() and so could be of the form 'a.b.c'.
keys and defaults are sequences.
default is any kind of object.
forgive and includeNames are flags.
If default is not None, then it is substituted when a key is not found.
Otherwise, if defaults is not None, then its corresponding/parallel
value for the current key is substituted when a key is not found.
Otherwise, if forgive is true, then unknown keys simply don't produce
any values.
Otherwise, if default and defaults are None, and forgive is false,
then the unknown keys will probably raise an exception through
self.valueForUnknownKey() although that method can always return
a final, default value.
if keys is None, then None is returned.
If keys is an empty list, then None is returned.
Often these last four arguments are specified by key.
Examples:
names = ['origin.x', 'origin.y', 'size.width', 'size.height']
obj.valuesForNames(names)
obj.valuesForNames(names, default=0.0)
obj.valuesForNames(names, defaults=[0.0, 0.0, 100.0, 100.0])
obj.valuesForNames(names, forgive=0)
@@ 2000-03-04 ce: includeNames is only supported when forgive=1.
It should be supported for the other cases.
It should be documented.
It should be included in the test cases.
|
class SerialCookie(BaseCookie) |
|
SerialCookie
SerialCookie supports arbitrary objects as cookie values. All
values are serialized (using cPickle) before being sent to the
client. All incoming values are assumed to be valid Pickle
representations. IF AN INCOMING VALUE IS NOT IN A VALID PICKLE
FORMAT, THEN AN EXCEPTION WILL BE RAISED.
Note: Large cookie values add overhead because they must be
retransmitted on every HTTP transaction.
Note: HTTP has a 2k limit on the size of a cookie. This class
does not check for this limit, so be careful!!! |
|
- Method resolution order:
- SerialCookie
- BaseCookie
- UserDict.UserDict
- MiscUtils.NamedValueAccess.NamedValueAccess
Methods defined here:
- value_decode(self, val)
- value_encode(self, val)
Methods inherited from BaseCookie:
- __init__(self, input=None)
- __repr__(self)
- __setitem__(self, key, value)
- Dictionary style assignment.
- __str__ = output(self, attrs=None, header='Set-Cookie:', sep='\n')
- Return a string suitable for HTTP.
- js_output(self, attrs=None)
- Return a string suitable for JavaScript.
- load(self, rawdata)
- Load cookies frmo raw data.
Load cookies from a string (presumably HTTP_COOKIE) or
from a dictionary. Loading cookies from a dictionary 'd'
is equivalent to calling:
map(Cookie.__setitem__, d.keys(), d.values())
- output(self, attrs=None, header='Set-Cookie:', sep='\n')
- Return a string suitable for HTTP.
Methods inherited from UserDict.UserDict:
- __cmp__(self, dict)
- __contains__(self, key)
- __delitem__(self, key)
- __getitem__(self, key)
- __len__(self)
- clear(self)
- copy(self)
- get(self, key, failobj=None)
- hasValueForKey = _UserDict_hasValueForKey(self, key)
- has_key(self, key)
- items(self)
- iteritems(self)
- iterkeys(self)
- itervalues(self)
- keys(self)
- pop(self, key, *args)
- popitem(self)
- setdefault(self, key, failobj=None)
- update(*args, **kwargs)
- valueForKey = _UserDict_valueForKey(self, key, default=<class MiscUtils.NoDefault>)
- values(self)
Class methods inherited from UserDict.UserDict:
- fromkeys(cls, iterable, value=None) from __builtin__.classobj
Data and other attributes inherited from UserDict.UserDict:
- __hash__ = None
Methods inherited from MiscUtils.NamedValueAccess.NamedValueAccess:
- handleUnknownSetKey(self, key)
- hasValueForName(self, keysString)
- Check whether name is available.
- resetKeyBindings(self)
- Rest all key bindings, releasing alreaedy referenced values.
- setValueForKey(self, key, value)
- Set value for a given key.
Suppose key is 'foo'.
This method sets the value with the following precedence:
1. Public attributes before private attributes
2. Methods before non-methods
More specifically, this method then uses one of the following:
@@ 2000-03-04 ce: fill in
... or invokes handleUnknownSetKey().
- valueForKeySequence(self, listOfKeys, default=None)
- Get the value for the given list of keys.
- valueForName(self, keysString, default=None)
- Get the value for the given keysString.
This is the more advanced version of valueForKey(), which can only
handle single names. This method can handle
'foo', 'foo1.foo2', 'a.b.c.d', etc.
It will traverse dictionaries if needed.
- valueForUnknownKey(self, key, default)
- valuesForNames(self, keys, default=None, defaults=None, forgive=0, includeNames=0)
- Get all values for given names.
Returns a list of values that match the given keys, each of which is
passed through valueForName() and so could be of the form 'a.b.c'.
keys and defaults are sequences.
default is any kind of object.
forgive and includeNames are flags.
If default is not None, then it is substituted when a key is not found.
Otherwise, if defaults is not None, then its corresponding/parallel
value for the current key is substituted when a key is not found.
Otherwise, if forgive is true, then unknown keys simply don't produce
any values.
Otherwise, if default and defaults are None, and forgive is false,
then the unknown keys will probably raise an exception through
self.valueForUnknownKey() although that method can always return
a final, default value.
if keys is None, then None is returned.
If keys is an empty list, then None is returned.
Often these last four arguments are specified by key.
Examples:
names = ['origin.x', 'origin.y', 'size.width', 'size.height']
obj.valuesForNames(names)
obj.valuesForNames(names, default=0.0)
obj.valuesForNames(names, defaults=[0.0, 0.0, 100.0, 100.0])
obj.valuesForNames(names, forgive=0)
@@ 2000-03-04 ce: includeNames is only supported when forgive=1.
It should be supported for the other cases.
It should be documented.
It should be included in the test cases.
|
class SimpleCookie(BaseCookie) |
|
SimpleCookie
SimpleCookie supports strings as cookie values. When setting
the value using the dictionary assignment notation, SimpleCookie
calls the builtin str() to convert the value to a string. Values
received from HTTP are kept as strings. |
|
- Method resolution order:
- SimpleCookie
- BaseCookie
- UserDict.UserDict
- MiscUtils.NamedValueAccess.NamedValueAccess
Methods defined here:
- value_decode(self, val)
- value_encode(self, val)
Methods inherited from BaseCookie:
- __init__(self, input=None)
- __repr__(self)
- __setitem__(self, key, value)
- Dictionary style assignment.
- __str__ = output(self, attrs=None, header='Set-Cookie:', sep='\n')
- Return a string suitable for HTTP.
- js_output(self, attrs=None)
- Return a string suitable for JavaScript.
- load(self, rawdata)
- Load cookies frmo raw data.
Load cookies from a string (presumably HTTP_COOKIE) or
from a dictionary. Loading cookies from a dictionary 'd'
is equivalent to calling:
map(Cookie.__setitem__, d.keys(), d.values())
- output(self, attrs=None, header='Set-Cookie:', sep='\n')
- Return a string suitable for HTTP.
Methods inherited from UserDict.UserDict:
- __cmp__(self, dict)
- __contains__(self, key)
- __delitem__(self, key)
- __getitem__(self, key)
- __len__(self)
- clear(self)
- copy(self)
- get(self, key, failobj=None)
- hasValueForKey = _UserDict_hasValueForKey(self, key)
- has_key(self, key)
- items(self)
- iteritems(self)
- iterkeys(self)
- itervalues(self)
- keys(self)
- pop(self, key, *args)
- popitem(self)
- setdefault(self, key, failobj=None)
- update(*args, **kwargs)
- valueForKey = _UserDict_valueForKey(self, key, default=<class MiscUtils.NoDefault>)
- values(self)
Class methods inherited from UserDict.UserDict:
- fromkeys(cls, iterable, value=None) from __builtin__.classobj
Data and other attributes inherited from UserDict.UserDict:
- __hash__ = None
Methods inherited from MiscUtils.NamedValueAccess.NamedValueAccess:
- handleUnknownSetKey(self, key)
- hasValueForName(self, keysString)
- Check whether name is available.
- resetKeyBindings(self)
- Rest all key bindings, releasing alreaedy referenced values.
- setValueForKey(self, key, value)
- Set value for a given key.
Suppose key is 'foo'.
This method sets the value with the following precedence:
1. Public attributes before private attributes
2. Methods before non-methods
More specifically, this method then uses one of the following:
@@ 2000-03-04 ce: fill in
... or invokes handleUnknownSetKey().
- valueForKeySequence(self, listOfKeys, default=None)
- Get the value for the given list of keys.
- valueForName(self, keysString, default=None)
- Get the value for the given keysString.
This is the more advanced version of valueForKey(), which can only
handle single names. This method can handle
'foo', 'foo1.foo2', 'a.b.c.d', etc.
It will traverse dictionaries if needed.
- valueForUnknownKey(self, key, default)
- valuesForNames(self, keys, default=None, defaults=None, forgive=0, includeNames=0)
- Get all values for given names.
Returns a list of values that match the given keys, each of which is
passed through valueForName() and so could be of the form 'a.b.c'.
keys and defaults are sequences.
default is any kind of object.
forgive and includeNames are flags.
If default is not None, then it is substituted when a key is not found.
Otherwise, if defaults is not None, then its corresponding/parallel
value for the current key is substituted when a key is not found.
Otherwise, if forgive is true, then unknown keys simply don't produce
any values.
Otherwise, if default and defaults are None, and forgive is false,
then the unknown keys will probably raise an exception through
self.valueForUnknownKey() although that method can always return
a final, default value.
if keys is None, then None is returned.
If keys is an empty list, then None is returned.
Often these last four arguments are specified by key.
Examples:
names = ['origin.x', 'origin.y', 'size.width', 'size.height']
obj.valuesForNames(names)
obj.valuesForNames(names, default=0.0)
obj.valuesForNames(names, defaults=[0.0, 0.0, 100.0, 100.0])
obj.valuesForNames(names, forgive=0)
@@ 2000-03-04 ce: includeNames is only supported when forgive=1.
It should be supported for the other cases.
It should be documented.
It should be included in the test cases.
|
class SmartCookie(BaseCookie) |
|
SmartCookie
SmartCookie supports arbitrary objects as cookie values. If the
object is a string, then it is quoted. If the object is not a
string, however, then SmartCookie will use cPickle to serialize
the object into a string representation.
Note: Large cookie values add overhead because they must be
retransmitted on every HTTP transaction.
Note: HTTP has a 2k limit on the size of a cookie. This class
does not check for this limit, so be careful!!! |
|
- Method resolution order:
- SmartCookie
- BaseCookie
- UserDict.UserDict
- MiscUtils.NamedValueAccess.NamedValueAccess
Methods defined here:
- value_decode(self, val)
- value_encode(self, val)
Methods inherited from BaseCookie:
- __init__(self, input=None)
- __repr__(self)
- __setitem__(self, key, value)
- Dictionary style assignment.
- __str__ = output(self, attrs=None, header='Set-Cookie:', sep='\n')
- Return a string suitable for HTTP.
- js_output(self, attrs=None)
- Return a string suitable for JavaScript.
- load(self, rawdata)
- Load cookies frmo raw data.
Load cookies from a string (presumably HTTP_COOKIE) or
from a dictionary. Loading cookies from a dictionary 'd'
is equivalent to calling:
map(Cookie.__setitem__, d.keys(), d.values())
- output(self, attrs=None, header='Set-Cookie:', sep='\n')
- Return a string suitable for HTTP.
Methods inherited from UserDict.UserDict:
- __cmp__(self, dict)
- __contains__(self, key)
- __delitem__(self, key)
- __getitem__(self, key)
- __len__(self)
- clear(self)
- copy(self)
- get(self, key, failobj=None)
- hasValueForKey = _UserDict_hasValueForKey(self, key)
- has_key(self, key)
- items(self)
- iteritems(self)
- iterkeys(self)
- itervalues(self)
- keys(self)
- pop(self, key, *args)
- popitem(self)
- setdefault(self, key, failobj=None)
- update(*args, **kwargs)
- valueForKey = _UserDict_valueForKey(self, key, default=<class MiscUtils.NoDefault>)
- values(self)
Class methods inherited from UserDict.UserDict:
- fromkeys(cls, iterable, value=None) from __builtin__.classobj
Data and other attributes inherited from UserDict.UserDict:
- __hash__ = None
Methods inherited from MiscUtils.NamedValueAccess.NamedValueAccess:
- handleUnknownSetKey(self, key)
- hasValueForName(self, keysString)
- Check whether name is available.
- resetKeyBindings(self)
- Rest all key bindings, releasing alreaedy referenced values.
- setValueForKey(self, key, value)
- Set value for a given key.
Suppose key is 'foo'.
This method sets the value with the following precedence:
1. Public attributes before private attributes
2. Methods before non-methods
More specifically, this method then uses one of the following:
@@ 2000-03-04 ce: fill in
... or invokes handleUnknownSetKey().
- valueForKeySequence(self, listOfKeys, default=None)
- Get the value for the given list of keys.
- valueForName(self, keysString, default=None)
- Get the value for the given keysString.
This is the more advanced version of valueForKey(), which can only
handle single names. This method can handle
'foo', 'foo1.foo2', 'a.b.c.d', etc.
It will traverse dictionaries if needed.
- valueForUnknownKey(self, key, default)
- valuesForNames(self, keys, default=None, defaults=None, forgive=0, includeNames=0)
- Get all values for given names.
Returns a list of values that match the given keys, each of which is
passed through valueForName() and so could be of the form 'a.b.c'.
keys and defaults are sequences.
default is any kind of object.
forgive and includeNames are flags.
If default is not None, then it is substituted when a key is not found.
Otherwise, if defaults is not None, then its corresponding/parallel
value for the current key is substituted when a key is not found.
Otherwise, if forgive is true, then unknown keys simply don't produce
any values.
Otherwise, if default and defaults are None, and forgive is false,
then the unknown keys will probably raise an exception through
self.valueForUnknownKey() although that method can always return
a final, default value.
if keys is None, then None is returned.
If keys is an empty list, then None is returned.
Often these last four arguments are specified by key.
Examples:
names = ['origin.x', 'origin.y', 'size.width', 'size.height']
obj.valuesForNames(names)
obj.valuesForNames(names, default=0.0)
obj.valuesForNames(names, defaults=[0.0, 0.0, 100.0, 100.0])
obj.valuesForNames(names, forgive=0)
@@ 2000-03-04 ce: includeNames is only supported when forgive=1.
It should be supported for the other cases.
It should be documented.
It should be included in the test cases.
| |