Praw

------------------

**Fixed**

- Calling :meth:`.parent` works on :class:`.Comment` instances obtained via
:meth:`.comment_replies`.

------------------

**Added**

- :meth:`.Modmail.unread_count` to get unread count by conversation state.
- :meth:`.Modmail.bulk_read` to mark conversations as read by conversation state.
- :meth:`.Modmail.subreddits` to fetch subreddits using new modmail.
- :meth:`.Modmail.create` to create a new modmail conversation.
- :meth:`.ModmailConversation.read` to mark modmail conversations as read.
- :meth:`.ModmailConversation.unread` to mark modmail conversations as unread.
- :meth:`.conversations` to get new modmail conversations.
- :meth:`.ModmailConversation.highlight` to highlight modmail conversations.
- :meth:`.ModmailConversation.unhighlight` to unhighlight modmail conversations.
- :meth:`.ModmailConversation.mute` to mute modmail conversations.
- :meth:`.ModmailConversation.unmute` to unmute modmail conversations.
- :meth:`.ModmailConversation.archive` to archive modmail conversations.
- :meth:`.ModmailConversation.unarchive` to unarchive modmail conversations.
- :meth:`.ModmailConversation.reply` to reply to modmail conversations.
- :meth:`.Modmail.__call__` to get a new modmail conversation.
- :meth:`.Inbox.stream` to stream new items in the inbox.
- Exponential request delay to all streams when no new items are returned in a request.
The maximum delay between requests is 66 seconds.

**Changed**

- :meth:`~.Subreddit.submit` accepts ``selftext=''`` to create a title-only submission.
- :class:`.Reddit` accepts ``requestor_class=cls`` for a customized requestor class and
``requestor_kwargs={"param": value}`` for passing arguments to requestor
initialization.
- :meth:`.SubredditStream.comments`, :meth:`.SubredditStream.submissions`, and
:meth:`.Subreddits.stream` accept a ``pause_after`` argument to allow pausing of the
stream. The default value of ``None`` retains the preexisting behavior.

**Deprecated**

- ``cloudsearch`` will no longer be the default syntax for :meth:`.Subreddit.search` in
PRAW 5. Instead, ``lucene`` will be the default syntax so that PRAW's default is
aligned with Reddit's default.

**Fixed**

- Fix bug where :class:`.WikiPage` revisions with deleted authors caused ``TypeError``.
- :class:`.Submission` attributes ``comment_limit`` and ``comment_sort`` maintain their
values after making instances non-lazy.

------------------

**Added**

- :meth:`.LiveThreadContribution.update` to update settings of a live thread.
- ``reset_timestamp`` to :meth:`.limits` to provide insight into when the current rate
limit window will expire.
- :meth:`.upload_mobile_header` to upload subreddit mobile header.
- :meth:`.upload_mobile_icon` to upload subreddit mobile icon.
- :meth:`.delete_mobile_header` to remove subreddit mobile header.
- :meth:`.delete_mobile_icon` to remove subreddit mobile icon.
- :meth:`.LiveUpdateContribution.strike` to strike a content of a live thread.
- :meth:`.LiveContributorRelationship.update` to update contributor permissions for a
redditor.
- :meth:`.LiveContributorRelationship.update_invite` to update contributor invite
permissions for a redditor.
- :meth:`.LiveThread.discussions` to get submissions linking to the thread.
- :meth:`.LiveThread.report` to report the thread violating the Reddit rules.
- :meth:`.LiveHelper.now` to get the currently featured live thread.
- :meth:`.LiveHelper.info` to fetch information about each live thread in live thread
IDs.

**Fixed**

- Uploading an image resulting in too large of a request (>500 KB) now raises
``prawcore.TooLarge`` instead of an :py:class:`AssertionError`.
- Uploading an invalid image raises ``APIException``.
- :class:`.Redditor` instances obtained via :attr:`~.Subreddit.moderator` (e.g.,
``reddit.subreddit("test").moderator()``) will contain attributes with the
relationship metadata (e.g., ``mod_permissions``).
- :class:`.Message` instances retrieved from the inbox now have attributes ``author``,
``dest`` ``replies`` and ``subreddit`` properly converted to their appropriate PRAW
model.

------------------

**Added**

- :meth:`.LiveContributorRelationship.leave` to abdicate the live thread contributor
position.
- :meth:`.LiveContributorRelationship.remove` to remove the redditor from the live
thread contributors.
- :meth:`.limits` to provide insight into number of requests made and remaining in the
current rate limit window.
- :attr:`.LiveThread.contrib` to obtain an instance of :class:`.LiveThreadContribution`.
- :meth:`.LiveThreadContribution.add` to add an update to the live thread.
- :meth:`.LiveThreadContribution.close` to close the live thread permanently.
- :attr:`.LiveUpdate.contrib` to obtain an instance of :class:`.LiveUpdateContribution`.
- :meth:`.LiveUpdateContribution.remove` to remove a live update.
- :meth:`.LiveContributorRelationship.accept_invite` to accept an invite to contribute
the live thread.
- :meth:`.SubredditHelper.create` and :meth:`.SubredditModeration.update` have
documented support for ``spoilers_enabled``. Note, however, that
:meth:`.SubredditModeration.update` will currently unset the ``spoilers_enabled``
value until such a time that Reddit returns the value along with the other settings.
- :meth:`.spoiler` and :meth:`.unspoiler` to change a submission's spoiler status.

