Fj$,dZddlmZddlZddlZddlZddlZddlZddlZddl m Z ddl m Z ddl mZmZmZmZddlmZddlmZmZmZmZmZmZmZmZmZdd lmZdd l m!Z!dd l"m#Z#dd l$m%Z%m&Z&m'Z'dd l(m)Z)m*Z*m+Z+ddl,m-Z- ddl.m/Z/dZ0er8ddl2Z2e2jfdk\rddl m4Z4nddl5m4Z4ddl6m7Z7m8Z8m9Z9ddl:Zddl;Zddl(me!j~Z?e!jZ@e dZAGddZBy#e1$rdZ/dZ0YwxYw)zProvide the Reddit class.) annotationsN)islice) getLogger)IO TYPE_CHECKINGAnycast)urlparse) AuthorizerDeviceIDAuthorizerReadOnlyAuthorizerRedirect RequestorScriptAuthorizerTrustedAuthenticatorUntrustedAuthenticatorsession) BadRequest)models)Config)API_PATHUSER_AGENT_FORMAT __version__)ClientException!MissingRequiredAttributeExceptionRedditAPIException)Objector) update_checkFT) )Self) GeneratorIterableIterator)RedditErrorItemprawceZdZdZej dZdZed,dZ ed-dZ e jd.dZ d/dZ d0dZ d1d d d d  d2d Zd3d Zd3d Zd4dZd d d dd dd d5dZd6dZd3dZd d d d7dZd8dZd8dZd9dZd1d dd:dZd d d d d;dZdd!Zd d d d d;d"Zd d d d d# d?d$Zd d d% d@d&Z d1d d'dAd(Z!d d d d d# d5d)Z"d1d ddBd*Z#dCd+Z$y )DRedditaThe Reddit class provides convenient access to Reddit's API. Instances of this class are the gateway to interacting with Reddit's API through PRAW. The canonical way to obtain an instance of this class is via: .. code-block:: python import praw reddit = praw.Reddit( client_id="CLIENT_ID", client_secret="CLIENT_SECRET", password="PASSWORD", user_agent="USERAGENT", username="USERNAME", ) z.([0-9]{1,3}) (milliseconds?|seconds?|minutes?)FcH|j}|xjdz c_|SN)_unique_counter)selfvalues I/root/workspace/ytshorts/venv/lib/python3.12/site-packages/praw/reddit.py _next_uniquezReddit._next_unique^s#$$ ! c4|j|jk(S)z/``True`` when using the ``ReadOnlyAuthorizer``.)_core_read_only_corer-s r/ read_onlyzReddit.read_onlydszzT1111r1c|r|j|_y|j d}t||j|_y)zSet or unset the use of the ReadOnlyAuthorizer. :raises: :class:`.ClientException` when attempting to unset ``read_only`` and only the ``ReadOnlyAuthorizer`` is available. NzFread_only cannot be unset as only the ReadOnlyAuthorizer is available.)r4r3_authorized_corer)r-r.msgs r/r6zReddit.read_onlyis= --DJ  " " *ZC!#& &..DJr1c|S)z Handle the context manager open.r5s r/ __enter__zReddit.__enter__ys r1cy)z!Handle the context manager close.Nr;)r-_s r/__exit__zReddit.__exit__}sr1N)config_interpolationrequestor_classrequestor_kwargsc Fdx|_x|_|_|d|_ |xst j dxsd}t ||fi||_d} dD]J} t|j| |jjdhvs2t| j| |jj|jjur| jd d } t| |j!|j#|j%|| t'j(|d|_ t'j,|d|_ t'j0|d|_ t'j4||_ t'j8|d|_ t'j<|d|_ t'j@|d|_! t'jD||_# t'jH|d|_% t'jL|d|_' t'jP|d|_) t'jT||_+y#tj$r"}d}||xjd|z c_ d}~wwxYw) a Initialize a :class:`.Reddit` instance. :param site_name: The name of a section in your ``praw.ini`` file from which to load settings from. This parameter, in tandem with an appropriately configured ``praw.ini``, file is useful if you wish to easily save credentials for different applications, or communicate with other servers running Reddit. If ``site_name`` is ``None``, then the site name will be looked for in the environment variable ``praw_site``. If it is not found there, the ``DEFAULT`` site will be used (default: ``None``). :param config_interpolation: Config parser interpolation type that will be passed to :class:`.Config` (default: ``None``). :param requestor_class: A class that will be used to create a requestor. If not set, use ``prawcore.Requestor`` (default: ``None``). :param requestor_kwargs: Dictionary with additional keyword arguments used to initialize the requestor (default: ``None``). Additional keyword arguments will be used to initialize the :class:`.Config` object. This can be used to specify configuration settings during instantiation of the :class:`.Reddit` instance. For more details, please see :ref:`configuration`. Required settings are: - ``client_id`` - ``client_secret`` (for installed applications set this value to ``None``) - ``user_agent`` The ``requestor_class`` and ``requestor_kwargs`` allow for customization of the requestor :class:`.Reddit` will use. This allows, e.g., easily adding behavior to the requestor or wrapping its |Session|_ in a caching layer. Example usage: .. |Session| replace:: ``Session`` .. _session: https://requests.readthedocs.io/en/stable/api/#request-sessions .. code-block:: python import json import requests from prawcore import Requestor from praw import Reddit class JSONDebugRequestor(Requestor): def request(self, *args, **kwargs): response = super().request(*args, **kwargs) print(json.dumps(response.json(), indent=4)) return response my_session = requests.Session() reddit = Reddit( ..., requestor_class=JSONDebugRequestor, requestor_kwargs={"session": my_session} ) Nr praw_siteDEFAULTa/You provided the name of a praw.ini configuration which does not exist. For help with creating a Reddit instance, visit https://praw.readthedocs.io/en/latest/code_overview/reddit_instance.html For help on configuring PRAW, visit https://praw.readthedocs.io/en/latest/getting_started/configuration.html zRequired configuration setting {!r} missing. This setting can be provided in a praw.ini file, as a keyword argument to the Reddit class constructor, or as an environment variable.) client_id user_agent client_secretzr For installed applications this value must be set to None via a keyword argument to the Reddit class constructor.rArB),r3r8r4r,osgetenvrconfig configparserNoSectionErrormessagegetattrCONFIG_NOT_SETrformatrI_check_for_update_prepare_objector_prepare_prawcorerAuthauthAnnouncementHelper announcements DraftHelperdraftsFrontfrontInboxinbox LiveHelperliveMultiredditHelper multiredditRedditModNotesnotes Redditors redditorsSubredditHelper subreddit Subreddits subredditsUseruser) r- site_namer@rArBconfig_settingsconfig_sectionexc help_messagerequired_message attributer9s r/__init__zReddit.__init__sFEIH HT*T-A   @RYY{3@y !1EYYDK ;  5 \It{{I.4;;3M3Mt2TT78H8O8OPY8Z[[ \ ;; $ $ (B(B B%,,_=>?rsC3C8 8     QabKKd+  $66tTB (((t4  $\\$'  \\$-  %%dD1  "33D$? **40  0 ))$5  //d; 2!++D$7 KK%  _** c $ L>22  s/I++J >JJ c|jjrdttdd}||jj dk(ryd} t jd}|rtjdyyy#t$rY%wxYw)N get_ipythonZMQInteractiveShellFTaIt appears that you are using PRAW in an asynchronous environment. It is strongly recommended to use Async PRAW: https://asyncpraw.readthedocs.io. See https://praw.readthedocs.io/en/latest/getting_started/multiple_instances.html#discord-bots-and-asynchronous-environments for more info. ) rMcheck_for_asyncrQbuiltins __class____name__asyncioget_running_loop Exceptionloggerwarning)r-rxin_asyncs r/_check_for_asynczReddit._check_for_asyncs ;; & &!(M4@K&;=+B+B+K+KOd+dH ((*( '  s A<< BBctstytjs<|jj r%tt xsdtdt_yyy)Nr&) package_namepackage_versionT)UPDATE_CHECKER_MISSINGrr(update_checkedrMcheck_for_updates __package__rr5s r/rTzReddit._check_for_updatesB !\%9 $$)F)F k&;V[ Y$(F !*G$r1c|jD]}|jdk(s|j |jj |j}|syt |j d}|j djdr|dz}n"|j djdrd}|t |jjks|dzcSy)N RATELIMITr+minute< millisecondr) items error_typerP_ratelimit_regexsearchintgroup startswithrMratelimit_seconds)r- exceptionitem amount_searchsecondss r/_handle_rate_limitzReddit._handle_rate_limitsOO 'D+-$,,2J $ 5 5 < rMG"((+66}EGc$++"?"?@@"Q;& 'r1datafilesjsonmethodparamspathc d|jj|j||||||S)aRun a request through the ``Objector``. :param data: Dictionary, bytes, or file-like object to send in the body of the request (default: ``None``). :param files: Dictionary, filename to file (like) object mapping (default: ``None``). :param json: JSON-serializable object to send in the body of the request with a Content-Type header of application/json (default: ``None``). If ``json`` is provided, ``data`` should not be. :param method: The HTTP method (e.g., ``"GET"``, ``"POST"``, ``"PUT"``, ``"DELETE"``). :param params: The query parameters to add to the request (default: ``None``). :param path: The path to fetch. r)r) _objector objectifyrequest)r-rrrrrrs r/_objectify_requestzReddit._objectify_requestsC2~~'' (  r1c|jjr"t||jj}n|j|_yt ||jj x|_|_y)N) authenticator refresh_token authorizer window_size)rMrr r4r3rrr8)r-rrs r/_prepare_common_authorizerz!Reddit._prepare_common_authorizersX ;; $ $#-t{{OhOhiJ--DJ -4 X\XcXcXoXo-pp T*r1c4i|jjdtj|jjdtj|jjdtj |jjdtj |jjdtj|jjdtjdtjdtjd tjd tjd tjd tjd tjdtj dtj"dtj$dtj&idtj(dtj*dtj,dtj.dtj0dtj2dtj4dtj6dtj8dtj:dtjdtj<dtj>dtj@d tjBd!tjDd"tjFtjHtjJtjLtjNtjPtjRtjTtjVtjXtjZtj\tj^d# }ta|||_1y)$NcommentrPredditor submissionrjtrophy AnnouncementAnnouncementListingButton CollectionDraft DraftListImage LabeledMultiListing LiveUpdateLiveUpdateEventMenuLink ModeratedList ModmailActionModmailConversationzModmailConversations-listModmailMessageSubmenu TrophyListUserList UserSubredditannbuttoncalendarzcommunity-listcustomzid-cardimage) menumod_note modactionzmoderator-list moderatorsmorez post-flairrule stylesheetzsubreddit-rulestextareawidget)2rMkindsrCommentMessageRedditor Submission SubredditTrophyrrrrrrr Multiredditrr LiveThreadrrrrModmailConversationsListingrrr RedditorListr ButtonWidgetCalendar CommunityList CustomWidgetIDCard ImageWidgetMenuModNote ModActionModeratorListingModeratorsWidget MoreCommentsPostFlairWidgetRule Stylesheet RulesWidgetTextAreaWidgetrr)r-mappingss r/rUzReddit._prepare_objectors-/ KK  i (&../ KK  i (&../  KK  j )6??/  KK  l +V->-> / KK  k *F,<,< / KK  h ' /  F///  "6#=#=/  fmm/  &++/  V\\/  ))/  V\\/  F../  v~~/ &++!/ " v00#/ $ %/ & V11'/ ( V11)/ * "6#=#=+/ , ()K)K-/ . f33// 0 v~~1/ 2 &++3/ 4 ++5/ 6 V117/ 8 6&&9/ : f));/ < =/ > f22?/ @ f))A/ B v}}C/ D V''E/ FKK))$55 11'' 00KK ++%11mm]/ `"$1r1rJcL|xst}|xsi}|d|jj|jjt j |jj d|}|jjr|j|y|j|y)N) oauth_url reddit_urlrHr;) rrMrrrrSrHrI_prepare_trusted_prawcore_prepare_untrusted_prawcore)r-rArB requestors r/rVzReddit._prepare_prawcore1s *6Y+1r# kk++{{--(// 0F0FG    ;; $ $  * *9 5  , ,Y 7r1cp|jjJt|jj|jj|jj|}t |}t ||jj|_|jjrz|jjrdt||jj|jj}t ||jjx|_ |_ y|j|y)N)rGrI redirect_urirrr)rpasswordusername)rMrIrrGrr rrr4rrrr3r8r)r-rrread_only_authorizerscript_authorizers r/rz Reddit._prepare_trusted_prawcoreFs{{((444,kk++++3311  2 N&2FTXT_T_TkTkl ;;  DKK$8$8 0+dkk6J6JUYU`U`UiUi! 29,$++:Q:Q2 DJ.  + +M :r1ct|jj|jj|}t |}t ||jj |_|j|y)N)rGrrrr) rrMrGrr rrr4r)r-rrrs r/rz"Reddit._prepare_untrusted_prawcore\s`.kk++$++:R:R^g  2 N&2FTXT_T_TkTkl '' 6r1c0t|jjdjd}d|vr |j ||S|S#t $r>}|j j}|J|jJ|jcYd}~Sd}~wwxYw)z/Return the canonical URL for a given share URL./sN) r rrstripsplitgetrresponsenexturl)r-rpartse next_requests r/_resolve_share_urlzReddit._resolve_share_urlds ""))#.44S9 %< (  s  ( zz #///#''333#'''  (sA B3B BB)rcX|r|j|}tj|||S)aFReturn a lazy instance of :class:`.Comment`. :param id: The ID of the comment. :param url: A permalink pointing to the comment. .. note:: If you want to obtain the comment's replies, you will need to call :meth:`~.Comment.refresh` on the returned :class:`.Comment`. idr)rrrr-rrs r/rzReddit.commentqs* ))#.C~~drs33r1)rrrc.|j||d||S)a)Return parsed objects returned from a DELETE request to ``path``. :param path: The path to fetch. :param data: Dictionary, bytes, or file-like object to send in the body of the request (default: ``None``). :param json: JSON-serializable object to send in the body of the request with a Content-Type header of application/json (default: ``None``). If ``json`` is provided, ``data`` should not be. :param params: The query parameters to add to the request (default: ``None``). DELETErrrrrrr-rrrrs r/deletez Reddit.deletes"&&&DtHU[bf&ggr1c.tj||S)z~Return an instance of :class:`.DomainListing`. :param domain: The domain to obtain submission listings for. )r DomainListing)r-domains r/rz Reddit.domains ##D&11r1rc*|jd||S)zReturn parsed objects returned from a GET request to ``path``. :param path: The path to fetch. :param params: The query parameters to add to the request (default: ``None``). GETrrrr)r-rrs r/r z Reddit.gets&&eF&NNr1) fullnamesrlrc td|||fD}|dk7r d}t||du r|n|}|7t|tr d}t| rdnd d fd }||S d fd }|J||S) aTFetch information about each item in ``fullnames``, ``url``, or ``subreddits``. :param fullnames: A list of fullnames for comments, submissions, and/or subreddits. :param subreddits: A list of subreddit names or :class:`.Subreddit` objects to retrieve subreddits from. :param url: A url (as a string) to retrieve lists of link submissions from. :returns: A generator that yields found items in their relative order. Items that cannot be matched will not be generated. Requests will be issued in batches for each 100 fullnames. .. note:: For comments that are retrieved via this method, if you want to obtain its replies, you will need to call :meth:`~.Comment.refresh` on the yielded :class:`.Comment`. .. note:: When using the URL option, it is important to be aware that URLs are treated literally by Reddit's API. As such, the URLs ``"youtube.com"`` and ``"https://www.youtube.com"`` will provide a different set of submissions. c3&K|] }|d ywr*r;).0r.s r/ zReddit.info..sYeuGXYsr+z.name_generator..s5tT5sd,infor )iterr-listrjoinr r)namesriterablechunkrapi_parameter_nameis_using_fullnamesr-s r/name_generatorz#Reddit.info..name_generators:LD5u55QUmrVseiWZ[_W`VsQt #!67E 4FQV3XF#xx(8xHHH WtIsBB ABB Bc3^Kd|i}jtd|Ed{y7w)Nrr0r )r r)_urlrr-s r/ url_generatorz"Reddit.info..url_generators--24=Fxx 0x@ @ @s "-+-)r4z Iterable[str | models.Subreddit]returnLGenerator[models.Subreddit | models.Comment | models.Submission, None, None])r;r-r=r>)sum TypeError isinstancer-) r-r$rlr set_countr9 ids_or_namesr9r<r7r8s ` @@r/r0z Reddit.infosJY 3 'CYY >PCC. &d2$6yJ  #,,Pn$);  I7 I I"",/ / A A  AS!!r1c.|j||d||S)a(Return parsed objects returned from a PATCH request to ``path``. :param path: The path to fetch. :param data: Dictionary, bytes, or file-like object to send in the body of the request (default: ``None``). :param json: JSON-serializable object to send in the body of the request with a Content-Type header of application/json (default: ``None``). If ``json`` is provided, ``data`` should not be. :param params: The query parameters to add to the request (default: ``None``). PATCHrrrs r/patchz Reddit.patchs"&&&DtGTZae&ffr1)rrrrc d||xsi}i}|r?|jD],\}} |j} |j| | ||<.d} t dD]O} | r2|r0|J|jD]\}} ||j|  |j|||d||cS| J| #ttt f$rYwxYw#t$r[} | } |j| } | Yd} ~ E| dk(rdnd}tjd | |tj| Yd} ~ d} ~ wwxYw) aReturn parsed objects returned from a POST request to ``path``. :param path: The path to fetch. :param data: Dictionary, bytes, or file-like object to send in the body of the request (default: ``None``). :param files: Dictionary, filename to file (like) object mapping (default: ``None``). :param json: JSON-serializable object to send in the body of the request with a Content-Type header of application/json (default: ``None``). If ``json`` is provided, ``data`` should not be. :param params: The query parameters to add to the request (default: ``None``). .. note:: This method automatically retries after a rate limit response. Only seekable file objects are rewound between attempts; a non-seekable object may be transmitted incompletely if a retry occurs. NrPOSTr)rr+secondrz"Rate limit hit, sleeping for %d %s)rtellseekAttributeErrorOSError ValueErrorrangerrrrdebugtimesleep)r-rrrrrfile_positionsnamefilepositionlast_exceptionattemptrr second_strings r/postz Reddit.postsp8 <:2D)+ #kkm 0 d#yy{HIIh'(0t$  059Qx $G>(((&4&:&:&</ND($K$$X./ $..!! /  $,)))9'<&& $!*11I1F?,3qLi  A7MZ 7## $s/!B1C 1CC D/D*05D**D/)rrc,|j||d|S)aReturn parsed objects returned from a PUT request to ``path``. :param path: The path to fetch. :param data: Dictionary, bytes, or file-like object to send in the body of the request (default: ``None``). :param json: JSON-serializable object to send in the body of the request with a Content-Type header of application/json (default: ``None``). If ``json`` is provided, ``data`` should not be. PUT)rrrrr)r-rrrs r/putz Reddit.putXs"&&DtEPT&UUr1)fullnamec2tj|||S)zReturn a lazy instance of :class:`.Redditor`. :param name: The name of the redditor. :param fullname: The fullname of the redditor, starting with ``t2_``. Either ``name`` or ``fullname`` can be provided, but not both. )r^rT)rr)r-rTr^s r/rzReddit.redditorksthTBBr1c l|jjr|j|r|r d}t||jJ |jj ||||||S#t $r} |jj} nA#t$r5|jjrd|jji} n|dYnwxYwt| ddhk(r| jd} d| vrt| dd k(sJ| dd } nd} ttd | d| | g|d}~wwxYw) aReturn the parsed JSON data returned from a request to URL. :param data: Dictionary, bytes, or file-like object to send in the body of the request (default: ``None``). :param files: Dictionary, filename to file (like) object mapping (default: ``None``). :param json: JSON-serializable object to send in the body of the request with a Content-Type header of application/json (default: ``None``). If ``json`` is provided, ``data`` should not be. :param method: The HTTP method (e.g., ``"GET"``, ``"POST"``, ``"PUT"``, ``"DELETE"``). :param params: The query parameters to add to the request (default: ``None``). :param path: The path to fetch. z-At most one of 'data' or 'json' is supported.NrreasonerrorrP explanationfieldsr+rz'list[RedditErrorItem | list[str] | str])rMrzrrr3rrr rrNtextsetr lenrr ) r-rrrrrrr9r error_datarcfields r/rzReddit.requestvse2 ;; & &  ! ! # DAC!#& &zz%%% ::%% &   .&//446  .%%**"*I,>,>,C,C!DJ#- . :7I"66$..7K:%:h/0A555"8,Q/$=);>   # s7 A(( D32B  D. ;C D. C  A#D..D3cX|r|j|}tj|||S)a Return a lazy instance of :class:`.Submission`. :param id: A Reddit base36 submission ID, e.g., ``"2gmzqe"``. :param url: A URL supported by :meth:`.Submission.id_from_url`. Either ``id`` or ``url`` can be provided, but not both. r)rrrrs r/rzReddit.submissions, ))#.C  "#66r1c<|jdd|itdS)zCheck to see if the username is available. For example, to check if the username ``bboe`` is available, try: .. code-block:: python reddit.username_available("bboe") r"rnusername_availabler#)rr)r-rTs r/rlzReddit.username_availables'&&eVTNQYZnQo&ppr1)r=r)r=bool)r.rmr=None)r=r!)r>objectr=rnr,) ro str | Noner@rprA)type[prawcore.requestor.Requestor] | NonerBdict[str, Any] | Nonerpzstr | bool | int | Noner=rn)r=rn)rrr=zint | float | None)r(dict[str, Any] | bytes | IO | str | Nonerdict[str, IO] | Noner!dict[Any, Any] | list[Any] | Nonerr-rdict[str, str | int] | Nonerr-r=r)rzprawcore.auth.BaseAuthenticatorr=rn)rArqrBrrr=rn)rzprawcore.requestor.Requestorr=rn)rr-r=r-)rrprrpr=zmodels.Comment) rr-rrsrrurrvr=r)rr-r=zmodels.DomainListing)rr-rrvr=r)r$zIterable[str] | Nonerlz'Iterable[models.Subreddit | str] | Nonerrpr=r>) rr-rrsrrtrrurrvr=r)rr-rrsrrur=r)rTrpr^rpr=zmodels.Redditor)rrprrpr=zmodels.Submission)rTr-r=rm)%r} __module__ __qualname____doc__recompilerrpropertyr0r6setterr<r?rvrrTrrrrUrVrrrrrrr r0rFrZr]rrrrlr;r1r/r(r(Gs&"rzz"STN  22 / /0 !%d ,0EI26 d d ) d C d 0 d 3d  d L ,) $:>&*26.2" 7" $ " 0 "  " ," "  " Hq12lFJ26 8C80 8  8*;,7 4$4(:>26.2 hh7 h 0 h , h h*2/3 O O, O O"+/>B R"(R"< R"  R"   R"p:>26.2 gg7 g 0 g , g g2:>&*26.2AA7 A $ A 0 A,A AN:>26 VV7 V 0 V V& C$ C:>&*26.2>7>$ > 0 >  >,>> >@ 7T 7 qr1r()Cry __future__rr~r{rNrKrzrQ itertoolsrloggingrtypingrrrr urllib.parser prawcorer r r rrrrrrprawcore.exceptionsrr&r praw.configr praw.constrrrpraw.exceptionsrrr praw.objectorrupdate_checkerrr ImportErrorsys version_infor!typing_extensionscollections.abcr"r#r$ prawcore.authprawcore.requestorr%rrrrrr(r;r1r/rs" //!   +?? #"+"  7"*==/ .. ??       6 FqFq9"L!"sD DD