--- /srv/rebuilderd/tmp/rebuilderduGL3kr/inputs/praw-doc_7.7.1+ds-1_all.deb +++ /srv/rebuilderd/tmp/rebuilderduGL3kr/out/praw-doc_7.7.1+ds-1_all.deb ├── file list │ @@ -1,3 +1,3 @@ │ -rw-r--r-- 0 0 0 4 2023-10-11 20:48:18.000000 debian-binary │ --rw-r--r-- 0 0 0 27288 2023-10-11 20:48:18.000000 control.tar.xz │ --rw-r--r-- 0 0 0 19538344 2023-10-11 20:48:18.000000 data.tar.xz │ +-rw-r--r-- 0 0 0 27296 2023-10-11 20:48:18.000000 control.tar.xz │ +-rw-r--r-- 0 0 0 19622788 2023-10-11 20:48:18.000000 data.tar.xz ├── control.tar.xz │ ├── control.tar │ │ ├── ./control │ │ │ @@ -1,13 +1,13 @@ │ │ │ Package: praw-doc │ │ │ Source: praw │ │ │ Version: 7.7.1+ds-1 │ │ │ Architecture: all │ │ │ Maintainer: Debian Python Team │ │ │ -Installed-Size: 33286 │ │ │ +Installed-Size: 32883 │ │ │ Depends: libjs-sphinxdoc (>= 5.2) │ │ │ Suggests: python3-praw │ │ │ Section: doc │ │ │ Priority: optional │ │ │ Multi-Arch: foreign │ │ │ Homepage: https://praw.readthedocs.org/ │ │ │ Description: Python Reddit API Wrapper (Documentation) │ │ ├── ./md5sums │ │ │ ├── ./md5sums │ │ │ │┄ Files differ ├── data.tar.xz │ ├── data.tar │ │ ├── file list │ │ │ @@ -178,171 +178,171 @@ │ │ │ -rw-r--r-- 0 root (0) root (0) 4992 2023-09-24 09:25:16.000000 ./usr/share/doc/praw-doc/html/_static/scripts/furo.js │ │ │ -rw-r--r-- 0 root (0) root (0) 12991 2023-09-24 09:25:16.000000 ./usr/share/doc/praw-doc/html/_static/scripts/gumshoe-patched.js │ │ │ -rw-r--r-- 0 root (0) root (0) 6034 2023-07-08 18:40:39.000000 ./usr/share/doc/praw-doc/html/_static/skeleton.css │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/_static/styles/ │ │ │ -rw-r--r-- 0 root (0) root (0) 6341 2023-09-24 09:25:16.000000 ./usr/share/doc/praw-doc/html/_static/styles/furo-extensions.css │ │ │ -rw-r--r-- 0 root (0) root (0) 53311 2023-09-24 09:25:16.000000 ./usr/share/doc/praw-doc/html/_static/styles/furo.css │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/ │ │ │ --rw-r--r-- 0 root (0) root (0) 111073 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/exceptions.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 101910 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/exceptions.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/models/ │ │ │ --rw-r--r-- 0 root (0) root (0) 111715 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/models/comment.html │ │ │ --rw-r--r-- 0 root (0) root (0) 69902 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/models/draft.html │ │ │ --rw-r--r-- 0 root (0) root (0) 64443 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/models/livethread.html │ │ │ --rw-r--r-- 0 root (0) root (0) 48418 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/models/liveupdate.html │ │ │ --rw-r--r-- 0 root (0) root (0) 57503 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/models/message.html │ │ │ --rw-r--r-- 0 root (0) root (0) 67166 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/models/modmailconversation.html │ │ │ --rw-r--r-- 0 root (0) root (0) 37576 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/models/more.html │ │ │ --rw-r--r-- 0 root (0) root (0) 99922 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/models/multireddit.html │ │ │ --rw-r--r-- 0 root (0) root (0) 152477 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/models/redditor.html │ │ │ --rw-r--r-- 0 root (0) root (0) 128538 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/models/submission.html │ │ │ --rw-r--r-- 0 root (0) root (0) 235565 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/models/subreddit.html │ │ │ --rw-r--r-- 0 root (0) root (0) 58957 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/models/wikipage.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 107048 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/models/comment.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 63200 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/models/draft.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 60509 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/models/livethread.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 45821 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/models/liveupdate.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 55777 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/models/message.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 64076 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/models/modmailconversation.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 36102 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/models/more.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 90236 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/models/multireddit.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 138340 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/models/redditor.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 121035 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/models/submission.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 211878 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/models/subreddit.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 54774 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/models/wikipage.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/ │ │ │ --rw-r--r-- 0 root (0) root (0) 49874 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/auth.html │ │ │ --rw-r--r-- 0 root (0) root (0) 55000 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/base_mod_notes.html │ │ │ --rw-r--r-- 0 root (0) root (0) 39913 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/baselist.html │ │ │ --rw-r--r-- 0 root (0) root (0) 39390 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/button.html │ │ │ --rw-r--r-- 0 root (0) root (0) 52300 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/buttonwidget.html │ │ │ --rw-r--r-- 0 root (0) root (0) 45703 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/calendar.html │ │ │ --rw-r--r-- 0 root (0) root (0) 38436 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/calendarconfiguration.html │ │ │ --rw-r--r-- 0 root (0) root (0) 56629 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/collection.html │ │ │ --rw-r--r-- 0 root (0) root (0) 53679 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/collectionmoderation.html │ │ │ --rw-r--r-- 0 root (0) root (0) 47393 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/commentforest.html │ │ │ --rw-r--r-- 0 root (0) root (0) 38181 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/commenthelper.html │ │ │ --rw-r--r-- 0 root (0) root (0) 75975 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/commentmoderation.html │ │ │ --rw-r--r-- 0 root (0) root (0) 49494 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/communitylist.html │ │ │ --rw-r--r-- 0 root (0) root (0) 34060 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/config.html │ │ │ --rw-r--r-- 0 root (0) root (0) 42243 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/contributorrelationship.html │ │ │ --rw-r--r-- 0 root (0) root (0) 45711 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/customwidget.html │ │ │ --rw-r--r-- 0 root (0) root (0) 68006 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/domainlisting.html │ │ │ --rw-r--r-- 0 root (0) root (0) 39739 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/draftlist.html │ │ │ --rw-r--r-- 0 root (0) root (0) 45402 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/emoji.html │ │ │ --rw-r--r-- 0 root (0) root (0) 30959 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/fullnamemixin.html │ │ │ --rw-r--r-- 0 root (0) root (0) 38934 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/hover.html │ │ │ --rw-r--r-- 0 root (0) root (0) 41625 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/idcard.html │ │ │ --rw-r--r-- 0 root (0) root (0) 37717 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/image.html │ │ │ --rw-r--r-- 0 root (0) root (0) 37763 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/imagedata.html │ │ │ --rw-r--r-- 0 root (0) root (0) 50180 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/imagewidget.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 45839 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/auth.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 52270 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/base_mod_notes.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 37823 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/baselist.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 37904 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/button.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 50210 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/buttonwidget.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 44475 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/calendar.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 36950 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/calendarconfiguration.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 53793 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/collection.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 52222 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/collectionmoderation.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 45900 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/commentforest.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 36832 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/commenthelper.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 74022 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/commentmoderation.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 47404 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/communitylist.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 32969 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/config.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 40888 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/contributorrelationship.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 44483 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/customwidget.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 61144 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/domainlisting.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 37649 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/draftlist.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 42928 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/emoji.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 30840 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/fullnamemixin.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 37448 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/hover.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 40397 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/idcard.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 36231 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/image.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 36277 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/imagedata.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 48090 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/imagewidget.html │ │ │ -rw-r--r-- 0 root (0) root (0) 41452 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/inboxablemixin.html │ │ │ --rw-r--r-- 0 root (0) root (0) 32218 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/inlinegif.html │ │ │ --rw-r--r-- 0 root (0) root (0) 32159 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/inlineimage.html │ │ │ --rw-r--r-- 0 root (0) root (0) 32152 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/inlinemedia.html │ │ │ --rw-r--r-- 0 root (0) root (0) 32174 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/inlinevideo.html │ │ │ --rw-r--r-- 0 root (0) root (0) 41426 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/listinggenerator.html │ │ │ --rw-r--r-- 0 root (0) root (0) 59773 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/livecontributorrelationship.html │ │ │ --rw-r--r-- 0 root (0) root (0) 42735 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/livethreadcontribution.html │ │ │ --rw-r--r-- 0 root (0) root (0) 37333 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/livethreadstream.html │ │ │ --rw-r--r-- 0 root (0) root (0) 36507 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/liveupdatecontribution.html │ │ │ --rw-r--r-- 0 root (0) root (0) 50848 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/menu.html │ │ │ --rw-r--r-- 0 root (0) root (0) 37626 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/menulink.html │ │ │ --rw-r--r-- 0 root (0) root (0) 36794 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/mod_action.html │ │ │ --rw-r--r-- 0 root (0) root (0) 42705 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/mod_note.html │ │ │ --rw-r--r-- 0 root (0) root (0) 37861 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/mod_note_mixin.html │ │ │ --rw-r--r-- 0 root (0) root (0) 39891 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/moderatedlist.html │ │ │ --rw-r--r-- 0 root (0) root (0) 70018 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/moderatorrelationship.html │ │ │ --rw-r--r-- 0 root (0) root (0) 46291 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/moderatorswidget.html │ │ │ --rw-r--r-- 0 root (0) root (0) 65852 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/modmail.html │ │ │ --rw-r--r-- 0 root (0) root (0) 39306 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/modmailmessage.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 31742 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/inlinegif.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 31683 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/inlineimage.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 31676 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/inlinemedia.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 31698 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/inlinevideo.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 38727 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/listinggenerator.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 57304 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/livecontributorrelationship.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 41374 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/livethreadcontribution.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 36836 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/livethreadstream.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 36375 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/liveupdatecontribution.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 48758 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/menu.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 36140 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/menulink.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 35308 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/mod_action.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 41219 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/mod_note.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 37122 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/mod_note_mixin.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 37801 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/moderatedlist.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 65444 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/moderatorrelationship.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 44201 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/moderatorswidget.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 62144 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/modmail.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 36840 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/modmailmessage.html │ │ │ -rw-r--r-- 0 root (0) root (0) 30272 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/partialredditor.html │ │ │ --rw-r--r-- 0 root (0) root (0) 44133 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/polldata.html │ │ │ --rw-r--r-- 0 root (0) root (0) 38782 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/polloption.html │ │ │ --rw-r--r-- 0 root (0) root (0) 50513 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/postflairwidget.html │ │ │ --rw-r--r-- 0 root (0) root (0) 35762 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/prawbase.html │ │ │ --rw-r--r-- 0 root (0) root (0) 65672 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/preferences.html │ │ │ --rw-r--r-- 0 root (0) root (0) 86686 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/reddit_mod_notes.html │ │ │ --rw-r--r-- 0 root (0) root (0) 39395 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/redditbase.html │ │ │ --rw-r--r-- 0 root (0) root (0) 68329 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/redditor_mod_notes.html │ │ │ --rw-r--r-- 0 root (0) root (0) 39874 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/redditorlist.html │ │ │ --rw-r--r-- 0 root (0) root (0) 39599 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/redditorstream.html │ │ │ --rw-r--r-- 0 root (0) root (0) 47354 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/removalreason.html │ │ │ --rw-r--r-- 0 root (0) root (0) 44144 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/rule.html │ │ │ --rw-r--r-- 0 root (0) root (0) 39849 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/rulemoderation.html │ │ │ --rw-r--r-- 0 root (0) root (0) 47208 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/ruleswidget.html │ │ │ --rw-r--r-- 0 root (0) root (0) 37439 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/styles.html │ │ │ --rw-r--r-- 0 root (0) root (0) 37248 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/stylesheet.html │ │ │ --rw-r--r-- 0 root (0) root (0) 61640 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/sublisting.html │ │ │ --rw-r--r-- 0 root (0) root (0) 41783 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/submenu.html │ │ │ --rw-r--r-- 0 root (0) root (0) 38646 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/submissionflair.html │ │ │ --rw-r--r-- 0 root (0) root (0) 102798 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/submissionmoderation.html │ │ │ --rw-r--r-- 0 root (0) root (0) 68437 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subreddit_mod_notes.html │ │ │ --rw-r--r-- 0 root (0) root (0) 47538 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditcollections.html │ │ │ --rw-r--r-- 0 root (0) root (0) 44709 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditcollectionsmoderation.html │ │ │ --rw-r--r-- 0 root (0) root (0) 41624 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditemoji.html │ │ │ --rw-r--r-- 0 root (0) root (0) 39408 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditfilters.html │ │ │ --rw-r--r-- 0 root (0) root (0) 68328 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditflair.html │ │ │ --rw-r--r-- 0 root (0) root (0) 48210 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditflairtemplates.html │ │ │ --rw-r--r-- 0 root (0) root (0) 65220 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditlinkflairtemplates.html │ │ │ --rw-r--r-- 0 root (0) root (0) 61956 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditmessage.html │ │ │ --rw-r--r-- 0 root (0) root (0) 92887 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditmoderation.html │ │ │ --rw-r--r-- 0 root (0) root (0) 73420 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditmoderationstream.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 42273 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/polldata.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 37296 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/polloption.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 48423 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/postflairwidget.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 34276 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/prawbase.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 56242 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/preferences.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 80219 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/reddit_mod_notes.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 36929 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/redditbase.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 64118 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/redditor_mod_notes.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 37784 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/redditorlist.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 37399 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/redditorstream.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 44380 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/removalreason.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 41914 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/rule.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 38857 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/rulemoderation.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 45118 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/ruleswidget.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 35953 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/styles.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 35762 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/stylesheet.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 56254 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/sublisting.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 39693 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/submenu.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 37424 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/submissionflair.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 99757 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/submissionmoderation.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 64226 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subreddit_mod_notes.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 45556 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditcollections.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 42499 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditcollectionsmoderation.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 40392 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditemoji.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 38546 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditfilters.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 62824 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditflair.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 45622 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditflairtemplates.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 58458 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditlinkflairtemplates.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 60230 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditmessage.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 86799 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditmoderation.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 66584 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditmoderationstream.html │ │ │ -rw-r--r-- 0 root (0) root (0) 35169 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditquarantine.html │ │ │ --rw-r--r-- 0 root (0) root (0) 62321 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditredditorflairtemplates.html │ │ │ --rw-r--r-- 0 root (0) root (0) 42017 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditrelationship.html │ │ │ --rw-r--r-- 0 root (0) root (0) 42559 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditremovalreasons.html │ │ │ --rw-r--r-- 0 root (0) root (0) 46540 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditrules.html │ │ │ --rw-r--r-- 0 root (0) root (0) 42967 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditrulesmoderation.html │ │ │ --rw-r--r-- 0 root (0) root (0) 38962 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditstream.html │ │ │ --rw-r--r-- 0 root (0) root (0) 79206 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditstylesheet.html │ │ │ --rw-r--r-- 0 root (0) root (0) 55063 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditwidgets.html │ │ │ --rw-r--r-- 0 root (0) root (0) 121039 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditwidgetsmoderation.html │ │ │ --rw-r--r-- 0 root (0) root (0) 46070 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditwiki.html │ │ │ --rw-r--r-- 0 root (0) root (0) 43959 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/textarea.html │ │ │ --rw-r--r-- 0 root (0) root (0) 73046 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/thingmoderationmixin.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 56541 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditredditorflairtemplates.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 40662 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditrelationship.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 41577 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditremovalreasons.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 45671 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditrules.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 42112 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditrulesmoderation.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 37970 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditstream.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 75949 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditstylesheet.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 54077 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditwidgets.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 110363 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditwidgetsmoderation.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 43614 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/subredditwiki.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 42731 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/textarea.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 71093 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/thingmoderationmixin.html │ │ │ -rw-r--r-- 0 root (0) root (0) 49143 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/token_manager.html │ │ │ --rw-r--r-- 0 root (0) root (0) 33922 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/trophy.html │ │ │ --rw-r--r-- 0 root (0) root (0) 230281 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/usersubreddit.html │ │ │ --rw-r--r-- 0 root (0) root (0) 91904 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/usersubredditmoderation.html │ │ │ --rw-r--r-- 0 root (0) root (0) 54628 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/util.html │ │ │ --rw-r--r-- 0 root (0) root (0) 36886 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/widget.html │ │ │ --rw-r--r-- 0 root (0) root (0) 40081 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/widgetmoderation.html │ │ │ --rw-r--r-- 0 root (0) root (0) 48134 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/wikipagemoderation.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 33435 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/trophy.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 208084 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/usersubreddit.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 85816 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/usersubredditmoderation.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 51317 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/util.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 35658 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/widget.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 39465 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/widgetmoderation.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 47033 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other/wikipagemoderation.html │ │ │ -rw-r--r-- 0 root (0) root (0) 65340 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/other.html │ │ │ -rw-r--r-- 0 root (0) root (0) 32449 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/praw_models.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/reddit/ │ │ │ --rw-r--r-- 0 root (0) root (0) 55292 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/reddit/drafts.html │ │ │ --rw-r--r-- 0 root (0) root (0) 75751 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/reddit/front.html │ │ │ --rw-r--r-- 0 root (0) root (0) 88549 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/reddit/inbox.html │ │ │ --rw-r--r-- 0 root (0) root (0) 49784 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/reddit/live.html │ │ │ --rw-r--r-- 0 root (0) root (0) 50428 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/reddit/multireddit.html │ │ │ --rw-r--r-- 0 root (0) root (0) 55160 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/reddit/redditors.html │ │ │ --rw-r--r-- 0 root (0) root (0) 45649 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/reddit/subreddit.html │ │ │ --rw-r--r-- 0 root (0) root (0) 68283 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/reddit/subreddits.html │ │ │ --rw-r--r-- 0 root (0) root (0) 74205 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/reddit/user.html │ │ │ --rw-r--r-- 0 root (0) root (0) 140685 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/reddit_instance.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 51088 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/reddit/drafts.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 67652 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/reddit/front.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 78837 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/reddit/inbox.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 46827 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/reddit/live.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 47232 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/reddit/multireddit.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 49750 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/reddit/redditors.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 43072 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/reddit/subreddit.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 59683 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/reddit/subreddits.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 69036 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/reddit/user.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 118441 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/code_overview/reddit_instance.html │ │ │ -rw-r--r-- 0 root (0) root (0) 205358 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/genindex.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/getting_started/ │ │ │ -rw-r--r-- 0 root (0) root (0) 55120 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/getting_started/authentication.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/getting_started/configuration/ │ │ │ -rw-r--r-- 0 root (0) root (0) 32500 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/getting_started/configuration/environment_variables.html │ │ │ -rw-r--r-- 0 root (0) root (0) 44573 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/getting_started/configuration/options.html │ │ │ --rw-r--r-- 0 root (0) root (0) 45743 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/getting_started/configuration/prawini.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 45598 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/getting_started/configuration/prawini.html │ │ │ -rw-r--r-- 0 root (0) root (0) 33331 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/getting_started/configuration/reddit_initialization.html │ │ │ -rw-r--r-- 0 root (0) root (0) 38236 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/getting_started/configuration.html │ │ │ -rw-r--r-- 0 root (0) root (0) 36012 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/getting_started/faq.html │ │ │ -rw-r--r-- 0 root (0) root (0) 33997 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/getting_started/installation.html │ │ │ --rw-r--r-- 0 root (0) root (0) 32943 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/getting_started/logging.html │ │ │ --rw-r--r-- 0 root (0) root (0) 36289 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/getting_started/multiple_instances.html │ │ │ --rw-r--r-- 0 root (0) root (0) 65780 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/getting_started/quick_start.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 32814 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/getting_started/logging.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 35841 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/getting_started/multiple_instances.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 65659 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/getting_started/quick_start.html │ │ │ -rw-r--r-- 0 root (0) root (0) 33790 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/getting_started/ratelimits.html │ │ │ -rw-r--r-- 0 root (0) root (0) 34496 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/index.html │ │ │ -rw-r--r-- 0 root (0) root (0) 11049 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/objects.inv │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/package_info/ │ │ │ --rw-r--r-- 0 root (0) root (0) 235200 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/package_info/change_log.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 234119 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/package_info/change_log.html │ │ │ -rw-r--r-- 0 root (0) root (0) 54553 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/package_info/contributing.html │ │ │ -rw-r--r-- 0 root (0) root (0) 35739 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/package_info/glossary.html │ │ │ -rw-r--r-- 0 root (0) root (0) 37969 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/package_info/praw7_migration.html │ │ │ -rw-r--r-- 0 root (0) root (0) 31877 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/package_info/references.html │ │ │ -rw-r--r-- 0 root (0) root (0) 30580 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/package_info/sponsors.html │ │ │ -rw-r--r-- 0 root (0) root (0) 29969 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/py-modindex.html │ │ │ -rw-r--r-- 0 root (0) root (0) 29263 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/search.html │ │ │ -rw-r--r-- 0 root (0) root (0) 302052 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/searchindex.js │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/tutorials/ │ │ │ --rw-r--r-- 0 root (0) root (0) 50762 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/tutorials/comments.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 50635 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/tutorials/comments.html │ │ │ -rw-r--r-- 0 root (0) root (0) 50479 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/tutorials/refresh_token.html │ │ │ --rw-r--r-- 0 root (0) root (0) 57945 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/tutorials/reply_bot.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 57701 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/tutorials/reply_bot.html │ │ │ -rw-r--r-- 0 root (0) root (0) 29978 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/html/typical_attributes.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2023-07-11 20:51:15.000000 ./usr/share/doc/praw-doc/tests/ │ │ │ -rw-r--r-- 0 root (0) root (0) 23 2023-07-11 20:51:03.000000 ./usr/share/doc/praw-doc/tests/__init__.py │ │ │ -rw-r--r-- 0 root (0) root (0) 1653 2023-07-11 20:51:03.000000 ./usr/share/doc/praw-doc/tests/conftest.py │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/tests/integration/ │ │ │ -rw-r--r-- 0 root (0) root (0) 1461 2023-07-11 20:51:03.000000 ./usr/share/doc/praw-doc/tests/integration/__init__.py.gz │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2023-10-11 20:48:18.000000 ./usr/share/doc/praw-doc/tests/integration/cassettes/ │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/exceptions.html │ │ │ @@ -366,23 +366,23 @@ │ │ │

PRAW exception classes.

│ │ │

Includes two main exceptions: RedditAPIException for when something goes wrong │ │ │ on the server side, and ClientException when something goes wrong on the │ │ │ client side. Both of these classes extend PRAWException.

│ │ │

All other exceptions are subclassed from ClientException.

│ │ │
│ │ │
│ │ │ -exception praw.exceptions.APIException(items: Union[List[Union[RedditErrorItem, List[str], str]], str], *optional_args: str)#
│ │ │ +exception praw.exceptions.APIException(items: Union[List[Union[RedditErrorItem, List[str], str]], str], *optional_args: str)# │ │ │

Old class preserved for alias purposes.

│ │ │
│ │ │

Deprecated since version 7.0: Class APIException has been deprecated in favor of │ │ │ RedditAPIException. This class will be removed in PRAW 8.0.

│ │ │
│ │ │
│ │ │
│ │ │ -__init__(items: Union[List[Union[RedditErrorItem, List[str], str]], str], *optional_args: str)#
│ │ │ +__init__(items: Union[List[Union[RedditErrorItem, List[str], str]], str], *optional_args: str)# │ │ │

Initialize a RedditAPIException instance.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • items – Either a list of instances of RedditErrorItem or a list │ │ │ containing lists of unformed errors.

    • │ │ │

  • optional_args – Takes the second and third arguments that │ │ │ @@ -397,51 +397,51 @@ │ │ │ add_note()# │ │ │

    Exception.add_note(note) – │ │ │ add a note to the exception

    │ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -property error_type: str#
│ │ │ +property error_type: str# │ │ │

Get error_type.

│ │ │
│ │ │

Deprecated since version 7.0: Accessing attributes through instances of RedditAPIException is │ │ │ deprecated. This behavior will be removed in PRAW 8.0. Check out the │ │ │ PRAW 7 Migration tutorial on how to migrate code │ │ │ from this behavior.

│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -property field: str#
│ │ │ +property field: str# │ │ │

Get field.

│ │ │
│ │ │

Deprecated since version 7.0: Accessing attributes through instances of RedditAPIException is │ │ │ deprecated. This behavior will be removed in PRAW 8.0. Check out the │ │ │ PRAW 7 Migration tutorial on how to migrate code │ │ │ from this behavior.

│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -property message: str#
│ │ │ +property message: str# │ │ │

Get message.

│ │ │
│ │ │

Deprecated since version 7.0: Accessing attributes through instances of RedditAPIException is │ │ │ deprecated. This behavior will be removed in PRAW 8.0. Check out the │ │ │ PRAW 7 Migration tutorial on how to migrate code │ │ │ from this behavior.

│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -static parse_exception_list(exceptions: List[Union[RedditErrorItem, List[str]]])#
│ │ │ +static parse_exception_list(exceptions: List[Union[RedditErrorItem, List[str]]])# │ │ │

Covert an exception list into a RedditErrorItem list.

│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ with_traceback()#
│ │ │

Exception.with_traceback(tb) – │ │ │ @@ -499,19 +499,19 @@ │ │ │ set self.__traceback__ to tb and return self.

│ │ │
│ │ │ │ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -exception praw.exceptions.InvalidFlairTemplateID(template_id: str)#
│ │ │ +exception praw.exceptions.InvalidFlairTemplateID(template_id: str)# │ │ │

Indicate exceptions where an invalid flair template ID is given.

│ │ │
│ │ │
│ │ │ -__init__(template_id: str)#
│ │ │ +__init__(template_id: str)# │ │ │

Initialize an InvalidFlairTemplateID instance.

│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ add_note()#
│ │ │

Exception.add_note(note) – │ │ │ @@ -551,19 +551,19 @@ │ │ │ set self.__traceback__ to tb and return self.

│ │ │
│ │ │ │ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -exception praw.exceptions.InvalidURL(url: str, *, message: str = 'Invalid URL: {}')#
│ │ │ +exception praw.exceptions.InvalidURL(url: str, *, message: str = 'Invalid URL: {}')# │ │ │

Indicate exceptions where an invalid URL is entered.

│ │ │
│ │ │
│ │ │ -__init__(url: str, *, message: str = 'Invalid URL: {}')#
│ │ │ +__init__(url: str, *, message: str = 'Invalid URL: {}')# │ │ │

Initialize an InvalidURL instance.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • url – The invalid URL.

    • │ │ │

  • message – The message to display. Must contain a format identifier ({} │ │ │ or {0}) (default: "Invalid URL: {}").

    • │ │ │ @@ -603,15 +603,15 @@ │ │ │ add_note()# │ │ │

    Exception.add_note(note) – │ │ │ add a note to the exception

    │ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -property original_exception: Exception#
│ │ │ +property original_exception: Exception# │ │ │

Access the original_exception attribute (now deprecated).

│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ with_traceback()#
│ │ │

Exception.with_traceback(tb) – │ │ │ @@ -693,19 +693,19 @@ │ │ │ set self.__traceback__ to tb and return self.

│ │ │
│ │ │ │ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -exception praw.exceptions.RedditAPIException(items: Union[List[Union[RedditErrorItem, List[str], str]], str], *optional_args: str)#
│ │ │ +exception praw.exceptions.RedditAPIException(items: Union[List[Union[RedditErrorItem, List[str], str]], str], *optional_args: str)# │ │ │

Container for error messages from Reddit’s API.

│ │ │
│ │ │
│ │ │ -__init__(items: Union[List[Union[RedditErrorItem, List[str], str]], str], *optional_args: str)#
│ │ │ +__init__(items: Union[List[Union[RedditErrorItem, List[str], str]], str], *optional_args: str)# │ │ │

Initialize a RedditAPIException instance.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • items – Either a list of instances of RedditErrorItem or a list │ │ │ containing lists of unformed errors.

    • │ │ │

  • optional_args – Takes the second and third arguments that │ │ │ @@ -720,97 +720,97 @@ │ │ │ add_note()# │ │ │

    Exception.add_note(note) – │ │ │ add a note to the exception

    │ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -property error_type: str#
│ │ │ +property error_type: str# │ │ │

Get error_type.

│ │ │
│ │ │

Deprecated since version 7.0: Accessing attributes through instances of RedditAPIException is │ │ │ deprecated. This behavior will be removed in PRAW 8.0. Check out the │ │ │ PRAW 7 Migration tutorial on how to migrate code │ │ │ from this behavior.

│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -property field: str#
│ │ │ +property field: str# │ │ │

Get field.

│ │ │
│ │ │

Deprecated since version 7.0: Accessing attributes through instances of RedditAPIException is │ │ │ deprecated. This behavior will be removed in PRAW 8.0. Check out the │ │ │ PRAW 7 Migration tutorial on how to migrate code │ │ │ from this behavior.

│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -property message: str#
│ │ │ +property message: str# │ │ │

Get message.

│ │ │
│ │ │

Deprecated since version 7.0: Accessing attributes through instances of RedditAPIException is │ │ │ deprecated. This behavior will be removed in PRAW 8.0. Check out the │ │ │ PRAW 7 Migration tutorial on how to migrate code │ │ │ from this behavior.

│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -static parse_exception_list(exceptions: List[Union[RedditErrorItem, List[str]]])#
│ │ │ +static parse_exception_list(exceptions: List[Union[RedditErrorItem, List[str]]])# │ │ │

Covert an exception list into a RedditErrorItem list.

│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ with_traceback()#
│ │ │

Exception.with_traceback(tb) – │ │ │ set self.__traceback__ to tb and return self.

│ │ │
│ │ │ │ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -class praw.exceptions.RedditErrorItem(error_type: str, *, field: Optional[str] = None, message: Optional[str] = None)#
│ │ │ +class praw.exceptions.RedditErrorItem(error_type: str, *, field: Optional[str] = None, message: Optional[str] = None)# │ │ │

Represents a single error returned from Reddit’s API.

│ │ │
│ │ │
│ │ │ -__init__(error_type: str, *, field: Optional[str] = None, message: Optional[str] = None)#
│ │ │ +__init__(error_type: str, *, field: Optional[str] = None, message: Optional[str] = None)# │ │ │

Initialize a RedditErrorItem instance.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • error_type – The error type set on Reddit’s end.

    • │ │ │

  • field – The input field associated with the error, if available.

    • │ │ │

  • message – The associated message for the error.

    • │ │ │
│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -property error_message: str#
│ │ │ +property error_message: str# │ │ │

Get the completed error message string.

│ │ │
│ │ │ │ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -exception praw.exceptions.TooLargeMediaException(*, actual: int, maximum_size: int)#
│ │ │ +exception praw.exceptions.TooLargeMediaException(*, actual: int, maximum_size: int)# │ │ │

Indicate exceptions from uploading media that’s too large.

│ │ │
│ │ │
│ │ │ -__init__(*, actual: int, maximum_size: int)#
│ │ │ +__init__(*, actual: int, maximum_size: int)# │ │ │

Initialize a TooLargeMediaException instance.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • actual – The actual size of the uploaded media.

    • │ │ │

  • maximum_size – The maximum size of the uploaded media.

    • │ │ │
│ │ │ @@ -832,19 +832,19 @@ │ │ │ set self.__traceback__ to tb and return self.

│ │ │
│ │ │ │ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -exception praw.exceptions.WebSocketException(message: str, exception: Optional[Exception])#
│ │ │ +exception praw.exceptions.WebSocketException(message: str, exception: Optional[Exception])# │ │ │

Indicate exceptions caused by use of WebSockets.

│ │ │
│ │ │
│ │ │ -__init__(message: str, exception: Optional[Exception])#
│ │ │ +__init__(message: str, exception: Optional[Exception])# │ │ │

Initialize a WebSocketException instance.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • message – The exception message.

    • │ │ │

  • exception –

    The exception thrown by the websocket library.

    │ │ │
    │ │ │ @@ -862,15 +862,15 @@ │ │ │ add_note()# │ │ │

    Exception.add_note(note) – │ │ │ add a note to the exception

    │ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -property original_exception: Exception#
│ │ │ +property original_exception: Exception# │ │ │

Access the original_exception attribute (now deprecated).

│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ with_traceback()#
│ │ │

Exception.with_traceback(tb) – │ │ │ ├── html2text {} │ │ │ │ @@ -171,49 +171,49 @@ │ │ │ │ _g_i_t_h_u_b_._c_o_m_/_p_r_a_w_-_d_e_v_/_p_r_a_w_c_o_r_e_/_b_l_o_b_/_m_a_s_t_e_r_/_p_r_a_w_c_o_r_e_/_e_x_c_e_p_t_i_o_n_s_._p_y │ │ │ │ ********** pprraaww..eexxcceeppttiioonnss_## ********** │ │ │ │ PRAW exception classes. │ │ │ │ Includes two main exceptions: _R_e_d_d_i_t_A_P_I_E_x_c_e_p_t_i_o_n for when something goes wrong │ │ │ │ on the server side, and _C_l_i_e_n_t_E_x_c_e_p_t_i_o_n when something goes wrong on the client │ │ │ │ side. Both of these classes extend _P_R_A_W_E_x_c_e_p_t_i_o_n. │ │ │ │ All other exceptions are subclassed from _C_l_i_e_n_t_E_x_c_e_p_t_i_o_n. │ │ │ │ - eexxcceeppttiioonn praw.exceptions.APIException(iitteemmss:: _UU_nn_ii_oo_nn[[_LL_ii_ss_tt[[_UU_nn_ii_oo_nn │ │ │ │ - [[_RR_ee_dd_dd_ii_tt_EE_rr_rr_oo_rr_II_tt_ee_mm,, _LL_ii_ss_tt[[_ss_tt_rr]],, _ss_tt_rr]]]],, _ss_tt_rr]], **ooppttiioonnaall__aarrggss:: _ss_tt_rr)_# │ │ │ │ + eexxcceeppttiioonn praw.exceptions.APIException(iitteemmss:: UUnniioonn[[LLiisstt[[UUnniioonn │ │ │ │ + [[_RR_ee_dd_dd_ii_tt_EE_rr_rr_oo_rr_II_tt_ee_mm,, LLiisstt[[ssttrr]],, ssttrr]]]],, ssttrr]], **ooppttiioonnaall__aarrggss:: ssttrr)_# │ │ │ │ Old class preserved for alias purposes. │ │ │ │ Deprecated since version 7.0: Class _A_P_I_E_x_c_e_p_t_i_o_n has been deprecated in │ │ │ │ favor of _R_e_d_d_i_t_A_P_I_E_x_c_e_p_t_i_o_n. This class will be removed in PRAW 8.0. │ │ │ │ - __init__(iitteemmss:: _UU_nn_ii_oo_nn[[_LL_ii_ss_tt[[_UU_nn_ii_oo_nn[[_RR_ee_dd_dd_ii_tt_EE_rr_rr_oo_rr_II_tt_ee_mm,, _LL_ii_ss_tt[[_ss_tt_rr]],, _ss_tt_rr]]]],, │ │ │ │ - _ss_tt_rr]], **ooppttiioonnaall__aarrggss:: _ss_tt_rr)_# │ │ │ │ + __init__(iitteemmss:: UUnniioonn[[LLiisstt[[UUnniioonn[[_RR_ee_dd_dd_ii_tt_EE_rr_rr_oo_rr_II_tt_ee_mm,, LLiisstt[[ssttrr]],, ssttrr]]]],, │ │ │ │ + ssttrr]], **ooppttiioonnaall__aarrggss:: ssttrr)_# │ │ │ │ Initialize a _R_e_d_d_i_t_A_P_I_E_x_c_e_p_t_i_o_n instance. │ │ │ │ Parameters: │ │ │ │ * iitteemmss – Either a list of instances of _R_e_d_d_i_t_E_r_r_o_r_I_t_e_m │ │ │ │ or a list containing lists of unformed errors. │ │ │ │ * ooppttiioonnaall__aarrggss – Takes the second and third arguments │ │ │ │ that _A_P_I_E_x_c_e_p_t_i_o_n used to take. │ │ │ │ add_note()_# │ │ │ │ Exception.add_note(note) – add a note to the exception │ │ │ │ - pprrooppeerrttyy error_type:: _ss_tt_rr_# │ │ │ │ + pprrooppeerrttyy error_type:: ssttrr_# │ │ │ │ Get error_type. │ │ │ │ Deprecated since version 7.0: Accessing attributes through │ │ │ │ instances of _R_e_d_d_i_t_A_P_I_E_x_c_e_p_t_i_o_n is deprecated. This behavior will │ │ │ │ be removed in PRAW 8.0. Check out the _P_R_A_W_ _7_ _M_i_g_r_a_t_i_o_n_ _t_u_t_o_r_i_a_l on │ │ │ │ how to migrate code from this behavior. │ │ │ │ - pprrooppeerrttyy field:: _ss_tt_rr_# │ │ │ │ + pprrooppeerrttyy field:: ssttrr_# │ │ │ │ Get field. │ │ │ │ Deprecated since version 7.0: Accessing attributes through │ │ │ │ instances of _R_e_d_d_i_t_A_P_I_E_x_c_e_p_t_i_o_n is deprecated. This behavior will │ │ │ │ be removed in PRAW 8.0. Check out the _P_R_A_W_ _7_ _M_i_g_r_a_t_i_o_n_ _t_u_t_o_r_i_a_l on │ │ │ │ how to migrate code from this behavior. │ │ │ │ - pprrooppeerrttyy message:: _ss_tt_rr_# │ │ │ │ + pprrooppeerrttyy message:: ssttrr_# │ │ │ │ Get message. │ │ │ │ Deprecated since version 7.0: Accessing attributes through │ │ │ │ instances of _R_e_d_d_i_t_A_P_I_E_x_c_e_p_t_i_o_n is deprecated. This behavior will │ │ │ │ be removed in PRAW 8.0. Check out the _P_R_A_W_ _7_ _M_i_g_r_a_t_i_o_n_ _t_u_t_o_r_i_a_l on │ │ │ │ how to migrate code from this behavior. │ │ │ │ - ssttaattiicc parse_exception_list(eexxcceeppttiioonnss:: _LL_ii_ss_tt[[_UU_nn_ii_oo_nn[[_RR_ee_dd_dd_ii_tt_EE_rr_rr_oo_rr_II_tt_ee_mm,, │ │ │ │ - _LL_ii_ss_tt[[_ss_tt_rr]]]]]])_# │ │ │ │ + ssttaattiicc parse_exception_list(eexxcceeppttiioonnss:: LLiisstt[[UUnniioonn[[_RR_ee_dd_dd_ii_tt_EE_rr_rr_oo_rr_II_tt_ee_mm,, │ │ │ │ + LLiisstt[[ssttrr]]]]]])_# │ │ │ │ Covert an exception list into a _R_e_d_d_i_t_E_r_r_o_r_I_t_e_m list. │ │ │ │ with_traceback()_# │ │ │ │ Exception.with_traceback(tb) – set self.__traceback__ to tb and │ │ │ │ return self. │ │ │ │ eexxcceeppttiioonn praw.exceptions.ClientException_# │ │ │ │ Indicate exceptions that don’t involve interaction with Reddit’s API. │ │ │ │ __init__(**aarrggss, ****kkwwaarrggss)_# │ │ │ │ @@ -227,17 +227,17 @@ │ │ │ │ __init__()_# │ │ │ │ Initialize a _D_u_p_l_i_c_a_t_e_R_e_p_l_a_c_e_E_x_c_e_p_t_i_o_n instance. │ │ │ │ add_note()_# │ │ │ │ Exception.add_note(note) – add a note to the exception │ │ │ │ with_traceback()_# │ │ │ │ Exception.with_traceback(tb) – set self.__traceback__ to tb and │ │ │ │ return self. │ │ │ │ - eexxcceeppttiioonn praw.exceptions.InvalidFlairTemplateID(tteemmppllaattee__iidd:: _ss_tt_rr)_# │ │ │ │ + eexxcceeppttiioonn praw.exceptions.InvalidFlairTemplateID(tteemmppllaattee__iidd:: ssttrr)_# │ │ │ │ Indicate exceptions where an invalid flair template ID is given. │ │ │ │ - __init__(tteemmppllaattee__iidd:: _ss_tt_rr)_# │ │ │ │ + __init__(tteemmppllaattee__iidd:: ssttrr)_# │ │ │ │ Initialize an _I_n_v_a_l_i_d_F_l_a_i_r_T_e_m_p_l_a_t_e_I_D instance. │ │ │ │ add_note()_# │ │ │ │ Exception.add_note(note) – add a note to the exception │ │ │ │ with_traceback()_# │ │ │ │ Exception.with_traceback(tb) – set self.__traceback__ to tb and │ │ │ │ return self. │ │ │ │ eexxcceeppttiioonn praw.exceptions.InvalidImplicitAuth_# │ │ │ │ @@ -245,18 +245,18 @@ │ │ │ │ __init__()_# │ │ │ │ Initialize an _I_n_v_a_l_i_d_I_m_p_l_i_c_i_t_A_u_t_h instance. │ │ │ │ add_note()_# │ │ │ │ Exception.add_note(note) – add a note to the exception │ │ │ │ with_traceback()_# │ │ │ │ Exception.with_traceback(tb) – set self.__traceback__ to tb and │ │ │ │ return self. │ │ │ │ - eexxcceeppttiioonn praw.exceptions.InvalidURL(uurrll:: _ss_tt_rr, **, mmeessssaaggee:: _ss_tt_rr == ''IInnvvaalliidd │ │ │ │ + eexxcceeppttiioonn praw.exceptions.InvalidURL(uurrll:: ssttrr, **, mmeessssaaggee:: ssttrr == ''IInnvvaalliidd │ │ │ │ UURRLL:: {{}}'')_# │ │ │ │ Indicate exceptions where an invalid URL is entered. │ │ │ │ - __init__(uurrll:: _ss_tt_rr, **, mmeessssaaggee:: _ss_tt_rr == ''IInnvvaalliidd UURRLL:: {{}}'')_# │ │ │ │ + __init__(uurrll:: ssttrr, **, mmeessssaaggee:: ssttrr == ''IInnvvaalliidd UURRLL:: {{}}'')_# │ │ │ │ Initialize an _I_n_v_a_l_i_d_U_R_L instance. │ │ │ │ Parameters: │ │ │ │ * uurrll – The invalid URL. │ │ │ │ * mmeessssaaggee – The message to display. Must contain a format │ │ │ │ identifier ({} or {0}) (default: "Invalid URL: {}"). │ │ │ │ add_note()_# │ │ │ │ Exception.add_note(note) – add a note to the exception │ │ │ │ @@ -265,15 +265,15 @@ │ │ │ │ return self. │ │ │ │ eexxcceeppttiioonn praw.exceptions.MediaPostFailed_# │ │ │ │ Indicate exceptions where media uploads failed.. │ │ │ │ __init__()_# │ │ │ │ Initialize a _M_e_d_i_a_P_o_s_t_F_a_i_l_e_d instance. │ │ │ │ add_note()_# │ │ │ │ Exception.add_note(note) – add a note to the exception │ │ │ │ - pprrooppeerrttyy original_exception:: _EE_xx_cc_ee_pp_tt_ii_oo_nn_# │ │ │ │ + pprrooppeerrttyy original_exception:: EExxcceeppttiioonn_# │ │ │ │ Access the original_exception attribute (now deprecated). │ │ │ │ with_traceback()_# │ │ │ │ Exception.with_traceback(tb) – set self.__traceback__ to tb and │ │ │ │ return self. │ │ │ │ eexxcceeppttiioonn praw.exceptions.MissingRequiredAttributeException_# │ │ │ │ Indicate exceptions caused by not including a required attribute. │ │ │ │ __init__(**aarrggss, ****kkwwaarrggss)_# │ │ │ │ @@ -294,85 +294,85 @@ │ │ │ │ Raised when a method call requires _r_e_a_d___o_n_l_y mode to be disabled. │ │ │ │ __init__(**aarrggss, ****kkwwaarrggss)_# │ │ │ │ add_note()_# │ │ │ │ Exception.add_note(note) – add a note to the exception │ │ │ │ with_traceback()_# │ │ │ │ Exception.with_traceback(tb) – set self.__traceback__ to tb and │ │ │ │ return self. │ │ │ │ - eexxcceeppttiioonn praw.exceptions.RedditAPIException(iitteemmss:: _UU_nn_ii_oo_nn[[_LL_ii_ss_tt[[_UU_nn_ii_oo_nn │ │ │ │ - [[_RR_ee_dd_dd_ii_tt_EE_rr_rr_oo_rr_II_tt_ee_mm,, _LL_ii_ss_tt[[_ss_tt_rr]],, _ss_tt_rr]]]],, _ss_tt_rr]], **ooppttiioonnaall__aarrggss:: _ss_tt_rr)_# │ │ │ │ + eexxcceeppttiioonn praw.exceptions.RedditAPIException(iitteemmss:: UUnniioonn[[LLiisstt[[UUnniioonn │ │ │ │ + [[_RR_ee_dd_dd_ii_tt_EE_rr_rr_oo_rr_II_tt_ee_mm,, LLiisstt[[ssttrr]],, ssttrr]]]],, ssttrr]], **ooppttiioonnaall__aarrggss:: ssttrr)_# │ │ │ │ Container for error messages from Reddit’s API. │ │ │ │ - __init__(iitteemmss:: _UU_nn_ii_oo_nn[[_LL_ii_ss_tt[[_UU_nn_ii_oo_nn[[_RR_ee_dd_dd_ii_tt_EE_rr_rr_oo_rr_II_tt_ee_mm,, _LL_ii_ss_tt[[_ss_tt_rr]],, _ss_tt_rr]]]],, │ │ │ │ - _ss_tt_rr]], **ooppttiioonnaall__aarrggss:: _ss_tt_rr)_# │ │ │ │ + __init__(iitteemmss:: UUnniioonn[[LLiisstt[[UUnniioonn[[_RR_ee_dd_dd_ii_tt_EE_rr_rr_oo_rr_II_tt_ee_mm,, LLiisstt[[ssttrr]],, ssttrr]]]],, │ │ │ │ + ssttrr]], **ooppttiioonnaall__aarrggss:: ssttrr)_# │ │ │ │ Initialize a _R_e_d_d_i_t_A_P_I_E_x_c_e_p_t_i_o_n instance. │ │ │ │ Parameters: │ │ │ │ * iitteemmss – Either a list of instances of _R_e_d_d_i_t_E_r_r_o_r_I_t_e_m │ │ │ │ or a list containing lists of unformed errors. │ │ │ │ * ooppttiioonnaall__aarrggss – Takes the second and third arguments │ │ │ │ that _A_P_I_E_x_c_e_p_t_i_o_n used to take. │ │ │ │ add_note()_# │ │ │ │ Exception.add_note(note) – add a note to the exception │ │ │ │ - pprrooppeerrttyy error_type:: _ss_tt_rr_# │ │ │ │ + pprrooppeerrttyy error_type:: ssttrr_# │ │ │ │ Get error_type. │ │ │ │ Deprecated since version 7.0: Accessing attributes through │ │ │ │ instances of _R_e_d_d_i_t_A_P_I_E_x_c_e_p_t_i_o_n is deprecated. This behavior will │ │ │ │ be removed in PRAW 8.0. Check out the _P_R_A_W_ _7_ _M_i_g_r_a_t_i_o_n_ _t_u_t_o_r_i_a_l on │ │ │ │ how to migrate code from this behavior. │ │ │ │ - pprrooppeerrttyy field:: _ss_tt_rr_# │ │ │ │ + pprrooppeerrttyy field:: ssttrr_# │ │ │ │ Get field. │ │ │ │ Deprecated since version 7.0: Accessing attributes through │ │ │ │ instances of _R_e_d_d_i_t_A_P_I_E_x_c_e_p_t_i_o_n is deprecated. This behavior will │ │ │ │ be removed in PRAW 8.0. Check out the _P_R_A_W_ _7_ _M_i_g_r_a_t_i_o_n_ _t_u_t_o_r_i_a_l on │ │ │ │ how to migrate code from this behavior. │ │ │ │ - pprrooppeerrttyy message:: _ss_tt_rr_# │ │ │ │ + pprrooppeerrttyy message:: ssttrr_# │ │ │ │ Get message. │ │ │ │ Deprecated since version 7.0: Accessing attributes through │ │ │ │ instances of _R_e_d_d_i_t_A_P_I_E_x_c_e_p_t_i_o_n is deprecated. This behavior will │ │ │ │ be removed in PRAW 8.0. Check out the _P_R_A_W_ _7_ _M_i_g_r_a_t_i_o_n_ _t_u_t_o_r_i_a_l on │ │ │ │ how to migrate code from this behavior. │ │ │ │ - ssttaattiicc parse_exception_list(eexxcceeppttiioonnss:: _LL_ii_ss_tt[[_UU_nn_ii_oo_nn[[_RR_ee_dd_dd_ii_tt_EE_rr_rr_oo_rr_II_tt_ee_mm,, │ │ │ │ - _LL_ii_ss_tt[[_ss_tt_rr]]]]]])_# │ │ │ │ + ssttaattiicc parse_exception_list(eexxcceeppttiioonnss:: LLiisstt[[UUnniioonn[[_RR_ee_dd_dd_ii_tt_EE_rr_rr_oo_rr_II_tt_ee_mm,, │ │ │ │ + LLiisstt[[ssttrr]]]]]])_# │ │ │ │ Covert an exception list into a _R_e_d_d_i_t_E_r_r_o_r_I_t_e_m list. │ │ │ │ with_traceback()_# │ │ │ │ Exception.with_traceback(tb) – set self.__traceback__ to tb and │ │ │ │ return self. │ │ │ │ - ccllaassss praw.exceptions.RedditErrorItem(eerrrroorr__ttyyppee:: _ss_tt_rr, **, ffiieelldd:: _OO_pp_tt_ii_oo_nn_aa_ll │ │ │ │ - [[_ss_tt_rr]] == NNoonnee, mmeessssaaggee:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee)_# │ │ │ │ + ccllaassss praw.exceptions.RedditErrorItem(eerrrroorr__ttyyppee:: ssttrr, **, ffiieelldd:: OOppttiioonnaall │ │ │ │ + [[ssttrr]] == NNoonnee, mmeessssaaggee:: OOppttiioonnaall[[ssttrr]] == NNoonnee)_# │ │ │ │ Represents a single error returned from Reddit’s API. │ │ │ │ - __init__(eerrrroorr__ttyyppee:: _ss_tt_rr, **, ffiieelldd:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, mmeessssaaggee:: │ │ │ │ - _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee)_# │ │ │ │ + __init__(eerrrroorr__ttyyppee:: ssttrr, **, ffiieelldd:: OOppttiioonnaall[[ssttrr]] == NNoonnee, mmeessssaaggee:: │ │ │ │ + OOppttiioonnaall[[ssttrr]] == NNoonnee)_# │ │ │ │ Initialize a _R_e_d_d_i_t_E_r_r_o_r_I_t_e_m instance. │ │ │ │ Parameters: │ │ │ │ * eerrrroorr__ttyyppee – The error type set on Reddit’s end. │ │ │ │ * ffiieelldd – The input field associated with the error, if │ │ │ │ available. │ │ │ │ * mmeessssaaggee – The associated message for the error. │ │ │ │ - pprrooppeerrttyy error_message:: _ss_tt_rr_# │ │ │ │ + pprrooppeerrttyy error_message:: ssttrr_# │ │ │ │ Get the completed error message string. │ │ │ │ - eexxcceeppttiioonn praw.exceptions.TooLargeMediaException(**, aaccttuuaall:: _ii_nn_tt, │ │ │ │ - mmaaxxiimmuumm__ssiizzee:: _ii_nn_tt)_# │ │ │ │ + eexxcceeppttiioonn praw.exceptions.TooLargeMediaException(**, aaccttuuaall:: iinntt, │ │ │ │ + mmaaxxiimmuumm__ssiizzee:: iinntt)_# │ │ │ │ Indicate exceptions from uploading media that’s too large. │ │ │ │ - __init__(**, aaccttuuaall:: _ii_nn_tt, mmaaxxiimmuumm__ssiizzee:: _ii_nn_tt)_# │ │ │ │ + __init__(**, aaccttuuaall:: iinntt, mmaaxxiimmuumm__ssiizzee:: iinntt)_# │ │ │ │ Initialize a _T_o_o_L_a_r_g_e_M_e_d_i_a_E_x_c_e_p_t_i_o_n instance. │ │ │ │ Parameters: │ │ │ │ * aaccttuuaall – The actual size of the uploaded media. │ │ │ │ * mmaaxxiimmuumm__ssiizzee – The maximum size of the uploaded media. │ │ │ │ add_note()_# │ │ │ │ Exception.add_note(note) – add a note to the exception │ │ │ │ with_traceback()_# │ │ │ │ Exception.with_traceback(tb) – set self.__traceback__ to tb and │ │ │ │ return self. │ │ │ │ - eexxcceeppttiioonn praw.exceptions.WebSocketException(mmeessssaaggee:: _ss_tt_rr, eexxcceeppttiioonn:: │ │ │ │ - _OO_pp_tt_ii_oo_nn_aa_ll[[_EE_xx_cc_ee_pp_tt_ii_oo_nn]])_# │ │ │ │ + eexxcceeppttiioonn praw.exceptions.WebSocketException(mmeessssaaggee:: ssttrr, eexxcceeppttiioonn:: │ │ │ │ + OOppttiioonnaall[[EExxcceeppttiioonn]])_# │ │ │ │ Indicate exceptions caused by use of WebSockets. │ │ │ │ - __init__(mmeessssaaggee:: _ss_tt_rr, eexxcceeppttiioonn:: _OO_pp_tt_ii_oo_nn_aa_ll[[_EE_xx_cc_ee_pp_tt_ii_oo_nn]])_# │ │ │ │ + __init__(mmeessssaaggee:: ssttrr, eexxcceeppttiioonn:: OOppttiioonnaall[[EExxcceeppttiioonn]])_# │ │ │ │ Initialize a _W_e_b_S_o_c_k_e_t_E_x_c_e_p_t_i_o_n instance. │ │ │ │ add_note()_# │ │ │ │ Exception.add_note(note) – add a note to the exception │ │ │ │ - pprrooppeerrttyy original_exception:: _EE_xx_cc_ee_pp_tt_ii_oo_nn_# │ │ │ │ + pprrooppeerrttyy original_exception:: EExxcceeppttiioonn_# │ │ │ │ Access the original_exception attribute (now deprecated). │ │ │ │ with_traceback()_# │ │ │ │ Exception.with_traceback(tb) – set self.__traceback__ to tb and │ │ │ │ return self. │ │ │ │ _N_e_x_t │ │ │ │ _O_t_h_e_r_ _C_l_a_s_s_e_s │ │ │ │ _P_r_e_v_i_o_u_s │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/models/comment.html │ │ │ @@ -355,15 +355,15 @@ │ │ │ │ │ │ │ │ │

│ │ │
│ │ │

Comment#

│ │ │
│ │ │
│ │ │ -class praw.models.Comment(reddit: praw.Reddit, id: Optional[str] = None, url: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)#
│ │ │ +class praw.models.Comment(reddit: praw.Reddit, id: Optional[str] = None, url: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)# │ │ │

A class that represents a Reddit comment.

│ │ │

Typical Attributes

│ │ │
│ │ │

Note

│ │ │

This table describes attributes that typically belong to objects of this class. PRAW │ │ │ dynamically provides the attributes that Reddit returns via the API. Since those │ │ │ attributes are subject to change on Reddit’s end, PRAW makes no effort to document │ │ │ @@ -442,21 +442,21 @@ │ │ │

The subreddit ID that the comment belongs to.

│ │ │ │ │ │ │ │ │ │ │ │
│ │ │
│ │ │
│ │ │ -__init__(reddit: praw.Reddit, id: Optional[str] = None, url: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)#
│ │ │ +__init__(reddit: praw.Reddit, id: Optional[str] = None, url: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)# │ │ │

Initialize a Comment instance.

│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -award(*, gild_type: str = 'gid_2', is_anonymous: bool = True, message: str = None) → dict#
│ │ │ +award(*, gild_type: str = 'gid_2', is_anonymous: bool = True, message: str = None) → dict# │ │ │

Award the author of the item.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • gild_type – Type of award to give. See table below for currently know │ │ │ global award types.

    • │ │ │

  • is_anonymous – If True, the authenticated user’s username will not be │ │ │ @@ -650,15 +650,15 @@ │ │ │

    See also

    │ │ │

    upvote()

    │ │ │ │ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -edit(body: str) → Union[praw.models.Comment, praw.models.Submission]#
│ │ │ +edit(body: str) → Union[praw.models.Comment, praw.models.Submission]# │ │ │

Replace the body of the object with body.

│ │ │
│ │ │
Parameters:
│ │ │

body – The Markdown formatted content for the updated object.

│ │ │
│ │ │
Returns:
│ │ │

The current instance after updating its attributes.

│ │ │ @@ -691,35 +691,35 @@ │ │ │

See also

│ │ │

disable_inbox_replies()

│ │ │ │ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -property fullname: str#
│ │ │ +property fullname: str# │ │ │

Return the object’s fullname.

│ │ │

A fullname is an object’s kind mapping like t3 followed by an underscore and │ │ │ the object’s base36 ID, e.g., t1_c5s96e0.

│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -gild() → dict#
│ │ │ +gild() → dict# │ │ │

Alias for award() to maintain backwards compatibility.

│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -static id_from_url(url: str) → str#
│ │ │ +static id_from_url(url: str) → str# │ │ │

Get the ID of a comment from the full URL.

│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -property is_root: bool#
│ │ │ +property is_root: bool# │ │ │

Return True when the comment is a top-level comment.

│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ mark_read()#
│ │ │

Mark a single inbox item as read.

│ │ │ @@ -774,15 +774,15 @@ │ │ │ comment.mod.approve() │ │ │ │ │ │ │ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -parent() → Union[Comment, praw.models.Submission]#
│ │ │ +parent() → Union[Comment, praw.models.Submission]# │ │ │

Return the parent of the comment.

│ │ │

The returned parent will be an instance of either Comment, or │ │ │ Submission.

│ │ │

If this comment was obtained through a Submission, then its entire │ │ │ ancestry should be immediately available, requiring no extra network requests. │ │ │ However, if this comment was obtained through other means, e.g., │ │ │ reddit.comment("COMMENT_ID"), or reddit.inbox.comment_replies, then the │ │ │ @@ -819,15 +819,15 @@ │ │ │ │ │ │

The above code should result in 5 network requests to Reddit. Without the calls │ │ │ to refresh() it would make at least 31 network requests.

│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
│ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

Return an instance of cls from data.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • data – The structured data.

    • │ │ │

  • reddit – An instance of Reddit.

    • │ │ │
│ │ │ @@ -867,15 +867,15 @@ │ │ │

The appropriate values for reply_sort include "confidence", │ │ │ "controversial", "new", "old", "q&a", and "top".

│ │ │ │ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -reply(body: str) → Optional[Union[praw.models.Comment, praw.models.Message]]#
│ │ │ +reply(body: str) → Optional[Union[praw.models.Comment, praw.models.Message]]# │ │ │

Reply to the object.

│ │ │
│ │ │
Parameters:
│ │ │

body – The Markdown formatted content for a comment.

│ │ │
│ │ │
Returns:
│ │ │

A Comment or Message object for the newly created │ │ │ @@ -898,15 +898,15 @@ │ │ │ comment.reply("reply") │ │ │ │ │ │ │ │ │

│ │ │ │ │ │
│ │ │
│ │ │ -report(reason: str)#
│ │ │ +report(reason: str)# │ │ │

Report this object to the moderators of its subreddit.

│ │ │
│ │ │
Parameters:
│ │ │

reason – The reason for reporting.

│ │ │
│ │ │
Raises:
│ │ │

RedditAPIException if reason is longer than 100 │ │ │ @@ -921,15 +921,15 @@ │ │ │ comment.report("report reason") │ │ │ │ │ │ │ │ │

│ │ │ │ │ │
│ │ │
│ │ │ -save(*, category: Optional[str] = None)#
│ │ │ +save(*, category: Optional[str] = None)# │ │ │

Save the object.

│ │ │
│ │ │
Parameters:
│ │ │

category – The category to save to. If the authenticated user does not │ │ │ have Reddit Premium this value is ignored by Reddit (default: None).

│ │ │
│ │ │
│ │ │ ├── html2text {} │ │ │ │ @@ -161,16 +161,16 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ CCoommmmeenntt_## ************ │ │ │ │ - ccllaassss praw.models.Comment(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, iidd:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, uurrll:: │ │ │ │ - _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]]]] == NNoonnee)_# │ │ │ │ + ccllaassss praw.models.Comment(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, iidd:: OOppttiioonnaall[[ssttrr]] == NNoonnee, uurrll:: │ │ │ │ + OOppttiioonnaall[[ssttrr]] == NNoonnee, __ddaattaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, AAnnyy]]]] == NNoonnee)_# │ │ │ │ A class that represents a Reddit comment. │ │ │ │ TTyyppiiccaall AAttttrriibbuutteess │ │ │ │ Note │ │ │ │ This table describes attributes that typically belong to objects of this │ │ │ │ class. PRAW dynamically provides the attributes that Reddit returns via │ │ │ │ the API. Since those attributes are subject to change on Reddit’s end, │ │ │ │ PRAW makes no effort to document any new/removed/changed attributes, │ │ │ │ @@ -200,19 +200,19 @@ │ │ │ │ score The number of upvotes for the comment. │ │ │ │ stickied Whether or not the comment is stickied. │ │ │ │ submission Provides an instance of _S_u_b_m_i_s_s_i_o_n. The submission that the │ │ │ │ comment belongs to. │ │ │ │ subreddit Provides an instance of _S_u_b_r_e_d_d_i_t. The subreddit that the │ │ │ │ comment belongs to. │ │ │ │ subreddit_id The subreddit ID that the comment belongs to. │ │ │ │ - __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, iidd:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, uurrll:: _OO_pp_tt_ii_oo_nn_aa_ll │ │ │ │ - [[_ss_tt_rr]] == NNoonnee, __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]]]] == NNoonnee)_# │ │ │ │ + __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, iidd:: OOppttiioonnaall[[ssttrr]] == NNoonnee, uurrll:: OOppttiioonnaall │ │ │ │ + [[ssttrr]] == NNoonnee, __ddaattaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, AAnnyy]]]] == NNoonnee)_# │ │ │ │ Initialize a _C_o_m_m_e_n_t instance. │ │ │ │ - award(**, ggiilldd__ttyyppee:: _ss_tt_rr == ''ggiidd__22'', iiss__aannoonnyymmoouuss:: _bb_oo_oo_ll == TTrruuee, mmeessssaaggee:: │ │ │ │ - _ss_tt_rr == NNoonnee) → _d_i_c_t_# │ │ │ │ + award(**, ggiilldd__ttyyppee:: ssttrr == ''ggiidd__22'', iiss__aannoonnyymmoouuss:: bbooooll == TTrruuee, mmeessssaaggee:: │ │ │ │ + ssttrr == NNoonnee) → dict_# │ │ │ │ Award the author of the item. │ │ │ │ Warning │ │ │ │ Requires the authenticated user to own Reddit Coins. Calling this │ │ │ │ method will consume Reddit Coins. │ │ │ │ To award the gold award anonymously do: │ │ │ │ comment = reddit.comment("dkk4qjd") │ │ │ │ comment.award() │ │ │ │ @@ -294,15 +294,15 @@ │ │ │ │ submission = reddit.submission("5or86n") │ │ │ │ submission.downvote() │ │ │ │ │ │ │ │ comment = reddit.comment("dxolpyc") │ │ │ │ comment.downvote() │ │ │ │ See also │ │ │ │ _u_p_v_o_t_e_(_) │ │ │ │ - edit(bbooddyy:: _ss_tt_rr) → _U_n_i_o_n[_p_r_a_w_._m_o_d_e_l_s_._C_o_m_m_e_n_t, _p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]_# │ │ │ │ + edit(bbooddyy:: ssttrr) → Union[_p_r_a_w_._m_o_d_e_l_s_._C_o_m_m_e_n_t, _p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]_# │ │ │ │ Replace the body of the object with body. │ │ │ │ Parameters: │ │ │ │ bbooddyy – The Markdown formatted content for the updated object. │ │ │ │ Returns: │ │ │ │ The current instance after updating its attributes. │ │ │ │ Example usage: │ │ │ │ comment = reddit.comment("dkk4qjd") │ │ │ │ @@ -317,23 +317,23 @@ │ │ │ │ comment = reddit.comment("dkk4qjd") │ │ │ │ comment.enable_inbox_replies() │ │ │ │ │ │ │ │ submission = reddit.submission("8dmv8z") │ │ │ │ submission.enable_inbox_replies() │ │ │ │ See also │ │ │ │ _d_i_s_a_b_l_e___i_n_b_o_x___r_e_p_l_i_e_s_(_) │ │ │ │ - pprrooppeerrttyy fullname:: _ss_tt_rr_# │ │ │ │ + pprrooppeerrttyy fullname:: ssttrr_# │ │ │ │ Return the object’s fullname. │ │ │ │ A fullname is an object’s kind mapping like t3 followed by an │ │ │ │ underscore and the object’s base36 ID, e.g., t1_c5s96e0. │ │ │ │ - gild() → _d_i_c_t_# │ │ │ │ + gild() → dict_# │ │ │ │ Alias for _a_w_a_r_d_(_) to maintain backwards compatibility. │ │ │ │ - ssttaattiicc id_from_url(uurrll:: _ss_tt_rr) → _s_t_r_# │ │ │ │ + ssttaattiicc id_from_url(uurrll:: ssttrr) → str_# │ │ │ │ Get the ID of a comment from the full URL. │ │ │ │ - pprrooppeerrttyy is_root:: _bb_oo_oo_ll_# │ │ │ │ + pprrooppeerrttyy is_root:: bbooooll_# │ │ │ │ Return True when the comment is a top-level comment. │ │ │ │ mark_read()_# │ │ │ │ Mark a single inbox item as read. │ │ │ │ Note │ │ │ │ This method pertains only to objects which were retrieved via the │ │ │ │ inbox. │ │ │ │ Example usage: │ │ │ │ @@ -360,15 +360,15 @@ │ │ │ │ See also │ │ │ │ _m_a_r_k___r_e_a_d_(_) │ │ │ │ mod() → _p_r_a_w_._m_o_d_e_l_s_._r_e_d_d_i_t_._c_o_m_m_e_n_t_._C_o_m_m_e_n_t_M_o_d_e_r_a_t_i_o_n_# │ │ │ │ Provide an instance of _C_o_m_m_e_n_t_M_o_d_e_r_a_t_i_o_n. │ │ │ │ Example usage: │ │ │ │ comment = reddit.comment("dkk4qjd") │ │ │ │ comment.mod.approve() │ │ │ │ - parent() → _U_n_i_o_n[_C_o_m_m_e_n_t, _p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]_# │ │ │ │ + parent() → Union[_C_o_m_m_e_n_t, _p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]_# │ │ │ │ Return the parent of the comment. │ │ │ │ The returned parent will be an instance of either _C_o_m_m_e_n_t, or │ │ │ │ _S_u_b_m_i_s_s_i_o_n. │ │ │ │ If this comment was obtained through a _S_u_b_m_i_s_s_i_o_n, then its entire │ │ │ │ ancestry should be immediately available, requiring no extra │ │ │ │ network requests. However, if this comment was obtained through │ │ │ │ other means, e.g., reddit.comment("COMMENT_ID"), or │ │ │ │ @@ -398,15 +398,15 @@ │ │ │ │ if refresh_counter % 9 == 0: │ │ │ │ ancestor.refresh() │ │ │ │ refresh_counter += 1 │ │ │ │ print(f"Top-most Ancestor: {ancestor}") │ │ │ │ The above code should result in 5 network requests to Reddit. │ │ │ │ Without the calls to _r_e_f_r_e_s_h_(_) it would make at least 31 network │ │ │ │ requests. │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ refresh()_# │ │ │ │ Refresh the comment’s attributes. │ │ │ │ If using _R_e_d_d_i_t_._c_o_m_m_e_n_t_(_) this method must be called in order to │ │ │ │ @@ -423,15 +423,15 @@ │ │ │ │ call to _r_e_f_r_e_s_h_(_): │ │ │ │ comment.reply_sort = "new" │ │ │ │ comment.refresh() │ │ │ │ replies = comment.replies │ │ │ │ Note │ │ │ │ The appropriate values for reply_sort include "confidence", │ │ │ │ "controversial", "new", "old", "q&a", and "top". │ │ │ │ - reply(bbooddyy:: _ss_tt_rr) → _O_p_t_i_o_n_a_l[_U_n_i_o_n[_p_r_a_w_._m_o_d_e_l_s_._C_o_m_m_e_n_t, │ │ │ │ + reply(bbooddyy:: ssttrr) → Optional[Union[_p_r_a_w_._m_o_d_e_l_s_._C_o_m_m_e_n_t, │ │ │ │ _p_r_a_w_._m_o_d_e_l_s_._M_e_s_s_a_g_e]]_# │ │ │ │ Reply to the object. │ │ │ │ Parameters: │ │ │ │ bbooddyy – The Markdown formatted content for a comment. │ │ │ │ Returns: │ │ │ │ A _C_o_m_m_e_n_t or _M_e_s_s_a_g_e object for the newly created comment or │ │ │ │ message or None if Reddit doesn’t provide one. │ │ │ │ @@ -446,27 +446,27 @@ │ │ │ │ by drawing the comment from the user’s comment history. │ │ │ │ Example usage: │ │ │ │ submission = reddit.submission("5or86n") │ │ │ │ submission.reply("reply") │ │ │ │ │ │ │ │ comment = reddit.comment("dxolpyc") │ │ │ │ comment.reply("reply") │ │ │ │ - report(rreeaassoonn:: _ss_tt_rr)_# │ │ │ │ + report(rreeaassoonn:: ssttrr)_# │ │ │ │ Report this object to the moderators of its subreddit. │ │ │ │ Parameters: │ │ │ │ rreeaassoonn – The reason for reporting. │ │ │ │ Raises: │ │ │ │ _R_e_d_d_i_t_A_P_I_E_x_c_e_p_t_i_o_n if reason is longer than 100 characters. │ │ │ │ Example usage: │ │ │ │ submission = reddit.submission("5or86n") │ │ │ │ submission.report("report reason") │ │ │ │ │ │ │ │ comment = reddit.comment("dxolpyc") │ │ │ │ comment.report("report reason") │ │ │ │ - save(**, ccaatteeggoorryy:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee)_# │ │ │ │ + save(**, ccaatteeggoorryy:: OOppttiioonnaall[[ssttrr]] == NNoonnee)_# │ │ │ │ Save the object. │ │ │ │ Parameters: │ │ │ │ ccaatteeggoorryy – The category to save to. If the authenticated user │ │ │ │ does not have Reddit Premium this value is ignored by Reddit │ │ │ │ (default: None). │ │ │ │ Example usage: │ │ │ │ submission = reddit.submission("5or86n") │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/models/draft.html │ │ │ @@ -355,15 +355,15 @@ │ │ │ │ │ │ │ │ │
│ │ │
│ │ │

Draft#

│ │ │
│ │ │
│ │ │ -class praw.models.Draft(reddit: praw.Reddit, id: Optional[str] = None, _data: Dict[str, Any] = None)#
│ │ │ +class praw.models.Draft(reddit: praw.Reddit, id: Optional[str] = None, _data: Dict[str, Any] = None)# │ │ │

A class that represents a Reddit submission draft.

│ │ │

Typical Attributes

│ │ │
│ │ │

Note

│ │ │

This table describes attributes that typically belong to objects of this class. PRAW │ │ │ dynamically provides the attributes that Reddit returns via the API. Since those │ │ │ attributes are subject to change on Reddit’s end, PRAW makes no effort to document │ │ │ @@ -414,15 +414,15 @@ │ │ │

The URL the submission draft links to.

│ │ │ │ │ │ │ │ │ │ │ │
│ │ │
│ │ │
│ │ │ -__init__(reddit: praw.Reddit, id: Optional[str] = None, _data: Dict[str, Any] = None)#
│ │ │ +__init__(reddit: praw.Reddit, id: Optional[str] = None, _data: Dict[str, Any] = None)# │ │ │

Initialize a Draft instance.

│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ delete()#
│ │ │

Delete the Draft.

│ │ │ @@ -431,29 +431,29 @@ │ │ │ draft.delete() │ │ │ │ │ │ │ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
│ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

Return an instance of cls from data.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • data – The structured data.

    • │ │ │

  • reddit – An instance of Reddit.

    • │ │ │
│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -submit(*, flair_id: Optional[str] = None, flair_text: Optional[str] = None, nsfw: Optional[bool] = None, selftext: Optional[str] = None, spoiler: Optional[bool] = None, subreddit: Optional[Union[str, praw.models.Subreddit, praw.models.UserSubreddit]] = None, title: Optional[str] = None, url: Optional[str] = None, **submit_kwargs) → praw.models.Submission#
│ │ │ +submit(*, flair_id: Optional[str] = None, flair_text: Optional[str] = None, nsfw: Optional[bool] = None, selftext: Optional[str] = None, spoiler: Optional[bool] = None, subreddit: Optional[Union[str, praw.models.Subreddit, praw.models.UserSubreddit]] = None, title: Optional[str] = None, url: Optional[str] = None, **submit_kwargs) → praw.models.Submission# │ │ │

Submit a draft.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • flair_id – The flair template to select (default: None).

    • │ │ │

  • flair_text – If the template’s flair_text_editable value is True, │ │ │ this value will set a custom text (default: None). flair_id is │ │ │ @@ -502,15 +502,15 @@ │ │ │

  • submit_video() to submit videos and videogifs

    • │ │ │
│ │ │ │ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -update(*, flair_id: Optional[str] = None, flair_text: Optional[str] = None, is_public_link: Optional[bool] = None, nsfw: Optional[bool] = None, original_content: Optional[bool] = None, selftext: Optional[str] = None, send_replies: Optional[bool] = None, spoiler: Optional[bool] = None, subreddit: Optional[Union[str, praw.models.Subreddit, praw.models.UserSubreddit]] = None, title: Optional[str] = None, url: Optional[str] = None, **draft_kwargs)#
│ │ │ +update(*, flair_id: Optional[str] = None, flair_text: Optional[str] = None, is_public_link: Optional[bool] = None, nsfw: Optional[bool] = None, original_content: Optional[bool] = None, selftext: Optional[str] = None, send_replies: Optional[bool] = None, spoiler: Optional[bool] = None, subreddit: Optional[Union[str, praw.models.Subreddit, praw.models.UserSubreddit]] = None, title: Optional[str] = None, url: Optional[str] = None, **draft_kwargs)# │ │ │

Update the Draft.

│ │ │
│ │ │

Note

│ │ │

Only provided values will be updated.

│ │ │
│ │ │
│ │ │
Parameters:
│ │ │ ├── html2text {} │ │ │ │ @@ -161,16 +161,16 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ DDrraafftt_## ************ │ │ │ │ - ccllaassss praw.models.Draft(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, iidd:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, __ddaattaa:: │ │ │ │ - _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]] == NNoonnee)_# │ │ │ │ + ccllaassss praw.models.Draft(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, iidd:: OOppttiioonnaall[[ssttrr]] == NNoonnee, __ddaattaa:: │ │ │ │ + DDiicctt[[ssttrr,, AAnnyy]] == NNoonnee)_# │ │ │ │ A class that represents a Reddit submission draft. │ │ │ │ TTyyppiiccaall AAttttrriibbuutteess │ │ │ │ Note │ │ │ │ This table describes attributes that typically belong to objects of this │ │ │ │ class. PRAW dynamically provides the attributes that Reddit returns via │ │ │ │ the API. Since those attributes are subject to change on Reddit’s end, │ │ │ │ PRAW makes no effort to document any new/removed/changed attributes, │ │ │ │ @@ -191,32 +191,32 @@ │ │ │ │ submission draft. │ │ │ │ spoiler Whether the submission will be marked as a │ │ │ │ spoiler. │ │ │ │ subreddit Provides an instance of _S_u_b_r_e_d_d_i_t or _U_s_e_r_S_u_b_r_e_d_d_i_t │ │ │ │ (if set). │ │ │ │ title The title of the submission draft. │ │ │ │ url The URL the submission draft links to. │ │ │ │ - __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, iidd:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, __ddaattaa:: _DD_ii_cc_tt │ │ │ │ - [[_ss_tt_rr,, _AA_nn_yy]] == NNoonnee)_# │ │ │ │ + __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, iidd:: OOppttiioonnaall[[ssttrr]] == NNoonnee, __ddaattaa:: DDiicctt │ │ │ │ + [[ssttrr,, AAnnyy]] == NNoonnee)_# │ │ │ │ Initialize a _D_r_a_f_t instance. │ │ │ │ delete()_# │ │ │ │ Delete the _D_r_a_f_t. │ │ │ │ Example usage: │ │ │ │ draft = reddit.drafts("124862bc-e1e9-11eb-aa4f-e68667a77cbb") │ │ │ │ draft.delete() │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ - submit(**, ffllaaiirr__iidd:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, ffllaaiirr__tteexxtt:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == │ │ │ │ - NNoonnee, nnssffww:: _OO_pp_tt_ii_oo_nn_aa_ll[[_bb_oo_oo_ll]] == NNoonnee, sseellfftteexxtt:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, │ │ │ │ - ssppooiilleerr:: _OO_pp_tt_ii_oo_nn_aa_ll[[_bb_oo_oo_ll]] == NNoonnee, ssuubbrreeddddiitt:: _OO_pp_tt_ii_oo_nn_aa_ll[[_UU_nn_ii_oo_nn[[_ss_tt_rr,, │ │ │ │ + submit(**, ffllaaiirr__iidd:: OOppttiioonnaall[[ssttrr]] == NNoonnee, ffllaaiirr__tteexxtt:: OOppttiioonnaall[[ssttrr]] == │ │ │ │ + NNoonnee, nnssffww:: OOppttiioonnaall[[bbooooll]] == NNoonnee, sseellfftteexxtt:: OOppttiioonnaall[[ssttrr]] == NNoonnee, │ │ │ │ + ssppooiilleerr:: OOppttiioonnaall[[bbooooll]] == NNoonnee, ssuubbrreeddddiitt:: OOppttiioonnaall[[UUnniioonn[[ssttrr,, │ │ │ │ _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt,, _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._UU_ss_ee_rr_SS_uu_bb_rr_ee_dd_dd_ii_tt]]]] == NNoonnee, ttiittllee:: │ │ │ │ - _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, uurrll:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, ****ssuubbmmiitt__kkwwaarrggss) → │ │ │ │ + OOppttiioonnaall[[ssttrr]] == NNoonnee, uurrll:: OOppttiioonnaall[[ssttrr]] == NNoonnee, ****ssuubbmmiitt__kkwwaarrggss) → │ │ │ │ _p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n_# │ │ │ │ Submit a draft. │ │ │ │ Parameters: │ │ │ │ * ffllaaiirr__iidd – The flair template to select (default: │ │ │ │ None). │ │ │ │ * ffllaaiirr__tteexxtt – If the template’s flair_text_editable │ │ │ │ value is True, this value will set a custom text │ │ │ │ @@ -251,21 +251,21 @@ │ │ │ │ See also │ │ │ │ * _s_u_b_m_i_t_(_) to submit url posts and selftexts │ │ │ │ * _s_u_b_m_i_t___g_a_l_l_e_r_y_(_). to submit more than one image in the same │ │ │ │ post │ │ │ │ * _s_u_b_m_i_t___i_m_a_g_e_(_) to submit images │ │ │ │ * _s_u_b_m_i_t___p_o_l_l_(_) to submit polls │ │ │ │ * _s_u_b_m_i_t___v_i_d_e_o_(_) to submit videos and videogifs │ │ │ │ - update(**, ffllaaiirr__iidd:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, ffllaaiirr__tteexxtt:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == │ │ │ │ - NNoonnee, iiss__ppuubblliicc__lliinnkk:: _OO_pp_tt_ii_oo_nn_aa_ll[[_bb_oo_oo_ll]] == NNoonnee, nnssffww:: _OO_pp_tt_ii_oo_nn_aa_ll[[_bb_oo_oo_ll]] == │ │ │ │ - NNoonnee, oorriiggiinnaall__ccoonntteenntt:: _OO_pp_tt_ii_oo_nn_aa_ll[[_bb_oo_oo_ll]] == NNoonnee, sseellfftteexxtt:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] │ │ │ │ - == NNoonnee, sseenndd__rreepplliieess:: _OO_pp_tt_ii_oo_nn_aa_ll[[_bb_oo_oo_ll]] == NNoonnee, ssppooiilleerr:: _OO_pp_tt_ii_oo_nn_aa_ll[[_bb_oo_oo_ll]] == │ │ │ │ - NNoonnee, ssuubbrreeddddiitt:: _OO_pp_tt_ii_oo_nn_aa_ll[[_UU_nn_ii_oo_nn[[_ss_tt_rr,, _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt,, │ │ │ │ - _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._UU_ss_ee_rr_SS_uu_bb_rr_ee_dd_dd_ii_tt]]]] == NNoonnee, ttiittllee:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, uurrll:: │ │ │ │ - _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, ****ddrraafftt__kkwwaarrggss)_# │ │ │ │ + update(**, ffllaaiirr__iidd:: OOppttiioonnaall[[ssttrr]] == NNoonnee, ffllaaiirr__tteexxtt:: OOppttiioonnaall[[ssttrr]] == │ │ │ │ + NNoonnee, iiss__ppuubblliicc__lliinnkk:: OOppttiioonnaall[[bbooooll]] == NNoonnee, nnssffww:: OOppttiioonnaall[[bbooooll]] == │ │ │ │ + NNoonnee, oorriiggiinnaall__ccoonntteenntt:: OOppttiioonnaall[[bbooooll]] == NNoonnee, sseellfftteexxtt:: OOppttiioonnaall[[ssttrr]] │ │ │ │ + == NNoonnee, sseenndd__rreepplliieess:: OOppttiioonnaall[[bbooooll]] == NNoonnee, ssppooiilleerr:: OOppttiioonnaall[[bbooooll]] == │ │ │ │ + NNoonnee, ssuubbrreeddddiitt:: OOppttiioonnaall[[UUnniioonn[[ssttrr,, _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt,, │ │ │ │ + _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._UU_ss_ee_rr_SS_uu_bb_rr_ee_dd_dd_ii_tt]]]] == NNoonnee, ttiittllee:: OOppttiioonnaall[[ssttrr]] == NNoonnee, uurrll:: │ │ │ │ + OOppttiioonnaall[[ssttrr]] == NNoonnee, ****ddrraafftt__kkwwaarrggss)_# │ │ │ │ Update the _D_r_a_f_t. │ │ │ │ Note │ │ │ │ Only provided values will be updated. │ │ │ │ Parameters: │ │ │ │ * ffllaaiirr__iidd – The flair template to select. │ │ │ │ * ffllaaiirr__tteexxtt – If the template’s flair_text_editable │ │ │ │ value is True, this value will set a custom text. │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/models/livethread.html │ │ │ @@ -355,15 +355,15 @@ │ │ │ │ │ │ │ │ │
│ │ │
│ │ │

LiveThread#

│ │ │
│ │ │
│ │ │ -class praw.models.LiveThread(reddit: praw.Reddit, id: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)#
│ │ │ +class praw.models.LiveThread(reddit: praw.Reddit, id: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)# │ │ │

An individual LiveThread object.

│ │ │

Typical Attributes

│ │ │
│ │ │

Note

│ │ │

This table describes attributes that typically belong to objects of this class. PRAW │ │ │ dynamically provides the attributes that Reddit returns via the API. Since those │ │ │ attributes are subject to change on Reddit’s end, PRAW makes no effort to document │ │ │ @@ -398,15 +398,15 @@ │ │ │ marked as NSFW.

│ │ │ │ │ │ │ │ │ │ │ │
│ │ │
│ │ │
│ │ │ -__getitem__(update_id: str) → praw.models.LiveUpdate#
│ │ │ +__getitem__(update_id: str) → praw.models.LiveUpdate# │ │ │

Return a lazy LiveUpdate instance.

│ │ │
│ │ │
Parameters:
│ │ │

update_id – A live update ID, e.g., │ │ │ "7827987a-c998-11e4-a0b9-22000b6a88d2".

│ │ │
│ │ │
│ │ │ @@ -418,15 +418,15 @@ │ │ │ update.author # "umbrae" │ │ │ │ │ │ │ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -__init__(reddit: praw.Reddit, id: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)#
│ │ │ +__init__(reddit: praw.Reddit, id: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)# │ │ │

Initialize a LiveThread instance.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • reddit – An instance of Reddit.

    • │ │ │

  • id – A live thread ID, e.g., "ukaeu1ik4sw5"

    • │ │ │
│ │ │ @@ -458,15 +458,15 @@ │ │ │ print(contributor, contributor.permissions) │ │ │ │ │ │ │ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -discussions(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[praw.models.Submission]#
│ │ │ +discussions(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[praw.models.Submission]# │ │ │

Get submissions linking to the thread.

│ │ │
│ │ │
Parameters:
│ │ │

generator_kwargs – keyword arguments passed to ListingGenerator │ │ │ constructor.

│ │ │
│ │ │
Returns:
│ │ │ @@ -482,29 +482,29 @@ │ │ │ print(submission.title) │ │ │ │ │ │ │ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
│ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

Return an instance of cls from data.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • data – The structured data.

    • │ │ │

  • reddit – An instance of Reddit.

    • │ │ │
│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -report(type: str)#
│ │ │ +report(type: str)# │ │ │

Report the thread violating the Reddit rules.

│ │ │
│ │ │
Parameters:
│ │ │

type – One of "spam", "vote-manipulation", "personal- │ │ │ information", "sexualizing-minors", or "site-breaking".

│ │ │
│ │ │
│ │ │ @@ -533,15 +533,15 @@ │ │ │ print(live_update.author) │ │ │ │ │ │ │ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -updates(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[praw.models.LiveUpdate]#
│ │ │ +updates(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[praw.models.LiveUpdate]# │ │ │

Return a ListingGenerator yields LiveUpdate s.

│ │ │
│ │ │
Parameters:
│ │ │

generator_kwargs – keyword arguments passed to ListingGenerator │ │ │ constructor.

│ │ │
│ │ │
Returns:
│ │ │ ├── html2text {} │ │ │ │ @@ -161,16 +161,16 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ LLiivveeTThhrreeaadd_## ************ │ │ │ │ - ccllaassss praw.models.LiveThread(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, iidd:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, │ │ │ │ - __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]]]] == NNoonnee)_# │ │ │ │ + ccllaassss praw.models.LiveThread(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, iidd:: OOppttiioonnaall[[ssttrr]] == NNoonnee, │ │ │ │ + __ddaattaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, AAnnyy]]]] == NNoonnee)_# │ │ │ │ An individual _L_i_v_e_T_h_r_e_a_d object. │ │ │ │ TTyyppiiccaall AAttttrriibbuutteess │ │ │ │ Note │ │ │ │ This table describes attributes that typically belong to objects of this │ │ │ │ class. PRAW dynamically provides the attributes that Reddit returns via │ │ │ │ the API. Since those attributes are subject to change on Reddit’s end, │ │ │ │ PRAW makes no effort to document any new/removed/changed attributes, │ │ │ │ @@ -182,27 +182,27 @@ │ │ │ │ AAttttrriibbuuttee DDeessccrriippttiioonn │ │ │ │ created_utc The creation time of the live thread, in _U_n_i_x_ _T_i_m_e. │ │ │ │ description Description of the live thread, as Markdown. │ │ │ │ description_html Description of the live thread, as HTML. │ │ │ │ id The ID of the live thread. │ │ │ │ nsfw A bool representing whether or not the live thread is │ │ │ │ marked as NSFW. │ │ │ │ - __getitem__(uuppddaattee__iidd:: _ss_tt_rr) → _p_r_a_w_._m_o_d_e_l_s_._L_i_v_e_U_p_d_a_t_e_# │ │ │ │ + __getitem__(uuppddaattee__iidd:: ssttrr) → _p_r_a_w_._m_o_d_e_l_s_._L_i_v_e_U_p_d_a_t_e_# │ │ │ │ Return a lazy _L_i_v_e_U_p_d_a_t_e instance. │ │ │ │ Parameters: │ │ │ │ uuppddaattee__iidd – A live update ID, e.g., "7827987a-c998-11e4-a0b9- │ │ │ │ 22000b6a88d2". │ │ │ │ Usage: │ │ │ │ thread = reddit.live("ukaeu1ik4sw5") │ │ │ │ update = thread["7827987a-c998-11e4-a0b9-22000b6a88d2"] │ │ │ │ update.thread # LiveThread(id="ukaeu1ik4sw5") │ │ │ │ update.id # "7827987a-c998-11e4-a0b9-22000b6a88d2" │ │ │ │ update.author # "umbrae" │ │ │ │ - __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, iidd:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll │ │ │ │ - [[_DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]]]] == NNoonnee)_# │ │ │ │ + __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, iidd:: OOppttiioonnaall[[ssttrr]] == NNoonnee, __ddaattaa:: OOppttiioonnaall │ │ │ │ + [[DDiicctt[[ssttrr,, AAnnyy]]]] == NNoonnee)_# │ │ │ │ Initialize a _L_i_v_e_T_h_r_e_a_d instance. │ │ │ │ Parameters: │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ * iidd – A live thread ID, e.g., "ukaeu1ik4sw5" │ │ │ │ contrib() → _p_r_a_w_._m_o_d_e_l_s_._r_e_d_d_i_t_._l_i_v_e_._L_i_v_e_T_h_r_e_a_d_C_o_n_t_r_i_b_u_t_i_o_n_# │ │ │ │ Provide an instance of _L_i_v_e_T_h_r_e_a_d_C_o_n_t_r_i_b_u_t_i_o_n. │ │ │ │ Usage: │ │ │ │ @@ -214,34 +214,34 @@ │ │ │ │ represented as _R_e_d_d_i_t_o_r_L_i_s_t instance consists of _R_e_d_d_i_t_o_r │ │ │ │ instances. Those _R_e_d_d_i_t_o_r instances have permissions attributes as │ │ │ │ contributors: │ │ │ │ thread = reddit.live("ukaeu1ik4sw5") │ │ │ │ for contributor in thread.contributor(): │ │ │ │ # prints `Redditor(name="Acidtwist") ["all"]` │ │ │ │ print(contributor, contributor.permissions) │ │ │ │ - discussions(****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → │ │ │ │ - _I_t_e_r_a_t_o_r[_p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]_# │ │ │ │ + discussions(****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → │ │ │ │ + Iterator[_p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]_# │ │ │ │ Get submissions linking to the thread. │ │ │ │ Parameters: │ │ │ │ ggeenneerraattoorr__kkwwaarrggss – keyword arguments passed to │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r constructor. │ │ │ │ Returns: │ │ │ │ A _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r object which yields _S_u_b_m_i_s_s_i_o_n objects. │ │ │ │ Additional keyword arguments are passed in the initialization of │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r. │ │ │ │ Usage: │ │ │ │ thread = reddit.live("ukaeu1ik4sw5") │ │ │ │ for submission in thread.discussions(limit=None): │ │ │ │ print(submission.title) │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ - report(ttyyppee:: _ss_tt_rr)_# │ │ │ │ + report(ttyyppee:: ssttrr)_# │ │ │ │ Report the thread violating the Reddit rules. │ │ │ │ Parameters: │ │ │ │ ttyyppee – One of "spam", "vote-manipulation", "personal- │ │ │ │ information", "sexualizing-minors", or "site-breaking". │ │ │ │ Usage: │ │ │ │ thread = reddit.live("xyu8kmjvfrww") │ │ │ │ thread.report("spam") │ │ │ │ @@ -254,15 +254,15 @@ │ │ │ │ Updates are yielded oldest first as _L_i_v_e_U_p_d_a_t_e. Up to 100 │ │ │ │ historical updates will initially be returned. To only retrieve new │ │ │ │ updates starting from when the stream is created, pass │ │ │ │ skip_existing=True: │ │ │ │ live_thread = reddit.live("ta535s1hq2je") │ │ │ │ for live_update in live_thread.stream.updates(skip_existing=True): │ │ │ │ print(live_update.author) │ │ │ │ - updates(****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → _I_t_e_r_a_t_o_r │ │ │ │ + updates(****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → Iterator │ │ │ │ [_p_r_a_w_._m_o_d_e_l_s_._L_i_v_e_U_p_d_a_t_e]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r yields _L_i_v_e_U_p_d_a_t_e s. │ │ │ │ Parameters: │ │ │ │ ggeenneerraattoorr__kkwwaarrggss – keyword arguments passed to │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r constructor. │ │ │ │ Returns: │ │ │ │ A _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r object which yields _L_i_v_e_U_p_d_a_t_e objects. │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/models/liveupdate.html │ │ │ @@ -355,15 +355,15 @@ │ │ │ │ │ │ │ │ │
│ │ │
│ │ │

LiveUpdate#

│ │ │
│ │ │
│ │ │ -class praw.models.LiveUpdate(reddit: praw.Reddit, thread_id: Optional[str] = None, update_id: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)#
│ │ │ +class praw.models.LiveUpdate(reddit: praw.Reddit, thread_id: Optional[str] = None, update_id: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)# │ │ │

An individual LiveUpdate object.

│ │ │

Typical Attributes

│ │ │
│ │ │

Note

│ │ │

This table describes attributes that typically belong to objects of this class. PRAW │ │ │ dynamically provides the attributes that Reddit returns via the API. Since those │ │ │ attributes are subject to change on Reddit’s end, PRAW makes no effort to document │ │ │ @@ -398,15 +398,15 @@ │ │ │ strike()).

│ │ │ │ │ │ │ │ │ │ │ │
│ │ │
│ │ │
│ │ │ -__init__(reddit: praw.Reddit, thread_id: Optional[str] = None, update_id: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)#
│ │ │ +__init__(reddit: praw.Reddit, thread_id: Optional[str] = None, update_id: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)# │ │ │

Initialize a LiveUpdate instance.

│ │ │

Either thread_id and update_id, or _data must be provided.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • reddit – An instance of Reddit.

    • │ │ │

  • thread_id – A live thread ID, e.g., "ukaeu1ik4sw5".

    • │ │ │ @@ -434,23 +434,23 @@ │ │ │ update.contrib # LiveUpdateContribution instance │ │ │ │ │ │ │ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -property fullname: str#
│ │ │ +property fullname: str# │ │ │

Return the object’s fullname.

│ │ │

A fullname is an object’s kind mapping like t3 followed by an underscore and │ │ │ the object’s base36 ID, e.g., t1_c5s96e0.

│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
│ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

Return an instance of cls from data.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • data – The structured data.

    • │ │ │

  • reddit – An instance of Reddit.

    • │ │ │
│ │ │ ├── html2text {} │ │ │ │ @@ -161,16 +161,16 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ LLiivveeUUppddaattee_## ************ │ │ │ │ - ccllaassss praw.models.LiveUpdate(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, tthhrreeaadd__iidd:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == │ │ │ │ - NNoonnee, uuppddaattee__iidd:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]]]] == │ │ │ │ + ccllaassss praw.models.LiveUpdate(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, tthhrreeaadd__iidd:: OOppttiioonnaall[[ssttrr]] == │ │ │ │ + NNoonnee, uuppddaattee__iidd:: OOppttiioonnaall[[ssttrr]] == NNoonnee, __ddaattaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, AAnnyy]]]] == │ │ │ │ NNoonnee)_# │ │ │ │ An individual _L_i_v_e_U_p_d_a_t_e object. │ │ │ │ TTyyppiiccaall AAttttrriibbuutteess │ │ │ │ Note │ │ │ │ This table describes attributes that typically belong to objects of this │ │ │ │ class. PRAW dynamically provides the attributes that Reddit returns via │ │ │ │ the API. Since those attributes are subject to change on Reddit’s end, │ │ │ │ @@ -183,16 +183,16 @@ │ │ │ │ AAttttrriibbuuttee DDeessccrriippttiioonn │ │ │ │ author The _R_e_d_d_i_t_o_r who made the update. │ │ │ │ body Body of the update, as Markdown. │ │ │ │ body_html Body of the update, as HTML. │ │ │ │ created_utc The time the update was created, as _U_n_i_x_ _T_i_m_e. │ │ │ │ stricken A bool representing whether or not the update was stricken │ │ │ │ (see _s_t_r_i_k_e_(_)). │ │ │ │ - __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, tthhrreeaadd__iidd:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, │ │ │ │ - uuppddaattee__iidd:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]]]] == │ │ │ │ + __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, tthhrreeaadd__iidd:: OOppttiioonnaall[[ssttrr]] == NNoonnee, │ │ │ │ + uuppddaattee__iidd:: OOppttiioonnaall[[ssttrr]] == NNoonnee, __ddaattaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, AAnnyy]]]] == │ │ │ │ NNoonnee)_# │ │ │ │ Initialize a _L_i_v_e_U_p_d_a_t_e instance. │ │ │ │ Either thread_id and update_id, or _data must be provided. │ │ │ │ Parameters: │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ * tthhrreeaadd__iidd – A live thread ID, e.g., "ukaeu1ik4sw5". │ │ │ │ * uuppddaattee__iidd – A live update ID, e.g., "7827987a-c998- │ │ │ │ @@ -205,19 +205,19 @@ │ │ │ │ update.author # "umbrae" │ │ │ │ contrib() → _p_r_a_w_._m_o_d_e_l_s_._r_e_d_d_i_t_._l_i_v_e_._L_i_v_e_U_p_d_a_t_e_C_o_n_t_r_i_b_u_t_i_o_n_# │ │ │ │ Provide an instance of _L_i_v_e_U_p_d_a_t_e_C_o_n_t_r_i_b_u_t_i_o_n. │ │ │ │ Usage: │ │ │ │ thread = reddit.live("ukaeu1ik4sw5") │ │ │ │ update = thread["7827987a-c998-11e4-a0b9-22000b6a88d2"] │ │ │ │ update.contrib # LiveUpdateContribution instance │ │ │ │ - pprrooppeerrttyy fullname:: _ss_tt_rr_# │ │ │ │ + pprrooppeerrttyy fullname:: ssttrr_# │ │ │ │ Return the object’s fullname. │ │ │ │ A fullname is an object’s kind mapping like t3 followed by an │ │ │ │ underscore and the object’s base36 ID, e.g., t1_c5s96e0. │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ pprrooppeerrttyy thread:: _LL_ii_vv_ee_TT_hh_rr_ee_aa_dd_# │ │ │ │ Return _L_i_v_e_T_h_r_e_a_d object the update object belongs to. │ │ │ │ _N_e_x_t │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/models/message.html │ │ │ @@ -355,15 +355,15 @@ │ │ │ │ │ │ │ │ │
│ │ │
│ │ │

Message#

│ │ │
│ │ │
│ │ │ -class praw.models.Message(reddit: praw.Reddit, _data: Dict[str, Any])#
│ │ │ +class praw.models.Message(reddit: praw.Reddit, _data: Dict[str, Any])# │ │ │

A class for private messages.

│ │ │

Typical Attributes

│ │ │
│ │ │

Note

│ │ │

This table describes attributes that typically belong to objects of this class. PRAW │ │ │ dynamically provides the attributes that Reddit returns via the API. Since those │ │ │ attributes are subject to change on Reddit’s end, PRAW makes no effort to document │ │ │ @@ -410,15 +410,15 @@ │ │ │

Whether or not the message was a comment reply.

│ │ │ │ │ │ │ │ │ │ │ │
│ │ │
│ │ │
│ │ │ -__init__(reddit: praw.Reddit, _data: Dict[str, Any])#
│ │ │ +__init__(reddit: praw.Reddit, _data: Dict[str, Any])# │ │ │

Initialize a Message instance.

│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ block()#
│ │ │

Block the user who sent the item.

│ │ │ @@ -471,15 +471,15 @@ │ │ │ 
next(reddit.inbox.all()).delete()
│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -property fullname: str#
│ │ │ +property fullname: str# │ │ │

Return the object’s fullname.

│ │ │

A fullname is an object’s kind mapping like t3 followed by an underscore and │ │ │ the object’s base36 ID, e.g., t1_c5s96e0.

│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ @@ -525,35 +525,35 @@ │ │ │

See also

│ │ │

mark_read()

│ │ │ │ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -property parent: Optional[praw.models.Message]#
│ │ │ +property parent: Optional[praw.models.Message]# │ │ │

Return the parent of the message if it exists.

│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit)#
│ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit)# │ │ │

Return an instance of Message or SubredditMessage from data.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • data – The structured data.

    • │ │ │

  • reddit – An instance of Reddit.

    • │ │ │
│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -reply(body: str) → Optional[Union[praw.models.Comment, praw.models.Message]]#
│ │ │ +reply(body: str) → Optional[Union[praw.models.Comment, praw.models.Message]]# │ │ │

Reply to the object.

│ │ │
│ │ │
Parameters:
│ │ │

body – The Markdown formatted content for a comment.

│ │ │
│ │ │
Returns:
│ │ │

A Comment or Message object for the newly created │ │ │ ├── html2text {} │ │ │ │ @@ -161,15 +161,15 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ MMeessssaaggee_## ************ │ │ │ │ - ccllaassss praw.models.Message(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]])_# │ │ │ │ + ccllaassss praw.models.Message(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]])_# │ │ │ │ A class for private messages. │ │ │ │ TTyyppiiccaall AAttttrriibbuutteess │ │ │ │ Note │ │ │ │ This table describes attributes that typically belong to objects of this │ │ │ │ class. PRAW dynamically provides the attributes that Reddit returns via │ │ │ │ the API. Since those attributes are subject to change on Reddit’s end, │ │ │ │ PRAW makes no effort to document any new/removed/changed attributes, │ │ │ │ @@ -185,15 +185,15 @@ │ │ │ │ created_utc Time the message was created, represented in _U_n_i_x_ _T_i_m_e. │ │ │ │ dest Provides an instance of _R_e_d_d_i_t_o_r. The recipient of the │ │ │ │ message. │ │ │ │ id The ID of the message. │ │ │ │ name The full ID of the message, prefixed with t4_. │ │ │ │ subject The subject of the message. │ │ │ │ was_comment Whether or not the message was a comment reply. │ │ │ │ - __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]])_# │ │ │ │ + __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]])_# │ │ │ │ Initialize a _M_e_s_s_a_g_e instance. │ │ │ │ block()_# │ │ │ │ Block the user who sent the item. │ │ │ │ Note │ │ │ │ This method pertains only to objects which were retrieved via the │ │ │ │ inbox. │ │ │ │ Example usage: │ │ │ │ @@ -218,15 +218,15 @@ │ │ │ │ delete()_# │ │ │ │ Delete the message. │ │ │ │ Note │ │ │ │ Reddit does not return an indication of whether or not the message │ │ │ │ was successfully deleted. │ │ │ │ For example, to delete the most recent message in your inbox: │ │ │ │ next(reddit.inbox.all()).delete() │ │ │ │ - pprrooppeerrttyy fullname:: _ss_tt_rr_# │ │ │ │ + pprrooppeerrttyy fullname:: ssttrr_# │ │ │ │ Return the object’s fullname. │ │ │ │ A fullname is an object’s kind mapping like t3 followed by an │ │ │ │ underscore and the object’s base36 ID, e.g., t1_c5s96e0. │ │ │ │ mark_read()_# │ │ │ │ Mark a single inbox item as read. │ │ │ │ Note │ │ │ │ This method pertains only to objects which were retrieved via the │ │ │ │ @@ -250,22 +250,22 @@ │ │ │ │ inbox = reddit.inbox(limit=10) │ │ │ │ │ │ │ │ for message in inbox: │ │ │ │ # process messages │ │ │ │ ... │ │ │ │ See also │ │ │ │ _m_a_r_k___r_e_a_d_(_) │ │ │ │ - pprrooppeerrttyy parent:: _OO_pp_tt_ii_oo_nn_aa_ll[[_pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._MM_ee_ss_ss_aa_gg_ee]]_# │ │ │ │ + pprrooppeerrttyy parent:: OOppttiioonnaall[[_pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._MM_ee_ss_ss_aa_gg_ee]]_# │ │ │ │ Return the parent of the message if it exists. │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt)_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt)_# │ │ │ │ Return an instance of _M_e_s_s_a_g_e or _S_u_b_r_e_d_d_i_t_M_e_s_s_a_g_e from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ - reply(bbooddyy:: _ss_tt_rr) → _O_p_t_i_o_n_a_l[_U_n_i_o_n[_p_r_a_w_._m_o_d_e_l_s_._C_o_m_m_e_n_t, │ │ │ │ + reply(bbooddyy:: ssttrr) → Optional[Union[_p_r_a_w_._m_o_d_e_l_s_._C_o_m_m_e_n_t, │ │ │ │ _p_r_a_w_._m_o_d_e_l_s_._M_e_s_s_a_g_e]]_# │ │ │ │ Reply to the object. │ │ │ │ Parameters: │ │ │ │ bbooddyy – The Markdown formatted content for a comment. │ │ │ │ Returns: │ │ │ │ A _C_o_m_m_e_n_t or _M_e_s_s_a_g_e object for the newly created comment or │ │ │ │ message or None if Reddit doesn’t provide one. │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/models/modmailconversation.html │ │ │ @@ -355,15 +355,15 @@ │ │ │ │ │ │ │ │ │

│ │ │
│ │ │

ModmailConversation#

│ │ │
│ │ │
│ │ │ -class praw.models.reddit.modmail.ModmailConversation(reddit: praw.Reddit, id: Optional[str] = None, mark_read: bool = False, _data: Optional[Dict[str, Any]] = None)#
│ │ │ +class praw.models.reddit.modmail.ModmailConversation(reddit: praw.Reddit, id: Optional[str] = None, mark_read: bool = False, _data: Optional[Dict[str, Any]] = None)# │ │ │

A class for modmail conversations.

│ │ │

Typical Attributes

│ │ │
│ │ │

Note

│ │ │

This table describes attributes that typically belong to objects of this class. PRAW │ │ │ dynamically provides the attributes that Reddit returns via the API. Since those │ │ │ attributes are subject to change on Reddit’s end, PRAW makes no effort to document │ │ │ @@ -430,15 +430,15 @@ │ │ │

The subject of the ModmailConversation.

│ │ │ │ │ │ │ │ │ │ │ │
│ │ │
│ │ │
│ │ │ -__init__(reddit: praw.Reddit, id: Optional[str] = None, mark_read: bool = False, _data: Optional[Dict[str, Any]] = None)#
│ │ │ +__init__(reddit: praw.Reddit, id: Optional[str] = None, mark_read: bool = False, _data: Optional[Dict[str, Any]] = None)# │ │ │

Initialize a ModmailConversation instance.

│ │ │
│ │ │
Parameters:
│ │ │

mark_read – If True, conversation is marked as read (default: │ │ │ False).

│ │ │
│ │ │
│ │ │ @@ -482,15 +482,15 @@ │ │ │ 
reddit.subreddit("test").modmail("2gmz").mute(num_days=7)
│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit, convert_objects: bool = True)#
│ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit, convert_objects: bool = True)# │ │ │

Return an instance of ModmailConversation from data.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • data – The structured data.

    • │ │ │

  • reddit – An instance of Reddit.

    • │ │ │

  • convert_objects – If True, convert message and mod action data into │ │ │ @@ -498,15 +498,15 @@ │ │ │

│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -read(*, other_conversations: Optional[List[ModmailConversation]] = None)#
│ │ │ +read(*, other_conversations: Optional[List[ModmailConversation]] = None)# │ │ │

Mark the conversation(s) as read.

│ │ │
│ │ │
Parameters:
│ │ │

other_conversations – A list of other conversations to mark (default: │ │ │ None).

│ │ │
│ │ │
│ │ │ @@ -517,15 +517,15 @@ │ │ │ conversation.read(other_conversations=conversation.user.recent_convos) │ │ │ │ │ │ │ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -reply(*, author_hidden: bool = False, body: str, internal: bool = False) → ModmailMessage#
│ │ │ +reply(*, author_hidden: bool = False, body: str, internal: bool = False) → ModmailMessage# │ │ │

Reply to the conversation.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • author_hidden – When True, author is hidden from non-moderators │ │ │ (default: False).

    • │ │ │

  • body – The Markdown formatted content for a message.

    • │ │ │ @@ -576,15 +576,15 @@ │ │ │ 
    reddit.subreddit("test").modmail("2gmz").unmute()
│ │ │
    │ │ │
    │ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -unread(*, other_conversations: Optional[List[ModmailConversation]] = None)#
│ │ │ +unread(*, other_conversations: Optional[List[ModmailConversation]] = None)# │ │ │

Mark the conversation(s) as unread.

│ │ │
│ │ │
Parameters:
│ │ │

other_conversations – A list of other conversations to mark (default: │ │ │ None).

│ │ │
│ │ │
│ │ │ ├── html2text {} │ │ │ │ @@ -162,16 +162,16 @@ │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ MMooddmmaaiillCCoonnvveerrssaattiioonn_## ************ │ │ │ │ ccllaassss praw.models.reddit.modmail.ModmailConversation(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, iidd:: │ │ │ │ - _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, mmaarrkk__rreeaadd:: _bb_oo_oo_ll == FFaallssee, __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, │ │ │ │ - _AA_nn_yy]]]] == NNoonnee)_# │ │ │ │ + OOppttiioonnaall[[ssttrr]] == NNoonnee, mmaarrkk__rreeaadd:: bbooooll == FFaallssee, __ddaattaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, │ │ │ │ + AAnnyy]]]] == NNoonnee)_# │ │ │ │ A class for modmail conversations. │ │ │ │ TTyyppiiccaall AAttttrriibbuutteess │ │ │ │ Note │ │ │ │ This table describes attributes that typically belong to objects of this │ │ │ │ class. PRAW dynamically provides the attributes that Reddit returns via │ │ │ │ the API. Since those attributes are subject to change on Reddit’s end, │ │ │ │ PRAW makes no effort to document any new/removed/changed attributes, │ │ │ │ @@ -200,16 +200,16 @@ │ │ │ │ ""messages" or "ModAction". "ModAction" represents │ │ │ │ archiving/highlighting etc. │ │ │ │ owner Provides an instance of _S_u_b_r_e_d_d_i_t. The subreddit that │ │ │ │ the _M_o_d_m_a_i_l_C_o_n_v_e_r_s_a_t_i_o_n belongs to. │ │ │ │ participant Provides an instance of _R_e_d_d_i_t_o_r. The participating user │ │ │ │ in the _M_o_d_m_a_i_l_C_o_n_v_e_r_s_a_t_i_o_n. │ │ │ │ subject The subject of the _M_o_d_m_a_i_l_C_o_n_v_e_r_s_a_t_i_o_n. │ │ │ │ - __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, iidd:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, mmaarrkk__rreeaadd:: _bb_oo_oo_ll │ │ │ │ - == FFaallssee, __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]]]] == NNoonnee)_# │ │ │ │ + __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, iidd:: OOppttiioonnaall[[ssttrr]] == NNoonnee, mmaarrkk__rreeaadd:: bbooooll │ │ │ │ + == FFaallssee, __ddaattaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, AAnnyy]]]] == NNoonnee)_# │ │ │ │ Initialize a _M_o_d_m_a_i_l_C_o_n_v_e_r_s_a_t_i_o_n instance. │ │ │ │ Parameters: │ │ │ │ mmaarrkk__rreeaadd – If True, conversation is marked as read (default: │ │ │ │ False). │ │ │ │ archive()_# │ │ │ │ Archive the conversation. │ │ │ │ For example: │ │ │ │ @@ -223,35 +223,35 @@ │ │ │ │ Parameters: │ │ │ │ nnuumm__ddaayyss – Duration of mute in days. Valid options are 3, 7, │ │ │ │ or 28 (default: 3). │ │ │ │ For example: │ │ │ │ reddit.subreddit("test").modmail("2gmz").mute() │ │ │ │ To mute for 7 days: │ │ │ │ reddit.subreddit("test").modmail("2gmz").mute(num_days=7) │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, │ │ │ │ - ccoonnvveerrtt__oobbjjeeccttss:: _bb_oo_oo_ll == TTrruuee)_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, │ │ │ │ + ccoonnvveerrtt__oobbjjeeccttss:: bbooooll == TTrruuee)_# │ │ │ │ Return an instance of _M_o_d_m_a_i_l_C_o_n_v_e_r_s_a_t_i_o_n from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ * ccoonnvveerrtt__oobbjjeeccttss – If True, convert message and mod │ │ │ │ action data into objects (default: True). │ │ │ │ - read(**, ootthheerr__ccoonnvveerrssaattiioonnss:: _OO_pp_tt_ii_oo_nn_aa_ll[[_LL_ii_ss_tt[[_MM_oo_dd_mm_aa_ii_ll_CC_oo_nn_vv_ee_rr_ss_aa_tt_ii_oo_nn]]]] == │ │ │ │ + read(**, ootthheerr__ccoonnvveerrssaattiioonnss:: OOppttiioonnaall[[LLiisstt[[_MM_oo_dd_mm_aa_ii_ll_CC_oo_nn_vv_ee_rr_ss_aa_tt_ii_oo_nn]]]] == │ │ │ │ NNoonnee)_# │ │ │ │ Mark the conversation(s) as read. │ │ │ │ Parameters: │ │ │ │ ootthheerr__ccoonnvveerrssaattiioonnss – A list of other conversations to mark │ │ │ │ (default: None). │ │ │ │ For example, to mark the conversation as read along with other │ │ │ │ recent conversations from the same user: │ │ │ │ subreddit = reddit.subreddit("test") │ │ │ │ conversation = subreddit.modmail.conversation("2gmz") │ │ │ │ conversation.read │ │ │ │ (other_conversations=conversation.user.recent_convos) │ │ │ │ - reply(**, aauutthhoorr__hhiiddddeenn:: _bb_oo_oo_ll == FFaallssee, bbooddyy:: _ss_tt_rr, iinntteerrnnaall:: _bb_oo_oo_ll == │ │ │ │ + reply(**, aauutthhoorr__hhiiddddeenn:: bbooooll == FFaallssee, bbooddyy:: ssttrr, iinntteerrnnaall:: bbooooll == │ │ │ │ FFaallssee) → _M_o_d_m_a_i_l_M_e_s_s_a_g_e_# │ │ │ │ Reply to the conversation. │ │ │ │ Parameters: │ │ │ │ * aauutthhoorr__hhiiddddeenn – When True, author is hidden from non- │ │ │ │ moderators (default: False). │ │ │ │ * bbooddyy – The Markdown formatted content for a message. │ │ │ │ * iinntteerrnnaall – When True, message is a private moderator │ │ │ │ @@ -272,15 +272,15 @@ │ │ │ │ Un-highlight the conversation. │ │ │ │ For example: │ │ │ │ reddit.subreddit("test").modmail("2gmz").unhighlight() │ │ │ │ unmute()_# │ │ │ │ Unmute the non-mod user associated with the conversation. │ │ │ │ For example: │ │ │ │ reddit.subreddit("test").modmail("2gmz").unmute() │ │ │ │ - unread(**, ootthheerr__ccoonnvveerrssaattiioonnss:: _OO_pp_tt_ii_oo_nn_aa_ll[[_LL_ii_ss_tt[[_MM_oo_dd_mm_aa_ii_ll_CC_oo_nn_vv_ee_rr_ss_aa_tt_ii_oo_nn]]]] == │ │ │ │ + unread(**, ootthheerr__ccoonnvveerrssaattiioonnss:: OOppttiioonnaall[[LLiisstt[[_MM_oo_dd_mm_aa_ii_ll_CC_oo_nn_vv_ee_rr_ss_aa_tt_ii_oo_nn]]]] == │ │ │ │ NNoonnee)_# │ │ │ │ Mark the conversation(s) as unread. │ │ │ │ Parameters: │ │ │ │ ootthheerr__ccoonnvveerrssaattiioonnss – A list of other conversations to mark │ │ │ │ (default: None). │ │ │ │ For example, to mark the conversation as unread along with other │ │ │ │ recent conversations from the same user: │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/models/more.html │ │ │ @@ -355,31 +355,31 @@ │ │ │ │ │ │ │ │ │
│ │ │
│ │ │

MoreComments#

│ │ │
│ │ │
│ │ │ -class praw.models.MoreComments(reddit: praw.Reddit, _data: Dict[str, Any])#
│ │ │ +class praw.models.MoreComments(reddit: praw.Reddit, _data: Dict[str, Any])# │ │ │

A class indicating there are more comments.

│ │ │
│ │ │
│ │ │ -__init__(reddit: praw.Reddit, _data: Dict[str, Any])#
│ │ │ +__init__(reddit: praw.Reddit, _data: Dict[str, Any])# │ │ │

Initialize a MoreComments instance.

│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -comments(*, update: bool = True) → List[praw.models.Comment]#
│ │ │ +comments(*, update: bool = True) → List[praw.models.Comment]# │ │ │

Fetch and return the comments for a single MoreComments object.

│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
│ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

Return an instance of cls from data.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • data – The structured data.

    • │ │ │

  • reddit – An instance of Reddit.

    • │ │ │
│ │ │ ├── html2text {} │ │ │ │ @@ -161,21 +161,21 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ MMoorreeCCoommmmeennttss_## ************ │ │ │ │ - ccllaassss praw.models.MoreComments(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]])_# │ │ │ │ + ccllaassss praw.models.MoreComments(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]])_# │ │ │ │ A class indicating there are more comments. │ │ │ │ - __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]])_# │ │ │ │ + __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]])_# │ │ │ │ Initialize a _M_o_r_e_C_o_m_m_e_n_t_s instance. │ │ │ │ - comments(**, uuppddaattee:: _bb_oo_oo_ll == TTrruuee) → _L_i_s_t[_p_r_a_w_._m_o_d_e_l_s_._C_o_m_m_e_n_t]_# │ │ │ │ + comments(**, uuppddaattee:: bbooooll == TTrruuee) → List[_p_r_a_w_._m_o_d_e_l_s_._C_o_m_m_e_n_t]_# │ │ │ │ Fetch and return the comments for a single _M_o_r_e_C_o_m_m_e_n_t_s object. │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ _N_e_x_t │ │ │ │ _M_u_l_t_i_r_e_d_d_i_t │ │ │ │ _P_r_e_v_i_o_u_s │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/models/multireddit.html │ │ │ @@ -355,15 +355,15 @@ │ │ │ │ │ │ │ │ │
│ │ │
│ │ │

Multireddit#

│ │ │
│ │ │
│ │ │ -class praw.models.Multireddit(reddit: praw.Reddit, _data: Dict[str, Any])#
│ │ │ +class praw.models.Multireddit(reddit: praw.Reddit, _data: Dict[str, Any])# │ │ │

A class for users’ multireddits.

│ │ │

This is referred to as a “Custom Feed” on the Reddit UI.

│ │ │

Typical Attributes

│ │ │
│ │ │

Note

│ │ │

This table describes attributes that typically belong to objects of this class. PRAW │ │ │ dynamically provides the attributes that Reddit returns via the API. Since those │ │ │ @@ -417,15 +417,15 @@ │ │ │ "public", or "hidden".

│ │ │ │ │ │ │ │ │ │ │ │
│ │ │
│ │ │
│ │ │ -__init__(reddit: praw.Reddit, _data: Dict[str, Any])#
│ │ │ +__init__(reddit: praw.Reddit, _data: Dict[str, Any])# │ │ │

Initialize a Multireddit instance.

│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ add(subreddit: praw.models.Subreddit)#
│ │ │

Add a subreddit to this multireddit.

│ │ │ @@ -451,23 +451,23 @@ │ │ │ print(comment.author) │ │ │ │ │ │ │ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -controversial(*, time_filter: str = 'all', **generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]#
│ │ │ +controversial(*, time_filter: str = 'all', **generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]# │ │ │

Return a ListingGenerator for controversial items.

│ │ │
│ │ │
Parameters:
│ │ │

time_filter – Can be one of: "all", "day", "hour", │ │ │ "month", "week", or "year" (default: "all").

│ │ │
│ │ │
Raises:
│ │ │ -

ValueError if time_filter is invalid.

│ │ │ +

ValueError if time_filter is invalid.

│ │ │
│ │ │
│ │ │

Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

│ │ │

This method can be used like:

│ │ │ 
reddit.domain("imgur.com").controversial(time_filter="week")
│ │ │  reddit.multireddit(redditor="samuraisam", name="programming").controversial(
│ │ │ @@ -479,15 +479,15 @@
│ │ │  reddit.subreddit("all").controversial(time_filter="hour")
│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -copy(*, display_name: Optional[str] = None) → praw.models.Multireddit#
│ │ │ +copy(*, display_name: Optional[str] = None) → praw.models.Multireddit# │ │ │

Copy this multireddit and return the new multireddit.

│ │ │
│ │ │
Parameters:
│ │ │

display_name – The display name for the copied multireddit. Reddit will │ │ │ generate the name field from this display name. When not provided the │ │ │ copy will use the same display name and name as this multireddit.

│ │ │
│ │ │ @@ -506,28 +506,28 @@ │ │ │ 
reddit.multireddit(redditor="bboe", name="test").delete()
│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -gilded(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]#
│ │ │ +gilded(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]# │ │ │

Return a ListingGenerator for gilded items.

│ │ │

Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

│ │ │

For example, to get gilded items in r/test:

│ │ │ 
for item in reddit.subreddit("test").gilded():
│ │ │      print(item.id)
│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -hot(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]#
│ │ │ +hot(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]# │ │ │

Return a ListingGenerator for hot items.

│ │ │

Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

│ │ │

This method can be used like:

│ │ │ 
reddit.domain("imgur.com").hot()
│ │ │  reddit.multireddit(redditor="samuraisam", name="programming").hot()
│ │ │  reddit.redditor("spez").hot()
│ │ │ @@ -536,15 +536,15 @@
│ │ │  reddit.subreddit("all").hot()
│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -new(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]#
│ │ │ +new(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]# │ │ │

Return a ListingGenerator for new items.

│ │ │

Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

│ │ │

This method can be used like:

│ │ │ 
reddit.domain("imgur.com").new()
│ │ │  reddit.multireddit(redditor="samuraisam", name="programming").new()
│ │ │  reddit.redditor("spez").new()
│ │ │ @@ -553,29 +553,29 @@
│ │ │  reddit.subreddit("all").new()
│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
│ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

Return an instance of cls from data.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • data – The structured data.

    • │ │ │

  • reddit – An instance of Reddit.

    • │ │ │
│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -random_rising(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[praw.models.Submission]#
│ │ │ +random_rising(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[praw.models.Submission]# │ │ │

Return a ListingGenerator for random rising submissions.

│ │ │

Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

│ │ │

For example, to get random rising submissions for r/test:

│ │ │ 
for submission in reddit.subreddit("test").random_rising():
│ │ │      print(submission.title)
│ │ │
│ │ │ @@ -596,28 +596,28 @@ │ │ │ reddit.multireddit(redditor="bboe", name="test").remove(subreddit) │ │ │
│ │ │ │ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -rising(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[praw.models.Submission]#
│ │ │ +rising(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[praw.models.Submission]# │ │ │

Return a ListingGenerator for rising submissions.

│ │ │

Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

│ │ │

For example, to get rising submissions for r/test:

│ │ │ 
for submission in reddit.subreddit("test").rising():
│ │ │      print(submission.title)
│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -static sluggify(title: str)#
│ │ │ +static sluggify(title: str)# │ │ │

Return a slug version of the title.

│ │ │
│ │ │
Parameters:
│ │ │

title – The title to make a slug of.

│ │ │
│ │ │
│ │ │

Adapted from Reddit’s utils.py.

│ │ │ @@ -641,23 +641,23 @@ │ │ │ print(submission) │ │ │ │ │ │ │ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -top(*, time_filter: str = 'all', **generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]#
│ │ │ +top(*, time_filter: str = 'all', **generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]# │ │ │

Return a ListingGenerator for top items.

│ │ │
│ │ │
Parameters:
│ │ │

time_filter – Can be one of: "all", "day", "hour", │ │ │ "month", "week", or "year" (default: "all").

│ │ │
│ │ │
Raises:
│ │ │ -

ValueError if time_filter is invalid.

│ │ │ +

ValueError if time_filter is invalid.

│ │ │
│ │ │
│ │ │

Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

│ │ │

This method can be used like:

│ │ │ 
reddit.domain("imgur.com").top(time_filter="week")
│ │ │  reddit.multireddit(redditor="samuraisam", name="programming").top(time_filter="day")
│ │ │ @@ -667,15 +667,15 @@
│ │ │  reddit.subreddit("all").top(time_filter="hour")
│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -update(**updated_settings: Union[str, List[Union[str, praw.models.Subreddit, Dict[str, str]]]])#
│ │ │ +update(**updated_settings: Union[str, List[Union[str, praw.models.Subreddit, Dict[str, str]]]])# │ │ │

Update this multireddit.

│ │ │

Keyword arguments are passed for settings that should be updated. They can any │ │ │ of:

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • display_name – The display name for this multireddit. Must be no longer │ │ │ ├── html2text {} │ │ │ │ @@ -161,15 +161,15 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ MMuullttiirreeddddiitt_## ************ │ │ │ │ - ccllaassss praw.models.Multireddit(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]])_# │ │ │ │ + ccllaassss praw.models.Multireddit(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]])_# │ │ │ │ A class for users’ multireddits. │ │ │ │ This is referred to as a “Custom Feed” on the Reddit UI. │ │ │ │ TTyyppiiccaall AAttttrriibbuutteess │ │ │ │ Note │ │ │ │ This table describes attributes that typically belong to objects of this │ │ │ │ class. PRAW dynamically provides the attributes that Reddit returns via │ │ │ │ the API. Since those attributes are subject to change on Reddit’s end, │ │ │ │ @@ -190,125 +190,125 @@ │ │ │ │ display_name The display name of the multireddit. │ │ │ │ name The name of the multireddit. │ │ │ │ over_18 A bool representing whether or not the multireddit is │ │ │ │ restricted for users over 18. │ │ │ │ subreddits A list of _S_u_b_r_e_d_d_i_ts that make up the multireddit. │ │ │ │ visibility The visibility of the multireddit, either "private", │ │ │ │ "public", or "hidden". │ │ │ │ - __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]])_# │ │ │ │ + __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]])_# │ │ │ │ Initialize a _M_u_l_t_i_r_e_d_d_i_t instance. │ │ │ │ add(ssuubbrreeddddiitt:: _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt)_# │ │ │ │ Add a subreddit to this multireddit. │ │ │ │ Parameters: │ │ │ │ ssuubbrreeddddiitt – The subreddit to add to this multi. │ │ │ │ For example, to add r/test to multireddit bboe/test: │ │ │ │ subreddit = reddit.subreddit("test") │ │ │ │ reddit.multireddit(redditor="bboe", name="test").add(subreddit) │ │ │ │ comments() → _C_o_m_m_e_n_t_H_e_l_p_e_r_# │ │ │ │ Provide an instance of _C_o_m_m_e_n_t_H_e_l_p_e_r. │ │ │ │ For example, to output the author of the 25 most recent comments of │ │ │ │ r/test execute: │ │ │ │ for comment in reddit.subreddit("test").comments(limit=25): │ │ │ │ print(comment.author) │ │ │ │ - controversial(**, ttiimmee__ffiilltteerr:: _ss_tt_rr == ''aallll'', ****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn │ │ │ │ - [[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → _I_t_e_r_a_t_o_r[_A_n_y]_# │ │ │ │ + controversial(**, ttiimmee__ffiilltteerr:: ssttrr == ''aallll'', ****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn │ │ │ │ + [[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → Iterator[Any]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for controversial items. │ │ │ │ Parameters: │ │ │ │ ttiimmee__ffiilltteerr – Can be one of: "all", "day", "hour", "month", │ │ │ │ "week", or "year" (default: "all"). │ │ │ │ Raises: │ │ │ │ - _V_a_l_u_e_E_r_r_o_r if time_filter is invalid. │ │ │ │ + ValueError if time_filter is invalid. │ │ │ │ Additional keyword arguments are passed in the initialization of │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r. │ │ │ │ This method can be used like: │ │ │ │ reddit.domain("imgur.com").controversial(time_filter="week") │ │ │ │ reddit.multireddit(redditor="samuraisam", │ │ │ │ name="programming").controversial( │ │ │ │ time_filter="day" │ │ │ │ ) │ │ │ │ reddit.redditor("spez").controversial(time_filter="month") │ │ │ │ reddit.redditor("spez").comments.controversial(time_filter="year") │ │ │ │ reddit.redditor("spez").submissions.controversial │ │ │ │ (time_filter="all") │ │ │ │ reddit.subreddit("all").controversial(time_filter="hour") │ │ │ │ - copy(**, ddiissppllaayy__nnaammee:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee) → _p_r_a_w_._m_o_d_e_l_s_._M_u_l_t_i_r_e_d_d_i_t_# │ │ │ │ + copy(**, ddiissppllaayy__nnaammee:: OOppttiioonnaall[[ssttrr]] == NNoonnee) → _p_r_a_w_._m_o_d_e_l_s_._M_u_l_t_i_r_e_d_d_i_t_# │ │ │ │ Copy this multireddit and return the new multireddit. │ │ │ │ Parameters: │ │ │ │ ddiissppllaayy__nnaammee – The display name for the copied multireddit. │ │ │ │ Reddit will generate the name field from this display name. │ │ │ │ When not provided the copy will use the same display name and │ │ │ │ name as this multireddit. │ │ │ │ To copy the multireddit bboe/test with a name of "testing": │ │ │ │ reddit.multireddit(redditor="bboe", name="test").copy │ │ │ │ (display_name="testing") │ │ │ │ delete()_# │ │ │ │ Delete this multireddit. │ │ │ │ For example, to delete multireddit bboe/test: │ │ │ │ reddit.multireddit(redditor="bboe", name="test").delete() │ │ │ │ - gilded(****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → _I_t_e_r_a_t_o_r │ │ │ │ - [_A_n_y]_# │ │ │ │ + gilded(****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → Iterator │ │ │ │ + [Any]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for gilded items. │ │ │ │ Additional keyword arguments are passed in the initialization of │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r. │ │ │ │ For example, to get gilded items in r/test: │ │ │ │ for item in reddit.subreddit("test").gilded(): │ │ │ │ print(item.id) │ │ │ │ - hot(****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → _I_t_e_r_a_t_o_r │ │ │ │ - [_A_n_y]_# │ │ │ │ + hot(****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → Iterator │ │ │ │ + [Any]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for hot items. │ │ │ │ Additional keyword arguments are passed in the initialization of │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r. │ │ │ │ This method can be used like: │ │ │ │ reddit.domain("imgur.com").hot() │ │ │ │ reddit.multireddit(redditor="samuraisam", name="programming").hot() │ │ │ │ reddit.redditor("spez").hot() │ │ │ │ reddit.redditor("spez").comments.hot() │ │ │ │ reddit.redditor("spez").submissions.hot() │ │ │ │ reddit.subreddit("all").hot() │ │ │ │ - new(****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → _I_t_e_r_a_t_o_r │ │ │ │ - [_A_n_y]_# │ │ │ │ + new(****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → Iterator │ │ │ │ + [Any]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for new items. │ │ │ │ Additional keyword arguments are passed in the initialization of │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r. │ │ │ │ This method can be used like: │ │ │ │ reddit.domain("imgur.com").new() │ │ │ │ reddit.multireddit(redditor="samuraisam", name="programming").new() │ │ │ │ reddit.redditor("spez").new() │ │ │ │ reddit.redditor("spez").comments.new() │ │ │ │ reddit.redditor("spez").submissions.new() │ │ │ │ reddit.subreddit("all").new() │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ - random_rising(****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → │ │ │ │ - _I_t_e_r_a_t_o_r[_p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]_# │ │ │ │ + random_rising(****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → │ │ │ │ + Iterator[_p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for random rising submissions. │ │ │ │ Additional keyword arguments are passed in the initialization of │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r. │ │ │ │ For example, to get random rising submissions for r/test: │ │ │ │ for submission in reddit.subreddit("test").random_rising(): │ │ │ │ print(submission.title) │ │ │ │ remove(ssuubbrreeddddiitt:: _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt)_# │ │ │ │ Remove a subreddit from this multireddit. │ │ │ │ Parameters: │ │ │ │ ssuubbrreeddddiitt – The subreddit to remove from this multi. │ │ │ │ For example, to remove r/test from multireddit bboe/test: │ │ │ │ subreddit = reddit.subreddit("test") │ │ │ │ reddit.multireddit(redditor="bboe", name="test").remove(subreddit) │ │ │ │ - rising(****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → _I_t_e_r_a_t_o_r │ │ │ │ + rising(****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → Iterator │ │ │ │ [_p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for rising submissions. │ │ │ │ Additional keyword arguments are passed in the initialization of │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r. │ │ │ │ For example, to get rising submissions for r/test: │ │ │ │ for submission in reddit.subreddit("test").rising(): │ │ │ │ print(submission.title) │ │ │ │ - ssttaattiicc sluggify(ttiittllee:: _ss_tt_rr)_# │ │ │ │ + ssttaattiicc sluggify(ttiittllee:: ssttrr)_# │ │ │ │ Return a slug version of the title. │ │ │ │ Parameters: │ │ │ │ ttiittllee – The title to make a slug of. │ │ │ │ Adapted from Reddit’s utils.py. │ │ │ │ stream() → _S_u_b_r_e_d_d_i_t_S_t_r_e_a_m_# │ │ │ │ Provide an instance of _S_u_b_r_e_d_d_i_t_S_t_r_e_a_m. │ │ │ │ Streams can be used to indefinitely retrieve new comments made to a │ │ │ │ @@ -319,34 +319,34 @@ │ │ │ │ Additionally, new submissions can be retrieved via the stream. In │ │ │ │ the following example all new submissions to the multireddit are │ │ │ │ fetched: │ │ │ │ for submission in reddit.multireddit( │ │ │ │ redditor="bboe", name="games" │ │ │ │ ).stream.submissions(): │ │ │ │ print(submission) │ │ │ │ - top(**, ttiimmee__ffiilltteerr:: _ss_tt_rr == ''aallll'', ****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, │ │ │ │ - _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → _I_t_e_r_a_t_o_r[_A_n_y]_# │ │ │ │ + top(**, ttiimmee__ffiilltteerr:: ssttrr == ''aallll'', ****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, │ │ │ │ + DDiicctt[[ssttrr,, ssttrr]]]]) → Iterator[Any]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for top items. │ │ │ │ Parameters: │ │ │ │ ttiimmee__ffiilltteerr – Can be one of: "all", "day", "hour", "month", │ │ │ │ "week", or "year" (default: "all"). │ │ │ │ Raises: │ │ │ │ - _V_a_l_u_e_E_r_r_o_r if time_filter is invalid. │ │ │ │ + ValueError if time_filter is invalid. │ │ │ │ Additional keyword arguments are passed in the initialization of │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r. │ │ │ │ This method can be used like: │ │ │ │ reddit.domain("imgur.com").top(time_filter="week") │ │ │ │ reddit.multireddit(redditor="samuraisam", name="programming").top │ │ │ │ (time_filter="day") │ │ │ │ reddit.redditor("spez").top(time_filter="month") │ │ │ │ reddit.redditor("spez").comments.top(time_filter="year") │ │ │ │ reddit.redditor("spez").submissions.top(time_filter="all") │ │ │ │ reddit.subreddit("all").top(time_filter="hour") │ │ │ │ - update(****uuppddaatteedd__sseettttiinnggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _LL_ii_ss_tt[[_UU_nn_ii_oo_nn[[_ss_tt_rr,, │ │ │ │ - _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]]]]])_# │ │ │ │ + update(****uuppddaatteedd__sseettttiinnggss:: UUnniioonn[[ssttrr,, LLiisstt[[UUnniioonn[[ssttrr,, │ │ │ │ + _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt,, DDiicctt[[ssttrr,, ssttrr]]]]]]]])_# │ │ │ │ Update this multireddit. │ │ │ │ Keyword arguments are passed for settings that should be updated. │ │ │ │ They can any of: │ │ │ │ Parameters: │ │ │ │ * ddiissppllaayy__nnaammee – The display name for this multireddit. │ │ │ │ Must be no longer than 50 characters. │ │ │ │ * ssuubbrreeddddiittss – Subreddits for this multireddit. │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/models/redditor.html │ │ │ @@ -355,15 +355,15 @@ │ │ │ │ │ │ │ │ │

    │ │ │
    │ │ │

    Redditor#

    │ │ │
    │ │ │
    │ │ │ -class praw.models.Redditor(reddit: praw.Reddit, name: Optional[str] = None, fullname: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)#
    │ │ │ +class praw.models.Redditor(reddit: praw.Reddit, name: Optional[str] = None, fullname: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)# │ │ │

    A class representing the users of Reddit.

    │ │ │

    Typical Attributes

    │ │ │
    │ │ │

    Note

    │ │ │

    This table describes attributes that typically belong to objects of this class. PRAW │ │ │ dynamically provides the attributes that Reddit returns via the API. Since those │ │ │ attributes are subject to change on Reddit’s end, PRAW makes no effort to document │ │ │ @@ -467,15 +467,15 @@ │ │ │

    The title of the user-subreddit.

    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │
    │ │ │ -__init__(reddit: praw.Reddit, name: Optional[str] = None, fullname: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)#
    │ │ │ +__init__(reddit: praw.Reddit, name: Optional[str] = None, fullname: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)# │ │ │

    Initialize a Redditor instance.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │

    • reddit – An instance of Reddit.

      • │ │ │

    • name – The name of the redditor.

      • │ │ │

    • fullname – The fullname of the redditor, starting with t2_.

      • │ │ │ @@ -512,23 +512,23 @@ │ │ │ print(comment.body.split("\\n", 1)[0][:79]) │ │ │ │ │ │ │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -controversial(*, time_filter: str = 'all', **generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]#
    │ │ │ +controversial(*, time_filter: str = 'all', **generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]# │ │ │

    Return a ListingGenerator for controversial items.

    │ │ │
    │ │ │
    Parameters:
    │ │ │

    time_filter – Can be one of: "all", "day", "hour", │ │ │ "month", "week", or "year" (default: "all").

    │ │ │
    │ │ │
    Raises:
    │ │ │ -

    ValueError if time_filter is invalid.

    │ │ │ +

    ValueError if time_filter is invalid.

    │ │ │
    │ │ │
    │ │ │

    Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

    │ │ │

    This method can be used like:

    │ │ │ 
    reddit.domain("imgur.com").controversial(time_filter="week")
│ │ │  reddit.multireddit(redditor="samuraisam", name="programming").controversial(
│ │ │ @@ -554,15 +554,15 @@
│ │ │  
    See also
    
│ │ │  
    trust()
    
│ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -downvoted(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Union[praw.models.Comment, praw.models.Submission]]#
    │ │ │ +downvoted(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Union[praw.models.Comment, praw.models.Submission]]# │ │ │

    Return a ListingGenerator for items the user has downvoted.

    │ │ │
    │ │ │
    Returns:
    │ │ │

    A ListingGenerator object which yields Comment or │ │ │ Submission objects the user has downvoted.

    │ │ │
    │ │ │
    Raises:
    │ │ │ @@ -582,15 +582,15 @@ │ │ │ print(item.id) │ │ │ │ │ │ │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -friend(*, note: str = None)#
    │ │ │ +friend(*, note: str = None)# │ │ │

    Friend the Redditor.

    │ │ │
    │ │ │
    Parameters:
    │ │ │

    note – A note to save along with the relationship. Requires Reddit Premium │ │ │ (default: None).

    │ │ │
    │ │ │
    │ │ │ @@ -626,51 +626,51 @@ │ │ │
    │ │ │ classmethod from_data(reddit, data)#
    │ │ │

    Return an instance of Redditor, or None from data.

    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -property fullname: str#
    │ │ │ +property fullname: str# │ │ │

    Return the object’s fullname.

    │ │ │

    A fullname is an object’s kind mapping like t3 followed by an underscore and │ │ │ the object’s base36 ID, e.g., t1_c5s96e0.

    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -gild(*, months: int = 1)#
    │ │ │ +gild(*, months: int = 1)# │ │ │

    Gild the Redditor.

    │ │ │
    │ │ │
    Parameters:
    │ │ │

    months – Specifies the number of months to gild up to 36 (default: 1).

    │ │ │
    │ │ │
    │ │ │

    For example, to gild Redditor u/spez for 1 month:

    │ │ │ 
    reddit.redditor("spez").gild(months=1)
│ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -gilded(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]#
    │ │ │ +gilded(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]# │ │ │

    Return a ListingGenerator for gilded items.

    │ │ │

    Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

    │ │ │

    For example, to get gilded items in r/test:

    │ │ │ 
    for item in reddit.subreddit("test").gilded():
│ │ │      print(item.id)
│ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -gildings(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Union[praw.models.Comment, praw.models.Submission]]#
    │ │ │ +gildings(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Union[praw.models.Comment, praw.models.Submission]]# │ │ │

    Return a ListingGenerator for items the user has gilded.

    │ │ │
    │ │ │
    Returns:
    │ │ │

    A ListingGenerator object which yields Comment or │ │ │ Submission objects the user has gilded.

    │ │ │
    │ │ │
    Raises:
    │ │ │ @@ -690,15 +690,15 @@ │ │ │ print(item.id) │ │ │ │ │ │ │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -hidden(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Union[praw.models.Comment, praw.models.Submission]]#
    │ │ │ +hidden(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Union[praw.models.Comment, praw.models.Submission]]# │ │ │

    Return a ListingGenerator for items the user has hidden.

    │ │ │
    │ │ │
    Returns:
    │ │ │

    A ListingGenerator object which yields Comment or │ │ │ Submission objects the user has hid.

    │ │ │
    │ │ │
    Raises:
    │ │ │ @@ -718,15 +718,15 @@ │ │ │ print(item.id) │ │ │ │ │ │ │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -hot(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]#
    │ │ │ +hot(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]# │ │ │

    Return a ListingGenerator for hot items.

    │ │ │

    Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

    │ │ │

    This method can be used like:

    │ │ │ 
    reddit.domain("imgur.com").hot()
│ │ │  reddit.multireddit(redditor="samuraisam", name="programming").hot()
│ │ │  reddit.redditor("spez").hot()
│ │ │ @@ -735,15 +735,15 @@
│ │ │  reddit.subreddit("all").hot()
│ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -message(*, from_subreddit: Optional[Union[praw.models.Subreddit, str]] = None, message: str, subject: str)#
    │ │ │ +message(*, from_subreddit: Optional[Union[praw.models.Subreddit, str]] = None, message: str, subject: str)# │ │ │

    Send a message to a Redditor or a Subreddit’s moderators (modmail).

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │

    • from_subreddit –

      A Subreddit instance or string to send the │ │ │ message from. When provided, messages are sent from the subreddit rather │ │ │ than from the authenticated user.

      │ │ │ @@ -772,15 +772,15 @@ │ │ │ 
      reddit.subreddit("test").message(subject="TEST", message="test PM from PRAW")
│ │ │
      │ │ │
      │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -moderated() → List[praw.models.Subreddit]#
    │ │ │ +moderated() → List[praw.models.Subreddit]# │ │ │

    Return a list of the redditor’s moderated subreddits.

    │ │ │
    │ │ │
    Returns:
    │ │ │

    A list of Subreddit objects. Return [] if the redditor │ │ │ has no moderated subreddits.

    │ │ │
    │ │ │
    Raises:
    │ │ │ @@ -818,25 +818,25 @@ │ │ │

    See also

    │ │ │

    User.moderator_subreddits()

    │ │ │ │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -multireddits() → List[praw.models.Multireddit]#
    │ │ │ +multireddits() → List[praw.models.Multireddit]# │ │ │

    Return a list of the redditor’s public multireddits.

    │ │ │

    For example, to to get Redditor u/spez’s multireddits:

    │ │ │ 
    multireddits = reddit.redditor("spez").multireddits()
│ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -new(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]#
    │ │ │ +new(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]# │ │ │

    Return a ListingGenerator for new items.

    │ │ │

    Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

    │ │ │

    This method can be used like:

    │ │ │ 
    reddit.domain("imgur.com").new()
│ │ │  reddit.multireddit(redditor="samuraisam", name="programming").new()
│ │ │  reddit.redditor("spez").new()
│ │ │ @@ -863,29 +863,29 @@
│ │ │      print(f"{note.label}: {note.note}")
│ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
    │ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

    Return an instance of cls from data.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │

    • data – The structured data.

      • │ │ │

    • reddit – An instance of Reddit.

      • │ │ │
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -saved(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Union[praw.models.Comment, praw.models.Submission]]#
    │ │ │ +saved(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Union[praw.models.Comment, praw.models.Submission]]# │ │ │

    Return a ListingGenerator for items the user has saved.

    │ │ │
    │ │ │
    Returns:
    │ │ │

    A ListingGenerator object which yields Comment or │ │ │ Submission objects the user has saved.

    │ │ │
    │ │ │
    Raises:
    │ │ │ @@ -935,23 +935,23 @@ │ │ │ print(submission.title) │ │ │ │ │ │ │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -top(*, time_filter: str = 'all', **generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]#
    │ │ │ +top(*, time_filter: str = 'all', **generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]# │ │ │

    Return a ListingGenerator for top items.

    │ │ │
    │ │ │
    Parameters:
    │ │ │

    time_filter – Can be one of: "all", "day", "hour", │ │ │ "month", "week", or "year" (default: "all").

    │ │ │
    │ │ │
    Raises:
    │ │ │ -

    ValueError if time_filter is invalid.

    │ │ │ +

    ValueError if time_filter is invalid.

    │ │ │
    │ │ │
    │ │ │

    Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

    │ │ │

    This method can be used like:

    │ │ │ 
    reddit.domain("imgur.com").top(time_filter="week")
│ │ │  reddit.multireddit(redditor="samuraisam", name="programming").top(time_filter="day")
│ │ │ @@ -961,15 +961,15 @@
│ │ │  reddit.subreddit("all").top(time_filter="hour")
│ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -trophies() → List[praw.models.Trophy]#
    │ │ │ +trophies() → List[praw.models.Trophy]# │ │ │

    Return a list of the redditor’s trophies.

    │ │ │
    │ │ │
    Returns:
    │ │ │

    A list of Trophy objects. Return [] if the redditor has │ │ │ no trophies.

    │ │ │
    │ │ │
    Raises:
    │ │ │ @@ -1037,15 +1037,15 @@ │ │ │ 
    reddit.redditor("spez").unfriend()
│ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -upvoted(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Union[praw.models.Comment, praw.models.Submission]]#
    │ │ │ +upvoted(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Union[praw.models.Comment, praw.models.Submission]]# │ │ │

    Return a ListingGenerator for items the user has upvoted.

    │ │ │
    │ │ │
    Returns:
    │ │ │

    A ListingGenerator object which yields Comment or │ │ │ Submission objects the user has upvoted.

    │ │ │
    │ │ │
    Raises:
    │ │ │ ├── html2text {} │ │ │ │ @@ -161,16 +161,16 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ RReeddddiittoorr_## ************ │ │ │ │ - ccllaassss praw.models.Redditor(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, nnaammee:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, │ │ │ │ - ffuullllnnaammee:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]]]] == NNoonnee)_# │ │ │ │ + ccllaassss praw.models.Redditor(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, nnaammee:: OOppttiioonnaall[[ssttrr]] == NNoonnee, │ │ │ │ + ffuullllnnaammee:: OOppttiioonnaall[[ssttrr]] == NNoonnee, __ddaattaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, AAnnyy]]]] == NNoonnee)_# │ │ │ │ A class representing the users of Reddit. │ │ │ │ TTyyppiiccaall AAttttrriibbuutteess │ │ │ │ Note │ │ │ │ This table describes attributes that typically belong to objects of this │ │ │ │ class. PRAW dynamically provides the attributes that Reddit returns via │ │ │ │ the API. Since those attributes are subject to change on Reddit’s end, │ │ │ │ PRAW makes no effort to document any new/removed/changed attributes, │ │ │ │ @@ -217,16 +217,16 @@ │ │ │ │ subreddit["over_18"] Whether or not the user-subreddit is │ │ │ │ NSFW. │ │ │ │ subreddit["public_description"] The public description of the user- │ │ │ │ subreddit. │ │ │ │ subreddit["subscribers"] The number of users subscribed to the │ │ │ │ user-subreddit. │ │ │ │ subreddit["title"] The title of the user-subreddit. │ │ │ │ - __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, nnaammee:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, ffuullllnnaammee:: │ │ │ │ - _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]]]] == NNoonnee)_# │ │ │ │ + __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, nnaammee:: OOppttiioonnaall[[ssttrr]] == NNoonnee, ffuullllnnaammee:: │ │ │ │ + OOppttiioonnaall[[ssttrr]] == NNoonnee, __ddaattaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, AAnnyy]]]] == NNoonnee)_# │ │ │ │ Initialize a _R_e_d_d_i_t_o_r instance. │ │ │ │ Parameters: │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ * nnaammee – The name of the redditor. │ │ │ │ * ffuullllnnaammee – The fullname of the redditor, starting with │ │ │ │ t2_. │ │ │ │ Exactly one of name, fullname or _data must be provided. │ │ │ │ @@ -241,22 +241,22 @@ │ │ │ │ _t_r_u_s_t_(_) │ │ │ │ comments() → _S_u_b_L_i_s_t_i_n_g_# │ │ │ │ Provide an instance of _S_u_b_L_i_s_t_i_n_g for comment access. │ │ │ │ For example, to output the first line of all new comments by u/spez │ │ │ │ try: │ │ │ │ for comment in reddit.redditor("spez").comments.new(limit=None): │ │ │ │ print(comment.body.split("\\n", 1)[0][:79]) │ │ │ │ - controversial(**, ttiimmee__ffiilltteerr:: _ss_tt_rr == ''aallll'', ****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn │ │ │ │ - [[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → _I_t_e_r_a_t_o_r[_A_n_y]_# │ │ │ │ + controversial(**, ttiimmee__ffiilltteerr:: ssttrr == ''aallll'', ****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn │ │ │ │ + [[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → Iterator[Any]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for controversial items. │ │ │ │ Parameters: │ │ │ │ ttiimmee__ffiilltteerr – Can be one of: "all", "day", "hour", "month", │ │ │ │ "week", or "year" (default: "all"). │ │ │ │ Raises: │ │ │ │ - _V_a_l_u_e_E_r_r_o_r if time_filter is invalid. │ │ │ │ + ValueError if time_filter is invalid. │ │ │ │ Additional keyword arguments are passed in the initialization of │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r. │ │ │ │ This method can be used like: │ │ │ │ reddit.domain("imgur.com").controversial(time_filter="week") │ │ │ │ reddit.multireddit(redditor="samuraisam", │ │ │ │ name="programming").controversial( │ │ │ │ time_filter="day" │ │ │ │ @@ -268,16 +268,16 @@ │ │ │ │ reddit.subreddit("all").controversial(time_filter="hour") │ │ │ │ distrust()_# │ │ │ │ Remove the _R_e_d_d_i_t_o_r from your whitelist of trusted users. │ │ │ │ For example, to remove _R_e_d_d_i_t_o_r u/spez from your whitelist: │ │ │ │ reddit.redditor("spez").distrust() │ │ │ │ See also │ │ │ │ _t_r_u_s_t_(_) │ │ │ │ - downvoted(****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → │ │ │ │ - _I_t_e_r_a_t_o_r[_U_n_i_o_n[_p_r_a_w_._m_o_d_e_l_s_._C_o_m_m_e_n_t, _p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]]_# │ │ │ │ + downvoted(****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → │ │ │ │ + Iterator[Union[_p_r_a_w_._m_o_d_e_l_s_._C_o_m_m_e_n_t, _p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for items the user has downvoted. │ │ │ │ Returns: │ │ │ │ A _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r object which yields _C_o_m_m_e_n_t or _S_u_b_m_i_s_s_i_o_n │ │ │ │ objects the user has downvoted. │ │ │ │ Raises: │ │ │ │ prawcore.Forbidden if the user is not authorized to access │ │ │ │ the list. │ │ │ │ @@ -286,15 +286,15 @@ │ │ │ │ may not occur until sometime after this function has │ │ │ │ returned. │ │ │ │ Additional keyword arguments are passed in the initialization of │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r. │ │ │ │ For example, to get all downvoted items of the authenticated user: │ │ │ │ for item in reddit.user.me().downvoted(): │ │ │ │ print(item.id) │ │ │ │ - friend(**, nnoottee:: _ss_tt_rr == NNoonnee)_# │ │ │ │ + friend(**, nnoottee:: ssttrr == NNoonnee)_# │ │ │ │ Friend the _R_e_d_d_i_t_o_r. │ │ │ │ Parameters: │ │ │ │ nnoottee – A note to save along with the relationship. Requires │ │ │ │ Reddit Premium (default: None). │ │ │ │ Calling this method subsequent times will update the note. │ │ │ │ For example, to friend u/spez: │ │ │ │ reddit.redditor("spez").friend() │ │ │ │ @@ -306,35 +306,35 @@ │ │ │ │ A _R_e_d_d_i_t_o_r instance with fields date, id, and possibly note │ │ │ │ if the authenticated user has Reddit Premium. │ │ │ │ For example, to get the friendship information of _R_e_d_d_i_t_o_r u/spez: │ │ │ │ info = reddit.redditor("spez").friend_info │ │ │ │ friend_data = info.date │ │ │ │ ccllaassssmmeetthhoodd from_data(rreeddddiitt, ddaattaa)_# │ │ │ │ Return an instance of _R_e_d_d_i_t_o_r, or None from data. │ │ │ │ - pprrooppeerrttyy fullname:: _ss_tt_rr_# │ │ │ │ + pprrooppeerrttyy fullname:: ssttrr_# │ │ │ │ Return the object’s fullname. │ │ │ │ A fullname is an object’s kind mapping like t3 followed by an │ │ │ │ underscore and the object’s base36 ID, e.g., t1_c5s96e0. │ │ │ │ - gild(**, mmoonntthhss:: _ii_nn_tt == 11)_# │ │ │ │ + gild(**, mmoonntthhss:: iinntt == 11)_# │ │ │ │ Gild the _R_e_d_d_i_t_o_r. │ │ │ │ Parameters: │ │ │ │ mmoonntthhss – Specifies the number of months to gild up to 36 │ │ │ │ (default: 1). │ │ │ │ For example, to gild _R_e_d_d_i_t_o_r u/spez for 1 month: │ │ │ │ reddit.redditor("spez").gild(months=1) │ │ │ │ - gilded(****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → _I_t_e_r_a_t_o_r │ │ │ │ - [_A_n_y]_# │ │ │ │ + gilded(****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → Iterator │ │ │ │ + [Any]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for gilded items. │ │ │ │ Additional keyword arguments are passed in the initialization of │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r. │ │ │ │ For example, to get gilded items in r/test: │ │ │ │ for item in reddit.subreddit("test").gilded(): │ │ │ │ print(item.id) │ │ │ │ - gildings(****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → │ │ │ │ - _I_t_e_r_a_t_o_r[_U_n_i_o_n[_p_r_a_w_._m_o_d_e_l_s_._C_o_m_m_e_n_t, _p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]]_# │ │ │ │ + gildings(****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → │ │ │ │ + Iterator[Union[_p_r_a_w_._m_o_d_e_l_s_._C_o_m_m_e_n_t, _p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for items the user has gilded. │ │ │ │ Returns: │ │ │ │ A _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r object which yields _C_o_m_m_e_n_t or _S_u_b_m_i_s_s_i_o_n │ │ │ │ objects the user has gilded. │ │ │ │ Raises: │ │ │ │ prawcore.Forbidden if the user is not authorized to access │ │ │ │ the list. │ │ │ │ @@ -343,16 +343,16 @@ │ │ │ │ may not occur until sometime after this function has │ │ │ │ returned. │ │ │ │ Additional keyword arguments are passed in the initialization of │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r. │ │ │ │ For example, to get all gilded items of the authenticated user: │ │ │ │ for item in reddit.user.me().gildings(): │ │ │ │ print(item.id) │ │ │ │ - hidden(****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → _I_t_e_r_a_t_o_r │ │ │ │ - [_U_n_i_o_n[_p_r_a_w_._m_o_d_e_l_s_._C_o_m_m_e_n_t, _p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]]_# │ │ │ │ + hidden(****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → Iterator │ │ │ │ + [Union[_p_r_a_w_._m_o_d_e_l_s_._C_o_m_m_e_n_t, _p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for items the user has hidden. │ │ │ │ Returns: │ │ │ │ A _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r object which yields _C_o_m_m_e_n_t or _S_u_b_m_i_s_s_i_o_n │ │ │ │ objects the user has hid. │ │ │ │ Raises: │ │ │ │ prawcore.Forbidden if the user is not authorized to access │ │ │ │ the list. │ │ │ │ @@ -361,41 +361,41 @@ │ │ │ │ may not occur until sometime after this function has │ │ │ │ returned. │ │ │ │ Additional keyword arguments are passed in the initialization of │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r. │ │ │ │ For example, to get all hidden items of the authenticated user: │ │ │ │ for item in reddit.user.me().hidden(): │ │ │ │ print(item.id) │ │ │ │ - hot(****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → _I_t_e_r_a_t_o_r │ │ │ │ - [_A_n_y]_# │ │ │ │ + hot(****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → Iterator │ │ │ │ + [Any]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for hot items. │ │ │ │ Additional keyword arguments are passed in the initialization of │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r. │ │ │ │ This method can be used like: │ │ │ │ reddit.domain("imgur.com").hot() │ │ │ │ reddit.multireddit(redditor="samuraisam", name="programming").hot() │ │ │ │ reddit.redditor("spez").hot() │ │ │ │ reddit.redditor("spez").comments.hot() │ │ │ │ reddit.redditor("spez").submissions.hot() │ │ │ │ reddit.subreddit("all").hot() │ │ │ │ - message(**, ffrroomm__ssuubbrreeddddiitt:: _OO_pp_tt_ii_oo_nn_aa_ll[[_UU_nn_ii_oo_nn[[_pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt,, _ss_tt_rr]]]] │ │ │ │ - == NNoonnee, mmeessssaaggee:: _ss_tt_rr, ssuubbjjeecctt:: _ss_tt_rr)_# │ │ │ │ + message(**, ffrroomm__ssuubbrreeddddiitt:: OOppttiioonnaall[[UUnniioonn[[_pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt,, ssttrr]]]] │ │ │ │ + == NNoonnee, mmeessssaaggee:: ssttrr, ssuubbjjeecctt:: ssttrr)_# │ │ │ │ Send a message to a _R_e_d_d_i_t_o_r or a _S_u_b_r_e_d_d_i_t’s moderators (modmail). │ │ │ │ For example, to send a private message to u/spez, try: │ │ │ │ reddit.redditor("spez").message(subject="TEST", message="test │ │ │ │ message from PRAW") │ │ │ │ To send a message to u/spez from the moderators of r/test try: │ │ │ │ reddit.redditor("spez").message( │ │ │ │ subject="TEST", message="test message from r/test", │ │ │ │ from_subreddit="test" │ │ │ │ ) │ │ │ │ To send a message to the moderators of r/test, try: │ │ │ │ reddit.subreddit("test").message(subject="TEST", message="test PM │ │ │ │ from PRAW") │ │ │ │ - moderated() → _L_i_s_t[_p_r_a_w_._m_o_d_e_l_s_._S_u_b_r_e_d_d_i_t]_# │ │ │ │ + moderated() → List[_p_r_a_w_._m_o_d_e_l_s_._S_u_b_r_e_d_d_i_t]_# │ │ │ │ Return a list of the redditor’s moderated subreddits. │ │ │ │ Returns: │ │ │ │ A list of _S_u_b_r_e_d_d_i_t objects. Return [] if the redditor has no │ │ │ │ moderated subreddits. │ │ │ │ Raises: │ │ │ │ prawcore.ServerError in certain circumstances. See the note │ │ │ │ below. │ │ │ │ @@ -417,20 +417,20 @@ │ │ │ │ a prawcore.ServerError exception. │ │ │ │ When used in read-only mode, this method does not retrieve │ │ │ │ information about subreddits that require certain special │ │ │ │ permissions to access, e.g., private subreddits and premium-only │ │ │ │ subreddits. │ │ │ │ See also │ │ │ │ _U_s_e_r_._m_o_d_e_r_a_t_o_r___s_u_b_r_e_d_d_i_t_s_(_) │ │ │ │ - multireddits() → _L_i_s_t[_p_r_a_w_._m_o_d_e_l_s_._M_u_l_t_i_r_e_d_d_i_t]_# │ │ │ │ + multireddits() → List[_p_r_a_w_._m_o_d_e_l_s_._M_u_l_t_i_r_e_d_d_i_t]_# │ │ │ │ Return a list of the redditor’s public multireddits. │ │ │ │ For example, to to get _R_e_d_d_i_t_o_r u/spez’s multireddits: │ │ │ │ multireddits = reddit.redditor("spez").multireddits() │ │ │ │ - new(****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → _I_t_e_r_a_t_o_r │ │ │ │ - [_A_n_y]_# │ │ │ │ + new(****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → Iterator │ │ │ │ + [Any]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for new items. │ │ │ │ Additional keyword arguments are passed in the initialization of │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r. │ │ │ │ This method can be used like: │ │ │ │ reddit.domain("imgur.com").new() │ │ │ │ reddit.multireddit(redditor="samuraisam", name="programming").new() │ │ │ │ reddit.redditor("spez").new() │ │ │ │ @@ -446,21 +446,21 @@ │ │ │ │ subreddit(s). │ │ │ │ For example, all the notes for u/spez in r/test can be iterated │ │ │ │ through like so: │ │ │ │ redditor = reddit.redditor("spez") │ │ │ │ │ │ │ │ for note in redditor.notes.subreddits("test"): │ │ │ │ print(f"{note.label}: {note.note}") │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ - saved(****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → _I_t_e_r_a_t_o_r │ │ │ │ - [_U_n_i_o_n[_p_r_a_w_._m_o_d_e_l_s_._C_o_m_m_e_n_t, _p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]]_# │ │ │ │ + saved(****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → Iterator │ │ │ │ + [Union[_p_r_a_w_._m_o_d_e_l_s_._C_o_m_m_e_n_t, _p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for items the user has saved. │ │ │ │ Returns: │ │ │ │ A _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r object which yields _C_o_m_m_e_n_t or _S_u_b_m_i_s_s_i_o_n │ │ │ │ objects the user has saved. │ │ │ │ Raises: │ │ │ │ prawcore.Forbidden if the user is not authorized to access │ │ │ │ the list. │ │ │ │ @@ -487,33 +487,33 @@ │ │ │ │ submissions() → _S_u_b_L_i_s_t_i_n_g_# │ │ │ │ Provide an instance of _S_u_b_L_i_s_t_i_n_g for submission access. │ │ │ │ For example, to output the title’s of top 100 of all time │ │ │ │ submissions for u/spez try: │ │ │ │ for submission in reddit.redditor("spez").submissions.top │ │ │ │ (time_filter="all"): │ │ │ │ print(submission.title) │ │ │ │ - top(**, ttiimmee__ffiilltteerr:: _ss_tt_rr == ''aallll'', ****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, │ │ │ │ - _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → _I_t_e_r_a_t_o_r[_A_n_y]_# │ │ │ │ + top(**, ttiimmee__ffiilltteerr:: ssttrr == ''aallll'', ****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, │ │ │ │ + DDiicctt[[ssttrr,, ssttrr]]]]) → Iterator[Any]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for top items. │ │ │ │ Parameters: │ │ │ │ ttiimmee__ffiilltteerr – Can be one of: "all", "day", "hour", "month", │ │ │ │ "week", or "year" (default: "all"). │ │ │ │ Raises: │ │ │ │ - _V_a_l_u_e_E_r_r_o_r if time_filter is invalid. │ │ │ │ + ValueError if time_filter is invalid. │ │ │ │ Additional keyword arguments are passed in the initialization of │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r. │ │ │ │ This method can be used like: │ │ │ │ reddit.domain("imgur.com").top(time_filter="week") │ │ │ │ reddit.multireddit(redditor="samuraisam", name="programming").top │ │ │ │ (time_filter="day") │ │ │ │ reddit.redditor("spez").top(time_filter="month") │ │ │ │ reddit.redditor("spez").comments.top(time_filter="year") │ │ │ │ reddit.redditor("spez").submissions.top(time_filter="all") │ │ │ │ reddit.subreddit("all").top(time_filter="hour") │ │ │ │ - trophies() → _L_i_s_t[_p_r_a_w_._m_o_d_e_l_s_._T_r_o_p_h_y]_# │ │ │ │ + trophies() → List[_p_r_a_w_._m_o_d_e_l_s_._T_r_o_p_h_y]_# │ │ │ │ Return a list of the redditor’s trophies. │ │ │ │ Returns: │ │ │ │ A list of _T_r_o_p_h_y objects. Return [] if the redditor has no │ │ │ │ trophies. │ │ │ │ Raises: │ │ │ │ _R_e_d_d_i_t_A_P_I_E_x_c_e_p_t_i_o_n if the redditor doesn’t exist. │ │ │ │ Usage: │ │ │ │ @@ -546,16 +546,16 @@ │ │ │ │ Unblock the _R_e_d_d_i_t_o_r. │ │ │ │ For example, to unblock _R_e_d_d_i_t_o_r u/spez: │ │ │ │ reddit.redditor("spez").unblock() │ │ │ │ unfriend()_# │ │ │ │ Unfriend the _R_e_d_d_i_t_o_r. │ │ │ │ For example, to unfriend _R_e_d_d_i_t_o_r u/spez: │ │ │ │ reddit.redditor("spez").unfriend() │ │ │ │ - upvoted(****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → _I_t_e_r_a_t_o_r │ │ │ │ - [_U_n_i_o_n[_p_r_a_w_._m_o_d_e_l_s_._C_o_m_m_e_n_t, _p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]]_# │ │ │ │ + upvoted(****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → Iterator │ │ │ │ + [Union[_p_r_a_w_._m_o_d_e_l_s_._C_o_m_m_e_n_t, _p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for items the user has upvoted. │ │ │ │ Returns: │ │ │ │ A _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r object which yields _C_o_m_m_e_n_t or _S_u_b_m_i_s_s_i_o_n │ │ │ │ objects the user has upvoted. │ │ │ │ Raises: │ │ │ │ prawcore.Forbidden if the user is not authorized to access │ │ │ │ the list. │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/models/submission.html │ │ │ @@ -355,15 +355,15 @@ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │

    Submission#

    │ │ │
    │ │ │
    │ │ │ -class praw.models.Submission(reddit: praw.Reddit, id: Optional[str] = None, url: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)#
    │ │ │ +class praw.models.Submission(reddit: praw.Reddit, id: Optional[str] = None, url: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)# │ │ │

    A class for submissions to Reddit.

    │ │ │

    Typical Attributes

    │ │ │
    │ │ │

    Note

    │ │ │

    This table describes attributes that typically belong to objects of this class. PRAW │ │ │ dynamically provides the attributes that Reddit returns via the API. Since those │ │ │ attributes are subject to change on Reddit’s end, PRAW makes no effort to document │ │ │ @@ -473,15 +473,15 @@ │ │ │ selfpost.

    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │
    │ │ │ -__init__(reddit: praw.Reddit, id: Optional[str] = None, url: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)#
    │ │ │ +__init__(reddit: praw.Reddit, id: Optional[str] = None, url: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)# │ │ │

    Initialize a Submission instance.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │

    • reddit – An instance of Reddit.

      • │ │ │

    • id – A reddit base36 submission ID, e.g., "2gmzqe".

      • │ │ │

    • url – A URL supported by id_from_url().

      • │ │ │ @@ -489,15 +489,15 @@ │ │ │
    │ │ │
    │ │ │

    Either id or url can be provided, but not both.

    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -_edit_experimental(body: str, *, preserve_inline_media=False, inline_media: Optional[Dict[str, praw.models.InlineMedia]] = None) → praw.models.Submission#
    │ │ │ +_edit_experimental(body: str, *, preserve_inline_media=False, inline_media: Optional[Dict[str, praw.models.InlineMedia]] = None) → praw.models.Submission# │ │ │

    Replace the body of the object with body.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │

    • body – The Markdown formatted content for the updated object.

      • │ │ │

    • preserve_inline_media –

      Attempt to preserve inline media in body.

      │ │ │
      │ │ │ @@ -548,15 +548,15 @@ │ │ │ print(submission.rtjson) │ │ │
      │ │ │ │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -award(*, gild_type: str = 'gid_2', is_anonymous: bool = True, message: str = None) → dict#
    │ │ │ +award(*, gild_type: str = 'gid_2', is_anonymous: bool = True, message: str = None) → dict# │ │ │

    Award the author of the item.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │

    • gild_type – Type of award to give. See table below for currently know │ │ │ global award types.

      • │ │ │

    • is_anonymous – If True, the authenticated user’s username will not be │ │ │ @@ -679,15 +679,15 @@ │ │ │ │ │ │

      See Extracting comments with PRAW for more on working with a │ │ │ CommentForest.

      │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -crosspost(subreddit: praw.models.Subreddit, *, flair_id: Optional[str] = None, flair_text: Optional[str] = None, nsfw: bool = False, send_replies: bool = True, spoiler: bool = False, title: Optional[str] = None) → praw.models.Submission#
    │ │ │ +crosspost(subreddit: praw.models.Subreddit, *, flair_id: Optional[str] = None, flair_text: Optional[str] = None, nsfw: bool = False, send_replies: bool = True, spoiler: bool = False, title: Optional[str] = None) → praw.models.Submission# │ │ │

    Crosspost the submission to a subreddit.

    │ │ │
    │ │ │

    Note

    │ │ │

    Be aware you have to be subscribed to the target subreddit.

    │ │ │
    │ │ │
    │ │ │
    Parameters:
    │ │ │ @@ -777,15 +777,15 @@ │ │ │

    See also

    │ │ │

    upvote()

    │ │ │ │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -duplicates(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[praw.models.Submission]#
    │ │ │ +duplicates(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[praw.models.Submission]# │ │ │

    Return a ListingGenerator for the submission’s duplicates.

    │ │ │

    Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

    │ │ │

    Example usage:

    │ │ │ 
    submission = reddit.submission("5or86n")
│ │ │  
│ │ │  for duplicate in submission.duplicates():
│ │ │ @@ -797,15 +797,15 @@
│ │ │  
    See also
    
│ │ │  
    upvote()
    
│ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -edit(body: str) → Union[praw.models.Comment, praw.models.Submission]#
    │ │ │ +edit(body: str) → Union[praw.models.Comment, praw.models.Submission]# │ │ │

    Replace the body of the object with body.

    │ │ │
    │ │ │
    Parameters:
    │ │ │

    body – The Markdown formatted content for the updated object.

    │ │ │
    │ │ │
    Returns:
    │ │ │

    The current instance after updating its attributes.

    │ │ │ @@ -853,29 +853,29 @@ │ │ │ submission.flair.select(template_id, text="my custom value") │ │ │ │ │ │ │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -property fullname: str#
    │ │ │ +property fullname: str# │ │ │

    Return the object’s fullname.

    │ │ │

    A fullname is an object’s kind mapping like t3 followed by an underscore and │ │ │ the object’s base36 ID, e.g., t1_c5s96e0.

    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -gild() → dict#
    │ │ │ +gild() → dict# │ │ │

    Alias for award() to maintain backwards compatibility.

    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -hide(*, other_submissions: Optional[List[praw.models.Submission]] = None)#
    │ │ │ +hide(*, other_submissions: Optional[List[praw.models.Submission]] = None)# │ │ │

    Hide Submission.

    │ │ │
    │ │ │
    Parameters:
    │ │ │

    other_submissions – When provided, additionally hide this list of │ │ │ Submission instances as part of a single request (default: │ │ │ None).

    │ │ │
    │ │ │ @@ -889,15 +889,15 @@ │ │ │

    See also

    │ │ │

    unhide()

    │ │ │ │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -static id_from_url(url: str) → str#
    │ │ │ +static id_from_url(url: str) → str# │ │ │

    Return the ID contained within a submission URL.

    │ │ │
    │ │ │
    Parameters:
    │ │ │

    url –

    A url to a submission in one of the following formats (http urls │ │ │ will also work):

    │ │ │
      │ │ │

    • "https://redd.it/2gmzqe"

      • │ │ │ @@ -934,29 +934,29 @@ │ │ │ submission.mod.approve() │ │ │ │ │ │ │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
    │ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

    Return an instance of cls from data.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │

    • data – The structured data.

      • │ │ │

    • reddit – An instance of Reddit.

      • │ │ │
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -reply(body: str) → Optional[Union[praw.models.Comment, praw.models.Message]]#
    │ │ │ +reply(body: str) → Optional[Union[praw.models.Comment, praw.models.Message]]# │ │ │

    Reply to the object.

    │ │ │
    │ │ │
    Parameters:
    │ │ │

    body – The Markdown formatted content for a comment.

    │ │ │
    │ │ │
    Returns:
    │ │ │

    A Comment or Message object for the newly created │ │ │ @@ -979,15 +979,15 @@ │ │ │ comment.reply("reply") │ │ │ │ │ │ │ │ │

    │ │ │ │ │ │
    │ │ │
    │ │ │ -report(reason: str)#
    │ │ │ +report(reason: str)# │ │ │

    Report this object to the moderators of its subreddit.

    │ │ │
    │ │ │
    Parameters:
    │ │ │

    reason – The reason for reporting.

    │ │ │
    │ │ │
    Raises:
    │ │ │

    RedditAPIException if reason is longer than 100 │ │ │ @@ -1002,15 +1002,15 @@ │ │ │ comment.report("report reason") │ │ │ │ │ │ │ │ │

    │ │ │ │ │ │
    │ │ │
    │ │ │ -save(*, category: Optional[str] = None)#
    │ │ │ +save(*, category: Optional[str] = None)# │ │ │

    Save the object.

    │ │ │
    │ │ │
    Parameters:
    │ │ │

    category – The category to save to. If the authenticated user does not │ │ │ have Reddit Premium this value is ignored by Reddit (default: None).

    │ │ │
    │ │ │
    │ │ │ @@ -1026,23 +1026,23 @@ │ │ │

    See also

    │ │ │

    unsave()

    │ │ │ │ │ │
    │ │ │ │ │ │
    │ │ │ │ │ │ +property shortlink: str# │ │ │

    Return a shortlink to the submission.

    │ │ │

    For example, https://redd.it/eorhm is a shortlink for │ │ │ https://www.reddit.com/r/announcements/comments/eorhm/reddit_30_less_typing/.

    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -unhide(*, other_submissions: Optional[List[praw.models.Submission]] = None)#
    │ │ │ +unhide(*, other_submissions: Optional[List[praw.models.Submission]] = None)# │ │ │

    Unhide Submission.

    │ │ │
    │ │ │
    Parameters:
    │ │ │

    other_submissions – When provided, additionally unhide this list of │ │ │ Submission instances as part of a single request (default: │ │ │ None).

    │ │ │
    │ │ │ ├── html2text {} │ │ │ │ @@ -161,16 +161,16 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ SSuubbmmiissssiioonn_## ************ │ │ │ │ - ccllaassss praw.models.Submission(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, iidd:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, │ │ │ │ - uurrll:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]]]] == NNoonnee)_# │ │ │ │ + ccllaassss praw.models.Submission(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, iidd:: OOppttiioonnaall[[ssttrr]] == NNoonnee, │ │ │ │ + uurrll:: OOppttiioonnaall[[ssttrr]] == NNoonnee, __ddaattaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, AAnnyy]]]] == NNoonnee)_# │ │ │ │ A class for submissions to Reddit. │ │ │ │ TTyyppiiccaall AAttttrriibbuutteess │ │ │ │ Note │ │ │ │ This table describes attributes that typically belong to objects of this │ │ │ │ class. PRAW dynamically provides the attributes that Reddit returns via │ │ │ │ the API. Since those attributes are subject to change on Reddit’s end, │ │ │ │ PRAW makes no effort to document any new/removed/changed attributes, │ │ │ │ @@ -215,24 +215,24 @@ │ │ │ │ stickied Whether or not the submission is stickied. │ │ │ │ subreddit Provides an instance of _S_u_b_r_e_d_d_i_t. │ │ │ │ title The title of the submission. │ │ │ │ upvote_ratio The percentage of upvotes from all votes on the │ │ │ │ submission. │ │ │ │ url The URL the submission links to, or the permalink │ │ │ │ if a selfpost. │ │ │ │ - __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, iidd:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, uurrll:: _OO_pp_tt_ii_oo_nn_aa_ll │ │ │ │ - [[_ss_tt_rr]] == NNoonnee, __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]]]] == NNoonnee)_# │ │ │ │ + __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, iidd:: OOppttiioonnaall[[ssttrr]] == NNoonnee, uurrll:: OOppttiioonnaall │ │ │ │ + [[ssttrr]] == NNoonnee, __ddaattaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, AAnnyy]]]] == NNoonnee)_# │ │ │ │ Initialize a _S_u_b_m_i_s_s_i_o_n instance. │ │ │ │ Parameters: │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ * iidd – A reddit base36 submission ID, e.g., "2gmzqe". │ │ │ │ * uurrll – A URL supported by _i_d___f_r_o_m___u_r_l_(_). │ │ │ │ Either id or url can be provided, but not both. │ │ │ │ - _edit_experimental(bbooddyy:: _ss_tt_rr, **, pprreesseerrvvee__iinnlliinnee__mmeeddiiaa==FFaallssee, │ │ │ │ - iinnlliinnee__mmeeddiiaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._II_nn_ll_ii_nn_ee_MM_ee_dd_ii_aa]]]] == NNoonnee) → │ │ │ │ + _edit_experimental(bbooddyy:: ssttrr, **, pprreesseerrvvee__iinnlliinnee__mmeeddiiaa==FFaallssee, │ │ │ │ + iinnlliinnee__mmeeddiiaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._II_nn_ll_ii_nn_ee_MM_ee_dd_ii_aa]]]] == NNoonnee) → │ │ │ │ _p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n_# │ │ │ │ Replace the body of the object with body. │ │ │ │ Returns: │ │ │ │ The current instance after updating its attributes. │ │ │ │ Example usage: │ │ │ │ from praw.models import InlineGif, InlineImage, InlineVideo │ │ │ │ │ │ │ │ @@ -254,16 +254,16 @@ │ │ │ │ * kkeeyy – The key of the fetch parameter. │ │ │ │ * vvaalluuee – The value of the fetch parameter. │ │ │ │ For example, to fetch a submission with the rtjson attribute │ │ │ │ populated: │ │ │ │ submission = reddit.submission("mcqjl8") │ │ │ │ submission.add_fetch_param("rtj", "all") │ │ │ │ print(submission.rtjson) │ │ │ │ - award(**, ggiilldd__ttyyppee:: _ss_tt_rr == ''ggiidd__22'', iiss__aannoonnyymmoouuss:: _bb_oo_oo_ll == TTrruuee, mmeessssaaggee:: │ │ │ │ - _ss_tt_rr == NNoonnee) → _d_i_c_t_# │ │ │ │ + award(**, ggiilldd__ttyyppee:: ssttrr == ''ggiidd__22'', iiss__aannoonnyymmoouuss:: bbooooll == TTrruuee, mmeessssaaggee:: │ │ │ │ + ssttrr == NNoonnee) → dict_# │ │ │ │ Award the author of the item. │ │ │ │ Warning │ │ │ │ Requires the authenticated user to own Reddit Coins. Calling this │ │ │ │ method will consume Reddit Coins. │ │ │ │ To award the gold award anonymously do: │ │ │ │ comment = reddit.comment("dkk4qjd") │ │ │ │ comment.award() │ │ │ │ @@ -304,17 +304,17 @@ │ │ │ │ submission.comment_sort = "new" │ │ │ │ comments = submission.comments.list() │ │ │ │ Note │ │ │ │ The appropriate values for "comment_sort" include "confidence", │ │ │ │ "controversial", "new", "old", "q&a", and "top" │ │ │ │ See _E_x_t_r_a_c_t_i_n_g_ _c_o_m_m_e_n_t_s_ _w_i_t_h_ _P_R_A_W for more on working with a │ │ │ │ _C_o_m_m_e_n_t_F_o_r_e_s_t. │ │ │ │ - crosspost(ssuubbrreeddddiitt:: _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt, **, ffllaaiirr__iidd:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] │ │ │ │ - == NNoonnee, ffllaaiirr__tteexxtt:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, nnssffww:: _bb_oo_oo_ll == FFaallssee, │ │ │ │ - sseenndd__rreepplliieess:: _bb_oo_oo_ll == TTrruuee, ssppooiilleerr:: _bb_oo_oo_ll == FFaallssee, ttiittllee:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] │ │ │ │ + crosspost(ssuubbrreeddddiitt:: _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt, **, ffllaaiirr__iidd:: OOppttiioonnaall[[ssttrr]] │ │ │ │ + == NNoonnee, ffllaaiirr__tteexxtt:: OOppttiioonnaall[[ssttrr]] == NNoonnee, nnssffww:: bbooooll == FFaallssee, │ │ │ │ + sseenndd__rreepplliieess:: bbooooll == TTrruuee, ssppooiilleerr:: bbooooll == FFaallssee, ttiittllee:: OOppttiioonnaall[[ssttrr]] │ │ │ │ == NNoonnee) → _p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n_# │ │ │ │ Crosspost the submission to a subreddit. │ │ │ │ Note │ │ │ │ Be aware you have to be subscribed to the target subreddit. │ │ │ │ Parameters: │ │ │ │ * ssuubbrreeddddiitt – Name of the subreddit or _S_u_b_r_e_d_d_i_t object │ │ │ │ to crosspost into. │ │ │ │ @@ -369,28 +369,28 @@ │ │ │ │ submission = reddit.submission("5or86n") │ │ │ │ submission.downvote() │ │ │ │ │ │ │ │ comment = reddit.comment("dxolpyc") │ │ │ │ comment.downvote() │ │ │ │ See also │ │ │ │ _u_p_v_o_t_e_(_) │ │ │ │ - duplicates(****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → │ │ │ │ - _I_t_e_r_a_t_o_r[_p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]_# │ │ │ │ + duplicates(****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → │ │ │ │ + Iterator[_p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for the submission’s duplicates. │ │ │ │ Additional keyword arguments are passed in the initialization of │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r. │ │ │ │ Example usage: │ │ │ │ submission = reddit.submission("5or86n") │ │ │ │ │ │ │ │ for duplicate in submission.duplicates(): │ │ │ │ # process each duplicate │ │ │ │ ... │ │ │ │ See also │ │ │ │ _u_p_v_o_t_e_(_) │ │ │ │ - edit(bbooddyy:: _ss_tt_rr) → _U_n_i_o_n[_p_r_a_w_._m_o_d_e_l_s_._C_o_m_m_e_n_t, _p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]_# │ │ │ │ + edit(bbooddyy:: ssttrr) → Union[_p_r_a_w_._m_o_d_e_l_s_._C_o_m_m_e_n_t, _p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]_# │ │ │ │ Replace the body of the object with body. │ │ │ │ Parameters: │ │ │ │ bbooddyy – The Markdown formatted content for the updated object. │ │ │ │ Returns: │ │ │ │ The current instance after updating its attributes. │ │ │ │ Example usage: │ │ │ │ comment = reddit.comment("dkk4qjd") │ │ │ │ @@ -416,53 +416,53 @@ │ │ │ │ _f_l_a_i_r_(_). │ │ │ │ For example, to select an arbitrary editable flair text (assuming │ │ │ │ there is one) and set a custom value try: │ │ │ │ choices = submission.flair.choices() │ │ │ │ template_id = next(x for x in choices if x["flair_text_editable"]) │ │ │ │ ["flair_template_id"] │ │ │ │ submission.flair.select(template_id, text="my custom value") │ │ │ │ - pprrooppeerrttyy fullname:: _ss_tt_rr_# │ │ │ │ + pprrooppeerrttyy fullname:: ssttrr_# │ │ │ │ Return the object’s fullname. │ │ │ │ A fullname is an object’s kind mapping like t3 followed by an │ │ │ │ underscore and the object’s base36 ID, e.g., t1_c5s96e0. │ │ │ │ - gild() → _d_i_c_t_# │ │ │ │ + gild() → dict_# │ │ │ │ Alias for _a_w_a_r_d_(_) to maintain backwards compatibility. │ │ │ │ - hide(**, ootthheerr__ssuubbmmiissssiioonnss:: _OO_pp_tt_ii_oo_nn_aa_ll[[_LL_ii_ss_tt[[_pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_mm_ii_ss_ss_ii_oo_nn]]]] == │ │ │ │ + hide(**, ootthheerr__ssuubbmmiissssiioonnss:: OOppttiioonnaall[[LLiisstt[[_pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_mm_ii_ss_ss_ii_oo_nn]]]] == │ │ │ │ NNoonnee)_# │ │ │ │ Hide _S_u_b_m_i_s_s_i_o_n. │ │ │ │ Parameters: │ │ │ │ ootthheerr__ssuubbmmiissssiioonnss – When provided, additionally hide this │ │ │ │ list of _S_u_b_m_i_s_s_i_o_n instances as part of a single request │ │ │ │ (default: None). │ │ │ │ Example usage: │ │ │ │ submission = reddit.submission("5or86n") │ │ │ │ submission.hide() │ │ │ │ See also │ │ │ │ _u_n_h_i_d_e_(_) │ │ │ │ - ssttaattiicc id_from_url(uurrll:: _ss_tt_rr) → _s_t_r_# │ │ │ │ + ssttaattiicc id_from_url(uurrll:: ssttrr) → str_# │ │ │ │ Return the ID contained within a submission URL. │ │ │ │ Raises: │ │ │ │ _I_n_v_a_l_i_d_U_R_L if url is not a valid submission URL. │ │ │ │ mark_visited()_# │ │ │ │ Mark submission as visited. │ │ │ │ This method requires a subscription to reddit premium. │ │ │ │ Example usage: │ │ │ │ submission = reddit.submission("5or86n") │ │ │ │ submission.mark_visited() │ │ │ │ mod() → _S_u_b_m_i_s_s_i_o_n_M_o_d_e_r_a_t_i_o_n_# │ │ │ │ Provide an instance of _S_u_b_m_i_s_s_i_o_n_M_o_d_e_r_a_t_i_o_n. │ │ │ │ Example usage: │ │ │ │ submission = reddit.submission("8dmv8z") │ │ │ │ submission.mod.approve() │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ - reply(bbooddyy:: _ss_tt_rr) → _O_p_t_i_o_n_a_l[_U_n_i_o_n[_p_r_a_w_._m_o_d_e_l_s_._C_o_m_m_e_n_t, │ │ │ │ + reply(bbooddyy:: ssttrr) → Optional[Union[_p_r_a_w_._m_o_d_e_l_s_._C_o_m_m_e_n_t, │ │ │ │ _p_r_a_w_._m_o_d_e_l_s_._M_e_s_s_a_g_e]]_# │ │ │ │ Reply to the object. │ │ │ │ Parameters: │ │ │ │ bbooddyy – The Markdown formatted content for a comment. │ │ │ │ Returns: │ │ │ │ A _C_o_m_m_e_n_t or _M_e_s_s_a_g_e object for the newly created comment or │ │ │ │ message or None if Reddit doesn’t provide one. │ │ │ │ @@ -477,46 +477,46 @@ │ │ │ │ by drawing the comment from the user’s comment history. │ │ │ │ Example usage: │ │ │ │ submission = reddit.submission("5or86n") │ │ │ │ submission.reply("reply") │ │ │ │ │ │ │ │ comment = reddit.comment("dxolpyc") │ │ │ │ comment.reply("reply") │ │ │ │ - report(rreeaassoonn:: _ss_tt_rr)_# │ │ │ │ + report(rreeaassoonn:: ssttrr)_# │ │ │ │ Report this object to the moderators of its subreddit. │ │ │ │ Parameters: │ │ │ │ rreeaassoonn – The reason for reporting. │ │ │ │ Raises: │ │ │ │ _R_e_d_d_i_t_A_P_I_E_x_c_e_p_t_i_o_n if reason is longer than 100 characters. │ │ │ │ Example usage: │ │ │ │ submission = reddit.submission("5or86n") │ │ │ │ submission.report("report reason") │ │ │ │ │ │ │ │ comment = reddit.comment("dxolpyc") │ │ │ │ comment.report("report reason") │ │ │ │ - save(**, ccaatteeggoorryy:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee)_# │ │ │ │ + save(**, ccaatteeggoorryy:: OOppttiioonnaall[[ssttrr]] == NNoonnee)_# │ │ │ │ Save the object. │ │ │ │ Parameters: │ │ │ │ ccaatteeggoorryy – The category to save to. If the authenticated user │ │ │ │ does not have Reddit Premium this value is ignored by Reddit │ │ │ │ (default: None). │ │ │ │ Example usage: │ │ │ │ submission = reddit.submission("5or86n") │ │ │ │ submission.save(category="view later") │ │ │ │ │ │ │ │ comment = reddit.comment("dxolpyc") │ │ │ │ comment.save() │ │ │ │ See also │ │ │ │ _u_n_s_a_v_e_(_) │ │ │ │ - pprrooppeerrttyy shortlink:: _ss_tt_rr_# │ │ │ │ + pprrooppeerrttyy shortlink:: ssttrr_# │ │ │ │ Return a shortlink to the submission. │ │ │ │ For example, _h_t_t_p_s_:_/_/_r_e_d_d_._i_t_/_e_o_r_h_m is a shortlink for _h_t_t_p_s_:_/_/ │ │ │ │ _w_w_w_._r_e_d_d_i_t_._c_o_m_/_r_/_a_n_n_o_u_n_c_e_m_e_n_t_s_/_c_o_m_m_e_n_t_s_/_e_o_r_h_m_/ │ │ │ │ _r_e_d_d_i_t___3_0___l_e_s_s___t_y_p_i_n_g_/. │ │ │ │ - unhide(**, ootthheerr__ssuubbmmiissssiioonnss:: _OO_pp_tt_ii_oo_nn_aa_ll[[_LL_ii_ss_tt[[_pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_mm_ii_ss_ss_ii_oo_nn]]]] == │ │ │ │ + unhide(**, ootthheerr__ssuubbmmiissssiioonnss:: OOppttiioonnaall[[LLiisstt[[_pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_mm_ii_ss_ss_ii_oo_nn]]]] == │ │ │ │ NNoonnee)_# │ │ │ │ Unhide _S_u_b_m_i_s_s_i_o_n. │ │ │ │ Parameters: │ │ │ │ ootthheerr__ssuubbmmiissssiioonnss – When provided, additionally unhide this │ │ │ │ list of _S_u_b_m_i_s_s_i_o_n instances as part of a single request │ │ │ │ (default: None). │ │ │ │ Example usage: │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/models/subreddit.html │ │ │ @@ -355,15 +355,15 @@ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │

    Subreddit#

    │ │ │
    │ │ │
    │ │ │ -class praw.models.Subreddit(reddit: praw.Reddit, display_name: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)#
    │ │ │ +class praw.models.Subreddit(reddit: praw.Reddit, display_name: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)# │ │ │

    A class for Subreddits.

    │ │ │

    To obtain an instance of this class for r/test execute:

    │ │ │ 
    subreddit = reddit.subreddit("test")
│ │ │
    │ │ │
    │ │ │

    While r/all is not a real subreddit, it can still be treated like one. The following │ │ │ outputs the titles of the 25 hottest submissions in r/all:

    │ │ │ @@ -461,15 +461,15 @@ │ │ │

    Note

    │ │ │

    Trying to retrieve attributes of quarantined or private subreddits will result │ │ │ in a 403 error. Trying to retrieve attributes of a banned subreddit will result │ │ │ in a 404 error.

    │ │ │ │ │ │
    │ │ │
    │ │ │ -__init__(reddit: praw.Reddit, display_name: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)#
    │ │ │ +__init__(reddit: praw.Reddit, display_name: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)# │ │ │

    Initialize a Subreddit instance.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │

    • reddit – An instance of Reddit.

      • │ │ │

    • display_name – The name of the subreddit.

      • │ │ │
    │ │ │ @@ -538,23 +538,23 @@ │ │ │ 
    reddit.subreddit("test").contributor.add("spez")
│ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -controversial(*, time_filter: str = 'all', **generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]#
    │ │ │ +controversial(*, time_filter: str = 'all', **generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]# │ │ │

    Return a ListingGenerator for controversial items.

    │ │ │
    │ │ │
    Parameters:
    │ │ │

    time_filter – Can be one of: "all", "day", "hour", │ │ │ "month", "week", or "year" (default: "all").

    │ │ │
    │ │ │
    Raises:
    │ │ │ -

    ValueError if time_filter is invalid.

    │ │ │ +

    ValueError if time_filter is invalid.

    │ │ │
    │ │ │
    │ │ │

    Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

    │ │ │

    This method can be used like:

    │ │ │ 
    reddit.domain("imgur.com").controversial(time_filter="week")
│ │ │  reddit.multireddit(redditor="samuraisam", name="programming").controversial(
│ │ │ @@ -614,36 +614,36 @@
│ │ │      print(template)
│ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -property fullname: str#
    │ │ │ +property fullname: str# │ │ │

    Return the object’s fullname.

    │ │ │

    A fullname is an object’s kind mapping like t3 followed by an underscore and │ │ │ the object’s base36 ID, e.g., t1_c5s96e0.

    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -gilded(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]#
    │ │ │ +gilded(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]# │ │ │

    Return a ListingGenerator for gilded items.

    │ │ │

    Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

    │ │ │

    For example, to get gilded items in r/test:

    │ │ │ 
    for item in reddit.subreddit("test").gilded():
│ │ │      print(item.id)
│ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -hot(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]#
    │ │ │ +hot(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]# │ │ │

    Return a ListingGenerator for hot items.

    │ │ │

    Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

    │ │ │

    This method can be used like:

    │ │ │ 
    reddit.domain("imgur.com").hot()
│ │ │  reddit.multireddit(redditor="samuraisam", name="programming").hot()
│ │ │  reddit.redditor("spez").hot()
│ │ │ @@ -652,15 +652,15 @@
│ │ │  reddit.subreddit("all").hot()
│ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -message(*, from_subreddit: Optional[Union[praw.models.Subreddit, str]] = None, message: str, subject: str)#
    │ │ │ +message(*, from_subreddit: Optional[Union[praw.models.Subreddit, str]] = None, message: str, subject: str)# │ │ │

    Send a message to a Redditor or a Subreddit’s moderators (modmail).

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │

    • from_subreddit –

      A Subreddit instance or string to send the │ │ │ message from. When provided, messages are sent from the subreddit rather │ │ │ than from the authenticated user.

      │ │ │ @@ -736,15 +736,15 @@ │ │ │ print(f"{mute}: {mute.date}") │ │ │ │ │ │ │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -new(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]#
    │ │ │ +new(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]# │ │ │

    Return a ListingGenerator for new items.

    │ │ │

    Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

    │ │ │

    This method can be used like:

    │ │ │ 
    reddit.domain("imgur.com").new()
│ │ │  reddit.multireddit(redditor="samuraisam", name="programming").new()
│ │ │  reddit.redditor("spez").new()
│ │ │ @@ -753,29 +753,29 @@
│ │ │  reddit.subreddit("all").new()
│ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
    │ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

    Return an instance of cls from data.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │

    • data – The structured data.

      • │ │ │

    • reddit – An instance of Reddit.

      • │ │ │
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -post_requirements() → Dict[str, Union[str, int, bool]]#
    │ │ │ +post_requirements() → Dict[str, Union[str, int, bool]]# │ │ │

    Get the post requirements for a subreddit.

    │ │ │
    │ │ │
    Returns:
    │ │ │

    A dict with the various requirements.

    │ │ │
    │ │ │
    │ │ │

    The returned dict contains the following keys:

    │ │ │ @@ -816,41 +816,41 @@ │ │ │ 
    reddit.subreddit("test").quaran.opt_in()
│ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -random() → Optional[praw.models.Submission]#
    │ │ │ +random() → Optional[praw.models.Submission]# │ │ │

    Return a random Submission.

    │ │ │

    Returns None on subreddits that do not support the random feature. One │ │ │ example, at the time of writing, is r/wallpapers.

    │ │ │

    For example, to get a random submission off of r/AskReddit:

    │ │ │ 
    submission = reddit.subreddit("AskReddit").random()
│ │ │  print(submission.title)
│ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -random_rising(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[praw.models.Submission]#
    │ │ │ +random_rising(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[praw.models.Submission]# │ │ │

    Return a ListingGenerator for random rising submissions.

    │ │ │

    Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

    │ │ │

    For example, to get random rising submissions for r/test:

    │ │ │ 
    for submission in reddit.subreddit("test").random_rising():
│ │ │      print(submission.title)
│ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -rising(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[praw.models.Submission]#
    │ │ │ +rising(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[praw.models.Submission]# │ │ │

    Return a ListingGenerator for rising submissions.

    │ │ │

    Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

    │ │ │

    For example, to get rising submissions for r/test:

    │ │ │ 
    for submission in reddit.subreddit("test").rising():
│ │ │      print(submission.title)
│ │ │
    │ │ │ @@ -874,15 +874,15 @@ │ │ │ ) │ │ │
    │ │ │ │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -search(query: str, *, sort: str = 'relevance', syntax: str = 'lucene', time_filter: str = 'all', **generator_kwargs: Any) → Iterator[praw.models.Submission]#
    │ │ │ +search(query: str, *, sort: str = 'relevance', syntax: str = 'lucene', time_filter: str = 'all', **generator_kwargs: Any) → Iterator[praw.models.Submission]# │ │ │

    Return a ListingGenerator for items that match query.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │

    • query – The query string to search for.

      • │ │ │

    • sort – Can be one of: "relevance", "hot", "top", "new", or │ │ │ "comments". (default: "relevance").

      • │ │ │ @@ -900,15 +900,15 @@ │ │ │ print(submission.title) │ │ │ │ │ │ │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -sticky(*, number: int = 1) → praw.models.Submission#
    │ │ │ +sticky(*, number: int = 1) → praw.models.Submission# │ │ │

    Return a Submission object for a sticky of the subreddit.

    │ │ │
    │ │ │
    Parameters:
    │ │ │

    number – Specify which sticky to return. 1 appears at the top (default: │ │ │ 1).

    │ │ │
    │ │ │
    Raises:
    │ │ │ @@ -951,15 +951,15 @@ │ │ │ subreddit.stylesheet.update(stylesheet.stylesheet) │ │ │ │ │ │ │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -submit(title: str, *, collection_id: Optional[str] = None, discussion_type: Optional[str] = None, draft_id: Optional[str] = None, flair_id: Optional[str] = None, flair_text: Optional[str] = None, inline_media: Optional[Dict[str, praw.models.InlineMedia]] = None, nsfw: bool = False, resubmit: bool = True, selftext: Optional[str] = None, send_replies: bool = True, spoiler: bool = False, url: Optional[str] = None) → praw.models.Submission#
    │ │ │ +submit(title: str, *, collection_id: Optional[str] = None, discussion_type: Optional[str] = None, draft_id: Optional[str] = None, flair_id: Optional[str] = None, flair_text: Optional[str] = None, inline_media: Optional[Dict[str, praw.models.InlineMedia]] = None, nsfw: bool = False, resubmit: bool = True, selftext: Optional[str] = None, send_replies: bool = True, spoiler: bool = False, url: Optional[str] = None) → praw.models.Submission# │ │ │

    Add a submission to the Subreddit.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │

    • title – The title of the submission.

      • │ │ │

    • collection_id – The UUID of a Collection to add the │ │ │ newly-submitted post to.

      • │ │ │ @@ -1047,15 +1047,15 @@ │ │ │

    • submit_video() to submit videos and videogifs

      • │ │ │
    │ │ │ │ │ │
    │ │ │ │ │ │
    │ │ │ │ │ │ +submit_gallery(title: str, images: List[Dict[str, str]], *, collection_id: Optional[str] = None, discussion_type: Optional[str] = None, flair_id: Optional[str] = None, flair_text: Optional[str] = None, nsfw: bool = False, send_replies: bool = True, spoiler: bool = False)# │ │ │

    Add an image gallery submission to the subreddit.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │

    • title – The title of the submission.

      • │ │ │

    • images – The images to post in dict with the following structure: │ │ │ {"image_path": "path", "caption": "caption", "outbound_url": "url"}, │ │ │ @@ -1112,15 +1112,15 @@ │ │ │

    • submit_video() to submit videos and videogifs

      • │ │ │
    │ │ │ │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -submit_image(title: str, image_path: str, *, collection_id: Optional[str] = None, discussion_type: Optional[str] = None, flair_id: Optional[str] = None, flair_text: Optional[str] = None, nsfw: bool = False, resubmit: bool = True, send_replies: bool = True, spoiler: bool = False, timeout: int = 10, without_websockets: bool = False)#
    │ │ │ +submit_image(title: str, image_path: str, *, collection_id: Optional[str] = None, discussion_type: Optional[str] = None, flair_id: Optional[str] = None, flair_text: Optional[str] = None, nsfw: bool = False, resubmit: bool = True, send_replies: bool = True, spoiler: bool = False, timeout: int = 10, without_websockets: bool = False)# │ │ │

    Add an image submission to the subreddit.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │

    • collection_id – The UUID of a Collection to add the │ │ │ newly-submitted post to.

      • │ │ │

    • discussion_type – Set to "CHAT" to enable live discussion instead of │ │ │ @@ -1182,15 +1182,15 @@ │ │ │

    • submit_video() to submit videos and videogifs

      • │ │ │
    │ │ │ │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -submit_poll(title: str, *, collection_id: Optional[str] = None, discussion_type: Optional[str] = None, duration: int, flair_id: Optional[str] = None, flair_text: Optional[str] = None, nsfw: bool = False, options: List[str], resubmit: bool = True, selftext: str, send_replies: bool = True, spoiler: bool = False)#
    │ │ │ +submit_poll(title: str, *, collection_id: Optional[str] = None, discussion_type: Optional[str] = None, duration: int, flair_id: Optional[str] = None, flair_text: Optional[str] = None, nsfw: bool = False, options: List[str], resubmit: bool = True, selftext: str, send_replies: bool = True, spoiler: bool = False)# │ │ │

    Add a poll submission to the subreddit.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │

    • title – The title of the submission.

      • │ │ │

    • collection_id – The UUID of a Collection to add the │ │ │ newly-submitted post to.

      • │ │ │ @@ -1235,15 +1235,15 @@ │ │ │

    • submit_video() to submit videos and videogifs

      • │ │ │
    │ │ │ │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -submit_video(title: str, video_path: str, *, collection_id: Optional[str] = None, discussion_type: Optional[str] = None, flair_id: Optional[str] = None, flair_text: Optional[str] = None, nsfw: bool = False, resubmit: bool = True, send_replies: bool = True, spoiler: bool = False, thumbnail_path: Optional[str] = None, timeout: int = 10, videogif: bool = False, without_websockets: bool = False)#
    │ │ │ +submit_video(title: str, video_path: str, *, collection_id: Optional[str] = None, discussion_type: Optional[str] = None, flair_id: Optional[str] = None, flair_text: Optional[str] = None, nsfw: bool = False, resubmit: bool = True, send_replies: bool = True, spoiler: bool = False, thumbnail_path: Optional[str] = None, timeout: int = 10, videogif: bool = False, without_websockets: bool = False)# │ │ │

    Add a video or videogif submission to the subreddit.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │

    • title – The title of the submission.

      • │ │ │

    • video_path – The path to a video, to upload and post.

      • │ │ │

    • collection_id – The UUID of a Collection to add the │ │ │ @@ -1310,15 +1310,15 @@ │ │ │

    • submit_poll() to submit polls

      • │ │ │
    │ │ │ │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -subscribe(*, other_subreddits: Optional[List[praw.models.Subreddit]] = None)#
    │ │ │ +subscribe(*, other_subreddits: Optional[List[praw.models.Subreddit]] = None)# │ │ │

    Subscribe to the subreddit.

    │ │ │
    │ │ │
    Parameters:
    │ │ │

    other_subreddits – When provided, also subscribe to the provided list of │ │ │ subreddits.

    │ │ │
    │ │ │
    │ │ │ @@ -1326,23 +1326,23 @@ │ │ │ 
    reddit.subreddit("test").subscribe()
│ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -top(*, time_filter: str = 'all', **generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]#
    │ │ │ +top(*, time_filter: str = 'all', **generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]# │ │ │

    Return a ListingGenerator for top items.

    │ │ │
    │ │ │
    Parameters:
    │ │ │

    time_filter – Can be one of: "all", "day", "hour", │ │ │ "month", "week", or "year" (default: "all").

    │ │ │
    │ │ │
    Raises:
    │ │ │ -

    ValueError if time_filter is invalid.

    │ │ │ +

    ValueError if time_filter is invalid.

    │ │ │
    │ │ │
    │ │ │

    Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

    │ │ │

    This method can be used like:

    │ │ │ 
    reddit.domain("imgur.com").top(time_filter="week")
│ │ │  reddit.multireddit(redditor="samuraisam", name="programming").top(time_filter="day")
│ │ │ @@ -1352,15 +1352,15 @@
│ │ │  reddit.subreddit("all").top(time_filter="hour")
│ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -traffic() → Dict[str, List[List[int]]]#
    │ │ │ +traffic() → Dict[str, List[List[int]]]# │ │ │

    Return a dictionary of the Subreddit’s traffic statistics.

    │ │ │
    │ │ │
    Raises:
    │ │ │

    prawcore.NotFound when the traffic stats aren’t available to the │ │ │ authenticated user, that is, they are not public and the authenticated user │ │ │ is not a moderator of the subreddit.

    │ │ │
    │ │ │ @@ -1380,15 +1380,15 @@ │ │ │ 
    stats = reddit.subreddit("test").traffic()
│ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -unsubscribe(*, other_subreddits: Optional[List[praw.models.Subreddit]] = None)#
    │ │ │ +unsubscribe(*, other_subreddits: Optional[List[praw.models.Subreddit]] = None)# │ │ │

    Unsubscribe from the subreddit.

    │ │ │
    │ │ │
    Parameters:
    │ │ │

    other_subreddits – When provided, also unsubscribe from the provided list │ │ │ of subreddits.

    │ │ │
    │ │ │
    │ │ │ ├── html2text {} │ │ │ │ @@ -161,16 +161,16 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ SSuubbrreeddddiitt_## ************ │ │ │ │ - ccllaassss praw.models.Subreddit(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, ddiissppllaayy__nnaammee:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] │ │ │ │ - == NNoonnee, __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]]]] == NNoonnee)_# │ │ │ │ + ccllaassss praw.models.Subreddit(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, ddiissppllaayy__nnaammee:: OOppttiioonnaall[[ssttrr]] │ │ │ │ + == NNoonnee, __ddaattaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, AAnnyy]]]] == NNoonnee)_# │ │ │ │ A class for Subreddits. │ │ │ │ To obtain an instance of this class for r/test execute: │ │ │ │ subreddit = reddit.subreddit("test") │ │ │ │ While r/all is not a real subreddit, it can still be treated like one. │ │ │ │ The following outputs the titles of the 25 hottest submissions in r/all: │ │ │ │ for submission in reddit.subreddit("all").hot(limit=25): │ │ │ │ print(submission.title) │ │ │ │ @@ -214,16 +214,16 @@ │ │ │ │ user_is_banned Whether the authenticated user is banned. │ │ │ │ user_is_moderator Whether the authenticated user is a moderator. │ │ │ │ user_is_subscriber Whether the authenticated user is subscribed. │ │ │ │ Note │ │ │ │ Trying to retrieve attributes of quarantined or private subreddits will │ │ │ │ result in a 403 error. Trying to retrieve attributes of a banned │ │ │ │ subreddit will result in a 404 error. │ │ │ │ - __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, ddiissppllaayy__nnaammee:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, │ │ │ │ - __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]]]] == NNoonnee)_# │ │ │ │ + __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, ddiissppllaayy__nnaammee:: OOppttiioonnaall[[ssttrr]] == NNoonnee, │ │ │ │ + __ddaattaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, AAnnyy]]]] == NNoonnee)_# │ │ │ │ Initialize a _S_u_b_r_e_d_d_i_t instance. │ │ │ │ Parameters: │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ * ddiissppllaayy__nnaammee – The name of the subreddit. │ │ │ │ Note │ │ │ │ This class should not be initialized directly. Instead, obtain an │ │ │ │ instance via: reddit.subreddit("test") │ │ │ │ @@ -253,22 +253,22 @@ │ │ │ │ for comment in reddit.subreddit("test").comments(limit=25): │ │ │ │ print(comment.author) │ │ │ │ contributor() → _p_r_a_w_._m_o_d_e_l_s_._r_e_d_d_i_t_._s_u_b_r_e_d_d_i_t_._C_o_n_t_r_i_b_u_t_o_r_R_e_l_a_t_i_o_n_s_h_i_p_# │ │ │ │ Provide an instance of _C_o_n_t_r_i_b_u_t_o_r_R_e_l_a_t_i_o_n_s_h_i_p. │ │ │ │ Contributors are also known as approved submitters. │ │ │ │ To add a contributor try: │ │ │ │ reddit.subreddit("test").contributor.add("spez") │ │ │ │ - controversial(**, ttiimmee__ffiilltteerr:: _ss_tt_rr == ''aallll'', ****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn │ │ │ │ - [[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → _I_t_e_r_a_t_o_r[_A_n_y]_# │ │ │ │ + controversial(**, ttiimmee__ffiilltteerr:: ssttrr == ''aallll'', ****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn │ │ │ │ + [[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → Iterator[Any]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for controversial items. │ │ │ │ Parameters: │ │ │ │ ttiimmee__ffiilltteerr – Can be one of: "all", "day", "hour", "month", │ │ │ │ "week", or "year" (default: "all"). │ │ │ │ Raises: │ │ │ │ - _V_a_l_u_e_E_r_r_o_r if time_filter is invalid. │ │ │ │ + ValueError if time_filter is invalid. │ │ │ │ Additional keyword arguments are passed in the initialization of │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r. │ │ │ │ This method can be used like: │ │ │ │ reddit.domain("imgur.com").controversial(time_filter="week") │ │ │ │ reddit.multireddit(redditor="samuraisam", │ │ │ │ name="programming").controversial( │ │ │ │ time_filter="day" │ │ │ │ @@ -298,40 +298,40 @@ │ │ │ │ example, to list all the flair for a subreddit which you have the │ │ │ │ flair moderator permission on try: │ │ │ │ for flair in reddit.subreddit("test").flair(): │ │ │ │ print(flair) │ │ │ │ Flair templates can be interacted with through this attribute via: │ │ │ │ for template in reddit.subreddit("test").flair.templates: │ │ │ │ print(template) │ │ │ │ - pprrooppeerrttyy fullname:: _ss_tt_rr_# │ │ │ │ + pprrooppeerrttyy fullname:: ssttrr_# │ │ │ │ Return the object’s fullname. │ │ │ │ A fullname is an object’s kind mapping like t3 followed by an │ │ │ │ underscore and the object’s base36 ID, e.g., t1_c5s96e0. │ │ │ │ - gilded(****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → _I_t_e_r_a_t_o_r │ │ │ │ - [_A_n_y]_# │ │ │ │ + gilded(****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → Iterator │ │ │ │ + [Any]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for gilded items. │ │ │ │ Additional keyword arguments are passed in the initialization of │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r. │ │ │ │ For example, to get gilded items in r/test: │ │ │ │ for item in reddit.subreddit("test").gilded(): │ │ │ │ print(item.id) │ │ │ │ - hot(****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → _I_t_e_r_a_t_o_r │ │ │ │ - [_A_n_y]_# │ │ │ │ + hot(****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → Iterator │ │ │ │ + [Any]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for hot items. │ │ │ │ Additional keyword arguments are passed in the initialization of │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r. │ │ │ │ This method can be used like: │ │ │ │ reddit.domain("imgur.com").hot() │ │ │ │ reddit.multireddit(redditor="samuraisam", name="programming").hot() │ │ │ │ reddit.redditor("spez").hot() │ │ │ │ reddit.redditor("spez").comments.hot() │ │ │ │ reddit.redditor("spez").submissions.hot() │ │ │ │ reddit.subreddit("all").hot() │ │ │ │ - message(**, ffrroomm__ssuubbrreeddddiitt:: _OO_pp_tt_ii_oo_nn_aa_ll[[_UU_nn_ii_oo_nn[[_pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt,, _ss_tt_rr]]]] │ │ │ │ - == NNoonnee, mmeessssaaggee:: _ss_tt_rr, ssuubbjjeecctt:: _ss_tt_rr)_# │ │ │ │ + message(**, ffrroomm__ssuubbrreeddddiitt:: OOppttiioonnaall[[UUnniioonn[[_pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt,, ssttrr]]]] │ │ │ │ + == NNoonnee, mmeessssaaggee:: ssttrr, ssuubbjjeecctt:: ssttrr)_# │ │ │ │ Send a message to a _R_e_d_d_i_t_o_r or a _S_u_b_r_e_d_d_i_t’s moderators (modmail). │ │ │ │ For example, to send a private message to u/spez, try: │ │ │ │ reddit.redditor("spez").message(subject="TEST", message="test │ │ │ │ message from PRAW") │ │ │ │ To send a message to u/spez from the moderators of r/test try: │ │ │ │ reddit.redditor("spez").message( │ │ │ │ subject="TEST", message="test message from r/test", │ │ │ │ @@ -358,32 +358,32 @@ │ │ │ │ reddit.subreddit("test").modmail.create(subject="test", │ │ │ │ body="hello", recipient="spez") │ │ │ │ muted() → _p_r_a_w_._m_o_d_e_l_s_._r_e_d_d_i_t_._s_u_b_r_e_d_d_i_t_._S_u_b_r_e_d_d_i_t_R_e_l_a_t_i_o_n_s_h_i_p_# │ │ │ │ Provide an instance of _S_u_b_r_e_d_d_i_t_R_e_l_a_t_i_o_n_s_h_i_p. │ │ │ │ For example, muted users can be iterated through like so: │ │ │ │ for mute in reddit.subreddit("test").muted(): │ │ │ │ print(f"{mute}: {mute.date}") │ │ │ │ - new(****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → _I_t_e_r_a_t_o_r │ │ │ │ - [_A_n_y]_# │ │ │ │ + new(****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → Iterator │ │ │ │ + [Any]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for new items. │ │ │ │ Additional keyword arguments are passed in the initialization of │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r. │ │ │ │ This method can be used like: │ │ │ │ reddit.domain("imgur.com").new() │ │ │ │ reddit.multireddit(redditor="samuraisam", name="programming").new() │ │ │ │ reddit.redditor("spez").new() │ │ │ │ reddit.redditor("spez").comments.new() │ │ │ │ reddit.redditor("spez").submissions.new() │ │ │ │ reddit.subreddit("all").new() │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ - post_requirements() → _D_i_c_t[_s_t_r, _U_n_i_o_n[_s_t_r, _i_n_t, _b_o_o_l]]_# │ │ │ │ + post_requirements() → Dict[str, Union[str, int, bool]]_# │ │ │ │ Get the post requirements for a subreddit. │ │ │ │ Returns: │ │ │ │ A dict with the various requirements. │ │ │ │ The returned dict contains the following keys: │ │ │ │ * domain_blacklist │ │ │ │ * body_restriction_policy │ │ │ │ * domain_whitelist │ │ │ │ @@ -407,30 +407,30 @@ │ │ │ │ quaran() → _p_r_a_w_._m_o_d_e_l_s_._r_e_d_d_i_t_._s_u_b_r_e_d_d_i_t_._S_u_b_r_e_d_d_i_t_Q_u_a_r_a_n_t_i_n_e_# │ │ │ │ Provide an instance of _S_u_b_r_e_d_d_i_t_Q_u_a_r_a_n_t_i_n_e. │ │ │ │ This property is named quaran because quarantine is a subreddit │ │ │ │ attribute returned by Reddit to indicate whether or not a subreddit │ │ │ │ is quarantined. │ │ │ │ To opt-in into a quarantined subreddit: │ │ │ │ reddit.subreddit("test").quaran.opt_in() │ │ │ │ - random() → _O_p_t_i_o_n_a_l[_p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]_# │ │ │ │ + random() → Optional[_p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]_# │ │ │ │ Return a random _S_u_b_m_i_s_s_i_o_n. │ │ │ │ Returns None on subreddits that do not support the random feature. │ │ │ │ One example, at the time of writing, is r/wallpapers. │ │ │ │ For example, to get a random submission off of r/AskReddit: │ │ │ │ submission = reddit.subreddit("AskReddit").random() │ │ │ │ print(submission.title) │ │ │ │ - random_rising(****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → │ │ │ │ - _I_t_e_r_a_t_o_r[_p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]_# │ │ │ │ + random_rising(****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → │ │ │ │ + Iterator[_p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for random rising submissions. │ │ │ │ Additional keyword arguments are passed in the initialization of │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r. │ │ │ │ For example, to get random rising submissions for r/test: │ │ │ │ for submission in reddit.subreddit("test").random_rising(): │ │ │ │ print(submission.title) │ │ │ │ - rising(****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → _I_t_e_r_a_t_o_r │ │ │ │ + rising(****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → Iterator │ │ │ │ [_p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for rising submissions. │ │ │ │ Additional keyword arguments are passed in the initialization of │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r. │ │ │ │ For example, to get rising submissions for r/test: │ │ │ │ for submission in reddit.subreddit("test").rising(): │ │ │ │ print(submission.title) │ │ │ │ @@ -442,16 +442,16 @@ │ │ │ │ print(rule) │ │ │ │ Moderators can also add rules to the subreddit. For example, to │ │ │ │ make a rule called "No spam" in r/test: │ │ │ │ reddit.subreddit("test").rules.mod.add( │ │ │ │ short_name="No spam", kind="all", description="Do not spam. │ │ │ │ Spam bad" │ │ │ │ ) │ │ │ │ - search(qquueerryy:: _ss_tt_rr, **, ssoorrtt:: _ss_tt_rr == ''rreelleevvaannccee'', ssyynnttaaxx:: _ss_tt_rr == ''lluucceennee'', │ │ │ │ - ttiimmee__ffiilltteerr:: _ss_tt_rr == ''aallll'', ****ggeenneerraattoorr__kkwwaarrggss:: _AA_nn_yy) → _I_t_e_r_a_t_o_r │ │ │ │ + search(qquueerryy:: ssttrr, **, ssoorrtt:: ssttrr == ''rreelleevvaannccee'', ssyynnttaaxx:: ssttrr == ''lluucceennee'', │ │ │ │ + ttiimmee__ffiilltteerr:: ssttrr == ''aallll'', ****ggeenneerraattoorr__kkwwaarrggss:: AAnnyy) → Iterator │ │ │ │ [_p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for items that match query. │ │ │ │ Parameters: │ │ │ │ * qquueerryy – The query string to search for. │ │ │ │ * ssoorrtt – Can be one of: "relevance", "hot", "top", "new", │ │ │ │ or "comments". (default: "relevance"). │ │ │ │ * ssyynnttaaxx – Can be one of: "cloudsearch", "lucene", or │ │ │ │ @@ -459,15 +459,15 @@ │ │ │ │ * ttiimmee__ffiilltteerr – Can be one of: "all", "day", "hour", │ │ │ │ "month", "week", or "year" (default: "all"). │ │ │ │ For more information on building a search query see: _h_t_t_p_s_:_/_/ │ │ │ │ _w_w_w_._r_e_d_d_i_t_._c_o_m_/_w_i_k_i_/_s_e_a_r_c_h │ │ │ │ For example, to search all subreddits for "praw" try: │ │ │ │ for submission in reddit.subreddit("all").search("praw"): │ │ │ │ print(submission.title) │ │ │ │ - sticky(**, nnuummbbeerr:: _ii_nn_tt == 11) → _p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n_# │ │ │ │ + sticky(**, nnuummbbeerr:: iinntt == 11) → _p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n_# │ │ │ │ Return a _S_u_b_m_i_s_s_i_o_n object for a sticky of the subreddit. │ │ │ │ Parameters: │ │ │ │ nnuummbbeerr – Specify which sticky to return. 1 appears at the top │ │ │ │ (default: 1). │ │ │ │ Raises: │ │ │ │ prawcore.NotFound if the sticky does not exist. │ │ │ │ For example, to get the stickied post on r/test: │ │ │ │ @@ -487,21 +487,21 @@ │ │ │ │ Provide an instance of _S_u_b_r_e_d_d_i_t_S_t_y_l_e_s_h_e_e_t. │ │ │ │ For example, to add the css data .test{color:blue} to the existing │ │ │ │ stylesheet: │ │ │ │ subreddit = reddit.subreddit("test") │ │ │ │ stylesheet = subreddit.stylesheet() │ │ │ │ stylesheet.stylesheet += ".test{color:blue}" │ │ │ │ subreddit.stylesheet.update(stylesheet.stylesheet) │ │ │ │ - submit(ttiittllee:: _ss_tt_rr, **, ccoolllleeccttiioonn__iidd:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, │ │ │ │ - ddiissccuussssiioonn__ttyyppee:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, ddrraafftt__iidd:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, │ │ │ │ - ffllaaiirr__iidd:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, ffllaaiirr__tteexxtt:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, │ │ │ │ - iinnlliinnee__mmeeddiiaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._II_nn_ll_ii_nn_ee_MM_ee_dd_ii_aa]]]] == NNoonnee, │ │ │ │ - nnssffww:: _bb_oo_oo_ll == FFaallssee, rreessuubbmmiitt:: _bb_oo_oo_ll == TTrruuee, sseellfftteexxtt:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == │ │ │ │ - NNoonnee, sseenndd__rreepplliieess:: _bb_oo_oo_ll == TTrruuee, ssppooiilleerr:: _bb_oo_oo_ll == FFaallssee, uurrll:: _OO_pp_tt_ii_oo_nn_aa_ll │ │ │ │ - [[_ss_tt_rr]] == NNoonnee) → _p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n_# │ │ │ │ + submit(ttiittllee:: ssttrr, **, ccoolllleeccttiioonn__iidd:: OOppttiioonnaall[[ssttrr]] == NNoonnee, │ │ │ │ + ddiissccuussssiioonn__ttyyppee:: OOppttiioonnaall[[ssttrr]] == NNoonnee, ddrraafftt__iidd:: OOppttiioonnaall[[ssttrr]] == NNoonnee, │ │ │ │ + ffllaaiirr__iidd:: OOppttiioonnaall[[ssttrr]] == NNoonnee, ffllaaiirr__tteexxtt:: OOppttiioonnaall[[ssttrr]] == NNoonnee, │ │ │ │ + iinnlliinnee__mmeeddiiaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._II_nn_ll_ii_nn_ee_MM_ee_dd_ii_aa]]]] == NNoonnee, │ │ │ │ + nnssffww:: bbooooll == FFaallssee, rreessuubbmmiitt:: bbooooll == TTrruuee, sseellfftteexxtt:: OOppttiioonnaall[[ssttrr]] == │ │ │ │ + NNoonnee, sseenndd__rreepplliieess:: bbooooll == TTrruuee, ssppooiilleerr:: bbooooll == FFaallssee, uurrll:: OOppttiioonnaall │ │ │ │ + [[ssttrr]] == NNoonnee) → _p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n_# │ │ │ │ Add a submission to the _S_u_b_r_e_d_d_i_t. │ │ │ │ Parameters: │ │ │ │ * ttiittllee – The title of the submission. │ │ │ │ * ccoolllleeccttiioonn__iidd – The UUID of a _C_o_l_l_e_c_t_i_o_n to add the │ │ │ │ newly-submitted post to. │ │ │ │ * ddiissccuussssiioonn__ttyyppee – Set to "CHAT" to enable live │ │ │ │ discussion instead of traditional comments (default: │ │ │ │ @@ -576,18 +576,18 @@ │ │ │ │ www.news.com/") │ │ │ │ See also │ │ │ │ * _s_u_b_m_i_t___g_a_l_l_e_r_y_(_) to submit more than one image in the same │ │ │ │ post │ │ │ │ * _s_u_b_m_i_t___i_m_a_g_e_(_) to submit images │ │ │ │ * _s_u_b_m_i_t___p_o_l_l_(_) to submit polls │ │ │ │ * _s_u_b_m_i_t___v_i_d_e_o_(_) to submit videos and videogifs │ │ │ │ - submit_gallery(ttiittllee:: _ss_tt_rr, iimmaaggeess:: _LL_ii_ss_tt[[_DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]], **, │ │ │ │ - ccoolllleeccttiioonn__iidd:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, ddiissccuussssiioonn__ttyyppee:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == │ │ │ │ - NNoonnee, ffllaaiirr__iidd:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, ffllaaiirr__tteexxtt:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, │ │ │ │ - nnssffww:: _bb_oo_oo_ll == FFaallssee, sseenndd__rreepplliieess:: _bb_oo_oo_ll == TTrruuee, ssppooiilleerr:: _bb_oo_oo_ll == FFaallssee)_# │ │ │ │ + submit_gallery(ttiittllee:: ssttrr, iimmaaggeess:: LLiisstt[[DDiicctt[[ssttrr,, ssttrr]]]], **, │ │ │ │ + ccoolllleeccttiioonn__iidd:: OOppttiioonnaall[[ssttrr]] == NNoonnee, ddiissccuussssiioonn__ttyyppee:: OOppttiioonnaall[[ssttrr]] == │ │ │ │ + NNoonnee, ffllaaiirr__iidd:: OOppttiioonnaall[[ssttrr]] == NNoonnee, ffllaaiirr__tteexxtt:: OOppttiioonnaall[[ssttrr]] == NNoonnee, │ │ │ │ + nnssffww:: bbooooll == FFaallssee, sseenndd__rreepplliieess:: bbooooll == TTrruuee, ssppooiilleerr:: bbooooll == FFaallssee)_# │ │ │ │ Add an image gallery submission to the subreddit. │ │ │ │ Parameters: │ │ │ │ * ttiittllee – The title of the submission. │ │ │ │ * iimmaaggeess – The images to post in dict with the following │ │ │ │ structure: {"image_path": "path", "caption": "caption", │ │ │ │ "outbound_url": "url"}, only image_path is required. │ │ │ │ * ccoolllleeccttiioonn__iidd – The UUID of a _C_o_l_l_e_c_t_i_o_n to add the │ │ │ │ @@ -632,19 +632,19 @@ │ │ │ │ ] │ │ │ │ reddit.subreddit("test").submit_gallery(title, images) │ │ │ │ See also │ │ │ │ * _s_u_b_m_i_t_(_) to submit url posts and selftexts │ │ │ │ * _s_u_b_m_i_t___i_m_a_g_e_(_) to submit single images │ │ │ │ * _s_u_b_m_i_t___p_o_l_l_(_) to submit polls │ │ │ │ * _s_u_b_m_i_t___v_i_d_e_o_(_) to submit videos and videogifs │ │ │ │ - submit_image(ttiittllee:: _ss_tt_rr, iimmaaggee__ppaatthh:: _ss_tt_rr, **, ccoolllleeccttiioonn__iidd:: _OO_pp_tt_ii_oo_nn_aa_ll │ │ │ │ - [[_ss_tt_rr]] == NNoonnee, ddiissccuussssiioonn__ttyyppee:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, ffllaaiirr__iidd:: _OO_pp_tt_ii_oo_nn_aa_ll │ │ │ │ - [[_ss_tt_rr]] == NNoonnee, ffllaaiirr__tteexxtt:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, nnssffww:: _bb_oo_oo_ll == FFaallssee, │ │ │ │ - rreessuubbmmiitt:: _bb_oo_oo_ll == TTrruuee, sseenndd__rreepplliieess:: _bb_oo_oo_ll == TTrruuee, ssppooiilleerr:: _bb_oo_oo_ll == │ │ │ │ - FFaallssee, ttiimmeeoouutt:: _ii_nn_tt == 1100, wwiitthhoouutt__wweebbssoocckkeettss:: _bb_oo_oo_ll == FFaallssee)_# │ │ │ │ + submit_image(ttiittllee:: ssttrr, iimmaaggee__ppaatthh:: ssttrr, **, ccoolllleeccttiioonn__iidd:: OOppttiioonnaall │ │ │ │ + [[ssttrr]] == NNoonnee, ddiissccuussssiioonn__ttyyppee:: OOppttiioonnaall[[ssttrr]] == NNoonnee, ffllaaiirr__iidd:: OOppttiioonnaall │ │ │ │ + [[ssttrr]] == NNoonnee, ffllaaiirr__tteexxtt:: OOppttiioonnaall[[ssttrr]] == NNoonnee, nnssffww:: bbooooll == FFaallssee, │ │ │ │ + rreessuubbmmiitt:: bbooooll == TTrruuee, sseenndd__rreepplliieess:: bbooooll == TTrruuee, ssppooiilleerr:: bbooooll == │ │ │ │ + FFaallssee, ttiimmeeoouutt:: iinntt == 1100, wwiitthhoouutt__wweebbssoocckkeettss:: bbooooll == FFaallssee)_# │ │ │ │ Add an image submission to the subreddit. │ │ │ │ Parameters: │ │ │ │ * ccoolllleeccttiioonn__iidd – The UUID of a _C_o_l_l_e_c_t_i_o_n to add the │ │ │ │ newly-submitted post to. │ │ │ │ * ddiissccuussssiioonn__ttyyppee – Set to "CHAT" to enable live │ │ │ │ discussion instead of traditional comments (default: │ │ │ │ None). │ │ │ │ @@ -696,19 +696,19 @@ │ │ │ │ reddit.subreddit("test").submit_image(title, image) │ │ │ │ See also │ │ │ │ * _s_u_b_m_i_t_(_) to submit url posts and selftexts │ │ │ │ * _s_u_b_m_i_t___g_a_l_l_e_r_y_(_) to submit more than one image in the same │ │ │ │ post │ │ │ │ * _s_u_b_m_i_t___p_o_l_l_(_) to submit polls │ │ │ │ * _s_u_b_m_i_t___v_i_d_e_o_(_) to submit videos and videogifs │ │ │ │ - submit_poll(ttiittllee:: _ss_tt_rr, **, ccoolllleeccttiioonn__iidd:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, │ │ │ │ - ddiissccuussssiioonn__ttyyppee:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, dduurraattiioonn:: _ii_nn_tt, ffllaaiirr__iidd:: │ │ │ │ - _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, ffllaaiirr__tteexxtt:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, nnssffww:: _bb_oo_oo_ll == │ │ │ │ - FFaallssee, ooppttiioonnss:: _LL_ii_ss_tt[[_ss_tt_rr]], rreessuubbmmiitt:: _bb_oo_oo_ll == TTrruuee, sseellfftteexxtt:: _ss_tt_rr, │ │ │ │ - sseenndd__rreepplliieess:: _bb_oo_oo_ll == TTrruuee, ssppooiilleerr:: _bb_oo_oo_ll == FFaallssee)_# │ │ │ │ + submit_poll(ttiittllee:: ssttrr, **, ccoolllleeccttiioonn__iidd:: OOppttiioonnaall[[ssttrr]] == NNoonnee, │ │ │ │ + ddiissccuussssiioonn__ttyyppee:: OOppttiioonnaall[[ssttrr]] == NNoonnee, dduurraattiioonn:: iinntt, ffllaaiirr__iidd:: │ │ │ │ + OOppttiioonnaall[[ssttrr]] == NNoonnee, ffllaaiirr__tteexxtt:: OOppttiioonnaall[[ssttrr]] == NNoonnee, nnssffww:: bbooooll == │ │ │ │ + FFaallssee, ooppttiioonnss:: LLiisstt[[ssttrr]], rreessuubbmmiitt:: bbooooll == TTrruuee, sseellfftteexxtt:: ssttrr, │ │ │ │ + sseenndd__rreepplliieess:: bbooooll == TTrruuee, ssppooiilleerr:: bbooooll == FFaallssee)_# │ │ │ │ Add a poll submission to the subreddit. │ │ │ │ Parameters: │ │ │ │ * ttiittllee – The title of the submission. │ │ │ │ * ccoolllleeccttiioonn__iidd – The UUID of a _C_o_l_l_e_c_t_i_o_n to add the │ │ │ │ newly-submitted post to. │ │ │ │ * ddiissccuussssiioonn__ttyyppee – Set to "CHAT" to enable live │ │ │ │ discussion instead of traditional comments (default: │ │ │ │ @@ -744,20 +744,20 @@ │ │ │ │ ) │ │ │ │ See also │ │ │ │ * _s_u_b_m_i_t_(_) to submit url posts and selftexts │ │ │ │ * _s_u_b_m_i_t___g_a_l_l_e_r_y_(_) to submit more than one image in the same │ │ │ │ post │ │ │ │ * _s_u_b_m_i_t___i_m_a_g_e_(_) to submit single images │ │ │ │ * _s_u_b_m_i_t___v_i_d_e_o_(_) to submit videos and videogifs │ │ │ │ - submit_video(ttiittllee:: _ss_tt_rr, vviiddeeoo__ppaatthh:: _ss_tt_rr, **, ccoolllleeccttiioonn__iidd:: _OO_pp_tt_ii_oo_nn_aa_ll │ │ │ │ - [[_ss_tt_rr]] == NNoonnee, ddiissccuussssiioonn__ttyyppee:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, ffllaaiirr__iidd:: _OO_pp_tt_ii_oo_nn_aa_ll │ │ │ │ - [[_ss_tt_rr]] == NNoonnee, ffllaaiirr__tteexxtt:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, nnssffww:: _bb_oo_oo_ll == FFaallssee, │ │ │ │ - rreessuubbmmiitt:: _bb_oo_oo_ll == TTrruuee, sseenndd__rreepplliieess:: _bb_oo_oo_ll == TTrruuee, ssppooiilleerr:: _bb_oo_oo_ll == │ │ │ │ - FFaallssee, tthhuummbbnnaaiill__ppaatthh:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, ttiimmeeoouutt:: _ii_nn_tt == 1100, │ │ │ │ - vviiddeeooggiiff:: _bb_oo_oo_ll == FFaallssee, wwiitthhoouutt__wweebbssoocckkeettss:: _bb_oo_oo_ll == FFaallssee)_# │ │ │ │ + submit_video(ttiittllee:: ssttrr, vviiddeeoo__ppaatthh:: ssttrr, **, ccoolllleeccttiioonn__iidd:: OOppttiioonnaall │ │ │ │ + [[ssttrr]] == NNoonnee, ddiissccuussssiioonn__ttyyppee:: OOppttiioonnaall[[ssttrr]] == NNoonnee, ffllaaiirr__iidd:: OOppttiioonnaall │ │ │ │ + [[ssttrr]] == NNoonnee, ffllaaiirr__tteexxtt:: OOppttiioonnaall[[ssttrr]] == NNoonnee, nnssffww:: bbooooll == FFaallssee, │ │ │ │ + rreessuubbmmiitt:: bbooooll == TTrruuee, sseenndd__rreepplliieess:: bbooooll == TTrruuee, ssppooiilleerr:: bbooooll == │ │ │ │ + FFaallssee, tthhuummbbnnaaiill__ppaatthh:: OOppttiioonnaall[[ssttrr]] == NNoonnee, ttiimmeeoouutt:: iinntt == 1100, │ │ │ │ + vviiddeeooggiiff:: bbooooll == FFaallssee, wwiitthhoouutt__wweebbssoocckkeettss:: bbooooll == FFaallssee)_# │ │ │ │ Add a video or videogif submission to the subreddit. │ │ │ │ Parameters: │ │ │ │ * ttiittllee – The title of the submission. │ │ │ │ * vviiddeeoo__ppaatthh – The path to a video, to upload and post. │ │ │ │ * ccoolllleeccttiioonn__iidd – The UUID of a _C_o_l_l_e_c_t_i_o_n to add the │ │ │ │ newly-submitted post to. │ │ │ │ * ddiissccuussssiioonn__ttyyppee – Set to "CHAT" to enable live │ │ │ │ @@ -815,41 +815,41 @@ │ │ │ │ reddit.subreddit("test").submit_video(title, video) │ │ │ │ See also │ │ │ │ * _s_u_b_m_i_t_(_) to submit url posts and selftexts │ │ │ │ * _s_u_b_m_i_t___i_m_a_g_e_(_) to submit images │ │ │ │ * _s_u_b_m_i_t___g_a_l_l_e_r_y_(_) to submit more than one image in the same │ │ │ │ post │ │ │ │ * _s_u_b_m_i_t___p_o_l_l_(_) to submit polls │ │ │ │ - subscribe(**, ootthheerr__ssuubbrreeddddiittss:: _OO_pp_tt_ii_oo_nn_aa_ll[[_LL_ii_ss_tt[[_pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt]]]] == │ │ │ │ + subscribe(**, ootthheerr__ssuubbrreeddddiittss:: OOppttiioonnaall[[LLiisstt[[_pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt]]]] == │ │ │ │ NNoonnee)_# │ │ │ │ Subscribe to the subreddit. │ │ │ │ Parameters: │ │ │ │ ootthheerr__ssuubbrreeddddiittss – When provided, also subscribe to the │ │ │ │ provided list of subreddits. │ │ │ │ For example, to subscribe to r/test: │ │ │ │ reddit.subreddit("test").subscribe() │ │ │ │ - top(**, ttiimmee__ffiilltteerr:: _ss_tt_rr == ''aallll'', ****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, │ │ │ │ - _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → _I_t_e_r_a_t_o_r[_A_n_y]_# │ │ │ │ + top(**, ttiimmee__ffiilltteerr:: ssttrr == ''aallll'', ****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, │ │ │ │ + DDiicctt[[ssttrr,, ssttrr]]]]) → Iterator[Any]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for top items. │ │ │ │ Parameters: │ │ │ │ ttiimmee__ffiilltteerr – Can be one of: "all", "day", "hour", "month", │ │ │ │ "week", or "year" (default: "all"). │ │ │ │ Raises: │ │ │ │ - _V_a_l_u_e_E_r_r_o_r if time_filter is invalid. │ │ │ │ + ValueError if time_filter is invalid. │ │ │ │ Additional keyword arguments are passed in the initialization of │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r. │ │ │ │ This method can be used like: │ │ │ │ reddit.domain("imgur.com").top(time_filter="week") │ │ │ │ reddit.multireddit(redditor="samuraisam", name="programming").top │ │ │ │ (time_filter="day") │ │ │ │ reddit.redditor("spez").top(time_filter="month") │ │ │ │ reddit.redditor("spez").comments.top(time_filter="year") │ │ │ │ reddit.redditor("spez").submissions.top(time_filter="all") │ │ │ │ reddit.subreddit("all").top(time_filter="hour") │ │ │ │ - traffic() → _D_i_c_t[_s_t_r, _L_i_s_t[_L_i_s_t[_i_n_t]]]_# │ │ │ │ + traffic() → Dict[str, List[List[int]]]_# │ │ │ │ Return a dictionary of the _S_u_b_r_e_d_d_i_t’s traffic statistics. │ │ │ │ Raises: │ │ │ │ prawcore.NotFound when the traffic stats aren’t available to │ │ │ │ the authenticated user, that is, they are not public and the │ │ │ │ authenticated user is not a moderator of the subreddit. │ │ │ │ The traffic method returns a dict with three keys. The keys are │ │ │ │ day, hour and month. Each key contains a list of lists with 3 or 4 │ │ │ │ @@ -859,15 +859,15 @@ │ │ │ │ the unique pageviews, total pageviews, and subscribers, │ │ │ │ respectively. │ │ │ │ Note │ │ │ │ The hour key does not contain subscribers, and therefore each sub- │ │ │ │ list contains three values. │ │ │ │ For example, to get the traffic stats for r/test: │ │ │ │ stats = reddit.subreddit("test").traffic() │ │ │ │ - unsubscribe(**, ootthheerr__ssuubbrreeddddiittss:: _OO_pp_tt_ii_oo_nn_aa_ll[[_LL_ii_ss_tt[[_pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt]]]] │ │ │ │ + unsubscribe(**, ootthheerr__ssuubbrreeddddiittss:: OOppttiioonnaall[[LLiisstt[[_pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt]]]] │ │ │ │ == NNoonnee)_# │ │ │ │ Unsubscribe from the subreddit. │ │ │ │ Parameters: │ │ │ │ ootthheerr__ssuubbrreeddddiittss – When provided, also unsubscribe from the │ │ │ │ provided list of subreddits. │ │ │ │ To unsubscribe from r/test: │ │ │ │ reddit.subreddit("test").unsubscribe() │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/models/wikipage.html │ │ │ @@ -355,15 +355,15 @@ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │

    WikiPage#

    │ │ │
    │ │ │
    │ │ │ -class praw.models.reddit.wikipage.WikiPage(reddit: praw.Reddit, subreddit: praw.models.Subreddit, name: str, revision: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)#
    │ │ │ +class praw.models.reddit.wikipage.WikiPage(reddit: praw.Reddit, subreddit: praw.models.Subreddit, name: str, revision: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)# │ │ │

    An individual WikiPage object.

    │ │ │

    Typical Attributes

    │ │ │
    │ │ │

    Note

    │ │ │

    This table describes attributes that typically belong to objects of this class. PRAW │ │ │ dynamically provides the attributes that Reddit returns via the API. Since those │ │ │ attributes are subject to change on Reddit’s end, PRAW makes no effort to document │ │ │ @@ -405,41 +405,41 @@ │ │ │

    The Subreddit this wiki page belongs to.

    │ │ │ │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │
    │ │ │ -__init__(reddit: praw.Reddit, subreddit: praw.models.Subreddit, name: str, revision: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)#
    │ │ │ +__init__(reddit: praw.Reddit, subreddit: praw.models.Subreddit, name: str, revision: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)# │ │ │

    Initialize a WikiPage instance.

    │ │ │
    │ │ │
    Parameters:
    │ │ │

    revision – A specific revision ID to fetch. By default, fetches the most │ │ │ recent revision.

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -discussions(**generator_kwargs: Any) → Iterator[praw.models.Submission]#
    │ │ │ +discussions(**generator_kwargs: Any) → Iterator[praw.models.Submission]# │ │ │

    Return a ListingGenerator for discussions of a wiki page.

    │ │ │

    Discussions are site-wide links to a wiki page.

    │ │ │

    Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

    │ │ │

    To view the titles of discussions of the page "praw_test" in r/test, try:

    │ │ │ 
    for submission in reddit.subreddit("test").wiki["praw_test"].discussions():
│ │ │      print(submission.title)
│ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -edit(*, content: str, reason: Optional[str] = None, **other_settings: Any)#
    │ │ │ +edit(*, content: str, reason: Optional[str] = None, **other_settings: Any)# │ │ │

    Edit this wiki page’s contents.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │

    • content – The updated Markdown content of the page.

      • │ │ │

    • reason – The reason for the revision.

      • │ │ │

    • other_settings – Additional keyword arguments to pass.

      • │ │ │ @@ -462,39 +462,39 @@ │ │ │ 
      reddit.subreddit("test").wiki["praw_test"].mod.add("spez")
│ │ │
      │ │ │
      │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
    │ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

    Return an instance of cls from data.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │

    • data – The structured data.

      • │ │ │

    • reddit – An instance of Reddit.

      • │ │ │
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -revision(revision: str)#
    │ │ │ +revision(revision: str)# │ │ │

    Return a specific version of this page by revision ID.

    │ │ │

    To view revision "1234abc" of "praw_test" in r/test:

    │ │ │ 
    page = reddit.subreddit("test").wiki["praw_test"].revision("1234abc")
│ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -revisions(**generator_kwargs: Union[str, int, Dict[str, str]]) → Generator[WikiPage, None, None]#
    │ │ │ +revisions(**generator_kwargs: Union[str, int, Dict[str, str]]) → Generator[WikiPage, None, None]# │ │ │

    Return a ListingGenerator for page revisions.

    │ │ │

    Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

    │ │ │

    To view the wiki revisions for "praw_test" in r/test try:

    │ │ │ 
    for item in reddit.subreddit("test").wiki["praw_test"].revisions():
│ │ │      print(item)
│ │ │
    │ │ │ ├── html2text {} │ │ │ │ @@ -162,16 +162,16 @@ │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ WWiikkiiPPaaggee_## ************ │ │ │ │ ccllaassss praw.models.reddit.wikipage.WikiPage(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, ssuubbrreeddddiitt:: │ │ │ │ - _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt, nnaammee:: _ss_tt_rr, rreevviissiioonn:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, __ddaattaa:: │ │ │ │ - _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]]]] == NNoonnee)_# │ │ │ │ + _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt, nnaammee:: ssttrr, rreevviissiioonn:: OOppttiioonnaall[[ssttrr]] == NNoonnee, __ddaattaa:: │ │ │ │ + OOppttiioonnaall[[DDiicctt[[ssttrr,, AAnnyy]]]] == NNoonnee)_# │ │ │ │ An individual _W_i_k_i_P_a_g_e object. │ │ │ │ TTyyppiiccaall AAttttrriibbuutteess │ │ │ │ Note │ │ │ │ This table describes attributes that typically belong to objects of this │ │ │ │ class. PRAW dynamically provides the attributes that Reddit returns via │ │ │ │ the API. Since those attributes are subject to change on Reddit’s end, │ │ │ │ PRAW makes no effort to document any new/removed/changed attributes, │ │ │ │ @@ -186,59 +186,59 @@ │ │ │ │ may_revise A bool representing whether or not the authenticated user │ │ │ │ may edit the wiki page. │ │ │ │ name The name of the wiki page. │ │ │ │ revision_by The _R_e_d_d_i_t_o_r who authored this revision of the wiki page. │ │ │ │ revision_date The time of this revision, in _U_n_i_x_ _T_i_m_e. │ │ │ │ subreddit The _S_u_b_r_e_d_d_i_t this wiki page belongs to. │ │ │ │ __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, ssuubbrreeddddiitt:: _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt, nnaammee:: │ │ │ │ - _ss_tt_rr, rreevviissiioonn:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]]]] == │ │ │ │ + ssttrr, rreevviissiioonn:: OOppttiioonnaall[[ssttrr]] == NNoonnee, __ddaattaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, AAnnyy]]]] == │ │ │ │ NNoonnee)_# │ │ │ │ Initialize a _W_i_k_i_P_a_g_e instance. │ │ │ │ Parameters: │ │ │ │ rreevviissiioonn – A specific revision ID to fetch. By default, │ │ │ │ fetches the most recent revision. │ │ │ │ - discussions(****ggeenneerraattoorr__kkwwaarrggss:: _AA_nn_yy) → _I_t_e_r_a_t_o_r │ │ │ │ + discussions(****ggeenneerraattoorr__kkwwaarrggss:: AAnnyy) → Iterator │ │ │ │ [_p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for discussions of a wiki page. │ │ │ │ Discussions are site-wide links to a wiki page. │ │ │ │ Additional keyword arguments are passed in the initialization of │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r. │ │ │ │ To view the titles of discussions of the page "praw_test" in r/ │ │ │ │ test, try: │ │ │ │ for submission in reddit.subreddit("test").wiki │ │ │ │ ["praw_test"].discussions(): │ │ │ │ print(submission.title) │ │ │ │ - edit(**, ccoonntteenntt:: _ss_tt_rr, rreeaassoonn:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, ****ootthheerr__sseettttiinnggss:: │ │ │ │ - _AA_nn_yy)_# │ │ │ │ + edit(**, ccoonntteenntt:: ssttrr, rreeaassoonn:: OOppttiioonnaall[[ssttrr]] == NNoonnee, ****ootthheerr__sseettttiinnggss:: │ │ │ │ + AAnnyy)_# │ │ │ │ Edit this wiki page’s contents. │ │ │ │ Parameters: │ │ │ │ * ccoonntteenntt – The updated Markdown content of the page. │ │ │ │ * rreeaassoonn – The reason for the revision. │ │ │ │ * ootthheerr__sseettttiinnggss – Additional keyword arguments to pass. │ │ │ │ For example, to replace the first wiki page of r/test with the │ │ │ │ phrase "test wiki page": │ │ │ │ page = next(iter(reddit.subreddit("test").wiki)) │ │ │ │ page.edit(content="test wiki page") │ │ │ │ mod() → _W_i_k_i_P_a_g_e_M_o_d_e_r_a_t_i_o_n_# │ │ │ │ Provide an instance of _W_i_k_i_P_a_g_e_M_o_d_e_r_a_t_i_o_n. │ │ │ │ For example, to add u/spez as an editor on the wikipage "praw_test" │ │ │ │ try: │ │ │ │ reddit.subreddit("test").wiki["praw_test"].mod.add("spez") │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ - revision(rreevviissiioonn:: _ss_tt_rr)_# │ │ │ │ + revision(rreevviissiioonn:: ssttrr)_# │ │ │ │ Return a specific version of this page by revision ID. │ │ │ │ To view revision "1234abc" of "praw_test" in r/test: │ │ │ │ page = reddit.subreddit("test").wiki["praw_test"].revision │ │ │ │ ("1234abc") │ │ │ │ - revisions(****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → │ │ │ │ - _G_e_n_e_r_a_t_o_r[_W_i_k_i_P_a_g_e, _N_o_n_e, _N_o_n_e]_# │ │ │ │ + revisions(****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → │ │ │ │ + Generator[_W_i_k_i_P_a_g_e, None, None]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for page revisions. │ │ │ │ Additional keyword arguments are passed in the initialization of │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r. │ │ │ │ To view the wiki revisions for "praw_test" in r/test try: │ │ │ │ for item in reddit.subreddit("test").wiki["praw_test"].revisions(): │ │ │ │ print(item) │ │ │ │ To get _W_i_k_i_P_a_g_e objects for each revision: │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/auth.html │ │ │ @@ -355,45 +355,45 @@ │ │ │ │ │ │
    │ │ │
    │ │ │
    │ │ │

    Auth#

    │ │ │
    │ │ │
    │ │ │ -class praw.models.Auth(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])#
    │ │ │ +class praw.models.Auth(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])# │ │ │

    Auth provides an interface to Reddit’s authorization.

    │ │ │
    │ │ │
    │ │ │ -__init__(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])#
    │ │ │ +__init__(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])# │ │ │

    Initialize a PRAWBase instance.

    │ │ │
    │ │ │
    Parameters:
    │ │ │

    reddit – An instance of Reddit.

    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -authorize(code: str) → Optional[str]#
    │ │ │ +authorize(code: str) → Optional[str]# │ │ │

    Complete the web authorization flow and return the refresh token.

    │ │ │
    │ │ │
    Parameters:
    │ │ │

    code – The code obtained through the request to the redirect uri.

    │ │ │
    │ │ │
    Returns:
    │ │ │

    The obtained refresh token, if available, otherwise None.

    │ │ │
    │ │ │
    │ │ │

    The session’s active authorization will be updated upon success.

    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -implicit(*, access_token: str, expires_in: int, scope: str) → None#
    │ │ │ +implicit(*, access_token: str, expires_in: int, scope: str) → None# │ │ │

    Set the active authorization to be an implicit authorization.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │

    • access_token – The access_token obtained from Reddit’s callback.

      • │ │ │

    • expires_in – The number of seconds the access_token is valid for. The │ │ │ origin of this value was returned from Reddit’s callback. You may need to │ │ │ @@ -409,15 +409,15 @@ │ │ │ non-installed application type.

      │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -property limits: Dict[str, Optional[Union[str, int]]]#
    │ │ │ +property limits: Dict[str, Optional[Union[str, int]]]# │ │ │

    Return a dictionary containing the rate limit info.

    │ │ │

    The keys are:

    │ │ │
    │ │ │
    Remaining:
    │ │ │

    The number of requests remaining to be made in the current rate │ │ │ limit window.

    │ │ │
    │ │ │ @@ -435,36 +435,36 @@ │ │ │ computed on Reddit’s end in preparation for sending the response. This value may │ │ │ change slightly within a given window due to slight changes in response times │ │ │ and rounding.

    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
    │ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

    Return an instance of cls from data.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │

    • data – The structured data.

      • │ │ │

    • reddit – An instance of Reddit.

      • │ │ │
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -scopes() → Set[str]#
    │ │ │ +scopes() → Set[str]# │ │ │

    Return a set of scopes included in the current authorization.

    │ │ │

    For read-only authorizations this should return {"*"}.

    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -url(*, duration: str = 'permanent', implicit: bool = False, scopes: List[str], state: str) → str#
    │ │ │ +url(*, duration: str = 'permanent', implicit: bool = False, scopes: List[str], state: str) → str# │ │ │

    Return the URL used out-of-band to grant access to your application.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │

    • duration – Either "permanent" or "temporary" (default: │ │ │ "permanent"). "temporary" authorizations generate access tokens that │ │ │ last only 1 hour. "permanent" authorizations additionally generate a │ │ │ ├── html2text {} │ │ │ │ @@ -161,29 +161,29 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ AAuutthh_## ************ │ │ │ │ - ccllaassss praw.models.Auth(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]]]])_# │ │ │ │ + ccllaassss praw.models.Auth(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, AAnnyy]]]])_# │ │ │ │ Auth provides an interface to Reddit’s authorization. │ │ │ │ - __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]]]])_# │ │ │ │ + __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, AAnnyy]]]])_# │ │ │ │ Initialize a _P_R_A_W_B_a_s_e instance. │ │ │ │ Parameters: │ │ │ │ rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ - authorize(ccooddee:: _ss_tt_rr) → _O_p_t_i_o_n_a_l[_s_t_r]_# │ │ │ │ + authorize(ccooddee:: ssttrr) → Optional[str]_# │ │ │ │ Complete the web authorization flow and return the refresh token. │ │ │ │ Parameters: │ │ │ │ ccooddee – The code obtained through the request to the redirect │ │ │ │ uri. │ │ │ │ Returns: │ │ │ │ The obtained refresh token, if available, otherwise None. │ │ │ │ The session’s active authorization will be updated upon success. │ │ │ │ - implicit(**, aacccceessss__ttookkeenn:: _ss_tt_rr, eexxppiirreess__iinn:: _ii_nn_tt, ssccooppee:: _ss_tt_rr) → _N_o_n_e_# │ │ │ │ + implicit(**, aacccceessss__ttookkeenn:: ssttrr, eexxppiirreess__iinn:: iinntt, ssccooppee:: ssttrr) → None_# │ │ │ │ Set the active authorization to be an implicit authorization. │ │ │ │ Parameters: │ │ │ │ * aacccceessss__ttookkeenn – The access_token obtained from Reddit’s │ │ │ │ callback. │ │ │ │ * eexxppiirreess__iinn – The number of seconds the access_token is │ │ │ │ valid for. The origin of this value was returned from │ │ │ │ Reddit’s callback. You may need to subtract an offset │ │ │ │ @@ -191,15 +191,15 @@ │ │ │ │ between when Reddit prepared the response, and when you │ │ │ │ make this function call. │ │ │ │ * ssccooppee – A space-delimited string of Reddit OAuth2 scope │ │ │ │ names as returned from Reddit’s callback. │ │ │ │ Raises: │ │ │ │ _I_n_v_a_l_i_d_I_m_p_l_i_c_i_t_A_u_t_h if _R_e_d_d_i_t was initialized for a non- │ │ │ │ installed application type. │ │ │ │ - pprrooppeerrttyy limits:: _DD_ii_cc_tt[[_ss_tt_rr,, _OO_pp_tt_ii_oo_nn_aa_ll[[_UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt]]]]]]_# │ │ │ │ + pprrooppeerrttyy limits:: DDiicctt[[ssttrr,, OOppttiioonnaall[[UUnniioonn[[ssttrr,, iinntt]]]]]]_# │ │ │ │ Return a dictionary containing the rate limit info. │ │ │ │ The keys are: │ │ │ │ Remaining: │ │ │ │ The number of requests remaining to be made in the current │ │ │ │ rate limit window. │ │ │ │ Reset_timestamp: │ │ │ │ A unix timestamp providing an upper bound on when the rate │ │ │ │ @@ -208,24 +208,24 @@ │ │ │ │ The number of requests made in the current rate limit window. │ │ │ │ All values are initially None as these values are set in response │ │ │ │ to issued requests. │ │ │ │ The reset_timestamp value is an upper bound as the real timestamp │ │ │ │ is computed on Reddit’s end in preparation for sending the │ │ │ │ response. This value may change slightly within a given window due │ │ │ │ to slight changes in response times and rounding. │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ - scopes() → _S_e_t[_s_t_r]_# │ │ │ │ + scopes() → Set[str]_# │ │ │ │ Return a set of scopes included in the current authorization. │ │ │ │ For read-only authorizations this should return {"*"}. │ │ │ │ - url(**, dduurraattiioonn:: _ss_tt_rr == ''ppeerrmmaanneenntt'', iimmpplliicciitt:: _bb_oo_oo_ll == FFaallssee, ssccooppeess:: │ │ │ │ - _LL_ii_ss_tt[[_ss_tt_rr]], ssttaattee:: _ss_tt_rr) → _s_t_r_# │ │ │ │ + url(**, dduurraattiioonn:: ssttrr == ''ppeerrmmaanneenntt'', iimmpplliicciitt:: bbooooll == FFaallssee, ssccooppeess:: │ │ │ │ + LLiisstt[[ssttrr]], ssttaattee:: ssttrr) → str_# │ │ │ │ Return the URL used out-of-band to grant access to your │ │ │ │ application. │ │ │ │ Parameters: │ │ │ │ * dduurraattiioonn – Either "permanent" or "temporary" (default: │ │ │ │ "permanent"). "temporary" authorizations generate │ │ │ │ access tokens that last only 1 hour. "permanent" │ │ │ │ authorizations additionally generate a refresh token │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/base_mod_notes.html │ │ │ @@ -370,15 +370,15 @@ │ │ │

      reddit – An instance of Reddit.

      │ │ │
      │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -create(*, label: Optional[str] = None, note: str, redditor: Optional[Union[Redditor, str]] = None, subreddit: Optional[Union[praw.models.Subreddit, str]] = None, thing: Optional[Union[Comment, Submission, str]] = None, **other_settings: Any) → praw.models.ModNote#
    │ │ │ +create(*, label: Optional[str] = None, note: str, redditor: Optional[Union[Redditor, str]] = None, subreddit: Optional[Union[praw.models.Subreddit, str]] = None, thing: Optional[Union[Comment, Submission, str]] = None, **other_settings: Any) → praw.models.ModNote# │ │ │

    Create a ModNote for a redditor in the specified subreddit.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │

    • label – The label for the note. As of this writing, this can be one of the │ │ │ following: "ABUSE_WARNING", "BAN", "BOT_BAN", │ │ │ "HELPFUL_USER", "PERMA_BAN", "SOLID_CONTRIBUTOR", │ │ │ @@ -425,15 +425,15 @@ │ │ │ ) │ │ │ │ │ │ │ │ │

    │ │ │ │ │ │
    │ │ │
    │ │ │ -delete(*, delete_all: bool = False, note_id: Optional[str] = None, redditor: Optional[Union[Redditor, str]] = None, subreddit: Optional[Union[praw.models.Subreddit, str]] = None)#
    │ │ │ +delete(*, delete_all: bool = False, note_id: Optional[str] = None, redditor: Optional[Union[Redditor, str]] = None, subreddit: Optional[Union[praw.models.Subreddit, str]] = None)# │ │ │

    Delete note(s) for a redditor.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │

    • delete_all –

      When True, delete all notes for the specified redditor in │ │ │ the specified subreddit (default: False).

      │ │ │
      │ │ │ ├── html2text {} │ │ │ │ @@ -167,18 +167,18 @@ │ │ │ │ ************ BBaasseeMMooddNNootteess_## ************ │ │ │ │ ccllaassss praw.models.mod_notes.BaseModNotes(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt)_# │ │ │ │ Provides base methods to interact with moderator notes. │ │ │ │ __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt)_# │ │ │ │ Initialize a _B_a_s_e_M_o_d_N_o_t_e_s instance. │ │ │ │ Parameters: │ │ │ │ rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ - create(**, llaabbeell:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, nnoottee:: _ss_tt_rr, rreeddddiittoorr:: _OO_pp_tt_ii_oo_nn_aa_ll │ │ │ │ - [[_UU_nn_ii_oo_nn[[_RR_ee_dd_dd_ii_tt_oo_rr,, _ss_tt_rr]]]] == NNoonnee, ssuubbrreeddddiitt:: _OO_pp_tt_ii_oo_nn_aa_ll[[_UU_nn_ii_oo_nn │ │ │ │ - [[_pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt,, _ss_tt_rr]]]] == NNoonnee, tthhiinngg:: _OO_pp_tt_ii_oo_nn_aa_ll[[_UU_nn_ii_oo_nn[[_CC_oo_mm_mm_ee_nn_tt,, │ │ │ │ - _SS_uu_bb_mm_ii_ss_ss_ii_oo_nn,, _ss_tt_rr]]]] == NNoonnee, ****ootthheerr__sseettttiinnggss:: _AA_nn_yy) → _p_r_a_w_._m_o_d_e_l_s_._M_o_d_N_o_t_e_# │ │ │ │ + create(**, llaabbeell:: OOppttiioonnaall[[ssttrr]] == NNoonnee, nnoottee:: ssttrr, rreeddddiittoorr:: OOppttiioonnaall │ │ │ │ + [[UUnniioonn[[_RR_ee_dd_dd_ii_tt_oo_rr,, ssttrr]]]] == NNoonnee, ssuubbrreeddddiitt:: OOppttiioonnaall[[UUnniioonn │ │ │ │ + [[_pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt,, ssttrr]]]] == NNoonnee, tthhiinngg:: OOppttiioonnaall[[UUnniioonn[[_CC_oo_mm_mm_ee_nn_tt,, │ │ │ │ + _SS_uu_bb_mm_ii_ss_ss_ii_oo_nn,, ssttrr]]]] == NNoonnee, ****ootthheerr__sseettttiinnggss:: AAnnyy) → _p_r_a_w_._m_o_d_e_l_s_._M_o_d_N_o_t_e_# │ │ │ │ Create a _M_o_d_N_o_t_e for a redditor in the specified subreddit. │ │ │ │ Returns: │ │ │ │ The new _M_o_d_N_o_t_e object. │ │ │ │ For example, to create a note for u/spez in r/test: │ │ │ │ reddit.subreddit("test").mod.notes.create( │ │ │ │ label="HELPFUL_USER", note="Test note", redditor="spez" │ │ │ │ ) │ │ │ │ @@ -187,17 +187,17 @@ │ │ │ │ label="HELPFUL_USER", note="Test note", subreddit="test" │ │ │ │ ) │ │ │ │ # or │ │ │ │ reddit.notes.create( │ │ │ │ label="HELPFUL_USER", note="Test note", redditor="spez", │ │ │ │ subreddit="test" │ │ │ │ ) │ │ │ │ - delete(**, ddeelleettee__aallll:: _bb_oo_oo_ll == FFaallssee, nnoottee__iidd:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, │ │ │ │ - rreeddddiittoorr:: _OO_pp_tt_ii_oo_nn_aa_ll[[_UU_nn_ii_oo_nn[[_RR_ee_dd_dd_ii_tt_oo_rr,, _ss_tt_rr]]]] == NNoonnee, ssuubbrreeddddiitt:: _OO_pp_tt_ii_oo_nn_aa_ll │ │ │ │ - [[_UU_nn_ii_oo_nn[[_pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt,, _ss_tt_rr]]]] == NNoonnee)_# │ │ │ │ + delete(**, ddeelleettee__aallll:: bbooooll == FFaallssee, nnoottee__iidd:: OOppttiioonnaall[[ssttrr]] == NNoonnee, │ │ │ │ + rreeddddiittoorr:: OOppttiioonnaall[[UUnniioonn[[_RR_ee_dd_dd_ii_tt_oo_rr,, ssttrr]]]] == NNoonnee, ssuubbrreeddddiitt:: OOppttiioonnaall │ │ │ │ + [[UUnniioonn[[_pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt,, ssttrr]]]] == NNoonnee)_# │ │ │ │ Delete note(s) for a redditor. │ │ │ │ For example, to delete a note with the ID "ModNote_d324b280-5ecc- │ │ │ │ 435d-8159-3e259e84e339", try: │ │ │ │ reddit.subreddit("test").mod.notes.delete( │ │ │ │ note_id="ModNote_d324b280-5ecc-435d-8159-3e259e84e339", │ │ │ │ redditor="spez" │ │ │ │ ) │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/baselist.html │ │ │ @@ -355,54 +355,54 @@ │ │ │ │ │ │
      │ │ │
      │ │ │
      │ │ │

      BaseList#

      │ │ │
      │ │ │
      │ │ │ -class praw.models.list.base.BaseList(reddit: praw.Reddit, _data: Dict[str, Any])#
      │ │ │ +class praw.models.list.base.BaseList(reddit: praw.Reddit, _data: Dict[str, Any])# │ │ │

      An abstract class to coerce a list into a PRAWBase.

      │ │ │
      │ │ │
      │ │ │ -__contains__(item: Any) → bool#
      │ │ │ +__contains__(item: Any) → bool# │ │ │

      Test if item exists in the list.

      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ -__getitem__(index: int) → Any#
      │ │ │ +__getitem__(index: int) → Any# │ │ │

      Return the item at position index in the list.

      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ -__init__(reddit: praw.Reddit, _data: Dict[str, Any])#
      │ │ │ +__init__(reddit: praw.Reddit, _data: Dict[str, Any])# │ │ │

      Initialize a BaseList instance.

      │ │ │
      │ │ │
      Parameters:
      │ │ │

      reddit – An instance of Reddit.

      │ │ │
      │ │ │
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ -__iter__() → Iterator[Any]#
      │ │ │ +__iter__() → Iterator[Any]# │ │ │

      Return an iterator to the list.

      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ -__len__() → int#
      │ │ │ +__len__() → int# │ │ │

      Return the number of items in the list.

      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
      │ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

      Return an instance of cls from data.

      │ │ │
      │ │ │
      Parameters:
      │ │ │
        │ │ │

      • data – The structured data.

        • │ │ │

      • reddit – An instance of Reddit.

        • │ │ │
      │ │ │ ├── html2text {} │ │ │ │ @@ -161,30 +161,30 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ BBaasseeLLiisstt_## ************ │ │ │ │ - ccllaassss praw.models.list.base.BaseList(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, │ │ │ │ - _AA_nn_yy]])_# │ │ │ │ + ccllaassss praw.models.list.base.BaseList(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: DDiicctt[[ssttrr,, │ │ │ │ + AAnnyy]])_# │ │ │ │ An abstract class to coerce a list into a _P_R_A_W_B_a_s_e. │ │ │ │ - __contains__(iitteemm:: _AA_nn_yy) → _b_o_o_l_# │ │ │ │ + __contains__(iitteemm:: AAnnyy) → bool_# │ │ │ │ Test if item exists in the list. │ │ │ │ - __getitem__(iinnddeexx:: _ii_nn_tt) → _A_n_y_# │ │ │ │ + __getitem__(iinnddeexx:: iinntt) → Any_# │ │ │ │ Return the item at position index in the list. │ │ │ │ - __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]])_# │ │ │ │ + __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]])_# │ │ │ │ Initialize a _B_a_s_e_L_i_s_t instance. │ │ │ │ Parameters: │ │ │ │ rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ - __iter__() → _I_t_e_r_a_t_o_r[_A_n_y]_# │ │ │ │ + __iter__() → Iterator[Any]_# │ │ │ │ Return an iterator to the list. │ │ │ │ - __len__() → _i_n_t_# │ │ │ │ + __len__() → int_# │ │ │ │ Return the number of items in the list. │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ _N_e_x_t │ │ │ │ _C_o_m_m_e_n_t_F_o_r_e_s_t │ │ │ │ _P_r_e_v_i_o_u_s │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/button.html │ │ │ @@ -355,15 +355,15 @@ │ │ │ │ │ │ │ │ │
      │ │ │
      │ │ │

      Button#

      │ │ │
      │ │ │
      │ │ │ -class praw.models.Button(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])#
      │ │ │ +class praw.models.Button(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])# │ │ │

      Class to represent a single button inside a ButtonWidget.

      │ │ │

      Typical Attributes

      │ │ │
      │ │ │

      Note

      │ │ │

      This table describes attributes that typically belong to objects of this class. PRAW │ │ │ dynamically provides the attributes that Reddit returns via the API. Since those │ │ │ attributes are subject to change on Reddit’s end, PRAW makes no effort to document │ │ │ @@ -419,26 +419,26 @@ │ │ │

      Image width. Only present on image buttons.

      │ │ │ │ │ │ │ │ │ │ │ │
      │ │ │
      │ │ │
      │ │ │ -__init__(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])#
      │ │ │ +__init__(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])# │ │ │

      Initialize a PRAWBase instance.

      │ │ │
      │ │ │
      Parameters:
      │ │ │

      reddit – An instance of Reddit.

      │ │ │
      │ │ │
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
      │ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

      Return an instance of cls from data.

      │ │ │
      │ │ │
      Parameters:
      │ │ │
        │ │ │

      • data – The structured data.

        • │ │ │

      • reddit – An instance of Reddit.

        • │ │ │
      │ │ │ ├── html2text {} │ │ │ │ @@ -161,16 +161,16 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ BBuuttttoonn_## ************ │ │ │ │ - ccllaassss praw.models.Button(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, │ │ │ │ - _AA_nn_yy]]]])_# │ │ │ │ + ccllaassss praw.models.Button(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, │ │ │ │ + AAnnyy]]]])_# │ │ │ │ Class to represent a single button inside a _B_u_t_t_o_n_W_i_d_g_e_t. │ │ │ │ TTyyppiiccaall AAttttrriibbuutteess │ │ │ │ Note │ │ │ │ This table describes attributes that typically belong to objects of this │ │ │ │ class. PRAW dynamically provides the attributes that Reddit returns via │ │ │ │ the API. Since those attributes are subject to change on Reddit’s end, │ │ │ │ PRAW makes no effort to document any new/removed/changed attributes, │ │ │ │ @@ -191,19 +191,19 @@ │ │ │ │ text The text displayed on the button. │ │ │ │ textColor The hex color for the text of the button. │ │ │ │ * If the button is a text button, a link that can be │ │ │ │ url visited by clicking the button. │ │ │ │ * If the button is an image button, the URL of a Reddit- │ │ │ │ hosted image. │ │ │ │ width Image width. Only present on image buttons. │ │ │ │ - __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]]]])_# │ │ │ │ + __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, AAnnyy]]]])_# │ │ │ │ Initialize a _P_R_A_W_B_a_s_e instance. │ │ │ │ Parameters: │ │ │ │ rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ _N_e_x_t │ │ │ │ _B_u_t_t_o_n_W_i_d_g_e_t │ │ │ │ _P_r_e_v_i_o_u_s │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/buttonwidget.html │ │ │ @@ -355,15 +355,15 @@ │ │ │ │ │ │ │ │ │
      │ │ │
      │ │ │

      ButtonWidget#

      │ │ │
      │ │ │
      │ │ │ -class praw.models.ButtonWidget(reddit: praw.Reddit, _data: Dict[str, Any])#
      │ │ │ +class praw.models.ButtonWidget(reddit: praw.Reddit, _data: Dict[str, Any])# │ │ │

      Class to represent a widget containing one or more buttons.

      │ │ │

      Find an existing one:

      │ │ │ 
      button_widget = None
│ │ │  widgets = reddit.subreddit("test").widgets
│ │ │  for widget in widgets.sidebar:
│ │ │      if isinstance(widget, praw.models.ButtonWidget):
│ │ │          button_widget = widget
│ │ │ @@ -464,39 +464,39 @@
│ │ │  
      The Subreddit the button widget belongs to.
      
│ │ │  
│ │ │  
│ │ │  
│ │ │
      │ │ │
      │ │ │
      │ │ │ -__contains__(item: Any) → bool#
      │ │ │ +__contains__(item: Any) → bool# │ │ │

      Test if item exists in the list.

      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ -__getitem__(index: int) → Any#
      │ │ │ +__getitem__(index: int) → Any# │ │ │

      Return the item at position index in the list.

      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ -__init__(reddit: praw.Reddit, _data: Dict[str, Any])#
      │ │ │ +__init__(reddit: praw.Reddit, _data: Dict[str, Any])# │ │ │

      Initialize a Widget instance.

      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ -__iter__() → Iterator[Any]#
      │ │ │ +__iter__() → Iterator[Any]# │ │ │

      Return an iterator to the list.

      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ -__len__() → int#
      │ │ │ +__len__() → int# │ │ │

      Return the number of items in the list.

      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ mod() → praw.models.WidgetModeration#
      │ │ │

      Get an instance of WidgetModeration for this widget.

      │ │ │ @@ -506,15 +506,15 @@ │ │ │ data in the SubredditWidgets that this widget belongs to outdated. │ │ │ To remedy this, call refresh().

      │ │ │
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
      │ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

      Return an instance of cls from data.

      │ │ │
      │ │ │
      Parameters:
      │ │ │
        │ │ │

      • data – The structured data.

        • │ │ │

      • reddit – An instance of Reddit.

        • │ │ │
      │ │ │ ├── html2text {} │ │ │ │ @@ -161,15 +161,15 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ BBuuttttoonnWWiiddggeett_## ************ │ │ │ │ - ccllaassss praw.models.ButtonWidget(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]])_# │ │ │ │ + ccllaassss praw.models.ButtonWidget(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]])_# │ │ │ │ Class to represent a widget containing one or more buttons. │ │ │ │ Find an existing one: │ │ │ │ button_widget = None │ │ │ │ widgets = reddit.subreddit("test").widgets │ │ │ │ for widget in widgets.sidebar: │ │ │ │ if isinstance(widget, praw.models.ButtonWidget): │ │ │ │ button_widget = widget │ │ │ │ @@ -235,31 +235,31 @@ │ │ │ │ description_html The description, in HTML. │ │ │ │ id The widget ID. │ │ │ │ kind The widget kind (always "button"). │ │ │ │ shortName The short name of the widget. │ │ │ │ styles A dict with the keys "backgroundColor" and │ │ │ │ "headerColor". │ │ │ │ subreddit The _S_u_b_r_e_d_d_i_t the button widget belongs to. │ │ │ │ - __contains__(iitteemm:: _AA_nn_yy) → _b_o_o_l_# │ │ │ │ + __contains__(iitteemm:: AAnnyy) → bool_# │ │ │ │ Test if item exists in the list. │ │ │ │ - __getitem__(iinnddeexx:: _ii_nn_tt) → _A_n_y_# │ │ │ │ + __getitem__(iinnddeexx:: iinntt) → Any_# │ │ │ │ Return the item at position index in the list. │ │ │ │ - __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]])_# │ │ │ │ + __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]])_# │ │ │ │ Initialize a _W_i_d_g_e_t instance. │ │ │ │ - __iter__() → _I_t_e_r_a_t_o_r[_A_n_y]_# │ │ │ │ + __iter__() → Iterator[Any]_# │ │ │ │ Return an iterator to the list. │ │ │ │ - __len__() → _i_n_t_# │ │ │ │ + __len__() → int_# │ │ │ │ Return the number of items in the list. │ │ │ │ mod() → _p_r_a_w_._m_o_d_e_l_s_._W_i_d_g_e_t_M_o_d_e_r_a_t_i_o_n_# │ │ │ │ Get an instance of _W_i_d_g_e_t_M_o_d_e_r_a_t_i_o_n for this widget. │ │ │ │ Note │ │ │ │ Using any of the methods of _W_i_d_g_e_t_M_o_d_e_r_a_t_i_o_n will likely make the │ │ │ │ data in the _S_u_b_r_e_d_d_i_t_W_i_d_g_e_t_s that this widget belongs to outdated. │ │ │ │ To remedy this, call _r_e_f_r_e_s_h_(_). │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ _N_e_x_t │ │ │ │ _C_a_l_e_n_d_a_r │ │ │ │ _P_r_e_v_i_o_u_s │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/calendar.html │ │ │ @@ -355,15 +355,15 @@ │ │ │ │ │ │ │ │ │
      │ │ │
      │ │ │

      Calendar#

      │ │ │
      │ │ │
      │ │ │ -class praw.models.Calendar(reddit: praw.Reddit, _data: Dict[str, Any])#
      │ │ │ +class praw.models.Calendar(reddit: praw.Reddit, _data: Dict[str, Any])# │ │ │

      Class to represent a calendar widget.

      │ │ │

      Find an existing one:

      │ │ │ 
      calendar = None
│ │ │  widgets = reddit.subreddit("test").widgets
│ │ │  for widget in widgets.sidebar:
│ │ │      if isinstance(widget, praw.models.Calendar):
│ │ │          calendar = widget
│ │ │ @@ -450,15 +450,15 @@
│ │ │  
      The Subreddit the button widget belongs to.
      
│ │ │  
│ │ │  
│ │ │  
│ │ │
      │ │ │
      │ │ │
      │ │ │ -__init__(reddit: praw.Reddit, _data: Dict[str, Any])#
      │ │ │ +__init__(reddit: praw.Reddit, _data: Dict[str, Any])# │ │ │

      Initialize a Widget instance.

      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ mod() → praw.models.WidgetModeration#
      │ │ │

      Get an instance of WidgetModeration for this widget.

      │ │ │ @@ -468,15 +468,15 @@ │ │ │ data in the SubredditWidgets that this widget belongs to outdated. │ │ │ To remedy this, call refresh().

      │ │ │
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
      │ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

      Return an instance of cls from data.

      │ │ │
      │ │ │
      Parameters:
      │ │ │
        │ │ │

      • data – The structured data.

        • │ │ │

      • reddit – An instance of Reddit.

        • │ │ │
      │ │ │ ├── html2text {} │ │ │ │ @@ -161,15 +161,15 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ CCaalleennddaarr_## ************ │ │ │ │ - ccllaassss praw.models.Calendar(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]])_# │ │ │ │ + ccllaassss praw.models.Calendar(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]])_# │ │ │ │ Class to represent a calendar widget. │ │ │ │ Find an existing one: │ │ │ │ calendar = None │ │ │ │ widgets = reddit.subreddit("test").widgets │ │ │ │ for widget in widgets.sidebar: │ │ │ │ if isinstance(widget, praw.models.Calendar): │ │ │ │ calendar = widget │ │ │ │ @@ -219,23 +219,23 @@ │ │ │ │ id The widget ID. │ │ │ │ kind The widget kind (always "calendar"). │ │ │ │ requiresSync A bool representing whether the calendar requires │ │ │ │ synchronization. │ │ │ │ shortName The short name of the widget. │ │ │ │ styles A dict with the keys "backgroundColor" and "headerColor". │ │ │ │ subreddit The _S_u_b_r_e_d_d_i_t the button widget belongs to. │ │ │ │ - __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]])_# │ │ │ │ + __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]])_# │ │ │ │ Initialize a _W_i_d_g_e_t instance. │ │ │ │ mod() → _p_r_a_w_._m_o_d_e_l_s_._W_i_d_g_e_t_M_o_d_e_r_a_t_i_o_n_# │ │ │ │ Get an instance of _W_i_d_g_e_t_M_o_d_e_r_a_t_i_o_n for this widget. │ │ │ │ Note │ │ │ │ Using any of the methods of _W_i_d_g_e_t_M_o_d_e_r_a_t_i_o_n will likely make the │ │ │ │ data in the _S_u_b_r_e_d_d_i_t_W_i_d_g_e_t_s that this widget belongs to outdated. │ │ │ │ To remedy this, call _r_e_f_r_e_s_h_(_). │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ _N_e_x_t │ │ │ │ _C_a_l_e_n_d_a_r_C_o_n_f_i_g_u_r_a_t_i_o_n │ │ │ │ _P_r_e_v_i_o_u_s │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/calendarconfiguration.html │ │ │ @@ -355,15 +355,15 @@ │ │ │ │ │ │ │ │ │
      │ │ │
      │ │ │

      CalendarConfiguration#

      │ │ │
      │ │ │
      │ │ │ -class praw.models.CalendarConfiguration(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])#
      │ │ │ +class praw.models.CalendarConfiguration(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])# │ │ │

      Class to represent the configuration of a Calendar.

      │ │ │

      Typical Attributes

      │ │ │
      │ │ │

      Note

      │ │ │

      This table describes attributes that typically belong to objects of this class. PRAW │ │ │ dynamically provides the attributes that Reddit returns via the API. Since those │ │ │ attributes are subject to change on Reddit’s end, PRAW makes no effort to document │ │ │ @@ -400,26 +400,26 @@ │ │ │

      Whether to show the titles of events.

      │ │ │ │ │ │ │ │ │ │ │ │
      │ │ │
      │ │ │
      │ │ │ -__init__(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])#
      │ │ │ +__init__(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])# │ │ │

      Initialize a PRAWBase instance.

      │ │ │
      │ │ │
      Parameters:
      │ │ │

      reddit – An instance of Reddit.

      │ │ │
      │ │ │
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
      │ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

      Return an instance of cls from data.

      │ │ │
      │ │ │
      Parameters:
      │ │ │
        │ │ │

      • data – The structured data.

        • │ │ │

      • reddit – An instance of Reddit.

        • │ │ │
      │ │ │ ├── html2text {} │ │ │ │ @@ -161,16 +161,16 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ CCaalleennddaarrCCoonnffiigguurraattiioonn_## ************ │ │ │ │ - ccllaassss praw.models.CalendarConfiguration(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll │ │ │ │ - [[_DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]]]])_# │ │ │ │ + ccllaassss praw.models.CalendarConfiguration(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: OOppttiioonnaall │ │ │ │ + [[DDiicctt[[ssttrr,, AAnnyy]]]])_# │ │ │ │ Class to represent the configuration of a _C_a_l_e_n_d_a_r. │ │ │ │ TTyyppiiccaall AAttttrriibbuutteess │ │ │ │ Note │ │ │ │ This table describes attributes that typically belong to objects of this │ │ │ │ class. PRAW dynamically provides the attributes that Reddit returns via │ │ │ │ the API. Since those attributes are subject to change on Reddit’s end, │ │ │ │ PRAW makes no effort to document any new/removed/changed attributes, │ │ │ │ @@ -182,19 +182,19 @@ │ │ │ │ AAttttrriibbuuttee DDeessccrriippttiioonn │ │ │ │ numEvents The number of events to display on the calendar. │ │ │ │ showDate Whether to show the dates of events. │ │ │ │ showDescription Whether to show the descriptions of events. │ │ │ │ showLocation Whether to show the locations of events. │ │ │ │ showTime Whether to show the times of events. │ │ │ │ showTitle Whether to show the titles of events. │ │ │ │ - __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]]]])_# │ │ │ │ + __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, AAnnyy]]]])_# │ │ │ │ Initialize a _P_R_A_W_B_a_s_e instance. │ │ │ │ Parameters: │ │ │ │ rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ _N_e_x_t │ │ │ │ _C_o_m_m_u_n_i_t_y_L_i_s_t │ │ │ │ _P_r_e_v_i_o_u_s │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/collection.html │ │ │ @@ -355,15 +355,15 @@ │ │ │ │ │ │ │ │ │
      │ │ │
      │ │ │

      Collection#

      │ │ │
      │ │ │
      │ │ │ -class praw.models.Collection(reddit: praw.Reddit, _data: Dict[str, Any] = None, collection_id: Optional[str] = None, permalink: Optional[str] = None)#
      │ │ │ +class praw.models.Collection(reddit: praw.Reddit, _data: Dict[str, Any] = None, collection_id: Optional[str] = None, permalink: Optional[str] = None)# │ │ │

      Class to represent a Collection.

      │ │ │

      Obtain an instance via:

      │ │ │ 
      collection = reddit.subreddit("test").collections("some_uuid")
│ │ │
      │ │ │
      │ │ │

      or

      │ │ │ 
      collection = reddit.subreddit("test").collections(
│ │ │ @@ -423,15 +423,15 @@
│ │ │  
      The title of the collection.
      
│ │ │  
│ │ │  
│ │ │  
│ │ │
      │ │ │
      │ │ │
      │ │ │ -__init__(reddit: praw.Reddit, _data: Dict[str, Any] = None, collection_id: Optional[str] = None, permalink: Optional[str] = None)#
      │ │ │ +__init__(reddit: praw.Reddit, _data: Dict[str, Any] = None, collection_id: Optional[str] = None, permalink: Optional[str] = None)# │ │ │

      Initialize a Collection instance.

      │ │ │
      │ │ │
      Parameters:
      │ │ │
        │ │ │

      • reddit – An instance of Reddit.

        • │ │ │

      • _data – Any data associated with the Collection.

        • │ │ │

      • collection_id – The ID of the Collection.

        • │ │ │ @@ -439,27 +439,27 @@ │ │ │
      │ │ │
      │ │ │
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ -__iter__() → Generator[Any, None, None]#
      │ │ │ +__iter__() → Generator[Any, None, None]# │ │ │

      Provide a way to iterate over the posts in this Collection.

      │ │ │

      Example usage:

      │ │ │ 
      collection = reddit.subreddit("test").collections("some_uuid")
│ │ │  for submission in collection:
│ │ │      print(submission.title, submission.permalink)
│ │ │
      │ │ │
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ -__len__() → int#
      │ │ │ +__len__() → int# │ │ │

      Get the number of posts in this Collection.

      │ │ │

      Example usage:

      │ │ │ 
      collection = reddit.subreddit("test").collections("some_uuid")
│ │ │  print(len(collection))
│ │ │
      │ │ │
      │ │ │
      │ │ │ @@ -491,15 +491,15 @@ │ │ │ collection.mod.update_title("My new title!") │ │ │
      │ │ │ │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
      │ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

      Return an instance of cls from data.

      │ │ │
      │ │ │
      Parameters:
      │ │ │
        │ │ │

      • data – The structured data.

        • │ │ │

      • reddit – An instance of Reddit.

        • │ │ │
      │ │ │ ├── html2text {} │ │ │ │ @@ -161,16 +161,16 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ CCoolllleeccttiioonn_## ************ │ │ │ │ - ccllaassss praw.models.Collection(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]] == │ │ │ │ - NNoonnee, ccoolllleeccttiioonn__iidd:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, ppeerrmmaalliinnkk:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee)_# │ │ │ │ + ccllaassss praw.models.Collection(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]] == │ │ │ │ + NNoonnee, ccoolllleeccttiioonn__iidd:: OOppttiioonnaall[[ssttrr]] == NNoonnee, ppeerrmmaalliinnkk:: OOppttiioonnaall[[ssttrr]] == NNoonnee)_# │ │ │ │ Class to represent a _C_o_l_l_e_c_t_i_o_n. │ │ │ │ Obtain an instance via: │ │ │ │ collection = reddit.subreddit("test").collections("some_uuid") │ │ │ │ or │ │ │ │ collection = reddit.subreddit("test").collections( │ │ │ │ permalink="https://reddit.com/r/SUBREDDIT/collection/some_uuid" │ │ │ │ ) │ │ │ │ @@ -194,29 +194,29 @@ │ │ │ │ display_layout The collection display layout. │ │ │ │ last_update_utc Time the collection was last updated, represented in _U_n_i_x │ │ │ │ _T_i_m_e. │ │ │ │ link_ids A list of _S_u_b_m_i_s_s_i_o_n fullnames. │ │ │ │ permalink The collection’s permalink (to view on the web). │ │ │ │ sorted_links An iterable listing of the posts in this collection. │ │ │ │ title The title of the collection. │ │ │ │ - __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]] == NNoonnee, │ │ │ │ - ccoolllleeccttiioonn__iidd:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, ppeerrmmaalliinnkk:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee)_# │ │ │ │ + __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]] == NNoonnee, │ │ │ │ + ccoolllleeccttiioonn__iidd:: OOppttiioonnaall[[ssttrr]] == NNoonnee, ppeerrmmaalliinnkk:: OOppttiioonnaall[[ssttrr]] == NNoonnee)_# │ │ │ │ Initialize a _C_o_l_l_e_c_t_i_o_n instance. │ │ │ │ Parameters: │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ * __ddaattaa – Any data associated with the _C_o_l_l_e_c_t_i_o_n. │ │ │ │ * ccoolllleeccttiioonn__iidd – The ID of the _C_o_l_l_e_c_t_i_o_n. │ │ │ │ * ppeerrmmaalliinnkk – The permalink of the _C_o_l_l_e_c_t_i_o_n. │ │ │ │ - __iter__() → _G_e_n_e_r_a_t_o_r[_A_n_y, _N_o_n_e, _N_o_n_e]_# │ │ │ │ + __iter__() → Generator[Any, None, None]_# │ │ │ │ Provide a way to iterate over the posts in this _C_o_l_l_e_c_t_i_o_n. │ │ │ │ Example usage: │ │ │ │ collection = reddit.subreddit("test").collections("some_uuid") │ │ │ │ for submission in collection: │ │ │ │ print(submission.title, submission.permalink) │ │ │ │ - __len__() → _i_n_t_# │ │ │ │ + __len__() → int_# │ │ │ │ Get the number of posts in this _C_o_l_l_e_c_t_i_o_n. │ │ │ │ Example usage: │ │ │ │ collection = reddit.subreddit("test").collections("some_uuid") │ │ │ │ print(len(collection)) │ │ │ │ follow()_# │ │ │ │ Follow this _C_o_l_l_e_c_t_i_o_n. │ │ │ │ Example usage: │ │ │ │ @@ -226,15 +226,15 @@ │ │ │ │ mod() → _C_o_l_l_e_c_t_i_o_n_M_o_d_e_r_a_t_i_o_n_# │ │ │ │ Get an instance of _C_o_l_l_e_c_t_i_o_n_M_o_d_e_r_a_t_i_o_n. │ │ │ │ Provides access to various methods, including _a_d_d___p_o_s_t_(_), _d_e_l_e_t_e_(_), │ │ │ │ _r_e_o_r_d_e_r_(_), and _u_p_d_a_t_e___t_i_t_l_e_(_). │ │ │ │ Example usage: │ │ │ │ collection = reddit.subreddit("test").collections("some_uuid") │ │ │ │ collection.mod.update_title("My new title!") │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ subreddit() → _p_r_a_w_._m_o_d_e_l_s_._S_u_b_r_e_d_d_i_t_# │ │ │ │ Get the subreddit that this collection belongs to. │ │ │ │ For example: │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/collectionmoderation.html │ │ │ @@ -355,23 +355,23 @@ │ │ │ │ │ │ │ │ │
      │ │ │
      │ │ │

      CollectionModeration#

      │ │ │
      │ │ │
      │ │ │ -class praw.models.reddit.collections.CollectionModeration(reddit: praw.Reddit, collection_id: str)#
      │ │ │ +class praw.models.reddit.collections.CollectionModeration(reddit: praw.Reddit, collection_id: str)# │ │ │

      Class to support moderation actions on a Collection.

      │ │ │

      Obtain an instance via:

      │ │ │ 
      reddit.subreddit("test").collections("some_uuid").mod
│ │ │
      │ │ │
      │ │ │
      │ │ │
      │ │ │ -__init__(reddit: praw.Reddit, collection_id: str)#
      │ │ │ +__init__(reddit: praw.Reddit, collection_id: str)# │ │ │

      Initialize a CollectionModeration instance.

      │ │ │
      │ │ │
      Parameters:
      │ │ │

      collection_id – The ID of a Collection.

      │ │ │
      │ │ │
      │ │ │
      │ │ │ @@ -409,15 +409,15 @@ │ │ │

      See also

      │ │ │

      create()

      │ │ │ │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
      │ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

      Return an instance of cls from data.

      │ │ │
      │ │ │
      Parameters:
      │ │ │
        │ │ │

      • data – The structured data.

        • │ │ │

      • reddit – An instance of Reddit.

        • │ │ │
      │ │ │ @@ -444,15 +444,15 @@ │ │ │

      See also

      │ │ │

      add_post()

      │ │ │ │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ -reorder(links: List[Union[str, praw.models.Submission]])#
      │ │ │ +reorder(links: List[Union[str, praw.models.Submission]])# │ │ │

      Reorder posts in the collection.

      │ │ │
      │ │ │
      Parameters:
      │ │ │

      links – A list of Submissions or a str that is either a │ │ │ fullname or an ID.

      │ │ │
      │ │ │
      │ │ │ @@ -463,15 +463,15 @@ │ │ │ collection.mod.reorder(new_order) │ │ │ │ │ │ │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ -update_description(description: str)#
      │ │ │ +update_description(description: str)# │ │ │

      Update the collection’s description.

      │ │ │
      │ │ │
      Parameters:
      │ │ │

      description – The new description.

      │ │ │
      │ │ │
      │ │ │

      Example usage:

      │ │ │ @@ -483,15 +483,15 @@ │ │ │

      See also

      │ │ │

      update_title()

      │ │ │ │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ -update_display_layout(display_layout: str)#
      │ │ │ +update_display_layout(display_layout: str)# │ │ │

      Update the collection’s display layout.

      │ │ │
      │ │ │
      Parameters:
      │ │ │

      display_layout – Either "TIMELINE" for events or discussions or │ │ │ "GALLERY" for images or memes. Passing None will clear the set │ │ │ layout and collection.display_layout will be None, however, the │ │ │ collection will appear on Reddit as if display_layout is set to │ │ │ @@ -503,15 +503,15 @@ │ │ │ collection.mod.update_display_layout("GALLERY") │ │ │ │ │ │ │ │ │

      │ │ │ │ │ │
      │ │ │
      │ │ │ -update_title(title: str)#
      │ │ │ +update_title(title: str)# │ │ │

      Update the collection’s title.

      │ │ │
      │ │ │
      Parameters:
      │ │ │

      title – The new title.

      │ │ │
      │ │ │
      │ │ │

      Example usage:

      │ │ │ ├── html2text {} │ │ │ │ @@ -162,19 +162,19 @@ │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ CCoolllleeccttiioonnMMooddeerraattiioonn_## ************ │ │ │ │ ccllaassss praw.models.reddit.collections.CollectionModeration(rreeddddiitt:: │ │ │ │ - _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, ccoolllleeccttiioonn__iidd:: _ss_tt_rr)_# │ │ │ │ + _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, ccoolllleeccttiioonn__iidd:: ssttrr)_# │ │ │ │ Class to support moderation actions on a _C_o_l_l_e_c_t_i_o_n. │ │ │ │ Obtain an instance via: │ │ │ │ reddit.subreddit("test").collections("some_uuid").mod │ │ │ │ - __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, ccoolllleeccttiioonn__iidd:: _ss_tt_rr)_# │ │ │ │ + __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, ccoolllleeccttiioonn__iidd:: ssttrr)_# │ │ │ │ Initialize a _C_o_l_l_e_c_t_i_o_n_M_o_d_e_r_a_t_i_o_n instance. │ │ │ │ Parameters: │ │ │ │ ccoolllleeccttiioonn__iidd – The ID of a _C_o_l_l_e_c_t_i_o_n. │ │ │ │ add_post(ssuubbmmiissssiioonn:: _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_mm_ii_ss_ss_ii_oo_nn)_# │ │ │ │ Add a post to the collection. │ │ │ │ Parameters: │ │ │ │ ssuubbmmiissssiioonn – The post to add, a _S_u_b_m_i_s_s_i_o_n, its permalink as │ │ │ │ @@ -186,60 +186,60 @@ │ │ │ │ _r_e_m_o_v_e___p_o_s_t_(_) │ │ │ │ delete()_# │ │ │ │ Delete this collection. │ │ │ │ Example usage: │ │ │ │ reddit.subreddit("test").collections("some_uuid").mod.delete() │ │ │ │ See also │ │ │ │ _c_r_e_a_t_e_(_) │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ remove_post(ssuubbmmiissssiioonn:: _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_mm_ii_ss_ss_ii_oo_nn)_# │ │ │ │ Remove a post from the collection. │ │ │ │ Parameters: │ │ │ │ ssuubbmmiissssiioonn – The post to remove, a _S_u_b_m_i_s_s_i_o_n, its permalink │ │ │ │ as a str, its fullname as a str, or its ID as a str. │ │ │ │ Example usage: │ │ │ │ collection = reddit.subreddit("test").collections("some_uuid") │ │ │ │ collection.mod.remove_post("bgibu9") │ │ │ │ See also │ │ │ │ _a_d_d___p_o_s_t_(_) │ │ │ │ - reorder(lliinnkkss:: _LL_ii_ss_tt[[_UU_nn_ii_oo_nn[[_ss_tt_rr,, _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_mm_ii_ss_ss_ii_oo_nn]]]])_# │ │ │ │ + reorder(lliinnkkss:: LLiisstt[[UUnniioonn[[ssttrr,, _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_mm_ii_ss_ss_ii_oo_nn]]]])_# │ │ │ │ Reorder posts in the collection. │ │ │ │ Parameters: │ │ │ │ lliinnkkss – A list of _S_u_b_m_i_s_s_i_o_ns or a str that is either a │ │ │ │ fullname or an ID. │ │ │ │ Example usage: │ │ │ │ collection = reddit.subreddit("test").collections("some_uuid") │ │ │ │ current_order = collection.link_ids │ │ │ │ new_order = reversed(current_order) │ │ │ │ collection.mod.reorder(new_order) │ │ │ │ - update_description(ddeessccrriippttiioonn:: _ss_tt_rr)_# │ │ │ │ + update_description(ddeessccrriippttiioonn:: ssttrr)_# │ │ │ │ Update the collection’s description. │ │ │ │ Parameters: │ │ │ │ ddeessccrriippttiioonn – The new description. │ │ │ │ Example usage: │ │ │ │ collection = reddit.subreddit("test").collections("some_uuid") │ │ │ │ collection.mod.update_description("Please enjoy these links!") │ │ │ │ See also │ │ │ │ _u_p_d_a_t_e___t_i_t_l_e_(_) │ │ │ │ - update_display_layout(ddiissppllaayy__llaayyoouutt:: _ss_tt_rr)_# │ │ │ │ + update_display_layout(ddiissppllaayy__llaayyoouutt:: ssttrr)_# │ │ │ │ Update the collection’s display layout. │ │ │ │ Parameters: │ │ │ │ ddiissppllaayy__llaayyoouutt – Either "TIMELINE" for events or discussions │ │ │ │ or "GALLERY" for images or memes. Passing None will clear the │ │ │ │ set layout and collection.display_layout will be None, │ │ │ │ however, the collection will appear on Reddit as if │ │ │ │ display_layout is set to "TIMELINE". │ │ │ │ Example usage: │ │ │ │ collection = reddit.subreddit("test").collections("some_uuid") │ │ │ │ collection.mod.update_display_layout("GALLERY") │ │ │ │ - update_title(ttiittllee:: _ss_tt_rr)_# │ │ │ │ + update_title(ttiittllee:: ssttrr)_# │ │ │ │ Update the collection’s title. │ │ │ │ Parameters: │ │ │ │ ttiittllee – The new title. │ │ │ │ Example usage: │ │ │ │ collection = reddit.subreddit("test").collections("some_uuid") │ │ │ │ collection.mod.update_title("Titley McTitleface") │ │ │ │ See also │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/commentforest.html │ │ │ @@ -355,20 +355,20 @@ │ │ │ │ │ │ │ │ │
      │ │ │
      │ │ │

      CommentForest#

      │ │ │
      │ │ │
      │ │ │ -class praw.models.comment_forest.CommentForest(submission: praw.models.Submission, comments: Optional[List[praw.models.Comment]] = None)#
      │ │ │ +class praw.models.comment_forest.CommentForest(submission: praw.models.Submission, comments: Optional[List[praw.models.Comment]] = None)# │ │ │

      A forest of comments starts with multiple top-level comments.

      │ │ │

      Each of these comments can be a tree of replies.

      │ │ │
      │ │ │
      │ │ │ -__getitem__(index: int)#
      │ │ │ +__getitem__(index: int)# │ │ │

      Return the comment at position index in the list.

      │ │ │

      This method is to be used like an array access, such as:

      │ │ │ 
      first_comment = submission.comments[0]
│ │ │
      │ │ │
      │ │ │

      Alternatively, the presence of this method enables one to iterate over all top │ │ │ level comments, like so:

      │ │ │ @@ -376,15 +376,15 @@ │ │ │ print(comment.body) │ │ │ │ │ │ │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ -__init__(submission: praw.models.Submission, comments: Optional[List[praw.models.Comment]] = None)#
      │ │ │ +__init__(submission: praw.models.Submission, comments: Optional[List[praw.models.Comment]] = None)# │ │ │

      Initialize a CommentForest instance.

      │ │ │
      │ │ │
      Parameters:
      │ │ │
        │ │ │

      • submission – An instance of Submission that is the parent of the │ │ │ comments.

        • │ │ │

      • comments – Initialize the forest with a list of comments (default: │ │ │ @@ -392,29 +392,29 @@ │ │ │

      │ │ │
      │ │ │
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ -__len__() → int#
      │ │ │ +__len__() → int# │ │ │

      Return the number of top-level comments in the forest.

      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ -list() → List[Union[praw.models.Comment, praw.models.MoreComments]]#
      │ │ │ +list() → List[Union[praw.models.Comment, praw.models.MoreComments]]# │ │ │

      Return a flattened list of all comments.

      │ │ │

      This list may contain MoreComments instances if replace_more() │ │ │ was not called first.

      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ -replace_more(*, limit: Optional[int] = 32, threshold: int = 0) → List[praw.models.MoreComments]#
      │ │ │ +replace_more(*, limit: Optional[int] = 32, threshold: int = 0) → List[praw.models.MoreComments]# │ │ │

      Update the comment forest by resolving instances of MoreComments.

      │ │ │
      │ │ │
      Parameters:
      │ │ │
        │ │ │

      • limit – The maximum number of MoreComments instances to replace. │ │ │ Each replacement requires 1 API request. Set to None to have no limit, │ │ │ or to 0 to remove all MoreComments instances without │ │ │ ├── html2text {} │ │ │ │ @@ -162,41 +162,41 @@ │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ CCoommmmeennttFFoorreesstt_## ************ │ │ │ │ ccllaassss praw.models.comment_forest.CommentForest(ssuubbmmiissssiioonn:: │ │ │ │ - _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_mm_ii_ss_ss_ii_oo_nn, ccoommmmeennttss:: _OO_pp_tt_ii_oo_nn_aa_ll[[_LL_ii_ss_tt[[_pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._CC_oo_mm_mm_ee_nn_tt]]]] == │ │ │ │ + _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_mm_ii_ss_ss_ii_oo_nn, ccoommmmeennttss:: OOppttiioonnaall[[LLiisstt[[_pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._CC_oo_mm_mm_ee_nn_tt]]]] == │ │ │ │ NNoonnee)_# │ │ │ │ A forest of comments starts with multiple top-level comments. │ │ │ │ Each of these comments can be a tree of replies. │ │ │ │ - __getitem__(iinnddeexx:: _ii_nn_tt)_# │ │ │ │ + __getitem__(iinnddeexx:: iinntt)_# │ │ │ │ Return the comment at position index in the list. │ │ │ │ This method is to be used like an array access, such as: │ │ │ │ first_comment = submission.comments[0] │ │ │ │ Alternatively, the presence of this method enables one to iterate │ │ │ │ over all top level comments, like so: │ │ │ │ for comment in submission.comments: │ │ │ │ print(comment.body) │ │ │ │ - __init__(ssuubbmmiissssiioonn:: _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_mm_ii_ss_ss_ii_oo_nn, ccoommmmeennttss:: _OO_pp_tt_ii_oo_nn_aa_ll[[_LL_ii_ss_tt │ │ │ │ + __init__(ssuubbmmiissssiioonn:: _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_mm_ii_ss_ss_ii_oo_nn, ccoommmmeennttss:: OOppttiioonnaall[[LLiisstt │ │ │ │ [[_pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._CC_oo_mm_mm_ee_nn_tt]]]] == NNoonnee)_# │ │ │ │ Initialize a _C_o_m_m_e_n_t_F_o_r_e_s_t instance. │ │ │ │ Parameters: │ │ │ │ * ssuubbmmiissssiioonn – An instance of _S_u_b_m_i_s_s_i_o_n that is the │ │ │ │ parent of the comments. │ │ │ │ * ccoommmmeennttss – Initialize the forest with a list of │ │ │ │ comments (default: None). │ │ │ │ - __len__() → _i_n_t_# │ │ │ │ + __len__() → int_# │ │ │ │ Return the number of top-level comments in the forest. │ │ │ │ - list() → _L_i_s_t[_U_n_i_o_n[_p_r_a_w_._m_o_d_e_l_s_._C_o_m_m_e_n_t, _p_r_a_w_._m_o_d_e_l_s_._M_o_r_e_C_o_m_m_e_n_t_s]]_# │ │ │ │ + list() → List[Union[_p_r_a_w_._m_o_d_e_l_s_._C_o_m_m_e_n_t, _p_r_a_w_._m_o_d_e_l_s_._M_o_r_e_C_o_m_m_e_n_t_s]]_# │ │ │ │ Return a flattened list of all comments. │ │ │ │ This list may contain _M_o_r_e_C_o_m_m_e_n_t_s instances if _r_e_p_l_a_c_e___m_o_r_e_(_) was │ │ │ │ not called first. │ │ │ │ - replace_more(**, lliimmiitt:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ii_nn_tt]] == 3322, tthhrreesshhoolldd:: _ii_nn_tt == 00) → _L_i_s_t │ │ │ │ + replace_more(**, lliimmiitt:: OOppttiioonnaall[[iinntt]] == 3322, tthhrreesshhoolldd:: iinntt == 00) → List │ │ │ │ [_p_r_a_w_._m_o_d_e_l_s_._M_o_r_e_C_o_m_m_e_n_t_s]_# │ │ │ │ Update the comment forest by resolving instances of _M_o_r_e_C_o_m_m_e_n_t_s. │ │ │ │ Parameters: │ │ │ │ * lliimmiitt – The maximum number of _M_o_r_e_C_o_m_m_e_n_t_s instances to │ │ │ │ replace. Each replacement requires 1 API request. Set │ │ │ │ to None to have no limit, or to 0 to remove all │ │ │ │ _M_o_r_e_C_o_m_m_e_n_t_s instances without additional requests │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/commenthelper.html │ │ │ @@ -359,15 +359,15 @@ │ │ │

        CommentHelper#

        │ │ │
        │ │ │
        │ │ │ class praw.models.listing.mixins.subreddit.CommentHelper(subreddit: praw.models.Subreddit)#
        │ │ │

        Provide a set of functions to interact with a Subreddit’s comments.

        │ │ │
        │ │ │
        │ │ │ -__call__(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[praw.models.Comment]#
        │ │ │ +__call__(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[praw.models.Comment]# │ │ │

        Return a ListingGenerator for the Subreddit’s comments.

        │ │ │

        Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

        │ │ │

        This method should be used in a way similar to the example below:

        │ │ │ 
        for comment in reddit.subreddit("test").comments(limit=25):
│ │ │      print(comment.author)
│ │ │
        │ │ │ @@ -378,15 +378,15 @@ │ │ │
        │ │ │ __init__(subreddit: praw.models.Subreddit)#
        │ │ │

        Initialize a CommentHelper instance.

        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
        │ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

        Return an instance of cls from data.

        │ │ │
        │ │ │
        Parameters:
        │ │ │
          │ │ │

        • data – The structured data.

          • │ │ │

        • reddit – An instance of Reddit.

          • │ │ │
        │ │ │ ├── html2text {} │ │ │ │ @@ -164,25 +164,25 @@ │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ CCoommmmeennttHHeellppeerr_## ************ │ │ │ │ ccllaassss praw.models.listing.mixins.subreddit.CommentHelper(ssuubbrreeddddiitt:: │ │ │ │ _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt)_# │ │ │ │ Provide a set of functions to interact with a _S_u_b_r_e_d_d_i_t’s comments. │ │ │ │ - __call__(****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → │ │ │ │ - _I_t_e_r_a_t_o_r[_p_r_a_w_._m_o_d_e_l_s_._C_o_m_m_e_n_t]_# │ │ │ │ + __call__(****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → │ │ │ │ + Iterator[_p_r_a_w_._m_o_d_e_l_s_._C_o_m_m_e_n_t]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for the _S_u_b_r_e_d_d_i_t’s comments. │ │ │ │ Additional keyword arguments are passed in the initialization of │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r. │ │ │ │ This method should be used in a way similar to the example below: │ │ │ │ for comment in reddit.subreddit("test").comments(limit=25): │ │ │ │ print(comment.author) │ │ │ │ __init__(ssuubbrreeddddiitt:: _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt)_# │ │ │ │ Initialize a _C_o_m_m_e_n_t_H_e_l_p_e_r instance. │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ _N_e_x_t │ │ │ │ _C_o_n_f_i_g │ │ │ │ _P_r_e_v_i_o_u_s │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/commentmoderation.html │ │ │ @@ -393,15 +393,15 @@ │ │ │ submission.mod.approve() │ │ │ │ │ │ │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -author_notes(**generator_kwargs) → Generator[praw.models.ModNote, None, None]#
        │ │ │ +author_notes(**generator_kwargs) → Generator[praw.models.ModNote, None, None]# │ │ │

        Get the moderator notes for the author of this object in the subreddit it’s posted in.

        │ │ │
        │ │ │
        Parameters:
        │ │ │

        generator_kwargs – Additional keyword arguments are passed in the │ │ │ initialization of the moderator note generator.

        │ │ │
        │ │ │
        Returns:
        │ │ │ @@ -413,15 +413,15 @@ │ │ │ print(f"{note.label}: {note.note}") │ │ │ │ │ │ │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -create_note(*, label: Optional[str] = None, note: str, **other_settings) → praw.models.ModNote#
        │ │ │ +create_note(*, label: Optional[str] = None, note: str, **other_settings) → praw.models.ModNote# │ │ │

        Create a moderator note on the author of this object in the subreddit it’s posted in.

        │ │ │
        │ │ │
        Parameters:
        │ │ │
          │ │ │

        • label – The label for the note. As of this writing, this can be one of the │ │ │ following: "ABUSE_WARNING", "BAN", "BOT_BAN", │ │ │ "HELPFUL_USER", "PERMA_BAN", "SOLID_CONTRIBUTOR", │ │ │ @@ -440,15 +440,15 @@ │ │ │ 

          reddit.submission("92dd8").mod.create_note(label="HELPFUL_USER", note="Test note")
│ │ │
          │ │ │
          │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -distinguish(*, how: str = 'yes', sticky: bool = False)#
        │ │ │ +distinguish(*, how: str = 'yes', sticky: bool = False)# │ │ │

        Distinguish a Comment or Submission.

        │ │ │
        │ │ │
        Parameters:
        │ │ │
          │ │ │

        • how – One of "yes", "no", "admin", or "special". "yes" │ │ │ adds a moderator level distinguish. "no" removes any distinction. │ │ │ "admin" and "special" require special user privileges to use │ │ │ @@ -514,15 +514,15 @@ │ │ │

          See also

          │ │ │

          unlock()

          │ │ │ │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -remove(*, mod_note: str = '', spam: bool = False, reason_id: Optional[str] = None)#
        │ │ │ +remove(*, mod_note: str = '', spam: bool = False, reason_id: Optional[str] = None)# │ │ │

        Remove a Comment or Submission.

        │ │ │
        │ │ │
        Parameters:
        │ │ │
          │ │ │

        • mod_note – A message for the other moderators.

          • │ │ │

        • spam – When True, use the removal to help train the │ │ │ Subreddit’s spam filter (default: False).

          • │ │ │ @@ -545,15 +545,15 @@ │ │ │ submission.mod.remove(reason_id=reason.id) │ │ │ │ │ │ │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -send_removal_message(*, message: str, title: str = 'ignored', type: str = 'public') → Optional[praw.models.Comment]#
        │ │ │ +send_removal_message(*, message: str, title: str = 'ignored', type: str = 'public') → Optional[praw.models.Comment]# │ │ │

        Send a removal message for a Comment or Submission.

        │ │ │
        │ │ │

        Warning

        │ │ │

        The object has to be removed before giving it a removal reason. Remove the │ │ │ object with remove(). Trying to add a removal reason without removing │ │ │ the object will result in RedditAPIException being thrown with an │ │ │ INVALID_ID error_type.

        │ │ │ ├── html2text {} │ │ │ │ @@ -184,27 +184,27 @@ │ │ │ │ Example usage: │ │ │ │ # approve a comment: │ │ │ │ comment = reddit.comment("dkk4qjd") │ │ │ │ comment.mod.approve() │ │ │ │ # approve a submission: │ │ │ │ submission = reddit.submission("5or86n") │ │ │ │ submission.mod.approve() │ │ │ │ - author_notes(****ggeenneerraattoorr__kkwwaarrggss) → _G_e_n_e_r_a_t_o_r[_p_r_a_w_._m_o_d_e_l_s_._M_o_d_N_o_t_e, _N_o_n_e, │ │ │ │ - _N_o_n_e]_# │ │ │ │ + author_notes(****ggeenneerraattoorr__kkwwaarrggss) → Generator[_p_r_a_w_._m_o_d_e_l_s_._M_o_d_N_o_t_e, None, │ │ │ │ + None]_# │ │ │ │ Get the moderator notes for the author of this object in the │ │ │ │ subreddit it’s posted in. │ │ │ │ Parameters: │ │ │ │ ggeenneerraattoorr__kkwwaarrggss – Additional keyword arguments are passed in │ │ │ │ the initialization of the moderator note generator. │ │ │ │ Returns: │ │ │ │ A generator of _M_o_d_N_o_t_e. │ │ │ │ For example, to list all notes the author of a submission, try: │ │ │ │ for note in reddit.submission("92dd8").mod.author_notes(): │ │ │ │ print(f"{note.label}: {note.note}") │ │ │ │ - create_note(**, llaabbeell:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, nnoottee:: _ss_tt_rr, │ │ │ │ + create_note(**, llaabbeell:: OOppttiioonnaall[[ssttrr]] == NNoonnee, nnoottee:: ssttrr, │ │ │ │ ****ootthheerr__sseettttiinnggss) → _p_r_a_w_._m_o_d_e_l_s_._M_o_d_N_o_t_e_# │ │ │ │ Create a moderator note on the author of this object in the │ │ │ │ subreddit it’s posted in. │ │ │ │ Parameters: │ │ │ │ * llaabbeell – The label for the note. As of this writing, │ │ │ │ this can be one of the following: "ABUSE_WARNING", │ │ │ │ "BAN", "BOT_BAN", "HELPFUL_USER", "PERMA_BAN", │ │ │ │ @@ -215,15 +215,15 @@ │ │ │ │ * ootthheerr__sseettttiinnggss – Additional keyword arguments are │ │ │ │ passed to _c_r_e_a_t_e_(_). │ │ │ │ Returns: │ │ │ │ The new _M_o_d_N_o_t_e object. │ │ │ │ For example, to create a note on a _S_u_b_m_i_s_s_i_o_n, try: │ │ │ │ reddit.submission("92dd8").mod.create_note(label="HELPFUL_USER", │ │ │ │ note="Test note") │ │ │ │ - distinguish(**, hhooww:: _ss_tt_rr == ''yyeess'', ssttiicckkyy:: _bb_oo_oo_ll == FFaallssee)_# │ │ │ │ + distinguish(**, hhooww:: ssttrr == ''yyeess'', ssttiicckkyy:: bbooooll == FFaallssee)_# │ │ │ │ Distinguish a _C_o_m_m_e_n_t or _S_u_b_m_i_s_s_i_o_n. │ │ │ │ Parameters: │ │ │ │ * hhooww – One of "yes", "no", "admin", or "special". "yes" │ │ │ │ adds a moderator level distinguish. "no" removes any │ │ │ │ distinction. "admin" and "special" require special user │ │ │ │ privileges to use (default "yes"). │ │ │ │ * ssttiicckkyy – _C_o_m_m_e_n_t is stickied if True, placing it at the │ │ │ │ @@ -261,16 +261,16 @@ │ │ │ │ comment = reddit.comment("dkk4qjd") │ │ │ │ comment.mod.lock() │ │ │ │ # lock a submission: │ │ │ │ submission = reddit.submission("5or86n") │ │ │ │ submission.mod.lock() │ │ │ │ See also │ │ │ │ _u_n_l_o_c_k_(_) │ │ │ │ - remove(**, mmoodd__nnoottee:: _ss_tt_rr == '''', ssppaamm:: _bb_oo_oo_ll == FFaallssee, rreeaassoonn__iidd:: _OO_pp_tt_ii_oo_nn_aa_ll │ │ │ │ - [[_ss_tt_rr]] == NNoonnee)_# │ │ │ │ + remove(**, mmoodd__nnoottee:: ssttrr == '''', ssppaamm:: bbooooll == FFaallssee, rreeaassoonn__iidd:: OOppttiioonnaall │ │ │ │ + [[ssttrr]] == NNoonnee)_# │ │ │ │ Remove a _C_o_m_m_e_n_t or _S_u_b_m_i_s_s_i_o_n. │ │ │ │ Parameters: │ │ │ │ * mmoodd__nnoottee – A message for the other moderators. │ │ │ │ * ssppaamm – When True, use the removal to help train the │ │ │ │ _S_u_b_r_e_d_d_i_t’s spam filter (default: False). │ │ │ │ * rreeaassoonn__iidd – The removal reason ID. │ │ │ │ If either reason_id or mod_note are provided, a second API call is │ │ │ │ @@ -282,16 +282,16 @@ │ │ │ │ # remove a submission │ │ │ │ submission = reddit.submission("5or86n") │ │ │ │ submission.mod.remove() │ │ │ │ # remove a submission with a removal reason │ │ │ │ reason = reddit.subreddit.mod.removal_reasons["110ni21zo23ql"] │ │ │ │ submission = reddit.submission("5or86n") │ │ │ │ submission.mod.remove(reason_id=reason.id) │ │ │ │ - send_removal_message(**, mmeessssaaggee:: _ss_tt_rr, ttiittllee:: _ss_tt_rr == ''iiggnnoorreedd'', ttyyppee:: _ss_tt_rr │ │ │ │ - == ''ppuubblliicc'') → _O_p_t_i_o_n_a_l[_p_r_a_w_._m_o_d_e_l_s_._C_o_m_m_e_n_t]_# │ │ │ │ + send_removal_message(**, mmeessssaaggee:: ssttrr, ttiittllee:: ssttrr == ''iiggnnoorreedd'', ttyyppee:: ssttrr │ │ │ │ + == ''ppuubblliicc'') → Optional[_p_r_a_w_._m_o_d_e_l_s_._C_o_m_m_e_n_t]_# │ │ │ │ Send a removal message for a _C_o_m_m_e_n_t or _S_u_b_m_i_s_s_i_o_n. │ │ │ │ Warning │ │ │ │ The object has to be removed before giving it a removal reason. │ │ │ │ Remove the object with _r_e_m_o_v_e_(_). Trying to add a removal reason │ │ │ │ without removing the object will result in _R_e_d_d_i_t_A_P_I_E_x_c_e_p_t_i_o_n being │ │ │ │ thrown with an INVALID_ID error_type. │ │ │ │ Reddit adds human-readable information about the object to the │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/communitylist.html │ │ │ @@ -355,15 +355,15 @@ │ │ │ │ │ │
        │ │ │
        │ │ │
        │ │ │

        CommunityList#

        │ │ │
        │ │ │
        │ │ │ -class praw.models.CommunityList(reddit: praw.Reddit, _data: Dict[str, Any])#
        │ │ │ +class praw.models.CommunityList(reddit: praw.Reddit, _data: Dict[str, Any])# │ │ │

        Class to represent a Related Communities widget.

        │ │ │

        Find an existing one:

        │ │ │ 
        community_list = None
│ │ │  widgets = reddit.subreddit("test").widgets
│ │ │  for widget in widgets.sidebar:
│ │ │      if isinstance(widget, praw.models.CommunityList):
│ │ │          community_list = widget
│ │ │ @@ -435,39 +435,39 @@
│ │ │  
        The Subreddit the button widget belongs to.
        
│ │ │  
│ │ │  
│ │ │  
│ │ │
        │ │ │
        │ │ │
        │ │ │ -__contains__(item: Any) → bool#
        │ │ │ +__contains__(item: Any) → bool# │ │ │

        Test if item exists in the list.

        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -__getitem__(index: int) → Any#
        │ │ │ +__getitem__(index: int) → Any# │ │ │

        Return the item at position index in the list.

        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -__init__(reddit: praw.Reddit, _data: Dict[str, Any])#
        │ │ │ +__init__(reddit: praw.Reddit, _data: Dict[str, Any])# │ │ │

        Initialize a Widget instance.

        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -__iter__() → Iterator[Any]#
        │ │ │ +__iter__() → Iterator[Any]# │ │ │

        Return an iterator to the list.

        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -__len__() → int#
        │ │ │ +__len__() → int# │ │ │

        Return the number of items in the list.

        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ mod() → praw.models.WidgetModeration#
        │ │ │

        Get an instance of WidgetModeration for this widget.

        │ │ │ @@ -477,15 +477,15 @@ │ │ │ data in the SubredditWidgets that this widget belongs to outdated. │ │ │ To remedy this, call refresh().

        │ │ │
        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
        │ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

        Return an instance of cls from data.

        │ │ │
        │ │ │
        Parameters:
        │ │ │
          │ │ │

        • data – The structured data.

          • │ │ │

        • reddit – An instance of Reddit.

          • │ │ │
        │ │ │ ├── html2text {} │ │ │ │ @@ -161,15 +161,15 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ CCoommmmuunniittyyLLiisstt_## ************ │ │ │ │ - ccllaassss praw.models.CommunityList(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]])_# │ │ │ │ + ccllaassss praw.models.CommunityList(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]])_# │ │ │ │ Class to represent a Related Communities widget. │ │ │ │ Find an existing one: │ │ │ │ community_list = None │ │ │ │ widgets = reddit.subreddit("test").widgets │ │ │ │ for widget in widgets.sidebar: │ │ │ │ if isinstance(widget, praw.models.CommunityList): │ │ │ │ community_list = widget │ │ │ │ @@ -209,31 +209,31 @@ │ │ │ │ data iterating over the _C_o_m_m_u_n_i_t_y_L_i_s_t (e.g., for sub in │ │ │ │ community_list). │ │ │ │ id The widget ID. │ │ │ │ kind The widget kind (always "community-list"). │ │ │ │ shortName The short name of the widget. │ │ │ │ styles A dict with the keys "backgroundColor" and "headerColor". │ │ │ │ subreddit The _S_u_b_r_e_d_d_i_t the button widget belongs to. │ │ │ │ - __contains__(iitteemm:: _AA_nn_yy) → _b_o_o_l_# │ │ │ │ + __contains__(iitteemm:: AAnnyy) → bool_# │ │ │ │ Test if item exists in the list. │ │ │ │ - __getitem__(iinnddeexx:: _ii_nn_tt) → _A_n_y_# │ │ │ │ + __getitem__(iinnddeexx:: iinntt) → Any_# │ │ │ │ Return the item at position index in the list. │ │ │ │ - __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]])_# │ │ │ │ + __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]])_# │ │ │ │ Initialize a _W_i_d_g_e_t instance. │ │ │ │ - __iter__() → _I_t_e_r_a_t_o_r[_A_n_y]_# │ │ │ │ + __iter__() → Iterator[Any]_# │ │ │ │ Return an iterator to the list. │ │ │ │ - __len__() → _i_n_t_# │ │ │ │ + __len__() → int_# │ │ │ │ Return the number of items in the list. │ │ │ │ mod() → _p_r_a_w_._m_o_d_e_l_s_._W_i_d_g_e_t_M_o_d_e_r_a_t_i_o_n_# │ │ │ │ Get an instance of _W_i_d_g_e_t_M_o_d_e_r_a_t_i_o_n for this widget. │ │ │ │ Note │ │ │ │ Using any of the methods of _W_i_d_g_e_t_M_o_d_e_r_a_t_i_o_n will likely make the │ │ │ │ data in the _S_u_b_r_e_d_d_i_t_W_i_d_g_e_t_s that this widget belongs to outdated. │ │ │ │ To remedy this, call _r_e_f_r_e_s_h_(_). │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ _N_e_x_t │ │ │ │ _C_u_s_t_o_m_W_i_d_g_e_t │ │ │ │ _P_r_e_v_i_o_u_s │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/config.html │ │ │ @@ -355,25 +355,25 @@ │ │ │ │ │ │ │ │ │
        │ │ │
        │ │ │

        Config#

        │ │ │
        │ │ │
        │ │ │ -class praw.config.Config(site_name: str, config_interpolation: Optional[str] = None, **settings: str)#
        │ │ │ +class praw.config.Config(site_name: str, config_interpolation: Optional[str] = None, **settings: str)# │ │ │

        A class containing the configuration for a Reddit site.

        │ │ │
        │ │ │
        │ │ │ -__init__(site_name: str, config_interpolation: Optional[str] = None, **settings: str)#
        │ │ │ +__init__(site_name: str, config_interpolation: Optional[str] = None, **settings: str)# │ │ │

        Initialize a Config instance.

        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -property short_url: str#
        │ │ │ +property short_url: str# │ │ │

        Return the short url.

        │ │ │
        │ │ │
        Raises:
        │ │ │

        ClientException if it is not set.

        │ │ │
        │ │ │
        │ │ │
        │ │ │ ├── html2text {} │ │ │ │ @@ -161,21 +161,21 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ CCoonnffiigg_## ************ │ │ │ │ - ccllaassss praw.config.Config(ssiittee__nnaammee:: _ss_tt_rr, ccoonnffiigg__iinntteerrppoollaattiioonn:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] │ │ │ │ - == NNoonnee, ****sseettttiinnggss:: _ss_tt_rr)_# │ │ │ │ + ccllaassss praw.config.Config(ssiittee__nnaammee:: ssttrr, ccoonnffiigg__iinntteerrppoollaattiioonn:: OOppttiioonnaall[[ssttrr]] │ │ │ │ + == NNoonnee, ****sseettttiinnggss:: ssttrr)_# │ │ │ │ A class containing the configuration for a Reddit site. │ │ │ │ - __init__(ssiittee__nnaammee:: _ss_tt_rr, ccoonnffiigg__iinntteerrppoollaattiioonn:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, │ │ │ │ - ****sseettttiinnggss:: _ss_tt_rr)_# │ │ │ │ + __init__(ssiittee__nnaammee:: ssttrr, ccoonnffiigg__iinntteerrppoollaattiioonn:: OOppttiioonnaall[[ssttrr]] == NNoonnee, │ │ │ │ + ****sseettttiinnggss:: ssttrr)_# │ │ │ │ Initialize a _C_o_n_f_i_g instance. │ │ │ │ - pprrooppeerrttyy short_url:: _ss_tt_rr_# │ │ │ │ + pprrooppeerrttyy short_url:: ssttrr_# │ │ │ │ Return the short url. │ │ │ │ Raises: │ │ │ │ _C_l_i_e_n_t_E_x_c_e_p_t_i_o_n if it is not set. │ │ │ │ _N_e_x_t │ │ │ │ _D_o_m_a_i_n_L_i_s_t_i_n_g │ │ │ │ _P_r_e_v_i_o_u_s │ │ │ │ _C_o_m_m_e_n_t_H_e_l_p_e_r │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/contributorrelationship.html │ │ │ @@ -355,54 +355,54 @@ │ │ │ │ │ │ │ │ │
        │ │ │
        │ │ │

        ContributorRelationship#

        │ │ │
        │ │ │
        │ │ │ -class praw.models.reddit.subreddit.ContributorRelationship(subreddit: praw.models.Subreddit, relationship: str)#
        │ │ │ +class praw.models.reddit.subreddit.ContributorRelationship(subreddit: praw.models.Subreddit, relationship: str)# │ │ │

        Provides methods to interact with a Subreddit’s contributors.

        │ │ │

        Contributors are also known as approved submitters.

        │ │ │

        Contributors of a subreddit can be iterated through like so:

        │ │ │ 
        for contributor in reddit.subreddit("test").contributor():
│ │ │      print(contributor)
│ │ │
        │ │ │
        │ │ │
        │ │ │
        │ │ │ -__call__(redditor: Optional[Union[praw.models.Redditor, str]] = None, **generator_kwargs) → Iterator[praw.models.Redditor]#
        │ │ │ +__call__(redditor: Optional[Union[praw.models.Redditor, str]] = None, **generator_kwargs) → Iterator[praw.models.Redditor]# │ │ │

        Return a ListingGenerator for Redditors in the relationship.

        │ │ │
        │ │ │
        Parameters:
        │ │ │

        redditor – When provided, yield at most a single Redditor │ │ │ instance. This is useful to confirm if a relationship exists, or to fetch │ │ │ the metadata associated with a particular relationship (default: None).

        │ │ │
        │ │ │
        │ │ │

        Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -__init__(subreddit: praw.models.Subreddit, relationship: str)#
        │ │ │ +__init__(subreddit: praw.models.Subreddit, relationship: str)# │ │ │

        Initialize a SubredditRelationship instance.

        │ │ │
        │ │ │
        Parameters:
        │ │ │
          │ │ │

        • subreddit – The Subreddit for the relationship.

          • │ │ │

        • relationship – The name of the relationship.

          • │ │ │
        │ │ │
        │ │ │
        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -add(redditor: Union[str, praw.models.Redditor], **other_settings: Any)#
        │ │ │ +add(redditor: Union[str, praw.models.Redditor], **other_settings: Any)# │ │ │

        Add redditor to this relationship.

        │ │ │
        │ │ │
        Parameters:
        │ │ │

        redditor – A redditor name or Redditor instance.

        │ │ │
        │ │ │
        │ │ │
        │ │ │ @@ -411,15 +411,15 @@ │ │ │
        │ │ │ leave()#
        │ │ │

        Abdicate the contributor position.

        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -remove(redditor: Union[str, praw.models.Redditor])#
        │ │ │ +remove(redditor: Union[str, praw.models.Redditor])# │ │ │

        Remove redditor from this relationship.

        │ │ │
        │ │ │
        Parameters:
        │ │ │

        redditor – A redditor name or Redditor instance.

        │ │ │
        │ │ │
        │ │ │
        │ │ │ ├── html2text {} │ │ │ │ @@ -162,42 +162,42 @@ │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ CCoonnttrriibbuuttoorrRReellaattiioonnsshhiipp_## ************ │ │ │ │ ccllaassss praw.models.reddit.subreddit.ContributorRelationship(ssuubbrreeddddiitt:: │ │ │ │ - _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt, rreellaattiioonnsshhiipp:: _ss_tt_rr)_# │ │ │ │ + _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt, rreellaattiioonnsshhiipp:: ssttrr)_# │ │ │ │ Provides methods to interact with a _S_u_b_r_e_d_d_i_t’s contributors. │ │ │ │ Contributors are also known as approved submitters. │ │ │ │ Contributors of a subreddit can be iterated through like so: │ │ │ │ for contributor in reddit.subreddit("test").contributor(): │ │ │ │ print(contributor) │ │ │ │ - __call__(rreeddddiittoorr:: _OO_pp_tt_ii_oo_nn_aa_ll[[_UU_nn_ii_oo_nn[[_pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._RR_ee_dd_dd_ii_tt_oo_rr,, _ss_tt_rr]]]] == NNoonnee, │ │ │ │ - ****ggeenneerraattoorr__kkwwaarrggss) → _I_t_e_r_a_t_o_r[_p_r_a_w_._m_o_d_e_l_s_._R_e_d_d_i_t_o_r]_# │ │ │ │ + __call__(rreeddddiittoorr:: OOppttiioonnaall[[UUnniioonn[[_pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._RR_ee_dd_dd_ii_tt_oo_rr,, ssttrr]]]] == NNoonnee, │ │ │ │ + ****ggeenneerraattoorr__kkwwaarrggss) → Iterator[_p_r_a_w_._m_o_d_e_l_s_._R_e_d_d_i_t_o_r]_# │ │ │ │ Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for _R_e_d_d_i_t_o_rs in the relationship. │ │ │ │ Parameters: │ │ │ │ rreeddddiittoorr – When provided, yield at most a single _R_e_d_d_i_t_o_r │ │ │ │ instance. This is useful to confirm if a relationship exists, │ │ │ │ or to fetch the metadata associated with a particular │ │ │ │ relationship (default: None). │ │ │ │ Additional keyword arguments are passed in the initialization of │ │ │ │ _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r. │ │ │ │ - __init__(ssuubbrreeddddiitt:: _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt, rreellaattiioonnsshhiipp:: _ss_tt_rr)_# │ │ │ │ + __init__(ssuubbrreeddddiitt:: _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt, rreellaattiioonnsshhiipp:: ssttrr)_# │ │ │ │ Initialize a _S_u_b_r_e_d_d_i_t_R_e_l_a_t_i_o_n_s_h_i_p instance. │ │ │ │ Parameters: │ │ │ │ * ssuubbrreeddddiitt – The _S_u_b_r_e_d_d_i_t for the relationship. │ │ │ │ * rreellaattiioonnsshhiipp – The name of the relationship. │ │ │ │ - add(rreeddddiittoorr:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._RR_ee_dd_dd_ii_tt_oo_rr]], ****ootthheerr__sseettttiinnggss:: _AA_nn_yy)_# │ │ │ │ + add(rreeddddiittoorr:: UUnniioonn[[ssttrr,, _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._RR_ee_dd_dd_ii_tt_oo_rr]], ****ootthheerr__sseettttiinnggss:: AAnnyy)_# │ │ │ │ Add redditor to this relationship. │ │ │ │ Parameters: │ │ │ │ rreeddddiittoorr – A redditor name or _R_e_d_d_i_t_o_r instance. │ │ │ │ leave()_# │ │ │ │ Abdicate the contributor position. │ │ │ │ - remove(rreeddddiittoorr:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._RR_ee_dd_dd_ii_tt_oo_rr]])_# │ │ │ │ + remove(rreeddddiittoorr:: UUnniioonn[[ssttrr,, _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._RR_ee_dd_dd_ii_tt_oo_rr]])_# │ │ │ │ Remove redditor from this relationship. │ │ │ │ Parameters: │ │ │ │ rreeddddiittoorr – A redditor name or _R_e_d_d_i_t_o_r instance. │ │ │ │ _N_e_x_t │ │ │ │ _M_o_d_e_r_a_t_o_r_R_e_l_a_t_i_o_n_s_h_i_p │ │ │ │ _P_r_e_v_i_o_u_s │ │ │ │ _L_i_v_e_U_p_d_a_t_e_C_o_n_t_r_i_b_u_t_i_o_n │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/customwidget.html │ │ │ @@ -355,15 +355,15 @@ │ │ │ │ │ │ │ │ │
        │ │ │
        │ │ │

        CustomWidget#

        │ │ │
        │ │ │
        │ │ │ -class praw.models.CustomWidget(reddit: praw.Reddit, _data: Dict[str, Any])#
        │ │ │ +class praw.models.CustomWidget(reddit: praw.Reddit, _data: Dict[str, Any])# │ │ │

        Class to represent a custom widget.

        │ │ │

        Find an existing one:

        │ │ │ 
        custom = None
│ │ │  widgets = reddit.subreddit("test").widgets
│ │ │  for widget in widgets.sidebar:
│ │ │      if isinstance(widget, praw.models.CustomWidget):
│ │ │          custom = widget
│ │ │ @@ -451,15 +451,15 @@
│ │ │  
        The text contents, as HTML.
        
│ │ │  
│ │ │  
│ │ │  
│ │ │
        │ │ │
        │ │ │
        │ │ │ -__init__(reddit: praw.Reddit, _data: Dict[str, Any])#
        │ │ │ +__init__(reddit: praw.Reddit, _data: Dict[str, Any])# │ │ │

        Initialize a CustomWidget instance.

        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ mod() → praw.models.WidgetModeration#
        │ │ │

        Get an instance of WidgetModeration for this widget.

        │ │ │ @@ -469,15 +469,15 @@ │ │ │ data in the SubredditWidgets that this widget belongs to outdated. │ │ │ To remedy this, call refresh().

        │ │ │
        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
        │ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

        Return an instance of cls from data.

        │ │ │
        │ │ │
        Parameters:
        │ │ │
          │ │ │

        • data – The structured data.

          • │ │ │

        • reddit – An instance of Reddit.

          • │ │ │
        │ │ │ ├── html2text {} │ │ │ │ @@ -161,15 +161,15 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ CCuussttoommWWiiddggeett_## ************ │ │ │ │ - ccllaassss praw.models.CustomWidget(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]])_# │ │ │ │ + ccllaassss praw.models.CustomWidget(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]])_# │ │ │ │ Class to represent a custom widget. │ │ │ │ Find an existing one: │ │ │ │ custom = None │ │ │ │ widgets = reddit.subreddit("test").widgets │ │ │ │ for widget in widgets.sidebar: │ │ │ │ if isinstance(widget, praw.models.CustomWidget): │ │ │ │ custom = widget │ │ │ │ @@ -214,23 +214,23 @@ │ │ │ │ kind The widget kind (always "custom"). │ │ │ │ shortName The short name of the widget. │ │ │ │ styles A dict with the keys "backgroundColor" and "headerColor". │ │ │ │ stylesheetUrl A link to the widget’s stylesheet. │ │ │ │ subreddit The _S_u_b_r_e_d_d_i_t the button widget belongs to. │ │ │ │ text The text contents, as Markdown. │ │ │ │ textHtml The text contents, as HTML. │ │ │ │ - __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]])_# │ │ │ │ + __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]])_# │ │ │ │ Initialize a _C_u_s_t_o_m_W_i_d_g_e_t instance. │ │ │ │ mod() → _p_r_a_w_._m_o_d_e_l_s_._W_i_d_g_e_t_M_o_d_e_r_a_t_i_o_n_# │ │ │ │ Get an instance of _W_i_d_g_e_t_M_o_d_e_r_a_t_i_o_n for this widget. │ │ │ │ Note │ │ │ │ Using any of the methods of _W_i_d_g_e_t_M_o_d_e_r_a_t_i_o_n will likely make the │ │ │ │ data in the _S_u_b_r_e_d_d_i_t_W_i_d_g_e_t_s that this widget belongs to outdated. │ │ │ │ To remedy this, call _r_e_f_r_e_s_h_(_). │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ _N_e_x_t │ │ │ │ _H_o_v_e_r │ │ │ │ _P_r_e_v_i_o_u_s │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/domainlisting.html │ │ │ @@ -355,41 +355,41 @@ │ │ │ │ │ │ │ │ │
        │ │ │
        │ │ │

        DomainListing#

        │ │ │
        │ │ │
        │ │ │ -class praw.models.DomainListing(reddit: praw.Reddit, domain: str)#
        │ │ │ +class praw.models.DomainListing(reddit: praw.Reddit, domain: str)# │ │ │

        Provide a set of functions to interact with domain listings.

        │ │ │
        │ │ │
        │ │ │ -__init__(reddit: praw.Reddit, domain: str)#
        │ │ │ +__init__(reddit: praw.Reddit, domain: str)# │ │ │

        Initialize a DomainListing instance.

        │ │ │
        │ │ │
        Parameters:
        │ │ │
          │ │ │

        • reddit – An instance of Reddit.

          • │ │ │

        • domain – The domain for which to obtain listings.

          • │ │ │
        │ │ │
        │ │ │
        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -controversial(*, time_filter: str = 'all', **generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]#
        │ │ │ +controversial(*, time_filter: str = 'all', **generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]# │ │ │

        Return a ListingGenerator for controversial items.

        │ │ │
        │ │ │
        Parameters:
        │ │ │

        time_filter – Can be one of: "all", "day", "hour", │ │ │ "month", "week", or "year" (default: "all").

        │ │ │
        │ │ │
        Raises:
        │ │ │ -

        ValueError if time_filter is invalid.

        │ │ │ +

        ValueError if time_filter is invalid.

        │ │ │
        │ │ │
        │ │ │

        Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

        │ │ │

        This method can be used like:

        │ │ │ 
        reddit.domain("imgur.com").controversial(time_filter="week")
│ │ │  reddit.multireddit(redditor="samuraisam", name="programming").controversial(
│ │ │ @@ -401,15 +401,15 @@
│ │ │  reddit.subreddit("all").controversial(time_filter="hour")
│ │ │
        │ │ │
        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -hot(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]#
        │ │ │ +hot(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]# │ │ │

        Return a ListingGenerator for hot items.

        │ │ │

        Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

        │ │ │

        This method can be used like:

        │ │ │ 
        reddit.domain("imgur.com").hot()
│ │ │  reddit.multireddit(redditor="samuraisam", name="programming").hot()
│ │ │  reddit.redditor("spez").hot()
│ │ │ @@ -418,15 +418,15 @@
│ │ │  reddit.subreddit("all").hot()
│ │ │
        │ │ │
        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -new(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]#
        │ │ │ +new(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]# │ │ │

        Return a ListingGenerator for new items.

        │ │ │

        Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

        │ │ │

        This method can be used like:

        │ │ │ 
        reddit.domain("imgur.com").new()
│ │ │  reddit.multireddit(redditor="samuraisam", name="programming").new()
│ │ │  reddit.redditor("spez").new()
│ │ │ @@ -435,63 +435,63 @@
│ │ │  reddit.subreddit("all").new()
│ │ │
        │ │ │
        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
        │ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

        Return an instance of cls from data.

        │ │ │
        │ │ │
        Parameters:
        │ │ │
          │ │ │

        • data – The structured data.

          • │ │ │

        • reddit – An instance of Reddit.

          • │ │ │
        │ │ │
        │ │ │
        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -random_rising(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[praw.models.Submission]#
        │ │ │ +random_rising(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[praw.models.Submission]# │ │ │

        Return a ListingGenerator for random rising submissions.

        │ │ │

        Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

        │ │ │

        For example, to get random rising submissions for r/test:

        │ │ │ 
        for submission in reddit.subreddit("test").random_rising():
│ │ │      print(submission.title)
│ │ │
        │ │ │
        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -rising(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[praw.models.Submission]#
        │ │ │ +rising(**generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[praw.models.Submission]# │ │ │

        Return a ListingGenerator for rising submissions.

        │ │ │

        Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

        │ │ │

        For example, to get rising submissions for r/test:

        │ │ │ 
        for submission in reddit.subreddit("test").rising():
│ │ │      print(submission.title)
│ │ │
        │ │ │
        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -top(*, time_filter: str = 'all', **generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]#
        │ │ │ +top(*, time_filter: str = 'all', **generator_kwargs: Union[str, int, Dict[str, str]]) → Iterator[Any]# │ │ │

        Return a ListingGenerator for top items.

        │ │ │
        │ │ │
        Parameters:
        │ │ │

        time_filter – Can be one of: "all", "day", "hour", │ │ │ "month", "week", or "year" (default: "all").

        │ │ │
        │ │ │
        Raises:
        │ │ │ -

        ValueError if time_filter is invalid.

        │ │ │ +

        ValueError if time_filter is invalid.

        │ │ │
        │ │ │
        │ │ │

        Additional keyword arguments are passed in the initialization of │ │ │ ListingGenerator.

        │ │ │

        This method can be used like:

        │ │ │ 
        reddit.domain("imgur.com").top(time_filter="week")
│ │ │  reddit.multireddit(redditor="samuraisam", name="programming").top(time_filter="day")
│ │ │ ├── html2text {}
│ │ │ │ @@ -161,95 +161,95 @@
│ │ │ │      * _R_e_f_e_r_e_n_c_e_s
│ │ │ │      * _S_p_o_n_s_o_r_s
│ │ │ │      * _I_n_d_e_x
│ │ │ │  _B_a_c_k_ _t_o_ _t_o_p
│ │ │ │  Toggle Light / Dark / Auto color theme
│ │ │ │  Toggle table of contents sidebar
│ │ │ │  ************ DDoommaaiinnLLiissttiinngg_## ************
│ │ │ │ -  ccllaassss praw.models.DomainListing(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, ddoommaaiinn:: _ss_tt_rr)_#
│ │ │ │ +  ccllaassss praw.models.DomainListing(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, ddoommaaiinn:: ssttrr)_#
│ │ │ │        Provide a set of functions to interact with domain listings.
│ │ │ │ -        __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, ddoommaaiinn:: _ss_tt_rr)_#
│ │ │ │ +        __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, ddoommaaiinn:: ssttrr)_#
│ │ │ │              Initialize a _D_o_m_a_i_n_L_i_s_t_i_n_g instance.
│ │ │ │                Parameters:
│ │ │ │                        * rreeddddiitt – An instance of _R_e_d_d_i_t.
│ │ │ │                        * ddoommaaiinn – The domain for which to obtain listings.
│ │ │ │ -        controversial(**, ttiimmee__ffiilltteerr:: _ss_tt_rr == ''aallll'', ****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn
│ │ │ │ -        [[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → _I_t_e_r_a_t_o_r[_A_n_y]_#
│ │ │ │ +        controversial(**, ttiimmee__ffiilltteerr:: ssttrr == ''aallll'', ****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn
│ │ │ │ +        [[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → Iterator[Any]_#
│ │ │ │              Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for controversial items.
│ │ │ │                Parameters:
│ │ │ │                    ttiimmee__ffiilltteerr – Can be one of: "all", "day", "hour", "month",
│ │ │ │                    "week", or "year" (default: "all").
│ │ │ │                Raises:
│ │ │ │ -                  _V_a_l_u_e_E_r_r_o_r if time_filter is invalid.
│ │ │ │ +                  ValueError if time_filter is invalid.
│ │ │ │              Additional keyword arguments are passed in the initialization of
│ │ │ │              _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r.
│ │ │ │              This method can be used like:
│ │ │ │              reddit.domain("imgur.com").controversial(time_filter="week")
│ │ │ │              reddit.multireddit(redditor="samuraisam",
│ │ │ │              name="programming").controversial(
│ │ │ │                  time_filter="day"
│ │ │ │              )
│ │ │ │              reddit.redditor("spez").controversial(time_filter="month")
│ │ │ │              reddit.redditor("spez").comments.controversial(time_filter="year")
│ │ │ │              reddit.redditor("spez").submissions.controversial
│ │ │ │              (time_filter="all")
│ │ │ │              reddit.subreddit("all").controversial(time_filter="hour")
│ │ │ │ -        hot(****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → _I_t_e_r_a_t_o_r
│ │ │ │ -        [_A_n_y]_#
│ │ │ │ +        hot(****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → Iterator
│ │ │ │ +        [Any]_#
│ │ │ │              Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for hot items.
│ │ │ │              Additional keyword arguments are passed in the initialization of
│ │ │ │              _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r.
│ │ │ │              This method can be used like:
│ │ │ │              reddit.domain("imgur.com").hot()
│ │ │ │              reddit.multireddit(redditor="samuraisam", name="programming").hot()
│ │ │ │              reddit.redditor("spez").hot()
│ │ │ │              reddit.redditor("spez").comments.hot()
│ │ │ │              reddit.redditor("spez").submissions.hot()
│ │ │ │              reddit.subreddit("all").hot()
│ │ │ │ -        new(****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → _I_t_e_r_a_t_o_r
│ │ │ │ -        [_A_n_y]_#
│ │ │ │ +        new(****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → Iterator
│ │ │ │ +        [Any]_#
│ │ │ │              Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for new items.
│ │ │ │              Additional keyword arguments are passed in the initialization of
│ │ │ │              _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r.
│ │ │ │              This method can be used like:
│ │ │ │              reddit.domain("imgur.com").new()
│ │ │ │              reddit.multireddit(redditor="samuraisam", name="programming").new()
│ │ │ │              reddit.redditor("spez").new()
│ │ │ │              reddit.redditor("spez").comments.new()
│ │ │ │              reddit.redditor("spez").submissions.new()
│ │ │ │              reddit.subreddit("all").new()
│ │ │ │ -        ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_#
│ │ │ │ +        ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_#
│ │ │ │              Return an instance of cls from data.
│ │ │ │                Parameters:
│ │ │ │                        * ddaattaa – The structured data.
│ │ │ │                        * rreeddddiitt – An instance of _R_e_d_d_i_t.
│ │ │ │ -        random_rising(****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) →
│ │ │ │ -        _I_t_e_r_a_t_o_r[_p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]_#
│ │ │ │ +        random_rising(****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) →
│ │ │ │ +        Iterator[_p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]_#
│ │ │ │              Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for random rising submissions.
│ │ │ │              Additional keyword arguments are passed in the initialization of
│ │ │ │              _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r.
│ │ │ │              For example, to get random rising submissions for r/test:
│ │ │ │              for submission in reddit.subreddit("test").random_rising():
│ │ │ │                  print(submission.title)
│ │ │ │ -        rising(****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,, _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → _I_t_e_r_a_t_o_r
│ │ │ │ +        rising(****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,, DDiicctt[[ssttrr,, ssttrr]]]]) → Iterator
│ │ │ │          [_p_r_a_w_._m_o_d_e_l_s_._S_u_b_m_i_s_s_i_o_n]_#
│ │ │ │              Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for rising submissions.
│ │ │ │              Additional keyword arguments are passed in the initialization of
│ │ │ │              _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r.
│ │ │ │              For example, to get rising submissions for r/test:
│ │ │ │              for submission in reddit.subreddit("test").rising():
│ │ │ │                  print(submission.title)
│ │ │ │ -        top(**, ttiimmee__ffiilltteerr:: _ss_tt_rr == ''aallll'', ****ggeenneerraattoorr__kkwwaarrggss:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt,,
│ │ │ │ -        _DD_ii_cc_tt[[_ss_tt_rr,, _ss_tt_rr]]]]) → _I_t_e_r_a_t_o_r[_A_n_y]_#
│ │ │ │ +        top(**, ttiimmee__ffiilltteerr:: ssttrr == ''aallll'', ****ggeenneerraattoorr__kkwwaarrggss:: UUnniioonn[[ssttrr,, iinntt,,
│ │ │ │ +        DDiicctt[[ssttrr,, ssttrr]]]]) → Iterator[Any]_#
│ │ │ │              Return a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r for top items.
│ │ │ │                Parameters:
│ │ │ │                    ttiimmee__ffiilltteerr – Can be one of: "all", "day", "hour", "month",
│ │ │ │                    "week", or "year" (default: "all").
│ │ │ │                Raises:
│ │ │ │ -                  _V_a_l_u_e_E_r_r_o_r if time_filter is invalid.
│ │ │ │ +                  ValueError if time_filter is invalid.
│ │ │ │              Additional keyword arguments are passed in the initialization of
│ │ │ │              _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r.
│ │ │ │              This method can be used like:
│ │ │ │              reddit.domain("imgur.com").top(time_filter="week")
│ │ │ │              reddit.multireddit(redditor="samuraisam", name="programming").top
│ │ │ │              (time_filter="day")
│ │ │ │              reddit.redditor("spez").top(time_filter="month")
│ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/draftlist.html
│ │ │ @@ -355,54 +355,54 @@
│ │ │            
│ │ │
        │ │ │
        │ │ │
        │ │ │

        DraftList#

        │ │ │
        │ │ │
        │ │ │ -class praw.models.DraftList(reddit: praw.Reddit, _data: Dict[str, Any])#
        │ │ │ +class praw.models.DraftList(reddit: praw.Reddit, _data: Dict[str, Any])# │ │ │

        A list of Draft objects. Works just like a regular list.

        │ │ │
        │ │ │
        │ │ │ -__contains__(item: Any) → bool#
        │ │ │ +__contains__(item: Any) → bool# │ │ │

        Test if item exists in the list.

        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -__getitem__(index: int) → Any#
        │ │ │ +__getitem__(index: int) → Any# │ │ │

        Return the item at position index in the list.

        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -__init__(reddit: praw.Reddit, _data: Dict[str, Any])#
        │ │ │ +__init__(reddit: praw.Reddit, _data: Dict[str, Any])# │ │ │

        Initialize a BaseList instance.

        │ │ │
        │ │ │
        Parameters:
        │ │ │

        reddit – An instance of Reddit.

        │ │ │
        │ │ │
        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -__iter__() → Iterator[Any]#
        │ │ │ +__iter__() → Iterator[Any]# │ │ │

        Return an iterator to the list.

        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -__len__() → int#
        │ │ │ +__len__() → int# │ │ │

        Return the number of items in the list.

        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
        │ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

        Return an instance of cls from data.

        │ │ │
        │ │ │
        Parameters:
        │ │ │
          │ │ │

        • data – The structured data.

          • │ │ │

        • reddit – An instance of Reddit.

          • │ │ │
        │ │ │ ├── html2text {} │ │ │ │ @@ -161,29 +161,29 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ DDrraaffttLLiisstt_## ************ │ │ │ │ - ccllaassss praw.models.DraftList(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]])_# │ │ │ │ + ccllaassss praw.models.DraftList(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]])_# │ │ │ │ A list of _D_r_a_f_t objects. Works just like a regular list. │ │ │ │ - __contains__(iitteemm:: _AA_nn_yy) → _b_o_o_l_# │ │ │ │ + __contains__(iitteemm:: AAnnyy) → bool_# │ │ │ │ Test if item exists in the list. │ │ │ │ - __getitem__(iinnddeexx:: _ii_nn_tt) → _A_n_y_# │ │ │ │ + __getitem__(iinnddeexx:: iinntt) → Any_# │ │ │ │ Return the item at position index in the list. │ │ │ │ - __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]])_# │ │ │ │ + __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]])_# │ │ │ │ Initialize a _B_a_s_e_L_i_s_t instance. │ │ │ │ Parameters: │ │ │ │ rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ - __iter__() → _I_t_e_r_a_t_o_r[_A_n_y]_# │ │ │ │ + __iter__() → Iterator[Any]_# │ │ │ │ Return an iterator to the list. │ │ │ │ - __len__() → _i_n_t_# │ │ │ │ + __len__() → int_# │ │ │ │ Return the number of items in the list. │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ _N_e_x_t │ │ │ │ _E_m_o_j_i │ │ │ │ _P_r_e_v_i_o_u_s │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/emoji.html │ │ │ @@ -355,15 +355,15 @@ │ │ │ │ │ │
        │ │ │
        │ │ │
        │ │ │

        Emoji#

        │ │ │
        │ │ │
        │ │ │ -class praw.models.reddit.emoji.Emoji(reddit: praw.Reddit, subreddit: praw.models.Subreddit, name: str, _data: Optional[Dict[str, Any]] = None)#
        │ │ │ +class praw.models.reddit.emoji.Emoji(reddit: praw.Reddit, subreddit: praw.models.Subreddit, name: str, _data: Optional[Dict[str, Any]] = None)# │ │ │

        An individual Emoji object.

        │ │ │

        Typical Attributes

        │ │ │
        │ │ │

        Note

        │ │ │

        This table describes attributes that typically belong to objects of this class. PRAW │ │ │ dynamically provides the attributes that Reddit returns via the API. Since those │ │ │ attributes are subject to change on Reddit’s end, PRAW makes no effort to document │ │ │ @@ -397,15 +397,15 @@ │ │ │

        Whether the emoji may appear in user flair.

        │ │ │ │ │ │ │ │ │ │ │ │
        │ │ │
        │ │ │
        │ │ │ -__init__(reddit: praw.Reddit, subreddit: praw.models.Subreddit, name: str, _data: Optional[Dict[str, Any]] = None)#
        │ │ │ +__init__(reddit: praw.Reddit, subreddit: praw.models.Subreddit, name: str, _data: Optional[Dict[str, Any]] = None)# │ │ │

        Initialize an Emoji instance.

        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ delete()#
        │ │ │

        Delete an emoji from this subreddit by Emoji.

        │ │ │ @@ -413,29 +413,29 @@ │ │ │ 
        reddit.subreddit("test").emoji["emoji"].delete()
│ │ │
        │ │ │
        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
        │ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

        Return an instance of cls from data.

        │ │ │
        │ │ │
        Parameters:
        │ │ │
          │ │ │

        • data – The structured data.

          • │ │ │

        • reddit – An instance of Reddit.

          • │ │ │
        │ │ │
        │ │ │
        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -update(*, mod_flair_only: Optional[bool] = None, post_flair_allowed: Optional[bool] = None, user_flair_allowed: Optional[bool] = None)#
        │ │ │ +update(*, mod_flair_only: Optional[bool] = None, post_flair_allowed: Optional[bool] = None, user_flair_allowed: Optional[bool] = None)# │ │ │

        Update the permissions of an emoji in this subreddit.

        │ │ │
        │ │ │
        Parameters:
        │ │ │
          │ │ │

        • mod_flair_only – Indicate whether the emoji is restricted to mod use only. │ │ │ Respects pre-existing settings if not provided.

          • │ │ │

        • post_flair_allowed – Indicate whether the emoji may appear in post flair. │ │ │ ├── html2text {} │ │ │ │ @@ -162,15 +162,15 @@ │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ EEmmoojjii_## ************ │ │ │ │ ccllaassss praw.models.reddit.emoji.Emoji(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, ssuubbrreeddddiitt:: │ │ │ │ - _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt, nnaammee:: _ss_tt_rr, __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]]]] == NNoonnee)_# │ │ │ │ + _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt, nnaammee:: ssttrr, __ddaattaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, AAnnyy]]]] == NNoonnee)_# │ │ │ │ An individual _E_m_o_j_i object. │ │ │ │ TTyyppiiccaall AAttttrriibbuutteess │ │ │ │ Note │ │ │ │ This table describes attributes that typically belong to objects of this │ │ │ │ class. PRAW dynamically provides the attributes that Reddit returns via │ │ │ │ the API. Since those attributes are subject to change on Reddit’s end, │ │ │ │ PRAW makes no effort to document any new/removed/changed attributes, │ │ │ │ @@ -182,27 +182,27 @@ │ │ │ │ AAttttrriibbuuttee DDeessccrriippttiioonn │ │ │ │ mod_flair_only Whether the emoji is restricted for mod use only. │ │ │ │ name The name of the emoji. │ │ │ │ post_flair_allowed Whether the emoji may appear in post flair. │ │ │ │ url The URL of the emoji image. │ │ │ │ user_flair_allowed Whether the emoji may appear in user flair. │ │ │ │ __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, ssuubbrreeddddiitt:: _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._SS_uu_bb_rr_ee_dd_dd_ii_tt, nnaammee:: │ │ │ │ - _ss_tt_rr, __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]]]] == NNoonnee)_# │ │ │ │ + ssttrr, __ddaattaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, AAnnyy]]]] == NNoonnee)_# │ │ │ │ Initialize an _E_m_o_j_i instance. │ │ │ │ delete()_# │ │ │ │ Delete an emoji from this subreddit by _E_m_o_j_i. │ │ │ │ To delete "emoji" as an emoji on r/test try: │ │ │ │ reddit.subreddit("test").emoji["emoji"].delete() │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ - update(**, mmoodd__ffllaaiirr__oonnllyy:: _OO_pp_tt_ii_oo_nn_aa_ll[[_bb_oo_oo_ll]] == NNoonnee, ppoosstt__ffllaaiirr__aalllloowweedd:: │ │ │ │ - _OO_pp_tt_ii_oo_nn_aa_ll[[_bb_oo_oo_ll]] == NNoonnee, uusseerr__ffllaaiirr__aalllloowweedd:: _OO_pp_tt_ii_oo_nn_aa_ll[[_bb_oo_oo_ll]] == NNoonnee)_# │ │ │ │ + update(**, mmoodd__ffllaaiirr__oonnllyy:: OOppttiioonnaall[[bbooooll]] == NNoonnee, ppoosstt__ffllaaiirr__aalllloowweedd:: │ │ │ │ + OOppttiioonnaall[[bbooooll]] == NNoonnee, uusseerr__ffllaaiirr__aalllloowweedd:: OOppttiioonnaall[[bbooooll]] == NNoonnee)_# │ │ │ │ Update the permissions of an emoji in this subreddit. │ │ │ │ Parameters: │ │ │ │ * mmoodd__ffllaaiirr__oonnllyy – Indicate whether the emoji is │ │ │ │ restricted to mod use only. Respects pre-existing │ │ │ │ settings if not provided. │ │ │ │ * ppoosstt__ffllaaiirr__aalllloowweedd – Indicate whether the emoji may │ │ │ │ appear in post flair. Respects pre-existing settings if │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/fullnamemixin.html │ │ │ @@ -364,15 +364,15 @@ │ │ │

          │ │ │
          │ │ │ __init__()#
          │ │ │
          │ │ │ │ │ │
          │ │ │
          │ │ │ -property fullname: str#
          │ │ │ +property fullname: str# │ │ │

          Return the object’s fullname.

          │ │ │

          A fullname is an object’s kind mapping like t3 followed by an underscore and │ │ │ the object’s base36 ID, e.g., t1_c5s96e0.

          │ │ │
          │ │ │ │ │ │
        │ │ │ ├── html2text {} │ │ │ │ @@ -164,15 +164,15 @@ │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ FFuullllnnaammeeMMiixxiinn_## ************ │ │ │ │ ccllaassss praw.models.reddit.mixins.FullnameMixin_# │ │ │ │ Interface for classes that have a fullname. │ │ │ │ __init__()_# │ │ │ │ - pprrooppeerrttyy fullname:: _ss_tt_rr_# │ │ │ │ + pprrooppeerrttyy fullname:: ssttrr_# │ │ │ │ Return the object’s fullname. │ │ │ │ A fullname is an object’s kind mapping like t3 followed by an │ │ │ │ underscore and the object’s base36 ID, e.g., t1_c5s96e0. │ │ │ │ _N_e_x_t │ │ │ │ _I_n_b_o_x_a_b_l_e_M_i_x_i_n │ │ │ │ _P_r_e_v_i_o_u_s │ │ │ │ _E_m_o_j_i │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/hover.html │ │ │ @@ -355,15 +355,15 @@ │ │ │ │ │ │ │ │ │
        │ │ │
        │ │ │

        Hover#

        │ │ │
        │ │ │
        │ │ │ -class praw.models.Hover(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])#
        │ │ │ +class praw.models.Hover(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])# │ │ │

        Class to represent the hover data for a ButtonWidget.

        │ │ │

        These values will take effect when the button is hovered over (the user moves their │ │ │ cursor so it’s on top of the button).

        │ │ │

        Typical Attributes

        │ │ │
        │ │ │

        Note

        │ │ │

        This table describes attributes that typically belong to objects of this class. PRAW │ │ │ @@ -413,26 +413,26 @@ │ │ │

        Image width. Only present on image buttons.

        │ │ │ │ │ │ │ │ │ │ │ │
        │ │ │
        │ │ │
        │ │ │ -__init__(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])#
        │ │ │ +__init__(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])# │ │ │

        Initialize a PRAWBase instance.

        │ │ │
        │ │ │
        Parameters:
        │ │ │

        reddit – An instance of Reddit.

        │ │ │
        │ │ │
        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
        │ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

        Return an instance of cls from data.

        │ │ │
        │ │ │
        Parameters:
        │ │ │
          │ │ │

        • data – The structured data.

          • │ │ │

        • reddit – An instance of Reddit.

          • │ │ │
        │ │ │ ├── html2text {} │ │ │ │ @@ -161,16 +161,16 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ HHoovveerr_## ************ │ │ │ │ - ccllaassss praw.models.Hover(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, │ │ │ │ - _AA_nn_yy]]]])_# │ │ │ │ + ccllaassss praw.models.Hover(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, │ │ │ │ + AAnnyy]]]])_# │ │ │ │ Class to represent the hover data for a _B_u_t_t_o_n_W_i_d_g_e_t. │ │ │ │ These values will take effect when the button is hovered over (the user │ │ │ │ moves their cursor so it’s on top of the button). │ │ │ │ TTyyppiiccaall AAttttrriibbuutteess │ │ │ │ Note │ │ │ │ This table describes attributes that typically belong to objects of this │ │ │ │ class. PRAW dynamically provides the attributes that Reddit returns via │ │ │ │ @@ -189,19 +189,19 @@ │ │ │ │ kind Either text or image. │ │ │ │ text The text displayed on the button. │ │ │ │ * If the button is a text button, a link that can be │ │ │ │ url visited by clicking the button. │ │ │ │ * If the button is an image button, the URL of a Reddit- │ │ │ │ hosted image. │ │ │ │ width Image width. Only present on image buttons. │ │ │ │ - __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]]]])_# │ │ │ │ + __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, AAnnyy]]]])_# │ │ │ │ Initialize a _P_R_A_W_B_a_s_e instance. │ │ │ │ Parameters: │ │ │ │ rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ _N_e_x_t │ │ │ │ _I_D_C_a_r_d │ │ │ │ _P_r_e_v_i_o_u_s │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/idcard.html │ │ │ @@ -355,15 +355,15 @@ │ │ │ │ │ │ │ │ │
        │ │ │
        │ │ │

        IDCard#

        │ │ │
        │ │ │
        │ │ │ -class praw.models.IDCard(reddit: praw.Reddit, _data: Dict[str, Any])#
        │ │ │ +class praw.models.IDCard(reddit: praw.Reddit, _data: Dict[str, Any])# │ │ │

        Class to represent an ID card widget.

        │ │ │ 
        widgets = reddit.subreddit("test").widgets
│ │ │  id_card = widgets.id_card
│ │ │  print(id_card.subscribersText)
│ │ │
        │ │ │
        │ │ │

        Update one:

        │ │ │ @@ -424,15 +424,15 @@ │ │ │ example, “users subscribed”.

        │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
        │ │ │
        │ │ │ -__init__(reddit: praw.Reddit, _data: Dict[str, Any])#
        │ │ │ +__init__(reddit: praw.Reddit, _data: Dict[str, Any])# │ │ │

        Initialize a Widget instance.

        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ mod() → praw.models.WidgetModeration#
        │ │ │

        Get an instance of WidgetModeration for this widget.

        │ │ │ @@ -442,15 +442,15 @@ │ │ │ data in the SubredditWidgets that this widget belongs to outdated. │ │ │ To remedy this, call refresh().

        │ │ │ │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
        │ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

        Return an instance of cls from data.

        │ │ │
        │ │ │
        Parameters:
        │ │ │
          │ │ │

        • data – The structured data.

          • │ │ │

        • reddit – An instance of Reddit.

          • │ │ │
        │ │ │ ├── html2text {} │ │ │ │ @@ -161,15 +161,15 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ IIDDCCaarrdd_## ************ │ │ │ │ - ccllaassss praw.models.IDCard(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]])_# │ │ │ │ + ccllaassss praw.models.IDCard(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]])_# │ │ │ │ Class to represent an ID card widget. │ │ │ │ widgets = reddit.subreddit("test").widgets │ │ │ │ id_card = widgets.id_card │ │ │ │ print(id_card.subscribersText) │ │ │ │ Update one: │ │ │ │ widgets.id_card.mod.update(currentlyViewingText="Bots") │ │ │ │ TTyyppiiccaall AAttttrriibbuutteess │ │ │ │ @@ -193,23 +193,23 @@ │ │ │ │ shortName The short name of the widget. │ │ │ │ styles A dict with the keys "backgroundColor" and │ │ │ │ "headerColor". │ │ │ │ subreddit The _S_u_b_r_e_d_d_i_t the button widget belongs to. │ │ │ │ subscribersCount The number of subscribers to the subreddit. │ │ │ │ subscribersText The text displayed next to the subscriber count. │ │ │ │ For example, “users subscribed”. │ │ │ │ - __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]])_# │ │ │ │ + __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]])_# │ │ │ │ Initialize a _W_i_d_g_e_t instance. │ │ │ │ mod() → _p_r_a_w_._m_o_d_e_l_s_._W_i_d_g_e_t_M_o_d_e_r_a_t_i_o_n_# │ │ │ │ Get an instance of _W_i_d_g_e_t_M_o_d_e_r_a_t_i_o_n for this widget. │ │ │ │ Note │ │ │ │ Using any of the methods of _W_i_d_g_e_t_M_o_d_e_r_a_t_i_o_n will likely make the │ │ │ │ data in the _S_u_b_r_e_d_d_i_t_W_i_d_g_e_t_s that this widget belongs to outdated. │ │ │ │ To remedy this, call _r_e_f_r_e_s_h_(_). │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ _N_e_x_t │ │ │ │ _I_m_a_g_e │ │ │ │ _P_r_e_v_i_o_u_s │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/image.html │ │ │ @@ -355,15 +355,15 @@ │ │ │ │ │ │ │ │ │
        │ │ │
        │ │ │

        Image#

        │ │ │
        │ │ │
        │ │ │ -class praw.models.Image(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])#
        │ │ │ +class praw.models.Image(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])# │ │ │

        Class to represent an image that’s part of a ImageWidget.

        │ │ │

        Typical Attributes

        │ │ │
        │ │ │

        Note

        │ │ │

        This table describes attributes that typically belong to objects of this class. PRAW │ │ │ dynamically provides the attributes that Reddit returns via the API. Since those │ │ │ attributes are subject to change on Reddit’s end, PRAW makes no effort to document │ │ │ @@ -394,26 +394,26 @@ │ │ │

        Image width.

        │ │ │ │ │ │ │ │ │ │ │ │
        │ │ │
        │ │ │
        │ │ │ -__init__(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])#
        │ │ │ +__init__(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])# │ │ │

        Initialize a PRAWBase instance.

        │ │ │
        │ │ │
        Parameters:
        │ │ │

        reddit – An instance of Reddit.

        │ │ │
        │ │ │
        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
        │ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

        Return an instance of cls from data.

        │ │ │
        │ │ │
        Parameters:
        │ │ │
          │ │ │

        • data – The structured data.

          • │ │ │

        • reddit – An instance of Reddit.

          • │ │ │
        │ │ │ ├── html2text {} │ │ │ │ @@ -161,16 +161,16 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ IImmaaggee_## ************ │ │ │ │ - ccllaassss praw.models.Image(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, │ │ │ │ - _AA_nn_yy]]]])_# │ │ │ │ + ccllaassss praw.models.Image(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, │ │ │ │ + AAnnyy]]]])_# │ │ │ │ Class to represent an image that’s part of a _I_m_a_g_e_W_i_d_g_e_t. │ │ │ │ TTyyppiiccaall AAttttrriibbuutteess │ │ │ │ Note │ │ │ │ This table describes attributes that typically belong to objects of this │ │ │ │ class. PRAW dynamically provides the attributes that Reddit returns via │ │ │ │ the API. Since those attributes are subject to change on Reddit’s end, │ │ │ │ PRAW makes no effort to document any new/removed/changed attributes, │ │ │ │ @@ -180,19 +180,19 @@ │ │ │ │ If you would like to add an attribute to this table, feel free to open a │ │ │ │ _p_u_l_l_ _r_e_q_u_e_s_t. │ │ │ │ AAttttrriibbuuttee DDeessccrriippttiioonn │ │ │ │ height Image height. │ │ │ │ linkUrl A link that can be visited by clicking the image. │ │ │ │ url The URL of the (Reddit-hosted) image. │ │ │ │ width Image width. │ │ │ │ - __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]]]])_# │ │ │ │ + __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, AAnnyy]]]])_# │ │ │ │ Initialize a _P_R_A_W_B_a_s_e instance. │ │ │ │ Parameters: │ │ │ │ rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ _N_e_x_t │ │ │ │ _I_m_a_g_e_D_a_t_a │ │ │ │ _P_r_e_v_i_o_u_s │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/imagedata.html │ │ │ @@ -355,15 +355,15 @@ │ │ │ │ │ │ │ │ │
        │ │ │
        │ │ │

        ImageData#

        │ │ │
        │ │ │
        │ │ │ -class praw.models.ImageData(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])#
        │ │ │ +class praw.models.ImageData(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])# │ │ │

        Class for image data that’s part of a CustomWidget.

        │ │ │

        Typical Attributes

        │ │ │
        │ │ │

        Note

        │ │ │

        This table describes attributes that typically belong to objects of this class. PRAW │ │ │ dynamically provides the attributes that Reddit returns via the API. Since those │ │ │ attributes are subject to change on Reddit’s end, PRAW makes no effort to document │ │ │ @@ -394,26 +394,26 @@ │ │ │

        The image width.

        │ │ │ │ │ │ │ │ │ │ │ │
        │ │ │
        │ │ │
        │ │ │ -__init__(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])#
        │ │ │ +__init__(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])# │ │ │

        Initialize a PRAWBase instance.

        │ │ │
        │ │ │
        Parameters:
        │ │ │

        reddit – An instance of Reddit.

        │ │ │
        │ │ │
        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
        │ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

        Return an instance of cls from data.

        │ │ │
        │ │ │
        Parameters:
        │ │ │
          │ │ │

        • data – The structured data.

          • │ │ │

        • reddit – An instance of Reddit.

          • │ │ │
        │ │ │ ├── html2text {} │ │ │ │ @@ -161,16 +161,16 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ IImmaaggeeDDaattaa_## ************ │ │ │ │ - ccllaassss praw.models.ImageData(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, │ │ │ │ - _AA_nn_yy]]]])_# │ │ │ │ + ccllaassss praw.models.ImageData(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, │ │ │ │ + AAnnyy]]]])_# │ │ │ │ Class for image data that’s part of a _C_u_s_t_o_m_W_i_d_g_e_t. │ │ │ │ TTyyppiiccaall AAttttrriibbuutteess │ │ │ │ Note │ │ │ │ This table describes attributes that typically belong to objects of this │ │ │ │ class. PRAW dynamically provides the attributes that Reddit returns via │ │ │ │ the API. Since those attributes are subject to change on Reddit’s end, │ │ │ │ PRAW makes no effort to document any new/removed/changed attributes, │ │ │ │ @@ -180,19 +180,19 @@ │ │ │ │ If you would like to add an attribute to this table, feel free to open a │ │ │ │ _p_u_l_l_ _r_e_q_u_e_s_t. │ │ │ │ AAttttrriibbuuttee DDeessccrriippttiioonn │ │ │ │ height The image height. │ │ │ │ name The image name. │ │ │ │ url The URL of the image on Reddit’s servers. │ │ │ │ width The image width. │ │ │ │ - __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]]]])_# │ │ │ │ + __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: OOppttiioonnaall[[DDiicctt[[ssttrr,, AAnnyy]]]])_# │ │ │ │ Initialize a _P_R_A_W_B_a_s_e instance. │ │ │ │ Parameters: │ │ │ │ rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ _N_e_x_t │ │ │ │ _I_m_a_g_e_W_i_d_g_e_t │ │ │ │ _P_r_e_v_i_o_u_s │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/imagewidget.html │ │ │ @@ -355,15 +355,15 @@ │ │ │ │ │ │ │ │ │
        │ │ │
        │ │ │

        ImageWidget#

        │ │ │
        │ │ │
        │ │ │ -class praw.models.ImageWidget(reddit: praw.Reddit, _data: Dict[str, Any])#
        │ │ │ +class praw.models.ImageWidget(reddit: praw.Reddit, _data: Dict[str, Any])# │ │ │

        Class to represent an image widget.

        │ │ │

        Find an existing one:

        │ │ │ 
        image_widget = None
│ │ │  widgets = reddit.subreddit("test").widgets
│ │ │  for widget in widgets.sidebar:
│ │ │      if isinstance(widget, praw.models.ImageWidget):
│ │ │          image_widget = widget
│ │ │ @@ -442,39 +442,39 @@
│ │ │  
        The Subreddit the button widget belongs to.
        
│ │ │  
│ │ │  
│ │ │  
│ │ │
        │ │ │
        │ │ │
        │ │ │ -__contains__(item: Any) → bool#
        │ │ │ +__contains__(item: Any) → bool# │ │ │

        Test if item exists in the list.

        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -__getitem__(index: int) → Any#
        │ │ │ +__getitem__(index: int) → Any# │ │ │

        Return the item at position index in the list.

        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -__init__(reddit: praw.Reddit, _data: Dict[str, Any])#
        │ │ │ +__init__(reddit: praw.Reddit, _data: Dict[str, Any])# │ │ │

        Initialize a Widget instance.

        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -__iter__() → Iterator[Any]#
        │ │ │ +__iter__() → Iterator[Any]# │ │ │

        Return an iterator to the list.

        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -__len__() → int#
        │ │ │ +__len__() → int# │ │ │

        Return the number of items in the list.

        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ mod() → praw.models.WidgetModeration#
        │ │ │

        Get an instance of WidgetModeration for this widget.

        │ │ │ @@ -484,15 +484,15 @@ │ │ │ data in the SubredditWidgets that this widget belongs to outdated. │ │ │ To remedy this, call refresh().

        │ │ │
        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
        │ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

        Return an instance of cls from data.

        │ │ │
        │ │ │
        Parameters:
        │ │ │
          │ │ │

        • data – The structured data.

          • │ │ │

        • reddit – An instance of Reddit.

          • │ │ │
        │ │ │ ├── html2text {} │ │ │ │ @@ -161,15 +161,15 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ IImmaaggeeWWiiddggeett_## ************ │ │ │ │ - ccllaassss praw.models.ImageWidget(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]])_# │ │ │ │ + ccllaassss praw.models.ImageWidget(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]])_# │ │ │ │ Class to represent an image widget. │ │ │ │ Find an existing one: │ │ │ │ image_widget = None │ │ │ │ widgets = reddit.subreddit("test").widgets │ │ │ │ for widget in widgets.sidebar: │ │ │ │ if isinstance(widget, praw.models.ImageWidget): │ │ │ │ image_widget = widget │ │ │ │ @@ -215,31 +215,31 @@ │ │ │ │ data A list of the _I_m_a_g_es in this widget. Can be iterated over by │ │ │ │ iterating over the _I_m_a_g_e_W_i_d_g_e_t (e.g., for img in image_widget). │ │ │ │ id The widget ID. │ │ │ │ kind The widget kind (always "image"). │ │ │ │ shortName The short name of the widget. │ │ │ │ styles A dict with the keys "backgroundColor" and "headerColor". │ │ │ │ subreddit The _S_u_b_r_e_d_d_i_t the button widget belongs to. │ │ │ │ - __contains__(iitteemm:: _AA_nn_yy) → _b_o_o_l_# │ │ │ │ + __contains__(iitteemm:: AAnnyy) → bool_# │ │ │ │ Test if item exists in the list. │ │ │ │ - __getitem__(iinnddeexx:: _ii_nn_tt) → _A_n_y_# │ │ │ │ + __getitem__(iinnddeexx:: iinntt) → Any_# │ │ │ │ Return the item at position index in the list. │ │ │ │ - __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]])_# │ │ │ │ + __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, __ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]])_# │ │ │ │ Initialize a _W_i_d_g_e_t instance. │ │ │ │ - __iter__() → _I_t_e_r_a_t_o_r[_A_n_y]_# │ │ │ │ + __iter__() → Iterator[Any]_# │ │ │ │ Return an iterator to the list. │ │ │ │ - __len__() → _i_n_t_# │ │ │ │ + __len__() → int_# │ │ │ │ Return the number of items in the list. │ │ │ │ mod() → _p_r_a_w_._m_o_d_e_l_s_._W_i_d_g_e_t_M_o_d_e_r_a_t_i_o_n_# │ │ │ │ Get an instance of _W_i_d_g_e_t_M_o_d_e_r_a_t_i_o_n for this widget. │ │ │ │ Note │ │ │ │ Using any of the methods of _W_i_d_g_e_t_M_o_d_e_r_a_t_i_o_n will likely make the │ │ │ │ data in the _S_u_b_r_e_d_d_i_t_W_i_d_g_e_t_s that this widget belongs to outdated. │ │ │ │ To remedy this, call _r_e_f_r_e_s_h_(_). │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ _N_e_x_t │ │ │ │ _M_e_n_u │ │ │ │ _P_r_e_v_i_o_u_s │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/inlinegif.html │ │ │ @@ -355,19 +355,19 @@ │ │ │ │ │ │ │ │ │
        │ │ │
        │ │ │

        InlineGif#

        │ │ │
        │ │ │
        │ │ │ -class praw.models.InlineGif(*, caption: str = None, path: str)#
        │ │ │ +class praw.models.InlineGif(*, caption: str = None, path: str)# │ │ │

        Class to provide a gif to embed in text.

        │ │ │
        │ │ │
        │ │ │ -__init__(*, caption: str = None, path: str)#
        │ │ │ +__init__(*, caption: str = None, path: str)# │ │ │

        Initialize an InlineMedia instance.

        │ │ │
        │ │ │
        Parameters:
        │ │ │
          │ │ │

        • caption – An optional caption to add to the image (default: None).

          • │ │ │

        • path – The path to a media file.

          • │ │ │
        │ │ │ ├── html2text {} │ │ │ │ @@ -161,17 +161,17 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ IInnlliinneeGGiiff_## ************ │ │ │ │ - ccllaassss praw.models.InlineGif(**, ccaappttiioonn:: _ss_tt_rr == NNoonnee, ppaatthh:: _ss_tt_rr)_# │ │ │ │ + ccllaassss praw.models.InlineGif(**, ccaappttiioonn:: ssttrr == NNoonnee, ppaatthh:: ssttrr)_# │ │ │ │ Class to provide a gif to embed in text. │ │ │ │ - __init__(**, ccaappttiioonn:: _ss_tt_rr == NNoonnee, ppaatthh:: _ss_tt_rr)_# │ │ │ │ + __init__(**, ccaappttiioonn:: ssttrr == NNoonnee, ppaatthh:: ssttrr)_# │ │ │ │ Initialize an _I_n_l_i_n_e_M_e_d_i_a instance. │ │ │ │ Parameters: │ │ │ │ * ccaappttiioonn – An optional caption to add to the image │ │ │ │ (default: None). │ │ │ │ * ppaatthh – The path to a media file. │ │ │ │ _N_e_x_t │ │ │ │ _I_n_l_i_n_e_I_m_a_g_e │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/inlineimage.html │ │ │ @@ -355,19 +355,19 @@ │ │ │ │ │ │ │ │ │
        │ │ │
        │ │ │

        InlineImage#

        │ │ │
        │ │ │
        │ │ │ -class praw.models.InlineImage(*, caption: str = None, path: str)#
        │ │ │ +class praw.models.InlineImage(*, caption: str = None, path: str)# │ │ │

        Class to provide am image to embed in text.

        │ │ │
        │ │ │
        │ │ │ -__init__(*, caption: str = None, path: str)#
        │ │ │ +__init__(*, caption: str = None, path: str)# │ │ │

        Initialize an InlineMedia instance.

        │ │ │
        │ │ │
        Parameters:
        │ │ │
          │ │ │

        • caption – An optional caption to add to the image (default: None).

          • │ │ │

        • path – The path to a media file.

          • │ │ │
        │ │ │ ├── html2text {} │ │ │ │ @@ -161,17 +161,17 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ IInnlliinneeIImmaaggee_## ************ │ │ │ │ - ccllaassss praw.models.InlineImage(**, ccaappttiioonn:: _ss_tt_rr == NNoonnee, ppaatthh:: _ss_tt_rr)_# │ │ │ │ + ccllaassss praw.models.InlineImage(**, ccaappttiioonn:: ssttrr == NNoonnee, ppaatthh:: ssttrr)_# │ │ │ │ Class to provide am image to embed in text. │ │ │ │ - __init__(**, ccaappttiioonn:: _ss_tt_rr == NNoonnee, ppaatthh:: _ss_tt_rr)_# │ │ │ │ + __init__(**, ccaappttiioonn:: ssttrr == NNoonnee, ppaatthh:: ssttrr)_# │ │ │ │ Initialize an _I_n_l_i_n_e_M_e_d_i_a instance. │ │ │ │ Parameters: │ │ │ │ * ccaappttiioonn – An optional caption to add to the image │ │ │ │ (default: None). │ │ │ │ * ppaatthh – The path to a media file. │ │ │ │ _N_e_x_t │ │ │ │ _I_n_l_i_n_e_M_e_d_i_a │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/inlinemedia.html │ │ │ @@ -355,19 +355,19 @@ │ │ │ │ │ │ │ │ │
        │ │ │
        │ │ │

        InlineMedia#

        │ │ │
        │ │ │
        │ │ │ -class praw.models.InlineMedia(*, caption: str = None, path: str)#
        │ │ │ +class praw.models.InlineMedia(*, caption: str = None, path: str)# │ │ │

        Provides a way to embed media in self posts.

        │ │ │
        │ │ │
        │ │ │ -__init__(*, caption: str = None, path: str)#
        │ │ │ +__init__(*, caption: str = None, path: str)# │ │ │

        Initialize an InlineMedia instance.

        │ │ │
        │ │ │
        Parameters:
        │ │ │
          │ │ │

        • caption – An optional caption to add to the image (default: None).

          • │ │ │

        • path – The path to a media file.

          • │ │ │
        │ │ │ ├── html2text {} │ │ │ │ @@ -161,17 +161,17 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ IInnlliinneeMMeeddiiaa_## ************ │ │ │ │ - ccllaassss praw.models.InlineMedia(**, ccaappttiioonn:: _ss_tt_rr == NNoonnee, ppaatthh:: _ss_tt_rr)_# │ │ │ │ + ccllaassss praw.models.InlineMedia(**, ccaappttiioonn:: ssttrr == NNoonnee, ppaatthh:: ssttrr)_# │ │ │ │ Provides a way to embed media in self posts. │ │ │ │ - __init__(**, ccaappttiioonn:: _ss_tt_rr == NNoonnee, ppaatthh:: _ss_tt_rr)_# │ │ │ │ + __init__(**, ccaappttiioonn:: ssttrr == NNoonnee, ppaatthh:: ssttrr)_# │ │ │ │ Initialize an _I_n_l_i_n_e_M_e_d_i_a instance. │ │ │ │ Parameters: │ │ │ │ * ccaappttiioonn – An optional caption to add to the image │ │ │ │ (default: None). │ │ │ │ * ppaatthh – The path to a media file. │ │ │ │ _N_e_x_t │ │ │ │ _I_n_l_i_n_e_V_i_d_e_o │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/inlinevideo.html │ │ │ @@ -355,19 +355,19 @@ │ │ │ │ │ │ │ │ │
        │ │ │
        │ │ │

        InlineVideo#

        │ │ │
        │ │ │
        │ │ │ -class praw.models.InlineVideo(*, caption: str = None, path: str)#
        │ │ │ +class praw.models.InlineVideo(*, caption: str = None, path: str)# │ │ │

        Class to provide a video to embed in text.

        │ │ │
        │ │ │
        │ │ │ -__init__(*, caption: str = None, path: str)#
        │ │ │ +__init__(*, caption: str = None, path: str)# │ │ │

        Initialize an InlineMedia instance.

        │ │ │
        │ │ │
        Parameters:
        │ │ │
          │ │ │

        • caption – An optional caption to add to the image (default: None).

          • │ │ │

        • path – The path to a media file.

          • │ │ │
        │ │ │ ├── html2text {} │ │ │ │ @@ -161,17 +161,17 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ IInnlliinneeVViiddeeoo_## ************ │ │ │ │ - ccllaassss praw.models.InlineVideo(**, ccaappttiioonn:: _ss_tt_rr == NNoonnee, ppaatthh:: _ss_tt_rr)_# │ │ │ │ + ccllaassss praw.models.InlineVideo(**, ccaappttiioonn:: ssttrr == NNoonnee, ppaatthh:: ssttrr)_# │ │ │ │ Class to provide a video to embed in text. │ │ │ │ - __init__(**, ccaappttiioonn:: _ss_tt_rr == NNoonnee, ppaatthh:: _ss_tt_rr)_# │ │ │ │ + __init__(**, ccaappttiioonn:: ssttrr == NNoonnee, ppaatthh:: ssttrr)_# │ │ │ │ Initialize an _I_n_l_i_n_e_M_e_d_i_a instance. │ │ │ │ Parameters: │ │ │ │ * ccaappttiioonn – An optional caption to add to the image │ │ │ │ (default: None). │ │ │ │ * ppaatthh – The path to a media file. │ │ │ │ _N_e_x_t │ │ │ │ _B_a_s_e_M_o_d_N_o_t_e_s │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/listinggenerator.html │ │ │ @@ -355,24 +355,24 @@ │ │ │ │ │ │ │ │ │
        │ │ │
        │ │ │

        ListingGenerator#

        │ │ │
        │ │ │
        │ │ │ -class praw.models.ListingGenerator(reddit: praw.Reddit, url: str, limit: int = 100, params: Optional[Dict[str, Union[str, int]]] = None)#
        │ │ │ +class praw.models.ListingGenerator(reddit: praw.Reddit, url: str, limit: int = 100, params: Optional[Dict[str, Union[str, int]]] = None)# │ │ │

        Instances of this class generate RedditBase instances.

        │ │ │
        │ │ │

        Warning

        │ │ │

        This class should not be directly utilized. Instead, you will find a number of │ │ │ methods that return instances of the class here.

        │ │ │
        │ │ │
        │ │ │
        │ │ │ -__init__(reddit: praw.Reddit, url: str, limit: int = 100, params: Optional[Dict[str, Union[str, int]]] = None)#
        │ │ │ +__init__(reddit: praw.Reddit, url: str, limit: int = 100, params: Optional[Dict[str, Union[str, int]]] = None)# │ │ │

        Initialize a ListingGenerator instance.

        │ │ │
        │ │ │
        Parameters:
        │ │ │
          │ │ │

        • reddit – An instance of Reddit.

          • │ │ │

        • url – A URL returning a Reddit listing.

          • │ │ │

        • limit – The number of content entries to fetch. If limit is None, │ │ │ @@ -384,21 +384,21 @@ │ │ │

        │ │ │
        │ │ │
        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -__iter__() → Iterator[Any]#
        │ │ │ +__iter__() → Iterator[Any]# │ │ │

        Permit ListingGenerator to operate as an iterator.

        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any#
        │ │ │ +classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) → Any# │ │ │

        Return an instance of cls from data.

        │ │ │
        │ │ │
        Parameters:
        │ │ │
          │ │ │

        • data – The structured data.

          • │ │ │

        • reddit – An instance of Reddit.

          • │ │ │
        │ │ │ ├── html2text {} │ │ │ │ @@ -161,37 +161,37 @@ │ │ │ │ * _R_e_f_e_r_e_n_c_e_s │ │ │ │ * _S_p_o_n_s_o_r_s │ │ │ │ * _I_n_d_e_x │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ LLiissttiinnggGGeenneerraattoorr_## ************ │ │ │ │ - ccllaassss praw.models.ListingGenerator(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, uurrll:: _ss_tt_rr, lliimmiitt:: _ii_nn_tt │ │ │ │ - == 110000, ppaarraammss:: _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt]]]]]] == NNoonnee)_# │ │ │ │ + ccllaassss praw.models.ListingGenerator(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, uurrll:: ssttrr, lliimmiitt:: iinntt │ │ │ │ + == 110000, ppaarraammss:: OOppttiioonnaall[[DDiicctt[[ssttrr,, UUnniioonn[[ssttrr,, iinntt]]]]]] == NNoonnee)_# │ │ │ │ Instances of this class generate _R_e_d_d_i_t_B_a_s_e instances. │ │ │ │ Warning │ │ │ │ This class should not be directly utilized. Instead, you will find a │ │ │ │ number of methods that return instances of the class _h_e_r_e. │ │ │ │ - __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, uurrll:: _ss_tt_rr, lliimmiitt:: _ii_nn_tt == 110000, ppaarraammss:: │ │ │ │ - _OO_pp_tt_ii_oo_nn_aa_ll[[_DD_ii_cc_tt[[_ss_tt_rr,, _UU_nn_ii_oo_nn[[_ss_tt_rr,, _ii_nn_tt]]]]]] == NNoonnee)_# │ │ │ │ + __init__(rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt, uurrll:: ssttrr, lliimmiitt:: iinntt == 110000, ppaarraammss:: │ │ │ │ + OOppttiioonnaall[[DDiicctt[[ssttrr,, UUnniioonn[[ssttrr,, iinntt]]]]]] == NNoonnee)_# │ │ │ │ Initialize a _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r instance. │ │ │ │ Parameters: │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ * uurrll – A URL returning a Reddit listing. │ │ │ │ * lliimmiitt – The number of content entries to fetch. If │ │ │ │ limit is None, then fetch as many entries as possible. │ │ │ │ Most of Reddit’s listings contain a maximum of 1000 │ │ │ │ items, and are returned 100 at a time. This class will │ │ │ │ automatically issue all necessary requests (default: │ │ │ │ 100). │ │ │ │ * ppaarraammss – A dictionary containing additional query │ │ │ │ string parameters to send with the request. │ │ │ │ - __iter__() → _I_t_e_r_a_t_o_r[_A_n_y]_# │ │ │ │ + __iter__() → Iterator[Any]_# │ │ │ │ Permit _L_i_s_t_i_n_g_G_e_n_e_r_a_t_o_r to operate as an iterator. │ │ │ │ - ccllaassssmmeetthhoodd parse(ddaattaa:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → _A_n_y_# │ │ │ │ + ccllaassssmmeetthhoodd parse(ddaattaa:: DDiicctt[[ssttrr,, AAnnyy]], rreeddddiitt:: _pp_rr_aa_ww_.._RR_ee_dd_dd_ii_tt) → Any_# │ │ │ │ Return an instance of cls from data. │ │ │ │ Parameters: │ │ │ │ * ddaattaa – The structured data. │ │ │ │ * rreeddddiitt – An instance of _R_e_d_d_i_t. │ │ │ │ _N_e_x_t │ │ │ │ _M_o_d_A_c_t_i_o_n │ │ │ │ _P_r_e_v_i_o_u_s │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/livecontributorrelationship.html │ │ │ @@ -359,15 +359,15 @@ │ │ │

        LiveContributorRelationship#

        │ │ │
        │ │ │
        │ │ │ class praw.models.reddit.live.LiveContributorRelationship(thread: praw.models.LiveThread)#
        │ │ │

        Provide methods to interact with live threads’ contributors.

        │ │ │
        │ │ │
        │ │ │ -__call__() → List[praw.models.Redditor]#
        │ │ │ +__call__() → List[praw.models.Redditor]# │ │ │

        Return a RedditorList for live threads’ contributors.

        │ │ │

        Usage:

        │ │ │ 
        thread = reddit.live("ukaeu1ik4sw5")
│ │ │  for contributor in thread.contributor():
│ │ │      print(contributor)
│ │ │
        │ │ │
        │ │ │ @@ -398,15 +398,15 @@ │ │ │ thread.contributor.accept_invite() │ │ │ │ │ │ │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -invite(redditor: Union[str, praw.models.Redditor], *, permissions: Optional[List[str]] = None)#
        │ │ │ +invite(redditor: Union[str, praw.models.Redditor], *, permissions: Optional[List[str]] = None)# │ │ │

        Invite a redditor to be a contributor of the live thread.

        │ │ │
        │ │ │
        Parameters:
        │ │ │
          │ │ │

        • redditor – A redditor name or Redditor instance.

          • │ │ │

        • permissions – When provided (not None), permissions should be a list │ │ │ of strings specifying which subset of permissions to grant. An empty list │ │ │ @@ -442,15 +442,15 @@ │ │ │ thread.contributor.leave() │ │ │ │ │ │ │ │ │

        │ │ │ │ │ │
        │ │ │
        │ │ │ -remove(redditor: Union[str, praw.models.Redditor])#
        │ │ │ +remove(redditor: Union[str, praw.models.Redditor])# │ │ │

        Remove the redditor from the live thread contributors.

        │ │ │
        │ │ │
        Parameters:
        │ │ │

        redditor – A redditor fullname (e.g., "t2_1w72") or Redditor │ │ │ instance.

        │ │ │
        │ │ │
        │ │ │ @@ -461,15 +461,15 @@ │ │ │ thread.contributor.remove("t2_1w72") # with fullname │ │ │ │ │ │ │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -remove_invite(redditor: Union[str, praw.models.Redditor])#
        │ │ │ +remove_invite(redditor: Union[str, praw.models.Redditor])# │ │ │

        Remove the invite for redditor.

        │ │ │
        │ │ │
        Parameters:
        │ │ │

        redditor – A redditor fullname (e.g., "t2_1w72") or Redditor │ │ │ instance.

        │ │ │
        │ │ │
        │ │ │ @@ -485,15 +485,15 @@ │ │ │

        LiveContributorRelationship.invite() to invite a redditor to be a │ │ │ contributor of the live thread.

        │ │ │ │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -update(redditor: Union[str, praw.models.Redditor], *, permissions: Optional[List[str]] = None)#
        │ │ │ +update(redditor: Union[str, praw.models.Redditor], *, permissions: Optional[List[str]] = None)# │ │ │

        Update the contributor permissions for redditor.

        │ │ │
        │ │ │
        Parameters:
        │ │ │
          │ │ │

        • redditor – A redditor name or Redditor instance.

          • │ │ │

        • permissions – When provided (not None), permissions should be a list │ │ │ of strings specifying which subset of permissions to grant (other │ │ │ @@ -516,15 +516,15 @@ │ │ │ 

          subreddit.moderator.update("spez", permissions=[])
│ │ │
          │ │ │
          │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -update_invite(redditor: Union[str, praw.models.Redditor], *, permissions: Optional[List[str]] = None)#
        │ │ │ +update_invite(redditor: Union[str, praw.models.Redditor], *, permissions: Optional[List[str]] = None)# │ │ │

        Update the contributor invite permissions for redditor.

        │ │ │
        │ │ │
        Parameters:
        │ │ │
          │ │ │

        • redditor – A redditor name or Redditor instance.

          • │ │ │

        • permissions – When provided (not None), permissions should be a list │ │ │ of strings specifying which subset of permissions to grant (other │ │ │ ├── html2text {} │ │ │ │ @@ -164,15 +164,15 @@ │ │ │ │ _B_a_c_k_ _t_o_ _t_o_p │ │ │ │ Toggle Light / Dark / Auto color theme │ │ │ │ Toggle table of contents sidebar │ │ │ │ ************ LLiivveeCCoonnttrriibbuuttoorrRReellaattiioonnsshhiipp_## ************ │ │ │ │ ccllaassss praw.models.reddit.live.LiveContributorRelationship(tthhrreeaadd:: │ │ │ │ _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._LL_ii_vv_ee_TT_hh_rr_ee_aa_dd)_# │ │ │ │ Provide methods to interact with live threads’ contributors. │ │ │ │ - __call__() → _L_i_s_t[_p_r_a_w_._m_o_d_e_l_s_._R_e_d_d_i_t_o_r]_# │ │ │ │ + __call__() → List[_p_r_a_w_._m_o_d_e_l_s_._R_e_d_d_i_t_o_r]_# │ │ │ │ Return a _R_e_d_d_i_t_o_r_L_i_s_t for live threads’ contributors. │ │ │ │ Usage: │ │ │ │ thread = reddit.live("ukaeu1ik4sw5") │ │ │ │ for contributor in thread.contributor(): │ │ │ │ print(contributor) │ │ │ │ __init__(tthhrreeaadd:: _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._LL_ii_vv_ee_TT_hh_rr_ee_aa_dd)_# │ │ │ │ Initialize a _L_i_v_e_C_o_n_t_r_i_b_u_t_o_r_R_e_l_a_t_i_o_n_s_h_i_p instance. │ │ │ │ @@ -182,16 +182,16 @@ │ │ │ │ This class should not be initialized directly. Instead, obtain an │ │ │ │ instance via: _L_i_v_e_T_h_r_e_a_d_._c_o_n_t_r_i_b_u_t_o_r_(_). │ │ │ │ accept_invite()_# │ │ │ │ Accept an invite to contribute the live thread. │ │ │ │ Usage: │ │ │ │ thread = reddit.live("ydwwxneu7vsa") │ │ │ │ thread.contributor.accept_invite() │ │ │ │ - invite(rreeddddiittoorr:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._RR_ee_dd_dd_ii_tt_oo_rr]], **, ppeerrmmiissssiioonnss:: │ │ │ │ - _OO_pp_tt_ii_oo_nn_aa_ll[[_LL_ii_ss_tt[[_ss_tt_rr]]]] == NNoonnee)_# │ │ │ │ + invite(rreeddddiittoorr:: UUnniioonn[[ssttrr,, _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._RR_ee_dd_dd_ii_tt_oo_rr]], **, ppeerrmmiissssiioonnss:: │ │ │ │ + OOppttiioonnaall[[LLiisstt[[ssttrr]]]] == NNoonnee)_# │ │ │ │ Invite a redditor to be a contributor of the live thread. │ │ │ │ Parameters: │ │ │ │ * rreeddddiittoorr – A redditor name or _R_e_d_d_i_t_o_r instance. │ │ │ │ * ppeerrmmiissssiioonnss – When provided (not None), permissions │ │ │ │ should be a list of strings specifying which subset of │ │ │ │ permissions to grant. An empty list [] indicates no │ │ │ │ permissions, and when not provided (None), indicates │ │ │ │ @@ -209,39 +209,39 @@ │ │ │ │ _L_i_v_e_C_o_n_t_r_i_b_u_t_o_r_R_e_l_a_t_i_o_n_s_h_i_p_._r_e_m_o_v_e___i_n_v_i_t_e_(_) to remove the invite │ │ │ │ for redditor. │ │ │ │ leave()_# │ │ │ │ Abdicate the live thread contributor position (use with care). │ │ │ │ Usage: │ │ │ │ thread = reddit.live("ydwwxneu7vsa") │ │ │ │ thread.contributor.leave() │ │ │ │ - remove(rreeddddiittoorr:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._RR_ee_dd_dd_ii_tt_oo_rr]])_# │ │ │ │ + remove(rreeddddiittoorr:: UUnniioonn[[ssttrr,, _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._RR_ee_dd_dd_ii_tt_oo_rr]])_# │ │ │ │ Remove the redditor from the live thread contributors. │ │ │ │ Parameters: │ │ │ │ rreeddddiittoorr – A redditor fullname (e.g., "t2_1w72") or _R_e_d_d_i_t_o_r │ │ │ │ instance. │ │ │ │ Usage: │ │ │ │ thread = reddit.live("ukaeu1ik4sw5") │ │ │ │ redditor = reddit.redditor("spez") │ │ │ │ thread.contributor.remove(redditor) │ │ │ │ thread.contributor.remove("t2_1w72") # with fullname │ │ │ │ - remove_invite(rreeddddiittoorr:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._RR_ee_dd_dd_ii_tt_oo_rr]])_# │ │ │ │ + remove_invite(rreeddddiittoorr:: UUnniioonn[[ssttrr,, _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._RR_ee_dd_dd_ii_tt_oo_rr]])_# │ │ │ │ Remove the invite for redditor. │ │ │ │ Parameters: │ │ │ │ rreeddddiittoorr – A redditor fullname (e.g., "t2_1w72") or _R_e_d_d_i_t_o_r │ │ │ │ instance. │ │ │ │ Usage: │ │ │ │ thread = reddit.live("ukaeu1ik4sw5") │ │ │ │ redditor = reddit.redditor("spez") │ │ │ │ thread.contributor.remove_invite(redditor) │ │ │ │ thread.contributor.remove_invite("t2_1w72") # with fullname │ │ │ │ See also │ │ │ │ _L_i_v_e_C_o_n_t_r_i_b_u_t_o_r_R_e_l_a_t_i_o_n_s_h_i_p_._i_n_v_i_t_e_(_) to invite a redditor to be a │ │ │ │ contributor of the live thread. │ │ │ │ - update(rreeddddiittoorr:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._RR_ee_dd_dd_ii_tt_oo_rr]], **, ppeerrmmiissssiioonnss:: │ │ │ │ - _OO_pp_tt_ii_oo_nn_aa_ll[[_LL_ii_ss_tt[[_ss_tt_rr]]]] == NNoonnee)_# │ │ │ │ + update(rreeddddiittoorr:: UUnniioonn[[ssttrr,, _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._RR_ee_dd_dd_ii_tt_oo_rr]], **, ppeerrmmiissssiioonnss:: │ │ │ │ + OOppttiioonnaall[[LLiisstt[[ssttrr]]]] == NNoonnee)_# │ │ │ │ Update the contributor permissions for redditor. │ │ │ │ Parameters: │ │ │ │ * rreeddddiittoorr – A redditor name or _R_e_d_d_i_t_o_r instance. │ │ │ │ * ppeerrmmiissssiioonnss – When provided (not None), permissions │ │ │ │ should be a list of strings specifying which subset of │ │ │ │ permissions to grant (other permissions are removed). │ │ │ │ An empty list [] indicates no permissions, and when not │ │ │ │ @@ -250,16 +250,16 @@ │ │ │ │ thread = reddit.live("ukaeu1ik4sw5") │ │ │ │ thread.contributor.update("spez") │ │ │ │ To grant "access" and "edit" permissions (and to remove other │ │ │ │ permissions), try: │ │ │ │ thread.contributor.update("spez", permissions=["access", "edit"]) │ │ │ │ To remove all permissions from the contributor, try: │ │ │ │ subreddit.moderator.update("spez", permissions=[]) │ │ │ │ - update_invite(rreeddddiittoorr:: _UU_nn_ii_oo_nn[[_ss_tt_rr,, _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._RR_ee_dd_dd_ii_tt_oo_rr]], **, │ │ │ │ - ppeerrmmiissssiioonnss:: _OO_pp_tt_ii_oo_nn_aa_ll[[_LL_ii_ss_tt[[_ss_tt_rr]]]] == NNoonnee)_# │ │ │ │ + update_invite(rreeddddiittoorr:: UUnniioonn[[ssttrr,, _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._RR_ee_dd_dd_ii_tt_oo_rr]], **, │ │ │ │ + ppeerrmmiissssiioonnss:: OOppttiioonnaall[[LLiisstt[[ssttrr]]]] == NNoonnee)_# │ │ │ │ Update the contributor invite permissions for redditor. │ │ │ │ Parameters: │ │ │ │ * rreeddddiittoorr – A redditor name or _R_e_d_d_i_t_o_r instance. │ │ │ │ * ppeerrmmiissssiioonnss – When provided (not None), permissions │ │ │ │ should be a list of strings specifying which subset of │ │ │ │ permissions to grant (other permissions are removed). │ │ │ │ An empty list [] indicates no permissions, and when not │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/livethreadcontribution.html │ │ │ @@ -376,15 +376,15 @@ │ │ │ thread.contrib.add("### update") │ │ │ │ │ │ │ │ │

        │ │ │ │ │ │
        │ │ │
        │ │ │ -add(body: str)#
        │ │ │ +add(body: str)# │ │ │

        Add an update to the live thread.

        │ │ │
        │ │ │
        Parameters:
        │ │ │

        body – The Markdown formatted content for the update.

        │ │ │
        │ │ │
        │ │ │

        Usage:

        │ │ │ @@ -403,15 +403,15 @@ │ │ │ thread.contrib.close() │ │ │ │ │ │ │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -update(*, description: Optional[str] = None, nsfw: Optional[bool] = None, resources: Optional[str] = None, title: Optional[str] = None, **other_settings: Optional[str])#
        │ │ │ +update(*, description: Optional[str] = None, nsfw: Optional[bool] = None, resources: Optional[str] = None, title: Optional[str] = None, **other_settings: Optional[str])# │ │ │

        Update settings of the live thread.

        │ │ │
        │ │ │
        Parameters:
        │ │ │
          │ │ │

        • description – The live thread’s description (default: None).

          • │ │ │

        • nsfw – Indicate whether this thread is not safe for work (default: │ │ │ None).

          • │ │ │ ├── html2text {} │ │ │ │ @@ -172,29 +172,29 @@ │ │ │ │ Initialize a _L_i_v_e_T_h_r_e_a_d_C_o_n_t_r_i_b_u_t_i_o_n instance. │ │ │ │ Parameters: │ │ │ │ tthhrreeaadd – An instance of _L_i_v_e_T_h_r_e_a_d. │ │ │ │ This instance can be retrieved through thread.contrib where thread │ │ │ │ is a _L_i_v_e_T_h_r_e_a_d instance. E.g., │ │ │ │ thread = reddit.live("ukaeu1ik4sw5") │ │ │ │ thread.contrib.add("### update") │ │ │ │ - add(bbooddyy:: _ss_tt_rr)_# │ │ │ │ + add(bbooddyy:: ssttrr)_# │ │ │ │ Add an update to the live thread. │ │ │ │ Parameters: │ │ │ │ bbooddyy – The Markdown formatted content for the update. │ │ │ │ Usage: │ │ │ │ thread = reddit.live("ydwwxneu7vsa") │ │ │ │ thread.contrib.add("test `LiveThreadContribution.add()`") │ │ │ │ close()_# │ │ │ │ Close the live thread permanently (cannot be undone). │ │ │ │ Usage: │ │ │ │ thread = reddit.live("ukaeu1ik4sw5") │ │ │ │ thread.contrib.close() │ │ │ │ - update(**, ddeessccrriippttiioonn:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, nnssffww:: _OO_pp_tt_ii_oo_nn_aa_ll[[_bb_oo_oo_ll]] == │ │ │ │ - NNoonnee, rreessoouurrcceess:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, ttiittllee:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]] == NNoonnee, │ │ │ │ - ****ootthheerr__sseettttiinnggss:: _OO_pp_tt_ii_oo_nn_aa_ll[[_ss_tt_rr]])_# │ │ │ │ + update(**, ddeessccrriippttiioonn:: OOppttiioonnaall[[ssttrr]] == NNoonnee, nnssffww:: OOppttiioonnaall[[bbooooll]] == │ │ │ │ + NNoonnee, rreessoouurrcceess:: OOppttiioonnaall[[ssttrr]] == NNoonnee, ttiittllee:: OOppttiioonnaall[[ssttrr]] == NNoonnee, │ │ │ │ + ****ootthheerr__sseettttiinnggss:: OOppttiioonnaall[[ssttrr]])_# │ │ │ │ Update settings of the live thread. │ │ │ │ Parameters: │ │ │ │ * ddeessccrriippttiioonn – The live thread’s description (default: │ │ │ │ None). │ │ │ │ * nnssffww – Indicate whether this thread is not safe for │ │ │ │ work (default: None). │ │ │ │ * rreessoouurrcceess – Markdown formatted information that is │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/livethreadstream.html │ │ │ @@ -375,15 +375,15 @@ │ │ │

          live_thread – The live thread associated with the stream.

          │ │ │
          │ │ │
        │ │ │
        │ │ │ │ │ │
        │ │ │
        │ │ │ -updates(**stream_options: Dict[str, Any]) → Iterator[praw.models.LiveUpdate]#
        │ │ │ +updates(**stream_options: Dict[str, Any]) → Iterator[praw.models.LiveUpdate]# │ │ │

        Yield new updates to the live thread as they become available.

        │ │ │
        │ │ │
        Parameters:
        │ │ │

        skip_existing – Set to True to only fetch items created after the │ │ │ stream (default: False).

        │ │ │
        │ │ │
        │ │ │ ├── html2text {} │ │ │ │ @@ -171,15 +171,15 @@ │ │ │ │ Usually used via: │ │ │ │ for live_update in reddit.live("ta535s1hq2je").stream.updates(): │ │ │ │ print(live_update.body) │ │ │ │ __init__(lliivvee__tthhrreeaadd:: _pp_rr_aa_ww_.._mm_oo_dd_ee_ll_ss_.._LL_ii_vv_ee_TT_hh_rr_ee_aa_dd)_# │ │ │ │ Initialize a _L_i_v_e_T_h_r_e_a_d_S_t_r_e_a_m instance. │ │ │ │ Parameters: │ │ │ │ lliivvee__tthhrreeaadd – The live thread associated with the stream. │ │ │ │ - updates(****ssttrreeaamm__ooppttiioonnss:: _DD_ii_cc_tt[[_ss_tt_rr,, _AA_nn_yy]]) → _I_t_e_r_a_t_o_r │ │ │ │ + updates(****ssttrreeaamm__ooppttiioonnss:: DDiicctt[[ssttrr,, AAnnyy]]) → Iterator │ │ │ │ [_p_r_a_w_._m_o_d_e_l_s_._L_i_v_e_U_p_d_a_t_e]_# │ │ │ │ Yield new updates to the live thread as they become available. │ │ │ │ Parameters: │ │ │ │ sskkiipp__eexxiissttiinngg – Set to True to only fetch items created after │ │ │ │ the stream (default: False). │ │ │ │ As with _L_i_v_e_T_h_r_e_a_d_._u_p_d_a_t_e_s_(_), updates are yielded as _L_i_v_e_U_p_d_a_t_e. │ │ │ │ Updates are yielded oldest first. Up to 100 historical updates will │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/liveupdatecontribution.html │ │ │ @@ -402,15 +402,15 @@ │ │ │ │ │ │ │ │ │

        To check whether the update is stricken or not, use update.stricken │ │ │ attribute.

        │ │ │
        │ │ │

        Note

        │ │ │

        Accessing lazy attributes on updates (includes update.stricken) may │ │ │ -raise AttributeError. See LiveUpdate for details.

        │ │ │ +raise AttributeError. See LiveUpdate for details.

        │ │ │
        │ │ │
        │ │ │ │ │ │
        │ │ │ │ │ │
        │ │ │ ├── html2text {} │ │ │ │ @@ -189,15 +189,15 @@ │ │ │ │ thread = reddit.live("xyu8kmjvfrww") │ │ │ │ update = thread["cb5fe532-dbee-11e6-9a91-0e6d74fabcc4"] │ │ │ │ update.contrib.strike() │ │ │ │ To check whether the update is stricken or not, use update.stricken │ │ │ │ attribute. │ │ │ │ Note │ │ │ │ Accessing lazy attributes on updates (includes update.stricken) may │ │ │ │ - raise _A_t_t_r_i_b_u_t_e_E_r_r_o_r. See _L_i_v_e_U_p_d_a_t_e for details. │ │ │ │ + raise AttributeError. See _L_i_v_e_U_p_d_a_t_e for details. │ │ │ │ _N_e_x_t │ │ │ │ _C_o_n_t_r_i_b_u_t_o_r_R_e_l_a_t_i_o_n_s_h_i_p │ │ │ │ _P_r_e_v_i_o_u_s │ │ │ │ _L_i_v_e_T_h_r_e_a_d_S_t_r_e_a_m │ │ │ │ Copyright © 2023, Bryce Boe │ │ │ │ Made with _S_p_h_i_n_x and _@_p_r_a_d_y_u_n_s_g's _F_u_r_o │ │ │ │ On this page │ │ ├── ./usr/share/doc/praw-doc/html/code_overview/other/menu.html │ │ │ @@ -355,15 +355,15 @@ │ │ │ │ │ │ │ │ │
        │ │ │