**Fixed**

- :meth:`.LiveContributorRelationship.invite` and
:meth:`.LiveContributorRelationship.remove_invite` now hit endpoints, which starts
with "api/", for consistency.
- :meth:`.ModeratorRelationship.update`, and
:meth:`.ModeratorRelationship.update_invite` now always remove known unlisted
permissions.

------------------

**Added**

- ``.Subreddit.rules`` to get the rules of a subreddit.
- :class:`.LiveContributorRelationship`, which can be obtained through
:attr:`.LiveThread.contributor`, to interact with live threads' contributors.
- :meth:`~.ModeratorRelationship.remove_invite` to remove a moderator invite.
- :meth:`.LiveContributorRelationship.invite` to send a contributor invitation.
- :meth:`.LiveContributorRelationship.remove_invite` to remove the contributor
invitation.

**Deprecated**

- Return values from :meth:`.Comment.block`, :meth:`.Message.block`,
:meth:`.SubredditMessage.block`, :meth:`.SubredditFlair.delete`, :meth:`.friend`,
:meth:`.Redditor.message`, :meth:`.Subreddit.message`, :meth:`.select`, and
:meth:`.unfriend` will be removed in PRAW 5 as they do not provide any useful
information.

**Fixed**

- :meth:`.hide` and :meth:`.unhide` now accept a list of additional submissions.
- :meth:`.replace_more` is now recoverable. Previously, when an exception was raised
during the work done by :meth:`.replace_more`, all unreplaced :class:`.MoreComments`
instances were lost. Now :class:`.MoreComments` instances are only removed once their
children have been added to the :class:`.CommentForest` enabling callers of
:meth:`.replace_more` to call the method as many times as required to complete the
replacement.
- Working with contributors on :class:`.SubredditWiki` is done consistently through
``contributor`` not ``contributors``.
- ``Subreddit.moderator()`` works.
- ``live_thread.contributor()`` now returns :class:`.RedditorList` correctly.

**Removed**

- ``validate_time_filter`` is no longer part of the public interface.

------------------

**Added**

- :meth:`.Subreddits.search_by_topic` to search subreddits by topic. (see:
https://www.reddit.com/dev/api/#GET_api_subreddits_by_topic).
- :meth:`.LiveHelper.__call__` to provide interface to
``praw.models.LiveThread.__init__``.
- :class:`.SubredditFilters` to work with filters for special subreddits, like
``r/all``.
- Added callables for :class:`.SubredditRelationship` and :class:`.SubredditFlair` so
that ``limit`` and other parameters can be passed.
- Add :meth:`.Message.reply` to :class:`.Message` which was accidentally missed
previously.
- Add ``sticky`` parameter to :meth:`.CommentModeration.distinguish` to sticky comments.
- :meth:`.Submission.flair` to add a submission's flair from an instance of
:class:`.Submission`.
- :meth:`.Comment.parent` to obtain the parent of a :class:`.Comment`.
- :meth:`.opt_in` and :meth:`.opt_out` to :class:`.Subreddit` to permit working with
quarantined subreddits.
- :class:`.LiveUpdate` to represent an individual update in a :class:`.LiveThread`.
- Ability to access an individual :class:`.LiveUpdate` via
``reddit.live("THREAD_ID")["UPDATE_ID"]``.
- :meth:`.LiveThread.updates` to iterate the updates of the thread.

**Changed**

- :meth:`.me` now caches its result in order to reduce redundant requests for methods
that depend on it. Set ``use_cache=False`` when calling to bypass the cache.
- :meth:`.replace_more` can be called on :class:`.Comment` ``replies``.

**Deprecated**

- ``validate_time_filter`` will be removed from the public interface in PRAW 4.2 as it
was never intended to be part of it to begin with.
- Iterating directly over :class:`.SubredditRelationship` (e.g., ``subreddit.banned``,
``subreddit.contributor``, ``subreddit.moderator``, etc) and :class:`.SubredditFlair`
will be removed in PRAW 5. Iterate instead over their callables, e.g.
``subreddit.banned()`` and ``subreddit.flair()``.
- The following methods are deprecated to be removed in PRAW 5 and are replaced with
similar ``Comment.mod...`` and ``Submission.mod...`` alternatives:
``Subreddit.mod.approve``, ``Subreddit.mod.distinguish``,
``Subreddit.mod.ignore_reports``, ``Subreddit.mod.remove``,
``Subreddit.mod.undistinguish``, ``Subreddit.mod.unignore_reports``.
- Support for passing a :class:`.Submission` to :meth:`.SubredditFlair.set` will be
removed in PRAW 5. Use :meth:`.Submission.flair` instead.
- The ``thing`` argument to :meth:`.SubredditFlair.set` is replaced with ``redditor``
and will be removed in PRAW 5.

**Fixed**

- :meth:`.SubredditModeration.update` accurately updates ``exclude_banned_modqueue``,
``header_hover_text``, ``show_media`` and ``show_media_preview`` values.
- Instances of :class:`.Comment` obtained through the inbox (including mentions) are now
refreshable.
- Searching ``r/all`` should now work as intended for all users.
- Accessing an invalid attribute on an instance of :class:`.Message` will raise
:py:class:`AttributeError` instead of :class:`.PRAWException`.