:right-sidebar: True

CookieJarText
===================================================================

.. currentmodule:: gi.repository.Soup





.. class:: CookieJarText(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.Soup.CookieJar`, :class:`~gi.repository.GObject.Object`



Implemented Interfaces: :class:`~gi.repository.Soup.SessionFeature`



Text-file-based ("cookies.txt") Cookie Jar

``SoupCookieJarText`` is a :obj:`~gi.repository.Soup.CookieJar` that reads cookies from and writes
them to a text file in format similar to Mozilla's "cookies.txt".


Constructors
------------

.. rst-class:: interim-class

.. class:: CookieJarText
   :no-index:


   .. classmethod:: new(filename: str, read_only: bool) -> ~gi.repository.Soup.CookieJar

      Creates a ``SoupCookieJarText``.

      ``filename`` will be read in at startup to create an initial set of cookies. If
      ``read_only`` is :const:`False`, then the non-session cookies will be written to
      ``filename`` when the :obj:`~gi.repository.Soup.CookieJar.signals.changed` signal is emitted from the
      jar. (If ``read_only`` is :const:`True`, then the cookie jar will only be used for this
      session, and changes made to it will be lost when the jar is destroyed.)






      :param filename: the filename to read to/write from

      :param read_only: :const:`True` if ``filename`` is read-only










Properties
----------

.. rst-class:: interim-class

.. class:: CookieJarText
   :no-index:
   

   .. attribute:: props.filename
      :type: str

      The type of the None singleton.