I've done several searches throughout the repo, and as far as I can tell there aren't any resources for handling Multireddits. I'd love to help develop this if a project manager can get some groundwork started. Any plans? (Is there a to-do file somewhere?)

Multireddit API

Feature Summary and Justification

This feature provides the ablilty to stream from subreddit.mod methods. Added Moderator stream for the following:

• edited
• mod log
• modqueue
• reports
• spam
• unmoderated
• unread
• modmail_conversations

Issue Description

A simple consumer like the below seems to not be processing all comments.

I observed a drop in total comment throughput with the praw stream sometime around december 2018 and it has never really recovered.

I have tested by manually making a number of comments and observing that some of them don't get captured by the praw stream.

IO on the client side is not a limiting factor.

for comment in reddit.subreddit('all').stream.comments():
   do_something(comment)

System Information

• PRAW Version: 6.0.0
• Python Version: 3.7
• Operating System:

Fixes # (provide issue number if applicable)

Feature Summary and Justification

Currently, there is no PRAW function to modify a collection's display layout to either:

• TIMELINE: Best for event or discussion collections
• GALLERY: Best for image-heavy or meme collections

This feature allows the user to do just that.

This pull request provides ... A solution to this problem.

References

Other

• An additional PRAW function will need to be made that sets a display layout type when creating a new collection.
• Sorry about the duplicate commit message. The second one should have said "Forgot to include unit test".

As of right now, flairs are returned as dicts. I was thinking of making them into Flair objects.

Several questions:

• How do I make the Reddit instance objectify the dict into this flair object?
• Should I throw a ClientException when a user tries to edit a flair that it cannot, or just pass.
• Should the flair() method accept a flair object (current), or both a flair object or an id/text combo?

Feature Summary and Justification

PRAW's current logo seemed a bit un-indicative of the package's purpose, I felt. (It would be at home if it were for a LEGO API, though). I feel that the image that should represent PRAW should also represent what it is - Python and Reddit.

I put together a new logo as a suggestion, one that combines the double-snakes of Python with the antenna of Reddit's Snoo. The background color is #FF4500, better known as "orangered" to long-time Redditors. The font is DIN 1451, chosen to avoid overt resemblance to the Reddit wordmark and font to avoid confusion about officiality.

I sized this to be the same size as GitHub's social media preview so it can be used for this repository as well. Humbly submitting it for consideration!

RateLimitExceeded.init was setting sleep_time to response['ratelimit'] which was throwing a KeyError exception every time I hit it. Swtiched to 'delay' which seemed to fix the functionality.

If this isn't correct, ignore this, but it fixed my problem and I thought I'd share it.

If this isn't the correct branch to send the pull request to but the fix should still be pulled, please let me know.

Hi, I've used this trick quite a lot, so I took some time and implemented a helper for praw. I hope you'll find it useful!

1. Reddit seems to use created attribute for "timestamp" queries. created seems to be a sort of broken timestamp. I think this is very confusing, and I always forget to convert time.time() output to "reddit timestamp". That's why I chose to make highest_timestamp and lowest_timestamp to be normal unix timestamp(even though it is inconsistent with r.search)

2. I am not a native speaker, so sorry in advance for possible grammatical errors in the docstring.

3. The basic algorithm is fairly simple, it just slides a dynamic length window over reddit timestamps and tries to keep 30..99 results within the window. Whenever this condition breaks, it increases or decreases the window length by a factor of 2x. I never really bothered to optimize these parameters, they are good enough for me. Maybe it is a good idea to expose them as function parameters.

4. Naming! TBH, I am not sure if all_submissions is a good name.

Any feedback is appereciated!

Describe the bug When loading all the comments for post 41ntws (and a handful of others), I get this assertion error. I have not had this problem on tons of other posts, just a few. In case it's helpful, here is the complete list of posts I get this error on:

50slvn
4wvz6z
4fmyzj
41ntws
41dkav
3gljgr
a8ekca
fz5363

They're all AskReddit posts with pretty high comment counts, but I've downloaded posts with even more comments regularly before with no issue.

I found that it seems to be breaking when it gets to comment cz3wnj7. Interestingly, going to the parent of that comment gives a weird "there doesn't seem to be anything here" page instead of showing a deleted comment like normal. That probably has something to do with it.

To Reproduce Steps to reproduce the behavior:

1. Fetch the post with ID 41ntws
2. Do comments.replace_more(limit=None)
3. Wait

Expected behavior All comments get loaded

Code/Logs Here is my exact repro code:

import praw
import json

credentials = json.load(open("D:/~No Sync/reddit auth.json"))
reddit = praw.Reddit(client_id=credentials['client_id'], client_secret=credentials['client_secret'], user_agent=credentials['user_agent'], username=credentials['username'], password=credentials['password'])
post = reddit.submission(url="https://reddit.com/comments/41ntws")
post.comments.replace_more(limit=None)

