Changelog History
Page 4
-
v4.3.0 Changes
January 19, 2017โ 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 forspoilers_enabled
. Note, however, that :meth:.SubredditModeration.update
will currently unset thespoilers_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.
- :meth:
-
v4.2.0 Changes
January 07, 2017โ Added
- :meth:
.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 throughcontributor
notcontributors
. Subreddit.moderator()
works.live_thread.contributor()
now returns :class:.RedditorList
correctly.
โ Removed
validate_time_filter
is no longer part of the public interface.
- :meth:
-
v4.1.0 Changes
December 24, 2016โ Added
- :meth:
praw.models.Subreddits.search_by_topic
to search subreddits by topic. (see: https://www.reddit.com/dev/api/#GET_api_subreddits_by_topic). - :meth:
praw.models.LiveHelper.__call__
to provide interface topraw.models.LiveThread.__init__
. - :class:
.SubredditFilters
to work with filters for special subreddits, like/r/all
. - โ Added callables for :class:
.SubredditRelationship
and :class:.SubredditFlair
so thatlimit
and other parameters can be passed. - โ Add :meth:
~praw.models.Message.reply
to :class:.Message
which was accidentally missed previously. - โ Add
sticky
parameter to :meth:.CommentModeration.distinguish
to sticky comments. - :meth:
.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
viareddit.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. Setuse_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()
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 :class:
.Submission
to :meth:.SubredditFlair.set
will be removed in PRAW 5. Use :meth:.flair
instead. - The
thing
argument to :meth:.SubredditFlair.set
is replaced withredditor
and will be removed in PRAW 5.
๐ Fixed
- โก๏ธ :meth:
.SubredditModeration.update
accurately updatesexclude_banned_modqueue
,header_hover_text
,show_media
andshow_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
.
- :meth:
-
v4.0.0 Changes
November 29, 2016๐ Fixed
- ๐ Fix bug where ipython tries to access attribute
_ipython_canary_method_should_not_exist_
resulting in a useless fetch. - ๐ Fix bug where :class:
.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).
- ๐ Fix bug where ipython tries to access attribute
-
v4.0.0.rc3 Changes
November 26, 2016โ Added
- ๐
implicit
parameter to :meth:.url
to support the implicit flow for installed applications (see: https://github.com/reddit/reddit/wiki/OAuth2#authorization-implicit-grant-flow) - :meth:
.scopes
to discover which scopes are available to the current authentication - ๐ Lots of documentation: https://praw.readthedocs.io/
- ๐
-
v4.0.0.rc2 Changes
November 20, 2016๐ Fixed
- :meth:
~praw.models.Auth.authorize
properly sets the session's Authentication (thanks @williammck).
- :meth:
-
v4.0.0.rc1 Changes
November 20, 2016PRAW 4 introduces significant breaking changes. The numerous changes are not listed here, only the feature removals. Please read through :doc:
/getting_started/quick_start
to help with updating your code to PRAW 4. If you require additional help please ask on/r/redditdev <https://www.reddit.com/r/redditdev>
_ or in thepraw-dev/praw <https://gitter.im/praw-dev/praw>
_ channel on gitter.โ Added
- :meth:
praw.models.Comment.block
, :meth:praw.models.Message.block
, and :meth:praw.models.SubredditMessage.block
to permit blocking unwanted user contact. - :meth:
praw.models.LiveHelper.create
to create new live threads. - :meth:
praw.models.Redditor.unblock
to undo a block. - :meth:
praw.models.Subreddits.gold
to iterate through gold subreddits. - :meth:
praw.models.Subreddits.search
to search for subreddits by name and description. - :meth:
praw.models.Subreddits.stream
to obtain newly created subreddits in near-realtime. - :meth:
praw.models.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. - :meth:
praw.models.reddit.subreddit.SubredditFlairTemplates.delete
to delete a single flair template. - :meth:
praw.models.reddit.subreddit.SubredditModeration.unread
to iterate over unread moderation messages. - :meth:
praw.models.reddit.subreddit.ModeratorRelationship.invite
to invite a moderator to a subreddit. - โก๏ธ :meth:
praw.models.reddit.subreddit.ModeratorRelationship.update
to update a moderator's permissions. - โก๏ธ :meth:
praw.models.reddit.subreddit.ModeratorRelationship.update_invite
to update an invited moderator's permissions. - :meth:
praw.models.Front.random_rising
, :meth:praw.models.Subreddit.random_rising
and :meth:praw.models.Multireddit.random_rising
. - ๐ :class:
~.WikiPage
supports a revision argument. - :meth:
~.SubredditWiki.revisions
to obtain a list of recent revisions to a subreddit. - :meth:
~.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 now :meth:praw.models.reddit.subreddit.SubredditStream.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 now :meth:praw.models.reddit.subreddit.SubredditStream.submissions
โ Removed
- โ Removed :class:
.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.4.0 changelog <http://praw.readthedocs.io/en/v3.4.0/pages/changelog.html>
_ - :meth:
-
v4.0.0rc3 Changes
November 26, 2016โ Added
- ๐
implicit
parameter to :meth:.url
to support the implicit flow for installed applications (see: https://github.com/reddit/reddit/wiki/OAuth2#authorization-implicit-grant-flow) - :meth:
.scopes
to discover which scopes are available to the current authentication - ๐ Lots of documentation: http://praw.readthedocs.io/
- ๐
-
v4.0.0rc2 Changes
November 20, 2016๐ Fixed
- :meth:
~praw.models.Auth.authorize
properly sets the session's Authentication (thanks @williammck).
- :meth:
-
v4.0.0rc1 Changes
November 20, 2016PRAW 4 introduces significant breaking changes. The numerous changes are not listed here, only the feature removals. Please read through :doc:
/getting_started/quick_start
to help with updating your code to PRAW 4. If you require additional help please ask on/r/redditdev <https://www.reddit.com/r/redditdev>
_ or in thepraw-dev/praw <https://gitter.im/praw-dev/praw>
_ channel on gitter.โ Added
- :meth:
praw.models.Comment.block
, :meth:praw.models.Message.block
, and :meth:praw.models.SubredditMessage.block
to permit blocking unwanted user contact. - :meth:
praw.models.LiveHelper.create
to create new live threads. - :meth:
praw.models.Redditor.unblock
to undo a block. - :meth:
praw.models.Subreddits.gold
to iterate through gold subreddits. - :meth:
praw.models.Subreddits.search
to search for subreddits by name and description. - :meth:
praw.models.Subreddits.stream
to obtain newly created subreddits in near-realtime. - :meth:
praw.models.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. - :meth:
praw.models.reddit.subreddit.SubredditFlairTemplates.delete
to delete a single flair template. - :meth:
praw.models.reddit.subreddit.SubredditModeration.unread
to iterate over unread moderation messages. - :meth:
praw.models.reddit.subreddit.ModeratorRelationship.invite
to invite a moderator to a subreddit. - โก๏ธ :meth:
praw.models.reddit.subreddit.ModeratorRelationship.update
to update a moderator's permissions. - โก๏ธ :meth:
praw.models.reddit.subreddit.ModeratorRelationship.update_invite
to update an invited moderator's permissions. - :meth:
praw.models.Front.random_rising
, :meth:praw.models.Subreddit.random_rising
and :meth:praw.models.Multireddit.random_rising
. - ๐ :class:
~.WikiPage
supports a revision argument. - :meth:
~.SubredditWiki.revisions
to obtain a list of recent revisions to a subreddit. - :meth:
~.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 now :meth:praw.models.reddit.subreddit.SubredditStream.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 now :meth:praw.models.reddit.subreddit.SubredditStream.submissions
โ Removed
- โ Removed :class:
.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.4.0 changelog <http://praw.readthedocs.io/en/v3.4.0/pages/changelog.html>
_ - :meth: