8000 gh-101100: Fix Sphinx warning in library/http.cookies.rst by hugovk · Pull Request #112908 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-101100: Fix Sphinx warning in library/http.cookies.rst #112908

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

Merged
merged 3 commits into from
Dec 10, 2023
Merged

gh-101100: Fix Sphinx warning in library/http.cookies.rst #112908

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3b303d1
Fix Sphinx warning in library/http.cookies.rst
hugovk Dec 9, 2023
d9ec706
MSIE 3 in past tense, lowercase cookie, formatting
hugovk Dec 9, 2023
b88747a
Apply suggestions from code review
hugovk Dec 10, 2023
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
40 changes: 20 additions & 20 deletions Doc/library/http.cookies.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,16 @@ cookie value.

The module formerly strictly applied the parsing rules described in the
:rfc:`2109` and :rfc:`2068` specifications. It has since been discovered that
MSIE 3.0x doesn't follow the character rules outlined in those specs and also
many current day browsers and servers have relaxed parsing rules when comes to
Cookie handling. As a result, the parsing rules used are a bit less strict.
MSIE 3.0x didn't follow the character rules outlined in those specs and also
many current day browsers and servers have relaxed parsing rules when it comes to
cookie handling. As a result, the parsing rules used are a bit less strict.

The character set, :data:`string.ascii_letters`, :data:`string.digits` and
``!#$%&'*+-.^_`|~:`` denote the set of valid characters allowed by this module
in Cookie name (as :attr:`~Morsel.key`).
in a cookie name (as :attr:`~Morsel.key`).

.. versionchanged:: 3.3
Allowed ':' as a valid Cookie name character.
Allowed ':' as a valid cookie name character.


.. note::
Expand All @@ -54,9 +54,9 @@ in Cookie name (as :attr:`~Morsel.key`).

.. class:: SimpleCookie([input])

This class derives from :class:`BaseCookie` and overrides :meth:`value_decode`
and :meth:`value_encode`. SimpleCookie supports strings as cookie values.
When setting the value, SimpleCookie calls the builtin :func:`str()` to convert
This class derives from :class:`BaseCookie` and overrides :meth:`~BaseCookie.value_decode`
and :meth:`~BaseCookie.value_encode`. SimpleCookie supports strings as cookie values.
When setting the value, :class:`!SimpleCookie` calls the builtin :func:`str()` to convert
the value to a string. Values received from HTTP are kept as strings.

.. seealso::
Expand Down Expand Up @@ -129,17 +129,17 @@ Morsel Objects
Abstract a key/value pair, which has some :rfc:`2109` attributes.

Morsels are dictionary-like objects, whose set of keys is constant --- the valid
:rfc:`2109` attributes, which are

* ``expires``
* ``path``
* ``comment``
* ``domain``
* ``max-age``
* ``secure``
* ``version``
* ``httponly``
* ``samesite``
:rfc:`2109` attributes, which are:

* .. attribute:: expires
* .. attribute:: path
* .. attribute:: comment
* .. attribute:: domain
* .. attribute:: max-age
* .. attribute:: secure
* .. attribute:: version
* .. attribute:: httponly
* .. attribute:: samesite

The attribute :attr:`httponly` specifies that the cookie is only transferred
in HTTP requests, and is not accessible through JavaScript. This is intended
Expand All @@ -152,7 +152,7 @@ Morsel Objects
The keys are case-insensitive and their default value is ``''``.

.. versionchanged:: 3.5
:meth:`~Morsel.__eq__` now takes :attr:`~Morsel.key` and :attr:`~Morsel.value`
:meth:`!__eq__` now takes :attr:`~Morsel.key` and :attr:`~Morsel.value`
into account.

.. versionchanged:: 3.7
Expand Down
1 change: 0 additions & 1 deletion Doc/tools/.nitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ Doc/library/ftplib.rst
Doc/library/functools.rst
Doc/library/http.client.rst
Doc/library/http.cookiejar.rst
Doc/library/http.cookies.rst
Doc/library/http.server.rst
Doc/library/importlib.rst
Doc/library/inspect.rst
Expand Down
0