Here is my stacktrace:

Traceback (most recent call last):
  File "D:\Documents\Website Archive\code\test.py", line 7, in <module>
    post.comments.replace_more(limit=None)
  File "C:\Program Files (x86)\Python38-32\lib\site-packages\praw\models\comment_forest.py", line 194, in replace_more
    self._insert_comment(comment)
  File "C:\Program Files (x86)\Python38-32\lib\site-packages\praw\models\comment_forest.py", line 82, in _insert_comment
    assert comment.parent_id in self._submission._comments_by_id, (
AssertionError: PRAW Error occured. Please file a bug report and include the code that caused the error.

System Info

• OS: Windows 10
• Python: 3.8.2
• PRAW Version: 7.0.0

Feature Summary and Justification

Added two methods to the SubmissionModeration class called set_original_content() and unset_original_content(). These methods allows a moderator to set a post as "Original Content (OC)", a tag that is similar to the existing NSFW and Spoiler tags. Note that moderators can mark a post as "OC" on both Old and New Reddit; but submitters have to use New Reddit in order to mark their own posts as such. The feature itself has to be enabled in a subreddit's settings first.

Though the admin announcement says the tag is only for New Reddit, the feature was backported to Old Reddit and is viewable on the old site as well.

This endpoint is not officially on the main API page, and the admin response of a year ago was to consider adding it to the API, but that was never done officially. Therefore there is a chance that this endpoint will be deprecated without warning in the future but it currently works and the feature has been fully operational on both desktop versions of Reddit for over a year and a half. The feature does not yet appear on the mobile app.

A submission with this tag will have another attribute is_original_content set to True. If that submission's OC tag is subsequently removed, its attribute is_original_content will become set to False. Generic submissions may not have is_original_content as an attribute.

Please note that unlike the NSFW tags, this has not been integrated by Reddit into search. Therefore, while nsfw:true works, oc:true will not return any results from a search query.

I have also tested this endpoint several times with my bot u/AssistantBOT.

Timeline

• 2018-04-05: OC feature announced for the redesign.
• 2018-04-09: Feature open for beta-testing.
• 2018-05-31: Feature is integrated into AutoModerator and made available for all subreddits.
• 2018-06-09: Feature is backported to Old Reddit.

References

• Credit to u/nmtake's discovery here.

Describe the solution you'd like Reddit's suggested solution of passing the 2FA token to /api/v1/access_token as part of the value of the password parameter, i.e 'password' = password+':'+token, doesn't work for users with long passwords because of what appears to be a bug on their end. This isn't a big deal, because instead of using Reddit's suggested method, it also turns out that you can pass the 2FA token to /api/v1/access_token in a separate otp parameter—see below. PRAW or prawcore could be tweaked to handle 2FA tokens if users input their original otp secret at initialization,

Describe alternatives you've considered Update documentation to inform users with long passwords and 2FA enabled that they're SOL.

Additional context Someone on /r/redditdev claimed that you couldn't use a password flow with 2FA if the password was >= 72 characters long, and it's true. Setting the password to password:token fails for large passwords, with or without PRAW. Reddit passwords can be up to 500kb long, but bcrypt only cares about the first 72 characters, so I would guess that Reddit has a bug somewhere in their password validation process.

I used the network inspector while logging into new Reddit, and noticed that the password form had a field for the 2FA token named 'otp'. On a whim, I added 'otp':'xxxxxx' to the POST data of the usual non-PRAW oauth login with Python:

import pyotp
import requests

otp_secret = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
otp_token = pyotp.TOTP(otp_secret).now()
client_auth = requests.auth.HTTPBasicAuth('client_id','client_secret')
post_data = {
	"grant_type": "password",
	"username": username,
	"password": password,
	"otp": otp_token
}
headers = {"User-Agent": "xxxxxxxxxxxxxxxxxxxxxxxx"}
response = requests.post(
	"https://www.reddit.com/api/v1/access_token",
	auth=client_auth,
	data=post_data,
	headers=headers
)

...and it worked. response.json() returns the usual set of

{'access_token': 'xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxx', 'token_type': 'bearer', 'expires_in': 3600, 'scope': '*'}.

So sure enough, 'otp' is a valid parameter for /api/v1/access_token when using a password with 2FA. If a user passed in the otp_secret at initialization, when it comes time to fetch or refresh bearer tokens, PRAW could then just calculate the 2FA token with pyotp.TOTP(otp_secret).now() (or with an equivalent function) and add that to the rest of the data in the request.

Describe the Bug

Errors when example code is executed.

Docs here: https://praw.readthedocs.io/en/stable/code_overview/other/subredditrelationship.html#praw.models.reddit.subreddit.SubredditRelationship

Desired Result

Change the docs?

Relevant Logs

c:\python39\lib\site-packages\praw\models\reddit\base.py in __getattr__(self, attribute)
     33         if not attribute.startswith("_") and not self._fetched:
     34             self._fetch()
---> 35             return getattr(self, attribute)
     36         raise AttributeError(
     37             f"{self.__class__.__name__!r} object has no attribute {attribute!r}"

c:\python39\lib\site-packages\praw\models\reddit\base.py in __getattr__(self, attribute)
     34             self._fetch()
     35             return getattr(self, attribute)
---> 36         raise AttributeError(
     37             f"{self.__class__.__name__!r} object has no attribute {attribute!r}"
     38         )

AttributeError: 'Redditor' object has no attribute 'note'

Code to reproduce the bug

for mute in reddit.subreddit("test").muted():
    print(f"{mute}: {mute.note}")

My code example does not include the Reddit() initialization to prevent credential leakage.

Yes

This code has previously worked as intended.

Yes

Operating System/Environment

windoze

Python Version

python 3.9.1

PRAW Version

7.4.0

Prawcore Version

2.3.0

Anything else?

Docs here: https://praw.readthedocs.io/en/stable/code_overview/other/subredditrelationship.html#praw.models.reddit.subreddit.SubredditRelationship

Describe the Bug

reddit.subreddit.mod.removal_reasons isn't indexed in display order

Desired Result

reddit.subreddit.mod.removal_reasons should be indexed in display order

Relevant Logs

No response

Code to reproduce the bug

No response

My code example does not include the Reddit() initialization to prevent credential leakage.

Yes

This code has previously worked as intended.

Yes

Operating System/Environment

windows

Python Version

python 3.9.1

PRAW Version

7.4.0

Prawcore Version

2.3.0

Anything else?

No response

Describe the Bug

When I do so, it posts a link to the media instead of embedding the media like it's supposed to. This is the first time trying to edit posts at with PRAW. @LilSpazJoekp said on Reddit I should submit this.

Desired Result

Right now I'm trying to get submission.edit() to preserve photos and videos, and once I do I want to be able to add in new photos and or videos when editing posts.

Relevant Logs

No response

Code to reproduce the bug

import praw

reddit = praw.Reddit("DEFAULT", user_agent="macos:praw:1.0.0 (by /u)") 
submission = reddit.submission(url="https://www.reddit.com/r/KamenRider/comments/xjw2k2/kamen_rider_geats_episode_other_content_ratings/")
submission.edit(body=submission.selftext)

My code example does not include the Reddit() initialization to prevent credential leakage.

Yes

This code has previously worked as intended.

No

Operating System/Environment

macOS Ventura 13.0

Python Version

3.9.13

PRAW Version

7.6.1

Prawcore Version

2.3.0

Anything else?

No response

Describe the Bug

Attempting to reorder the rules of a subreddit tracebacks because the response is returning None.

Desired Result

It looks as though this line should return an iterative function: response = self.subreddit_rules._reddit.post(API_PATH["reorder_subreddit_rules"], data=data)I've tried commenting out the lines that traceback to just see what response is, and response=None

Relevant Logs

File "C:\python332\lib\site-packages\praw\models\reddit\rules.py", line 448, in reorder
    for rule in response:
TypeError: 'NoneType' object is not iterable
>>>

Code to reproduce the bug

subreddit = reddit.subreddit("test")
rules = list(subreddit.rules)
# reorder them in any means you like, my preferred is:
new = [rules[1], rules[0], rules[2]]
subreddit.rules.mod.reorder(new)

My code example does not include the Reddit() initialization to prevent credential leakage.

Yes

This code has previously worked as intended.

No

Operating System/Environment

windows

Python Version

3.8

PRAW Version

7.6.0

Prawcore Version

2.3.0

Anything else?

No response

Feature Summary and Justification

This feature enables a user to upload an image or images each represented as a Bytes Object to Reddit through the submit_image and submit_gallery functions.

For context, my own use-case involves backblaze.com, particularly this function of their API. To summarize, a successful request to the backblaze API returns images as bytes objects. After looking into PRAW documentation I discovered that I could only submit an image through it by first downloading and saving the file before providing each of the modified functions the filepath(s) of any images I wanted to submit. Given my use case, this would mean I would need my machine to download, save, upload, and then delete any number of images on my system each time I made use of those functions.

These changes mean an object can be pulled in from a foreign API and passed directly to PRAW for uploading. It skips the awkward saving and deleting steps which should save processing time when scaled.

The "image_path" input parameter for both functions has been changed to "image". It still accepts image paths--it's only the name of the input parameter that has changed so as to more clearly indicate that Bytes Objects now work too. In the case of submit_gallery, the input can be mixed. So there could be any number of image paths and Bytes Objects submitted to the same gallery.

References

• Python Bytes Objects