Skip to content

Latest commit

 

History

History
329 lines (244 loc) · 12.7 KB

CHANGES.rst

File metadata and controls

329 lines (244 loc) · 12.7 KB
Raw

Change Log

Async PRAW follows semantic versioning.

Unreleased

7.8.0 (2024/10/20)

Added

  • :meth:`~.SubredditLinkFlairTemplates.reorder` to reorder a subreddit's link flair templates.

  • :meth:`~.SubredditRedditorFlairTemplates.reorder` to reorder a subreddit's redditor flair templates.

  • Experimental :meth:`~.Submission._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 :meth:`.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.

  • :func:`.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.

  • :class:`.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

Fixed

  • An issue with iterating :class:`.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

Fixed

7.6.0 (2022/10/23)

Added

Changed

Deprecated

  • The after argument for :meth:`.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

Deprecated

Fixed

  • Fixed return value type of methods returning a listing in :class:`.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

Changed

Deprecated

7.3.1 (2021/07/06)

Changed

Fixed

7.3.0 (2021/06/18)

Added

Changed

  • :meth:`.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.
  • :meth:`.Redditor.block` no longer needs to retrieve a user's fullname.

Deprecated

Fixed

  • Fixed bug where :meth:`.WikiPage.edit` and :meth:`.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 :meth:`.request` could not handle instances of BadRequests when the JSON data contained only the keys "reason" and "message".
  • Fixed bug where :meth:`.request` could not handle instances of BadRequests when the response did not contain valid JSON data.
  • Fixed bug where :meth:`~.FullnameMixin.fullname` sometimes returned the wrong fullname.

7.2.0 (2021/02/25)

Added

Deprecated

  • The configuration setting refresh_token is deprecated and its use will result in a :py:class:`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 :class:`.Reddit`, and via the PRAW_REFRESH_TOKEN environment variable. To be prepared for Async PRAW 8, use the new :class:`.Reddit` keyword argument token_manager. See :ref:`refresh_token` in Async PRAW's documentation for an example.
  • :meth:`.me` will no longer return None when called in :attr:`.read_only` mode starting in Async PRAW 8. A :py:class:`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

Changed

Deprecated

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 :class:`.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