| |
- WebKit.Object.Object(__builtin__.object, MiscUtils.NamedValueAccess.NamedValueAccess)
-
- Cookie
class Cookie(WebKit.Object.Object) |
|
Delicious cookies.
Cookie is used to create cookies that have additional attributes
beyond their value.
Note that web browsers don't typically send any information with
the cookie other than it's value. Therefore `HTTPRequest.cookie`
simply returns a value such as an integer or a string.
When the server sends cookies back to the browser, it can send
a cookie that simply has a value, or the cookie can be
accompanied by various attributes (domain, path, max-age, ...)
as described in `RFC 2109`_. Therefore, in HTTPResponse,
`setCookie` can take either an instance of the Cookie class,
as defined in this module, or a value.
Note that Cookies values get pickled (see the `pickle` module),
so you can set and get cookies that are integers, lists,
dictionaries, etc.
.. _`RFC 2109`: ftp://ftp.isi.edu/in-notes/rfc2109.txt |
|
- Method resolution order:
- Cookie
- WebKit.Object.Object
- __builtin__.object
- MiscUtils.NamedValueAccess.NamedValueAccess
Methods defined here:
- __init__(self, name, value)
- Create a cookie.
Properties other than `name` and `value` are set with methods.
- __repr__(self)
- comment(self)
- delete(self)
- Delete a cookie.
When sent, this should delete the cookie from the user's
browser, by making it empty, expiring it in the past,
and setting its max-age to 0. One of these will delete
the cookie for any browser (which one actually works
depends on the browser).
- domain(self)
- expires(self)
- headerValue(self)
- Return header value.
Returns a string with the value that should be used
in the HTTP headers.
- isSecure(self)
- maxAge(self)
- name(self)
- path(self)
- setComment(self, comment)
- setDomain(self, domain)
- setExpires(self, expires)
- setMaxAge(self, maxAge)
- setPath(self, path)
- setSecure(self, secure=True)
- setValue(self, value)
- setVersion(self, version)
- value(self)
- version(self)
Methods inherited from WebKit.Object.Object:
- deprecated(self, method)
- Output a deprecation warning.
The implementation of WebKit sometimes invokes this method which prints
a warning that the method you are using has been deprecated.
This method expects that deprecated methods say so at the beginning of
their doc string and terminate that msg with @. For example:
DEPRECATED: Class.foo() on 01/24/01 in ver 0.5. Use Class.bar() instead. @
Putting this information in the doc string is important for accuracy
in the generated docs.
Example call:
deprecated(self.foo)
Data descriptors inherited from WebKit.Object.Object:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Methods inherited from MiscUtils.NamedValueAccess.NamedValueAccess:
- handleUnknownSetKey(self, key)
- hasValueForKey(self, key)
- Check whether key is available.
Returns true if the key is available, although that does not guarantee
that there will not be errors caused by retrieving the 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().
- valueForKey(self, key, default=<class MiscUtils.NoDefault at 0x8c81d0>)
- Get value for given key.
Suppose key is 'foo'.
This method returns the value with the following precedence:
1. Methods before non-methods
2. Public attributes before private attributes
More specifically, this method then returns one of the following:
* foo()
* _foo()
* self.foo
* self._foo
... or default, if it was specified,
otherwise invokes and returns result of valueForUnknownKey().
Note that valueForUnknownKey() normally returns an exception.
See valueForName() which is a more advanced version of this method
that allows multiple, qualified keys.
- 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 it's 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
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.
| |