Skip to content

bpo-19670: Added SimpleCookie.value_encode/value_decode docs #21017

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
idomic wants to merge 6 commits into
base: main
Choose a base branch
from
Open

bpo-19670: Added SimpleCookie.value_encode/value_decode docs #21017

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2a19acd
Added SimpleCookie.value_encode/value_decode docs
idomic Jun 20, 2020
73d527c
📜🤖 Added by blurb_it.
blurb-it[bot] Jun 20, 2020
9aef9f0
Added doc strings
idomic Jun 20, 2020
c458255
Added doc strings
idomic Jun 21, 2020
74366e0
Fixed typo + reverted the url parse last section
idomic Jun 27, 2020
5ebd3e5
Merge branch 'master' into bpo-19670-cookie
idomic Jun 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions Lib/http/cookies.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -598,15 +598,19 @@ def __parse_string(self, str, patt=_CookiePattern):


class SimpleCookie(BaseCookie):
"""
SimpleCookie supports strings as cookie values. When setting
"""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.
"""
def value_decode(self, val):
"""Return an unquoted string, from the cookie header in a reversed fasion of value_encode.

@aisk aisk Dec 30, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a typo:

Suggested change
"""Return an unquoted string, from the cookie header in a reversed fasion of value_encode.
"""Return an unquoted string, from the cookie header in a reversed fashion of value_encode.

And this line width is larger than 80, we should break it.

"""
return _unquote(val), val

def value_encode(self, val):
"""Return an escaped quoted string, if needed, for the cookie header usage.
Will include non-compliant characters in the cookie value if exist.
"""
strval = str(val)
return strval, _quote(strval)
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Documentation/2020-06-20-19-47-29.bpo-19670.wMt__Y.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
added documentation to `SimpleCookie.value_decode` and `SimpleCookie.value_encode`

@aisk aisk Dec 30, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to the Dev Guide https://devguide.python.org/contrib/core-team/committing/#changes-that-require-news-entries, docs changes don't requires a news entry file.

Loading