Change Log

asyncpraw follows semantic versioning.

8.0.0 (2026/06/14)

Added

• Announcement and AnnouncementHelper, exposed as Reddit.announcements, for listing, hiding, and marking the currently authenticated user’s announcements as read. Provides Announcement.hide(), Announcement.mark_read(), AnnouncementHelper.hide(), AnnouncementHelper.mark_read(), and AnnouncementHelper.mark_all_read(). Announcement.sent_datetime and Announcement.read_datetime return the announcement’s sent_at and read_at timestamps as timezone-aware datetime.datetime objects (read_datetime is None for unread announcements).

• created_datetime to objects with a creation time (for example Comment, Submission, Redditor, Subreddit, Collection, and ModNote), returning a timezone-aware datetime.datetime.

• updated_datetime to Collection, voting_end_datetime to PollData, and edited_datetime to Comment and Submission (None when the object has not been edited), all returning timezone-aware datetime.datetime objects.

• An exception_handler keyword argument to stream_generator() (and thus all stream methods) that is invoked with any exception raised while fetching items, allowing the stream to resume rather than terminate. Re-raise from the handler to stop the stream.

• Warn when a praw.ini in the current working directory sets the oauth_url or reddit_url endpoint, as such a file can redirect credentials to an untrusted host. The warning can be silenced by setting the PRAW_ALLOW_ENDPOINT_OVERRIDE environment variable.

• Redditor.overview() to iterate over a Redditor’s combined comments and submissions, mirroring the user overview page on Reddit.

• Add support for Python 3.13.

• Add support for Python 3.14.

• Add support for optional Markdown-formatted selftext when submitting link, image, gallery and video posts.

• Add Media and its subclasses EmojiMedia, PostMedia, StylesheetAsset, StylesheetImage, and WidgetMedia to consolidate media uploads. Media can be constructed from a file path, or from bytes content along with a name, so media no longer has to be written to disk before uploading.

• Support delayed session creation in asyncprawcore 2.5.0+.

• Add parameter fetch to get_rule() to control whether to fetch the rule data when initializing the rule object.

• A py.typed marker (PEP 561) so that downstream projects can type check against Async PRAW’s inline annotations.

Changed

• Drop support for Python 3.9, which was end-of-life on 2025-10-31.

• Require asyncprawcore >=3.1.0, <4 for its public Session and authorizer accessors and the widened Session.request() annotations, which let Async PRAW drop a number of internal casts and type-checker suppressions.

• Require update_checker[async] >=1.0, <2.0 and perform the update check using its native async API on the first request, instead of a blocking call during Reddit initialization. The 1.0 release is dependency-free, dropping requests from Async PRAW’s transitive dependencies.

• Drop support for Python 3.8, which was end-of-life on 2024-10-07.

• Change Reddit.user.me to raise ReadOnlyException when called in read_only mode.

• The subreddit attribute of Redditor is a UserSubreddit instance.

• The data argument to Objector.objectify must now be passed by keyword.

• The mark_read argument to subreddit.modmail (ModmailConversation) must now be passed by keyword.

• The flair_type argument to SubredditFlairTemplates must be passed by keyword.

• The selftext and url arguments to Subreddit.submit() are no longer mutually exclusive. When url is provided selftext will be used as optional body text to accompany the link submission. An exception is raised when trying to use inline_media with selftext for a url submission because Reddit does not support inline media in body text for link submissions.

• Subreddit.submit_gallery, Subreddit.submit_image, Subreddit.submit_poll, and Subreddit.submit_video have been merged into Subreddit.submit(). The kind of submission is selected with the gallery, image, poll, url, or video keyword argument. At least one of those, or selftext, must be provided, and they are mutually exclusive, while selftext may accompany any of them as optional Markdown-formatted body text. image takes a PostMedia instance; gallery takes a list of PostMedia instances or dicts with a media key; video takes a PostMedia instance or a dict with a media key and optional gif and thumbnail keys; and poll takes a dict with duration and options keys.

• Media upload methods now accept Media instances instead of file paths:

  • The image_path argument to SubredditEmoji.add() has been replaced by media, which takes an EmojiMedia instance.

  • The image_path arguments to the SubredditStylesheet upload_* methods have been replaced by media, which must be passed positionally. SubredditStylesheet.upload(), SubredditStylesheet.upload_header(), SubredditStylesheet.upload_mobile_header(), and SubredditStylesheet.upload_mobile_icon() take a StylesheetImage instance, while SubredditStylesheet.upload_banner(), SubredditStylesheet.upload_banner_additional_image(), SubredditStylesheet.upload_banner_hover_image(), and SubredditStylesheet.upload_mobile_banner() take a StylesheetAsset instance.

  • The file_path argument to SubredditWidgetsModeration.upload_image() has been replaced by media, which takes a WidgetMedia instance and must be passed positionally.

  • The path argument to InlineMedia (InlineGif, InlineImage, and InlineVideo) has been replaced by media, which takes a PostMedia instance.

