Cookie 物件¶

BaseCookie.value_decode(val)¶

從字串表示回傳(real_value,coded_value) 的元組。real_value 可以是任何型別。此方法在BaseCookie 中不做解碼 --- 它存在以便可以被覆寫。

BaseCookie.value_encode(val)¶

回傳一個元組(real_value,coded_value)。val 可以是任何型別，但coded_value 總是會被轉換為字串。此方法在BaseCookie 中不做編碼 --- 它存在以便可以被覆寫。

一般來說，value_encode() 和value_decode() 應該在value_decode 的範圍內是互逆的 (inverse)。

BaseCookie.output(attrs=None,header='Set-Cookie:',sep='\r\n')¶

回傳一個適合作為 HTTP 標頭來傳送的字串表示。attrs 和header 會傳送給每個Morsel 的output() 方法。sep 用來連接標頭，預設為'\r\n' (CRLF) 的組合。

BaseCookie.js_output(attrs=None)¶

回傳一個可嵌入的 JavaScript 片段，如果在支援 JavaScript 的瀏覽器上執行，它的行為會與 HTTP 標頭被傳送的情況相同。

attrs 的意義與output() 裡的相同。

BaseCookie.load(rawdata)¶

如果rawdata 是字串，會將其作為HTTP_COOKIE 剖析，並將在其中找到的值當作Morsel 新增。如果它是一個字典，則等同於：

fork,vinrawdata.items():cookie[k]=v

Morsel 物件¶

classhttp.cookies.Morsel¶

抽象化一個鍵 / 值對，它有一些RFC 2109 屬性。

Morsel 是一種類似字典的物件，其鍵的集合是固定的 --- 有效的RFC 2109 屬性，它們是：

expires¶

path¶

comment¶

domain¶

max-age

secure¶

version¶

httponly¶

samesite¶

partitioned¶

屬性httponly 指定 cookie 僅在 HTTP 請求中傳輸，而不可通過 JavaScript 存取。這是為了減輕某些形式的跨網站腳本攻擊。

samesite 屬性控制瀏覽器要在何時將 cookie 與跨網站請求一起傳送，這有助於減輕 CSRF 攻擊。有效值為 "Strict"（僅在同站請求時傳送）、"Lax"（同站請求和頂層導航時傳送）和 "None"（同站請求和跨站請求時傳送）。使用 "None" 時，必須同時設定 "secure" 屬性，這是現代瀏覽器的要求。

The attributepartitioned indicates to user agents that thesecross-site cookiesshould only be available in the same top-level contextthat the cookie was first set in. For this to be accepted by the user agent,youmust also setSecure.

In addition, it is recommended to use the__Host prefix when settingpartitioned cookies to make them bound to the hostname and not theregistrable domain. ReadCHIPS (Cookies Having Independent Partitioned State)for full details and examples.

鍵不區分大小寫，其預設值為''。

在 3.5 版的變更:__eq__() 現在會考慮key 和value。

在 3.7 版的變更:屬性key、value 和coded_value 是唯讀的。請使用set() 來設定它們。

在 3.8 版的變更:新增對samesite 屬性的支援。

在 3.14 版的變更:新增對partitioned 屬性的支援。

Morsel.value¶

cookie 的值。

Morsel.coded_value¶

cookie 的編碼值 --- 這是應該被傳送的值。

Morsel.key¶

cookie 的名稱。

Morsel.set(key,value,coded_value)¶

設定key、value 和coded_value 屬性。

Morsel.isReservedKey(K)¶

K 是否為Morsel 的鍵集合中的成員。

Morsel.output(attrs=None,header='Set-Cookie:')¶

回傳適合作為 HTTP 標頭傳送的 Morsel 的字串表示。預設會包含所有屬性，除非有給定attrs，在此情況下，它應該是一個要使用的屬性的串列。預設的header 是"Set-Cookie:"。

Morsel.js_output(attrs=None)¶

回傳一個可嵌入的 JavaScript 片段，如果在支援 JavaScript 的瀏覽器上執行，它的行為會與 HTTP 標頭被傳送的情況相同。

attrs 的意義與output() 裡的相同。

Morsel.OutputString(attrs=None)¶

回傳表示 Morsel 的字串，不包含周圍任何的 HTTP 或 JavaScript。

attrs 的意義與output() 裡的相同。

Morsel.update(values)¶

更新 Morsel 字典中的值為values 字典中的值。如果values 字典中的任何鍵不是有效的RFC 2109 屬性則引發錯誤。

在 3.5 版的變更:對於無效的鍵會引發錯誤。

Morsel.copy(value)¶

回傳 Morsel 物件的淺層複製。

在 3.5 版的變更:回傳 Morsel 物件而不是字典。

Morsel.setdefault(key,value=None)¶

如果鍵不是一個有效的RFC 2109 屬性會引發錯誤，否則行為與dict.setdefault() 相同。

範例¶

以下範例示範如何使用http.cookies 模組。

>>>fromhttpimportcookies>>>C=cookies.SimpleCookie()>>>C["fig"]="newton">>>C["sugar"]="wafer">>>print(C)# 產生 HTTP 標頭Set-Cookie: fig=newtonSet-Cookie: sugar=wafer>>>print(C.output())# 同上Set-Cookie: fig=newtonSet-Cookie: sugar=wafer>>>C=cookies.SimpleCookie()>>>C["rocky"]="road">>>C["rocky"]["path"]="/cookie">>>print(C.output(header="Cookie:"))Cookie: rocky=road; Path=/cookie>>>print(C.output(attrs=[],header="Cookie:"))Cookie: rocky=road>>>C=cookies.SimpleCookie()>>>C.load("chips=ahoy; vienna=finger")# 從字串（HTTP 標頭）載入>>>print(C)Set-Cookie: chips=ahoySet-Cookie: vienna=finger>>>C=cookies.SimpleCookie()>>>C.load('keebler="E=everybody; L=\\"Loves\\"; fudge=\\012;";')>>>print(C)Set-Cookie: keebler="E=everybody; L=\"Loves\"; fudge=\012;">>>C=cookies.SimpleCookie()>>>C["oreo"]="doublestuff">>>C["oreo"]["path"]="/">>>print(C)Set-Cookie: oreo=doublestuff; Path=/>>>C=cookies.SimpleCookie()>>>C["twix"]="none for you">>>C["twix"].value'none for you'>>>C=cookies.SimpleCookie()>>>C["number"]=7# 等同於 C["number"] = str(7)>>>C["string"]="seven">>>C["number"].value'7'>>>C["string"].value'seven'>>>print(C)Set-Cookie: number=7Set-Cookie: string=seven