[Python-checkins] gh-61105: Add default param, note on using cookiejar subclass (GH-95427)

miss-islington webhook-mailer at python.org
Fri Oct 7 22:00:41 EDT 2022


https://github.com/python/cpython/commit/1a31799d168d6f75ed0db89b5ea7cefda74be37b
commit: 1a31799d168d6f75ed0db89b5ea7cefda74be37b
branch: 3.10
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2022-10-07T19:00:35-07:00
summary:

gh-61105: Add default param, note on using cookiejar subclass (GH-95427)

(cherry picked from commit 5eaf4d610147a3b9adc91a55790096d05bbe01d4)

Co-authored-by: Stanley <46876382+slateny at users.noreply.github.com>

files:
M Doc/library/http.cookiejar.rst

diff --git a/Doc/library/http.cookiejar.rst b/Doc/library/http.cookiejar.rst
index 1ce24c676182..3bdf9b5ead74 100644
--- a/Doc/library/http.cookiejar.rst
+++ b/Doc/library/http.cookiejar.rst
@@ -61,7 +61,7 @@ The following classes are provided:
    responsible for storing and retrieving cookies from a file or database.
 
 
-.. class:: FileCookieJar(filename, delayload=None, policy=None)
+.. class:: FileCookieJar(filename=None, delayload=None, policy=None)
 
    *policy* is an object implementing the :class:`CookiePolicy` interface.  For the
    other arguments, see the documentation for the corresponding attributes.
@@ -71,6 +71,8 @@ The following classes are provided:
    :meth:`load` or :meth:`revert` method is called.  Subclasses of this class are
    documented in section :ref:`file-cookie-jar-classes`.
 
+   This should not be initialized directly – use its subclasses below instead.
+
    .. versionchanged:: 3.8
 
       The filename parameter supports a :term:`path-like object`.
@@ -317,7 +319,7 @@ FileCookieJar subclasses and co-operation with web browsers
 The following :class:`CookieJar` subclasses are provided for reading and
 writing.
 
-.. class:: MozillaCookieJar(filename, delayload=None, policy=None)
+.. class:: MozillaCookieJar(filename=None, delayload=None, policy=None)
 
    A :class:`FileCookieJar` that can load from and save cookies to disk in the
    Mozilla ``cookies.txt`` file format (which is also used by curl and the Lynx
@@ -338,7 +340,7 @@ writing.
    Mozilla.
 
 
-.. class:: LWPCookieJar(filename, delayload=None, policy=None)
+.. class:: LWPCookieJar(filename=None, delayload=None, policy=None)
 
    A :class:`FileCookieJar` that can load from and save cookies to disk in format
    compatible with the libwww-perl library's ``Set-Cookie3`` file format.  This is



More information about the Python-checkins mailing list