• An unknown media type now raises ClientException when uploading media, instead of falling back to JPEG.

• Media uploads to Reddit’s S3 buckets now respect the configured timeout and raise asyncprawcore.RequestException on transport errors, consistent with all other requests, instead of bypassing the configured timeout and raising raw aiohttp exceptions.

• CommentForest.list() no longer needs to be awaited.

• The keyword argument lazy has been replace by fetch to consolidate the keyword argument used to explicitly perform a fetch when initializing an object.

• The argument reason_id in RemovalReason.__init__() has been replaced with id and is now a positional-only argument.

• The name argument in get_emoji() is now a positional-only argument.

• The reason_id argument in get_reason() has been replaced with id and is now a positional-only argument.

• The short_name argument in get_rule() is now a positional-only argument.

• The update_id argument in get_update() has been replaced with id and is now a positional-only argument.

• The page_name argument in get_page() is now a positional-only argument.

• The fetch argument in the following methods is now a keyword-only argument:

  • get_emoji()

  • get_reason()

  • get_update()

  • DraftHelper.__call__()

  • LiveHelper.__call__()

  • Modmail.__call__()

  • SubredditCollections.__call__()

  • SubredditHelper.__call__()

• Submission.add_fetch_param() now raises ClientException when called on a submission that has already been fetched, rather than logging a warning, since the added parameters would have no effect.

• The comment_sort and comment_limit attributes of a Submission must now be set before the submission is fetched; setting either after the submission has been fetched raises ClientException instead of logging a warning. Because reddit.submission() fetches by default, initialize the submission with fetch=False, set the attributes, then call load().

• Require asyncprawcore >=4, <5.

• Split asyncpraw/models/reddit/subreddit.py into an asyncpraw.models.reddit.subreddit package, with Subreddit and each of its helper classes (Modmail, SubredditFilters, SubredditFlair, SubredditModeration, SubredditQuarantine, SubredditRelationship, SubredditStream, SubredditStylesheet, SubredditWiki, and their related classes) moved to dedicated modules. All classes remain importable from asyncpraw.models.reddit.subreddit and asyncpraw.models for backwards compatibility. See the migration guide for the full mapping.

Fixed

• An issue where submitting a gallery post with websockets enabled would fail.

• Fix API endpoint for Submission.hide() and Submission.unhide(), which returned a 404 due to a trailing slash.

• Fix TypeError when objectifying a response whose json.errors field is null rather than an empty list (e.g. api/hide).

Removed

• The warn_additional_fetch_params configuration option, which is obsolete now that adding fetch parameters to an already-fetched submission raises ClientException.

• The warn_comment_sort configuration option, which is obsolete now that setting comment_sort or comment_limit after the comments have been fetched raises ClientException.

• Remove Reddit.random_subreddit, Subreddit.random, and Subreddit.random_rising.

• Remove APIException class.

• Remove PRAWException class rename handler.

• Remove Comment.award and Submission.award methods.

• Remove Comment.gild, Redditor.gild, and Submission.gild methods.

• Remove Redditor.gilded and Subreddit.gilded methods.

• Remove Redditor.gildings method.

• Remove Subreddit.mod.inbox, Subreddit.mod.unread, and Subreddit.mod.stream.unread methods.

• Remove Subreddits.search_by_topic method.

• Remove Subreddits.gold method.

• Remove Reddit keyword argument token_manager and all associated token managers.

• Remove Reddit.validate_on_submit configuration attribute.

• Remove WebSocketException.original_exception method.

• Remove the after argument for conversations().

• Remove ability to use CommentForest as an asynchronous iterator.

• Remove ability to use Reddit as an synchronous context manager.

• Remove key reset_timestamp from limits().

• Remove SubredditMessage.mute and SubredditMessage.unmute methods.

• Remove InboxableMixin.unblock_subreddit method.

7.8.1 (2024/12/21)

Changed

• Bump asyncprawcore minimum version.

7.8.0 (2024/10/20)

Added

• reorder() to reorder a subreddit’s link flair templates.

• reorder() to reorder a subreddit’s redditor flair templates.

• Experimental _edit_experimental() for adding new inline media or editing a submission that has inline media.

  Danger

  This method is experimental. It is reliant on undocumented API endpoints and may result in existing inline media not displaying correctly and/or creating a malformed body. Use at your own risk. This method may be removed in the future without warning.

  This method is identical to Submission.edit() except for the following:

  • The ability to add inline media to existing posts.

  • Additional preserve_inline_media keyword argument to allow Async PRAW to attempt to preserve the existing inline media when editing a post. This is an experimental fix for an issue that occurs when editing a post with inline media would cause the media to lose their inline appearance.

