Method update

praw/models/reddit/widgets.py:1805–1833

Update the widget. Returns the updated widget. Parameters differ based on the type of widget. See `Reddit documentation `_ or the document of the particular type of widget. :returns: The updated :class:`.Wid

(self, **kwargs: Any)

        self._reddit.delete(path)

    def update(self, **kwargs: Any) -> Widget:
        """Update the widget. Returns the updated widget.

        Parameters differ based on the type of widget. See `Reddit documentation
        <https://www.reddit.com/dev/api#PUT_api_widget_{widget_id}>`_ or the document of
        the particular type of widget.

        :returns: The updated :class:`.Widget`.

        For example, update a text widget like so:

        .. code-block:: python

            text_widget.mod.update(shortName="New text area", text="Hello!")

        .. note::

            Most parameters follow the ``lowerCamelCase`` convention. When in doubt,
            check the Reddit documentation linked above.

        """
        path = API_PATH["widget_modify"].format(subreddit=self._subreddit, widget_id=self.widget.id)
        payload = {key: value for key, value in vars(self.widget).items() if not key.startswith("_")}
        del payload["subreddit"]  # not JSON serializable
        payload.pop("mod", None)
        payload.update(kwargs)
        widget = self._reddit.put(path, data={"json": dumps(payload, cls=WidgetEncoder)})
        widget.subreddit = self._subreddit
        return widget