Implements the standard rules for accepting and returning cookies.
Both RFC 2965 and Netscape cookies are covered. RFC 2965 handling is switched off by default.
The easiest way to provide your own policy is to override this class and call its methods in your overridden implementations before adding your own additional checks:
import cookielib class MyCookiePolicy(cookielib.DefaultCookiePolicy): def set_ok(self, cookie, request): if not cookielib.DefaultCookiePolicy.set_ok(self, cookie, request): return False if i_dont_want_to_store_this_cookie(cookie): return False return True
In addition to the features required to implement the CookiePolicy interface, this class allows you to block and allow domains from setting and receiving cookies. There are also some strictness switches that allow you to tighten up the rather loose Netscape protocol rules a little bit (at the cost of blocking some benign cookies).
A domain blacklist and whitelist is provided (both off by default). Only domains not in the blacklist and present in the whitelist (if the whitelist is active) participate in cookie setting and returning. Use the blocked_domains constructor argument, and blocked_domains() and set_blocked_domains() methods (and the corresponding argument and methods for allowed_domains). If you set a whitelist, you can turn it off again by setting it to None.
Domains in block or allow lists that do not start with a dot must
equal the cookie domain to be matched. For example,
"example.com" matches a blacklist entry of
"www.example.com" does not. Domains
that do start with a dot are matched by more specific domains too.
For example, both
"example.com" itself does not). IP addresses are an exception,
and must match exactly. For example, if blocked_domains contains
".168.1.2", 192.168.1.2 is blocked,
but 22.214.171.124 is not.
DefaultCookiePolicy implements the following additional methods:
DefaultCookiePolicy instances have the following attributes, which are all initialised from the constructor arguments of the same name, and which may all be assigned to.
General strictness switches:
.co.nz.etc. This is far from perfect and isn't guaranteed to work!
RFC 2965 protocol strictness switches:
Netscape protocol strictness switches:
strict_ns_domain is a collection of flags. Its value is
constructed by or-ing together (for example,
DomainStrictNoDots|DomainStrictNonDomain means both flags are
www.foo.bar.comcan't set a cookie for
www.foocontains a dot).
domaincookie-attribute can only be returned to a domain equal to the domain that set the cookie (eg.
spam.example.comwon't be returned cookies from
example.comthat had no
The following attributes are provided for convenience, and are the most useful combinations of the above flags:
See About this document... for information on suggesting changes.