• stream_generator() now accepts the continue_after_id parameter, which starts the stream after a given item ID.

• Support for new share URL format created from Reddit’s mobile apps.

• Reddit has a new configurable parameter, window_size. This tells PRAW how long reddit’s rate limit window is. This defaults to 600 seconds and shouldn’t need to be changed unless reddit changes the size of their rate limit window.

Fixed

• An issue where submitting a post with media would fail due to an API change.

Changed

• Drop support for Python 3.7, which is end-of-life on 2023-06-27.

Fixed

• XML parsing error when media uploads fail.

7.7.1 (2023/07/11)

Changed

• Drop asyncio_extras dependency, use contextlib.asynccontextmanager instead.

Fixed

• An issue with replying to a modmail conversation results in a error.

7.7.0 (2023/02/25)

Added

• delete_mobile_banner() to delete mobile banners.

• upload_mobile_banner() to upload mobile banners.

Fixed

• An issue with iterating ModNote when a user has more than a hundred notes.

• An issue when uploading media during the submission of a new media post.

• Removal reasons are now returned in the same order as they appear on Reddit.

7.6.1 (2022/11/28)

Changed

• Revert edit() positional argument deprecation.

• Revert edit() positional argument deprecation.

Fixed

• An issue where ModmailConversation’s messages attribute would only contain the latest message.

7.6.0 (2022/10/23)

Added

• pin() to manage pinned submissions on the authenticated user’s profile.

• update_display_layout() to update the display layout of posts in a Collection.

• SubredditCollectionsModeration.create() keyword argument display_layout for specifying a display layout when creating a Collection.

• parent to get the parent of a Message.

• ModNote to represent a moderator note.

• ModNote.delete() to delete a single moderator note.

• RedditModNotes to interact with moderator notes from a Reddit instance. This provides the ability to create and fetch notes for one or more redditors from one or more subreddits.

• RedditorModNotes to interact with moderator notes from a Redditor instance.

• RedditorModNotes.subreddits() to obtain moderator notes from multiple subreddits for a single redditor.

• SubredditModNotes to interact with moderator notes from a Subreddit instance.

• SubredditModNotes.redditors() to obtain moderator notes for multiple redditors from a single subreddit.

• create() to create a moderator note.

• Redditor.notes to interact with RedditorModNotes.

• SubredditModeration.notes to interact with SubredditModNotes.

• create_note() create a moderator note from a Comment or Submission.

• author_notes() to view the moderator notes for the author of a Comment or Submission.

Changed

• Drop support for Python 3.6, which is end-of-life on 2021-12-23.

• conversations() now returns a ListingGenerator allowing you to page through more than 100 conversations.

Deprecated

• The after argument for conversations() will now have to be included in params keyword argument.

• Positional keyword arguments for applicable functions and methods. Starting with Async PRAW 8, most functions and methods will no longer support positional arguments. It will encourage more explicit argument passing, enable arguments to be sorted alphabetically, and prevent breaking changes when adding new arguments to existing methods.

7.5.0 (2021/11/13)

Added

• Log a warning if a submission’s comment_sort attribute is updated after the submission has already been fetched and a warn_comment_sort config setting to turn off the warning.

• user_selectable() to get available subreddit link flairs.

• Automatic RateLimit handling will support errors with millisecond resolution.

• Draft to represent a submission draft.

• Draft.delete() to delete drafts.

• Draft.submit() to submit drafts.

• Draft.update() to modify drafts.

• DraftHelper to fetch or create drafts on new Reddit.

• DraftList to represent a list of Draft objects.

Deprecated

• Ability to use CommentForest as an asynchronous iterator.

• CommentForest.list() no longer needs to be awaited.

• Submission.comments no longer needs to be awaited and is now a property.

• The keyword argument lazy has been replace by fetch to consolidate the keyword argument used to explicitly perform a fetch when initializing an object.

Fixed

• Fixed return value type of methods returning a listing in Subreddit and its helper classes.

• An import error when using Async PRAW in environments where libsqlite3-dev is needed to utilize aiosqlite package which depends on the sqlite3 builtin.

7.4.0 (2021/07/30)

Added

• discussions() to obtain site-wide link submissions that link to the WikiPage.

• revert() to revert a WikiPage to a specified revision.

• Inbox.mark_all_read() to mark all messages as read with one API call.

• InboxableMixin.unblock_subreddit to unblock a subreddit.

• update_crowd_control_level() to update the crowd control level of a post.

• moderator_subreddits(), which returns information about the subreddits that the authenticated user moderates, has been restored.

