Change Log#
PRAW follows semantic versioning.
7.7.1 (2023/07/11)#
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.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 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.
Fixed
An issue with iterating
ModNote
when a user has more than a hundred notes.Removal reasons are now returned in the same order as they appear on Reddit.
7.6.1 (2022/11/11)#
Changed
Revert
edit()
positional argument deprecation.Revert
reply()
positional argument deprecation.Revert
reply()
positional argument deprecation.Revert
edit()
positional argument deprecation.Revert
reply()
positional argument deprecation.
Fixed
An issue where
ModmailConversation
’smessages
attribute would only contain the latest message.
7.6.0 (2022/05/10)#
Added
pin()
to manage pinned submissions on the authenticated user’s profile.update_display_layout()
to update the display layout of posts in aCollection
.SubredditCollectionsModeration.create()
keyword argumentdisplay_layout
for specifying a display layout when creating aCollection
.ModNote
to represent a moderator note.ModNote.delete()
to delete a single moderator note.RedditModNotes
to interact with moderator notes from aReddit
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 aRedditor
instance.RedditorModNotes.subreddits()
to obtain moderator notes from multiple subreddits for a single redditor.SubredditModNotes
to interact with moderator notes from aSubreddit
instance.SubredditModNotes.redditors()
to obtain moderator notes for multiple redditors from a single subreddit.create()
to create a moderator note.Redditor.notes
to interact withRedditorModNotes
.SubredditModeration.notes
to interact withSubredditModNotes
.create_note()
create a moderator note from aComment
orSubmission
.author_notes()
to view the moderator notes for the author of aComment
orSubmission
.
Changed
Drop support for Python 3.6, which is end-of-life on 2021-12-23.
conversations()
now returns aListingGenerator
allowing you to page through more than 100 conversations.
Deprecated
The
after
argument forconversations()
will now have to be included inparams
keyword argument.Positional keyword arguments for applicable functions and methods. Starting with 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 awarn_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.
Fixed
An import error when using PRAW in environments where
libsqlite3-dev
is needed to utilize thesqlite3
builtin.Fixed bug where some keyword arguments that are passed to
Draft.submit()
would not have an effect.
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.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.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.
Changed
Reddit.delete()
now accepts theparams
parameter.
Deprecated
Reddit
keyword argumenttoken_manager
.
7.3.0 (2021/06/17)#
Added
UserSubreddit
for thesubreddit
attribute ofRedditor
.username_available()
checks if a username is available.trusted()
to retrieve aRedditorList
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 fromr/{subreddit}/api/wiki/edit/
tor/{subreddit}/api/wiki/edit
.Redditor.block()
no longer needs to retrieve a user’s fullname.
Deprecated
The
subreddit
attribute ofRedditor
is no longer 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()
andSubredditWiki.create()
would fail if passedcontent
andreason
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 ofBadRequest
s when the JSON data contained only the keys “reason” and “message”.Fixed bug where
request()
could not handle instances ofBadRequest
s when the response did not contain valid JSON data.Fixed bug where
fullname()
sometimes returned the wrong fullname.
7.2.0 (2021/02/24)#
Added
Reddit
keyword argumenttoken_manager
.FileTokenManager
and its parent abstract classBaseTokenManager
.
Deprecated
The configuration setting
refresh_token
is deprecated and its use will result in aDeprecationWarning
. This deprecation applies in all ways of setting configuration values, i.e., viapraw.ini
, as a keyword argument when initializing an instance ofReddit
, and via thePRAW_REFRESH_TOKEN
environment variable. To be prepared for PRAW 8, use the newReddit
keyword argumenttoken_manager
. See Working with Refresh Tokens in PRAW’s documentation for an example.me()
will no longer returnNone
when called inread_only
mode starting in PRAW 8. ADeprecationWarning
will be issued. To switch forward to the PRAW 8 behavior setpraw8_raise_exception_on_me=True
in yourReddit
call.
7.1.4 (2021/02/07)#
Fixed
Asynchronous check will no longer fail in Python 3.6 multithreading edge cases.
7.1.3 (2021/02/05)#
Changed
Asynchronous check will no longer occur when in a Jupyter notebook.
7.1.2 (2021/02/03)#
Fixed
Asynchronous check would not work on Python 3.6 as
get_running_loop()
only exists on Python 3.7+.
7.1.1 (2021/02/02)#
Added
Add method
Subreddits.premium()
to reflect the naming change in Reddit’s API.Ability to submit image galleries with
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()
andComment.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()
.A check to see if PRAW is running in an asynchronous environment and will advise the user to use Async PRAW. This also adds a configuration option to disable the check.
Changed
Drop support for Python 3.5, which is end-of-life on 2020-09-13.
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
submit_image()
andsubmit_video()
performance in slow network environments by removing a race condition when establishing a websocket connection.
Deprecated
Subreddits.gold()
is superseded bySubreddits.premium()
.Submission.gild()
is superseded bySubmission.award()
.Comment.gild()
is superseded byComment.award()
.
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.
Some cases where streams yield the same item multiple times. This cannot be prevented in every case.
7.1.0 (2020/06/22)#
Added
Rule
to represent one rule of a subreddit.SubredditRules
to get and add rules.Ability to submit polls with
submit_poll()
.PollData
andPollOption
.Ability to view poll data and poll options via the
.poll_data
attribute on poll submissions.Add method
delete()
toReddit
class to support HTTP DELETE requests.Added
CalendarConfiguration
to represent the configuration of aCalendar
widget.Added
Styles
to represent widget styling information.Ability to stream live thread updates via new class
LiveThreadStream
with methodupdates()
.
Changed
RemovalReason.update()
’s parameters are now optional.SubredditRemovalReasons.__getitem__()
now takes integers and slices to get removal reasons from the list of reasons as returned by Reddit.
Deprecated
WebSocketException.original_exception
is deprecated and slated for removal in PRAW 8.0.
Fixed
An issue where certain subreddit settings could not be set through
SubredditModeration.update()
, such aswelcome_message_enabled
andwelcome_message_text
. This change also removes the need for PRAW to track current subreddit settings and send unmodified ones in the update request.Instances of
BadRequest
s captured by PRAW that do not contain any detailed JSON data are re-raised as the originalBadRequest
.submit_image()
andsubmit_video()
will throwMediaPostFailed
when Reddit fails to post an image or video post.
7.0.0 (2020/04/24)#
Added
config_interpolation
parameter forReddit
supporting basic and extended modes.Add
partial_redditors()
that returns lightweight redditor objects that contain only a few fields. This is useful for resolvingRedditor
IDs to their usernames in bulk.User.friends()
has a new parameteruser
that takes either an instance ofRedditor
or a string containing a redditor name and returns an instance ofRedditor
if the authenticated user is friends with the user, otherwise throws an exception.SubmissionModeration.flair()
has the parameterflair_template_id
for applying flairs with template IDs.Emoji.update()
supports modifying an emoji’s permissions.SubredditEmoji.add()
now supports optionally passing booleans to set an emoji’s permissions upon upload.Methods
SubredditLinkFlairTemplates.update()
andSubredditRedditorFlairTemplates.update()
contain a new parameter,fetch
, that toggles the automatic fetching of existing data from Reddit. It is set to True by default.Values in methods
SubredditLinkFlairTemplates.update()
andSubredditRedditorFlairTemplates.update()
that are left as the defaults will no longer be over-written if thefetch
parameter is set toTrue
, but will fill in existing values for the flair template.The parameter
text
for methodsSubredditLinkFlairTemplates.update()
andSubredditRedditorFlairTemplates.update()
is no longer required.There is a new method,
post_requirements()
, to fetch a subreddit’s post requirements.Method
SubmissionModeration.sticky()
will now ignore the Conflict exception generated by trying to sticky the same post multiple times.A new method
CommentModeration.show()
will uncollapse a comment that was collapsed because of Crowd ControlMethods
submit_image()
andsubmit_video()
will throwTooLargeMediaException
if the submitted media is rejected by Reddit due to the size of the media.Class
Reddit
has an attribute,validate_on_submit
, that can be set after class initialization that causes methodssubmit()
,submit_image()
,submit_video()
, andSubmission.edit()
to check that the submission matches a subreddit’s post validation rules. This attribute will be functionally useless once Reddit implements their change. This attribute will be deprecated on the next release after Reddit’s change, and will be removed on the next major release after Reddit’s change.
Warning
In May-June 2020, Reddit will force all submissions to run through a subreddit’s validation rules.
Introduced a data class,
RedditErrorItem
, to represent an individual error item returned from Reddit.Class
RedditAPIException
now serves as a container for theRedditErrorItem
s. You can access the items by doingRedditAPIException.items
, which returns a list.APIException
is an alias toRedditAPIException
.Parameter
discussion_type
to methodssubmit()
,submit_image()
, andsubmit_video()
to support submitting as a live discussion (set to"CHAT"
).Instances of
Trophy
can be compared for equality with each other.Reddit
has a new configurable parameter,timeout
. This defaults to 16 seconds. It controls how long PRAW will wait for a response before throwing an exception.PRAW now handles ratelimit errors returned as instances of
RedditAPIException
.Reddit
has one new parameter,ratelimit_seconds
. The parameter configures the maximum amount of seconds to catch ratelimits for. It defaults to 5 seconds when not specified.
Changed
prawcore.BadRequest
should no longer be raised. Instead, a more usefulRedditAPIException
instance will be raised.Set the default comment sort to
confidence
instead ofbest
because it turns outbest
isn’t actually the correct value for the parameter.
Deprecated
APIException
is deprecated and slated for removal in PRAW 8.0.
Fixed
SubredditFlair.update()
will not error out when the flair text contains quote marks.
Removed
Converting
APIException
to string will no longer escape unicode characters.Module
praw.models.modaction
no longer exists. Please use the modulepraw.models.mod_action
, or directly importModAction
frompraw.models
.Methods
SubredditLinkFlairTemplates.update()
andSubredditRedditorFlairTemplates.update()
will no longer create flairs that are using an invalid template id, but instead throw aInvalidFlairTemplateID
.Method
reddit.user.moderator_subreddits
has been removed. Please usemoderated()
instead.
6.5.1 (2020/01/07)#
Fixed
Removed usages of
NoReturn
that caused PRAW to fail due toImportError
in Python<3.5.4
and<3.6.2
.
6.5.0 (2020/01/05)#
Added
set_original_content()
supports marking a submission as original content.unset_original_content()
supports unmarking a submission as original content.moderated()
to get a list of a redditor’s moderated subreddits.Parameter
without_websockets
tosubmit_image()
andsubmit_video()
to submit without using WebSockets.Reddit.redditor()
supportsfullname
param to fetch aRedditor
by the fullname instead of name.Redditor
constructor now also hasfullname
param.Add
RemovalReason
andSubredditRemovalReasons
to work with removal reasonsAttribute
removal_reasons
toSubredditModeration
to interact with new removal reason classesParameters
mod_note
andreason_id
toremove()
to optionally apply a removal reason on removalAdd
SubredditModerationStream
to enable moderation streamsAttribute
stream
toSubredditModeration
to interact with new moderation streamsAdd
edited()
to allow streaming ofSubredditModeration.edited()
Add
log()
to allow streaming ofSubredditModeration.log()
Add
modmail_conversations()
to allow streaming ofModmail.conversations()
Add
modqueue()
to allow streaming ofSubredditModeration.modqueue()
Add
reports()
to allow streaming ofSubredditModeration.reports()
Add
spam()
to allow streaming ofSubredditModeration.spam()
Add
unmoderated()
to allow streaming ofSubredditModeration.unmoderated()
Add
unread()
to allow streaming ofSubredditModeration.unread()
Parameter
exclude_before
tostream_generator()
to allowmodmail_conversations()
to workParameters
allowable_content
andmax_emojis
toadd()
,add()
, andupdate()
, as well as its child classes.
Deprecated
Method
reddit.user.moderator_subreddits
asmoderated()
provides more functionality.The file for ModActions (
praw/models/modaction.py
) has been moved topraw/models/mod_action.py
and the previous has been deprecated.
Expected Changes
The behavior of
APIException
will no longer unicode-escape strings in the next minor release.
6.4.0 (2019/09/21)#
Added
crosspost()
support parameterflair_id
to flair the submission immediately upon crossposting.crosspost()
support parameterflair_text
to set a custom text to the flair immediately upon crossposting.crosspost()
support parameternsfw
to mark the submission NSFW immediately upon crossposting.crosspost()
support parameterspoiler
to mark the submission as a spoiler immediately upon crossposting.
Fixed
add_community_list()
has parameterdescription
to support unannounced upstream Reddit API changes.WidgetModeration.update()
supports passing a list ofSubreddit
objects.
Changed
Removed
css_class
parameter cannot be used withbackground_color
,text_color
, ormod_only
constraint on methods:SubredditFlairTemplates.update()
SubredditRedditorFlairTemplates.add()
SubredditLinkFlairTemplates.add()
Removed
Drop official support for Python 2.7.
Multireddit.rename()
no longer works due to a change in the Reddit API.
6.3.1 (2019/06/10)#
Removed
SubredditListingMixin.gilded()
, as this was supposed to be removed in 6.0.0 after deprecation in 5.2.0.
6.3.0 (2019/06/09)#
Added
Collections (
Collection
and helper classes).submit()
,submit_image()
, andsubmit_video()
can be used to submit a post directly to a collection.praw.util.camel_to_snake
andpraw.util.snake_case_keys
.Comments can now be locked and unlocked via
comment.mod.lock()
andcomment.mod.unlock()
. See: (lock()
andunlock()
).align
parameter toupload_banner_additional_image()
Changed
Reddit.info()
now accepts any non-str iterable for fullnames (not justlist
).Reddit.info()
now returns a generator instead of a list when using theurl
parameter.
6.2.0 (2019/05/05)#
Added
submit()
,submit_image()
, andsubmit_video()
support parameternsfw
to mark the submission NSFW immediately upon posting.submit()
,submit_image()
, andsubmit_video()
support parameterspoiler
to mark the submission as a spoiler immediately upon posting.submit_image()
andsubmit_video()
support parametertimeout
. Default timeout has been raised from 2 seconds to 10 seconds.Added parameter
function_kwargs
tostream_generator()
to pass additional kwargs tofunction
.
Fixed
Subreddit.random()
returnsNone
instead of raisingClientException
when the subreddit does not support generating random submissions.
Other
Bumped minimum prawcore version to 1.0.1.
6.1.1 (2019/01/29)#
Added
SubredditFlair.set()
supports parameterflair_template_id
for giving a user redesign flair.
6.1.0 (2019/01/19)#
Added
Add method
Redditor.trophies()
to get a list of the Redditor’s trophies.Add class
PostFlairWidget
.Add attributes
reply_limit
andreply_sort
to classComment
Add class
SubredditWidgetsModeration
(accessible throughSubredditWidgets.mod
) and methodadd_text_area()
.Add class
WidgetModeration
(accessible through the.mod
attribute on any widget) with methodsupdate()
anddelete()
.Add method
Reddit.put()
for HTTP PUT requests.Add methods
add_calendar()
andadd_community_list()
.Add methods
add_image_widget()
andupload_image()
.Add method
add_custom_widget()
.Add method
add_post_flair_widget()
.Add method
add_menu()
.Add method
add_button_widget()
.Add method
reorder()
to reorder a subreddit’s widgets.Add
Redditors
(reddit.redditors
) to provideRedditor
listings.Add
submit_image()
for submitting native images to Reddit.Add
submit_video()
for submitting native videos and videogifs to Reddit.
Changed
SubredditLinkFlairTemplates.__iter__()
uses the v2 flair API endpoint. This change will result in additional fields being returned. All fields that were previously returned will still be returned.SubredditRedditorFlairTemplates.__iter__()
uses the v2 flair API endpoint. The method will still return the exact same items.Methods
SubredditRedditorFlairTemplates.add()
,SubredditLinkFlairTemplates.add()
,SubredditRedditorFlairTemplates.update()
, andSubredditLinkFlairTemplates.update()
can add and update redesign-style flairs with the v2 flair API endpoint. They can still update pre-redesign-style flairs with the older endpoint.
Fixed
Widgets of unknown types are parsed as
Widget
s rather than raising an exception.
6.0.0 (2018/07/24)#
Added
Add method
revision()
to get a specific wiki page revision.Added parameter
skip_existing
tostream_generator()
to skip existing items when starting a stream.Add method
Front.best()
to get the front page “best” listing.Add
Subreddit.widgets
,SubredditWidgets
, and widget subclasses likeTextArea
to support fetching Reddit widgets.Add method
Submission.mark_visited()
to mark a submission as visited on the Reddit backend.
Fixed
Fix
RecursionError
onSubredditEmoji
’srepr
andstr
.SubredditFilters.add()
andSubredditFilters.remove()
also accept aSubreddit
for thesubreddit
parameter.Remove restriction which prevents installed (non-confidential) apps from using OAuth2 authorization code grant flow.
Removed
Subreddit.submissions
as the API endpoint backing the method is no more. See https://www.reddit.com/r/changelog/comments/7tus5f/update_to_search_api/.
5.4.0 (2018/03/27)#
Added
Add method
patch()
toReddit
class to support HTTP PATCH requests.Add class
Preferences
to access and update Reddit preferences.Add attribute
User.preferences
to access an instance ofPreferences
.Add method
Message.delete()
.Add class
Emoji
to work with custom subreddit emoji.
Deprecated
Subreddit.submissions
as the API endpoint backing the method is going away. See https://www.reddit.com/r/changelog/comments/7tus5f/update_to_search_api/.
Fixed
Fix bug with positive
pause_after
values in streams provided bystream_generator()
where the wait time was not reset after a yieldedNone
.Parse URLs with trailing slashes and no
"comments"
element when creatingSubmission
objects.Fix bug where
Subreddit.submissions
returns a same submission more than onceFix bug where
ListingGenerator
fetches the same batch of submissions in an infinite loop when"before"
parameter is provided.
Removed
Removed support for Python 3.3 as it is no longer supported by requests.
5.3.0 (2017/12/16)#
Added
Multireddit.stream
, to stream submissions and comments from a multireddit.
Fixed
Now raises
prawcore.UnavailableForLegalReasons
instead of anAssertionError
when encountering a HTTP 451 response.
5.2.0 (2017/10/24)#
Changed
An attribute on
LiveUpdate
now works as lazy attribute (i.e., populate an attribute when the attribute is first accessed).
Deprecated
subreddit.comments.gilded
because there isn’t actually an endpoint that returns only gilded comments. Usesubreddit.gilded
instead.
Fixed
Removed
comment.permalink()
becausecomment.permalink
is now an attribute returned by Reddit.
5.1.0 (2017/08/31)#
Added
Redditor.stream
, with methodsRedditorStream.submissions()
andRedditorStream.comments()
to stream a Redditor’s comments or submissionsRedditorStream
has been added to facilitateRedditor.stream
Inbox.collapse()
to mark messages as collapsed.Inbox.uncollapse()
to mark messages as uncollapsed.Raise
ClientException
when callingComment.refresh()
when the comment does not appear in the resulting comment tree.Submission.crosspost()
to crosspost to a subreddit.
Fixed
Calling
Comment.refresh()
on a directly fetched, deeply nestedComment
will additionally pull in as many parent comments as possible (currently 8) enabling significantly quicker traversal to the top-mostComment
via successiveparent()
calls.Calling
refresh()
previously could have resulted in aAttributeError: "MoreComments" object has no attribute "_replies"
exception. This situation will now result in aClientException
.Properly handle
BAD_CSS_NAME
errors when uploading stylesheet images with invalid filenames. Previously anAssertionError
was raised.Submission
’sgilded
attribute properly returns the expected value from reddit.
5.0.1 (2017/07/11)#
Fixed
5.0.0 (2017/07/04)#
Added
Comment.disable_inbox_replies()
,Comment.enable_inbox_replies()
Submission.disable_inbox_replies()
, andSubmission.enable_inbox_replies()
to toggle inbox replies on comments and submissions.
Changed
cloudsearch
is no longer the default syntax forsearch()
.lucene
is now the default syntax so that PRAW’s default is aligned with Reddit’s default.Reddit.info()
will now take either a list of fullnames or a single URL string.Subreddit.submit()
accepts a flair template ID and text.
Fixed
Fix accessing
LiveUpdate.contrib
raisesAttributeError
.
Removed
Iterating directly over
SubredditRelationship
(e.g.,subreddit.banned
,subreddit.contributor
,subreddit.moderator
, etc) andSubredditFlair
is no longer possible. Iterate instead over their callables, e.g.subreddit.banned()
andsubreddit.flair()
.The following methods are removed:
Subreddit.mod.approve
,Subreddit.mod.distinguish
,Subreddit.mod.ignore_reports
,Subreddit.mod.remove
,Subreddit.mod.undistinguish
,Subreddit.mod.unignore_reports
.Support for passing a
Submission
toSubredditFlair.set()
is removed.The
thing
argument toSubredditFlair.set()
is removed.Return values from
Comment.block()
,Message.block()
,SubredditMessage.block()
,SubredditFlair.delete()
,friend()
,Redditor.message()
,Subreddit.message()
,select()
, andunfriend()
are removed as they do not provide any useful information.praw.ini
no longer reads inhttp_proxy
andhttps_proxy
settings.is_link
parameter ofSubredditRedditorFlairTemplates.add()
andSubredditRedditorFlairTemplates.clear()
. UseSubredditLinkFlairTemplates
instead.
4.6.0 (2017/07/04)#
The release’s sole purpose is to announce the deprecation of the is_link
parameter
as described below:
Added
SubredditFlair.link_templates
to manage link flair templates.
Deprecated
is_link
parameter ofSubredditRedditorFlairTemplates.add()
andSubredditRedditorFlairTemplates.clear()
. UseSubredditLinkFlairTemplates
instead.
4.5.1 (2017/05/07)#
Fixed
Calling
parent()
works onComment
instances obtained viacomment_replies()
.
4.5.0 (2017/04/29)#
Added
Modmail.unread_count()
to get unread count by conversation state.Modmail.bulk_read()
to mark conversations as read by conversation state.Modmail.subreddits()
to fetch subreddits using new modmail.Modmail.create()
to create a new modmail conversation.ModmailConversation.read()
to mark modmail conversations as read.ModmailConversation.unread()
to mark modmail conversations as unread.conversations()
to get new modmail conversations.ModmailConversation.highlight()
to highlight modmail conversations.ModmailConversation.unhighlight()
to unhighlight modmail conversations.ModmailConversation.mute()
to mute modmail conversations.ModmailConversation.unmute()
to unmute modmail conversations.ModmailConversation.archive()
to archive modmail conversations.ModmailConversation.unarchive()
to unarchive modmail conversations.ModmailConversation.reply()
to reply to modmail conversations.Modmail.__call__()
to get a new modmail conversation.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
submit()
acceptsselftext=''
to create a title-only submission.Reddit
acceptsrequestor_class=cls
for a customized requestor class andrequestor_kwargs={"param": value}
for passing arguments to requestor initialization.SubredditStream.comments()
,SubredditStream.submissions()
, andSubreddits.stream()
accept apause_after
argument to allow pausing of the stream. The default value ofNone
retains the preexisting behavior.
Deprecated
cloudsearch
will no longer be the default syntax forSubreddit.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
WikiPage
revisions with deleted authors causedTypeError
.Submission
attributescomment_limit
andcomment_sort
maintain their values after making instances non-lazy.
4.4.0 (2017/02/21)#
Added
LiveThreadContribution.update()
to update settings of a live thread.reset_timestamp
tolimits()
to provide insight into when the current rate limit window will expire.upload_mobile_header()
to upload subreddit mobile header.upload_mobile_icon()
to upload subreddit mobile icon.delete_mobile_header()
to remove subreddit mobile header.delete_mobile_icon()
to remove subreddit mobile icon.LiveUpdateContribution.strike()
to strike a content of a live thread.LiveContributorRelationship.update()
to update contributor permissions for a redditor.LiveContributorRelationship.update_invite()
to update contributor invite permissions for a redditor.LiveThread.discussions()
to get submissions linking to the thread.LiveThread.report()
to report the thread violating the Reddit rules.LiveHelper.now()
to get the currently featured live thread.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 anAssertionError
.Uploading an invalid image raises
APIException
.Redditor
instances obtained viamoderator
(e.g.,reddit.subreddit("test").moderator()
) will contain attributes with the relationship metadata (e.g.,mod_permissions
).Message
instances retrieved from the inbox now have attributesauthor
,dest
replies
andsubreddit
properly converted to their appropriate PRAW model.
4.3.0 (2017/01/19)#
Added
LiveContributorRelationship.leave()
to abdicate the live thread contributor position.LiveContributorRelationship.remove()
to remove the redditor from the live thread contributors.limits()
to provide insight into number of requests made and remaining in the current rate limit window.LiveThread.contrib
to obtain an instance ofLiveThreadContribution
.LiveThreadContribution.add()
to add an update to the live thread.LiveThreadContribution.close()
to close the live thread permanently.LiveUpdate.contrib
to obtain an instance ofLiveUpdateContribution
.LiveUpdateContribution.remove()
to remove a live update.LiveContributorRelationship.accept_invite()
to accept an invite to contribute the live thread.SubredditHelper.create()
andSubredditModeration.update()
have documented support forspoilers_enabled
. Note, however, thatSubredditModeration.update()
will currently unset thespoilers_enabled
value until such a time that Reddit returns the value along with the other settings.spoiler()
andunspoiler()
to change a submission’s spoiler status.
Fixed
LiveContributorRelationship.invite()
andLiveContributorRelationship.remove_invite()
now hit endpoints, which starts with “api/”, for consistency.ModeratorRelationship.update()
, andModeratorRelationship.update_invite()
now always remove known unlisted permissions.
4.2.0 (2017/01/07)#
Added
.Subreddit.rules
to get the rules of a subreddit.LiveContributorRelationship
, which can be obtained throughLiveThread.contributor
, to interact with live threads’ contributors.remove_invite()
to remove a moderator invite.LiveContributorRelationship.invite()
to send a contributor invitation.LiveContributorRelationship.remove_invite()
to remove the contributor invitation.
Deprecated
Return values from
Comment.block()
,Message.block()
,SubredditMessage.block()
,SubredditFlair.delete()
,friend()
,Redditor.message()
,Subreddit.message()
,select()
, andunfriend()
will be removed in PRAW 5 as they do not provide any useful information.
Fixed
hide()
andunhide()
now accept a list of additional submissions.replace_more()
is now recoverable. Previously, when an exception was raised during the work done byreplace_more()
, all unreplacedMoreComments
instances were lost. NowMoreComments
instances are only removed once their children have been added to theCommentForest
enabling callers ofreplace_more()
to call the method as many times as required to complete the replacement.Working with contributors on
SubredditWiki
is done consistently throughcontributor
notcontributors
.Subreddit.moderator()
works.live_thread.contributor()
now returnsRedditorList
correctly.
Removed
validate_time_filter
is no longer part of the public interface.
4.1.0 (2016/12/24)#
Added
Subreddits.search_by_topic()
to search subreddits by topic. (see: https://www.reddit.com/dev/api/#GET_api_subreddits_by_topic).LiveHelper.__call__()
to provide interface topraw.models.LiveThread.__init__
.SubredditFilters
to work with filters for special subreddits, liker/all
.Added callables for
SubredditRelationship
andSubredditFlair
so thatlimit
and other parameters can be passed.Add
Message.reply()
toMessage
which was accidentally missed previously.Add
sticky
parameter toCommentModeration.distinguish()
to sticky comments.Submission.flair()
to add a submission’s flair from an instance ofSubmission
.Comment.parent()
to obtain the parent of aComment
.opt_in()
andopt_out()
toSubreddit
to permit working with quarantined subreddits.LiveUpdate
to represent an individual update in aLiveThread
.Ability to access an individual
LiveUpdate
viareddit.live("THREAD_ID")["UPDATE_ID"]
.LiveThread.updates()
to iterate the updates of the thread.
Changed
me()
now caches its result in order to reduce redundant requests for methods that depend on it. Setuse_cache=False
when calling to bypass the cache.replace_more()
can be called onComment
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
SubredditRelationship
(e.g.,subreddit.banned
,subreddit.contributor
,subreddit.moderator
, etc) andSubredditFlair
will be removed in PRAW 5. Iterate instead over their callables, e.g.subreddit.banned()
andsubreddit.flair()
.The following methods are deprecated to be removed in PRAW 5 and are replaced with similar
Comment.mod...
andSubmission.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
Submission
toSubredditFlair.set()
will be removed in PRAW 5. UseSubmission.flair()
instead.The
thing
argument toSubredditFlair.set()
is replaced withredditor
and will be removed in PRAW 5.
Fixed
SubredditModeration.update()
accurately updatesexclude_banned_modqueue
,header_hover_text
,show_media
andshow_media_preview
values.Instances of
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
Message
will raiseAttributeError
instead ofPRAWException
.
4.0.0 (2016/11/29)#
Fixed
Fix bug where ipython tries to access attribute
_ipython_canary_method_should_not_exist_
resulting in a useless fetch.Fix bug where
Comment
replies becomes[]
after attempting to access an invalid attribute on the Comment.Reddit.wiki[…] converts the passed in page name to lower case as pages are only saved in lower case and non-lower case page names results in a Redirect exception (thanks pcjonathan).
4.0.0rc3 (2016/11/26)#
Added
implicit
parameter tourl()
to support the implicit flow for installed applications (see: https://github.com/reddit/reddit/wiki/OAuth2#authorization-implicit-grant-flow)scopes()
to discover which scopes are available to the current authenticationLots of documentation: https://praw.readthedocs.io/
4.0.0rc2 (2016/11/20)#
Fixed
Auth.authorize()
properly sets the session’s Authentication (thanks @williammck).
4.0.0rc1 (2016/11/20)#
PRAW 4 introduces significant breaking changes. The numerous changes are not listed here, only the feature removals. Please read through Quick Start to help with updating your code to PRAW 4. If you require additional help please ask on r/redditdev or via Slack.
Added
Comment.block()
,Message.block()
, andSubredditMessage.block()
to permit blocking unwanted user contact.LiveHelper.create()
to create new live threads.Redditor.unblock()
to undo a block.Subreddits.gold()
to iterate through gold subreddits.Subreddits.search()
to search for subreddits by name and description.Subreddits.stream()
to obtain newly created subreddits in near realtime.User.karma()
to retrieve the current user’s subreddit karma.praw.models.reddit.submission.SubmissionModeration.lock
andpraw.models.reddit.submission.SubmissionModeration.unlock
to change a Submission’s lock state.SubredditFlairTemplates.delete()
to delete a single flair template.SubredditModeration.unread()
to iterate over unread moderation messages.ModeratorRelationship.invite()
to invite a moderator to a subreddit.ModeratorRelationship.update()
to update a moderator’s permissions.ModeratorRelationship.update_invite()
to update an invited moderator’s permissions.Front.random_rising()
,Subreddit.random_rising()
andMultireddit.random_rising()
.WikiPage
supports a revision argument.SubredditWiki.revisions()
to obtain a list of recent revisions to a subreddit.WikiPage.revisions()
to obtain a list of revisions for a wiki page.Support installed-type OAuth apps.
Support read-only OAuth for all application types.
Support script-type OAuth apps.
Changed
Note
Only prominent changes are listed here.
helpers.comments_stream
is nowSubredditStream.comments()
helpers.submissions_between
is nowSubreddit.submissions
. This new method now only iterates through newest submissions first and as a result makes approximately 33% fewer requests.helpers.submission_stream
is nowSubredditStream.submissions()
Removed
Removed
Reddit
’slogin
method. Authentication must be done through OAuth.Removed
praw-multiprocess
as this functionality is no longer needed with PRAW 4.Removed non-oauth functions
Message.collapse
andMessage.uncollapse
is_username_available
.Removed captcha related functions.
For changes prior to version 4.0 please see: 3.6.2 changelog