• The configuration setting refresh_token has been added back. See https://www.reddit.com/r/redditdev/comments/olk5e6/followup_oauth2_api_changes_regarding_refresh/ for more info.

Changed

• Reddit.delete() now accepts the params parameter.

Deprecated

• Reddit keyword argument token_manager.

7.3.1 (2021/07/06)

Changed

• Reddit will now be shallow copied when a deepcopy is preformed on it as asyncprawcore.Session (more specifically, asyncio.AbstractEventLoop) does not support being deepcopied.

Fixed

• Fixed an issue where some RedditBase objects would be sent in a request as "None".

7.3.0 (2021/06/18)

Added

• UserSubreddit for the subreddit attribute of Redditor.

• username_available() checks if a username is available.

• trusted() to retrieve a RedditorList of trusted users.

• trust() to add a user to the trusted list.

• distrust() to remove a user from the trusted list.

• SQLiteTokenManager (may not work on Windows).

Changed

• moderated() will now objectify all data returned from the API.

• The wiki_edit endpoint has been changed from r/{subreddit}/api/wiki/edit/ to r/{subreddit}/api/wiki/edit.

• Redditor.block() no longer needs to retrieve a user’s fullname.

Deprecated

• The subreddit attribute of Redditor will no longer function as a dict.

• Legacy modmail is slated for deprecation by Reddit in June 2021. See https://www.reddit.com/r/modnews/comments/mar9ha/even_more_modmail_improvements/ for more info.

Fixed

• Fixed bug where WikiPage.edit() and SubredditWiki.create() would fail if passed content and reason parameters that produced a request with a body greater than 500 KiB, even when the parameters did not exceed their respective permitted maximum lengths.

• Fixed bug where request() could not handle instances of BadRequests when the JSON data contained only the keys “reason” and “message”.

• Fixed bug where request() could not handle instances of BadRequests when the response did not contain valid JSON data.

• Fixed bug where fullname() sometimes returned the wrong fullname.

7.2.0 (2021/02/25)

Added

• Reddit keyword argument token_manager.

• FileTokenManager and its parent abstract class BaseTokenManager.

Deprecated

• The configuration setting refresh_token is deprecated and its use will result in a DeprecationWarning. This deprecation applies in all ways of setting configuration values, i.e., via praw.ini, as a keyword argument when initializing an instance of Reddit, and via the PRAW_REFRESH_TOKEN environment variable. To be prepared for Async PRAW 8, use the new Reddit keyword argument token_manager. See Working with Refresh Tokens in Async PRAW’s documentation for an example.

• Reddit.user.me will no longer return None when called in read_only mode starting in Async PRAW 8. A DeprecationWarning will be issued. To switch forward to the Async PRAW 8 behavior set praw8_raise_exception_on_me=True in your asyncpraw.Reddit(...) call.

7.1.1 (2021/02/11)

Added

• Add method Subreddits.premium() to reflect the naming change in Reddit’s API.

• Ability to submit image galleries with Subreddit.submit_gallery.

• Ability to pass a gallery url to Reddit.submission().

• Ability to specify modmail mute duration.

• Add method invited() to get invited moderators of a subreddit.

• Ability to submit text/self posts with inline media.

• Add method Submission.award and Comment.award with the ability to specify type of award, anonymity, and message when awarding a submission or comment.

• Ability to specify subreddits by name using the subreddits parameter in Reddit.info().

• Added Reddit.close() to close the requestor session.

• Ability to use Reddit as an asynchronous context manager that automatically closes the requestor session on exit.

Changed

• BoundedSet will now utilize a Last-Recently-Used (LRU) storing mechanism, which will change the order in which elements are removed from the set.

• Improved Subreddit.submit_image and Subreddit.submit_video performance in slow network environments by removing a race condition when establishing a websocket connection.

Deprecated

• Subreddits.gold is superseded by Subreddits.premium().

• Submission.gild is superseded by Submission.award.

• Comment.gild is superseded by Comment.award.

• PRAWException is superseded by AsyncPRAWException.

Fixed

• An issue where leaving as a moderator fails if you are using token auth.

• An issue where an incorrect error was being raised due to invalid submission urls.

• A bug where if you call .parent() on a comment it clears its replies.

• An issue where performing a deepcopy on an RedditBase object will fail.

• Some cases where streams yield the same item multiple times. This cannot be prevented in every case.

• An issue where streams could get stuck on a deleted item and never pull new items.

• Fix subreddit style asset uploading.

7.1.0 (2020/07/16)

• First official Async PRAW release!

7.1.0.pre1 (2020/07/16)

• Initial Async PRAW pre-release.

For changes in PRAW please see: PRAW Changelog