}iD,dZddlZddlZddlZddlZddlZddlZddlZddlZddl m Z m Z m Z m Z mZmZddlmZddlmZej(eZGddZded ed ed efd Zd$d eded efdZej8dfdedeed dfdZedZde defd efdZded e fdZ d%deed efdZ!de eefd dfdZ"de d e fdZ#dZ$d e ee ffd Z%d!Z&d&d"e'fd#Z(y)'z/Various helper functions implemented by pytube.N)AnyCallableDictListOptionalTypeVar)request)RegexMatchErrorc^eZdZdZdZdZdefdZdZdefdZ de fdZ de fd Z d Zd Zy ) DeferredGeneratorLista#A wrapper class for deferring list generation. Pytubefix has some continuation generators that create web calls, which means that any time a full list is requested, all of those web calls must be made at once, which could lead to slowdowns. This will allow individual elements to be queried, so that slowdowns only happen as necessary. For example, you can iterate over elements in the list without accessing them all simultaneously. This should allow for speed improvements for playlist and channel interactions. c ||_g|_y)aConstruct a :class:`DeferredGeneratorList `. :param generator generator: The deferrable generator to create a wrapper for. :param func func: (Optional) A function to call on the generator items to produce the list. N)gen _elements)self generators >""rcL|jt|jS)z#String representation of all items.)r2strrr3s r__repr__zDeferredGeneratorList.__repr__^r5rcF|j|jdddS)N)r2rr3s r __reversed__z"DeferredGeneratorList.__reversed__cs! ~~dd##rc t|j}|jj|2#t$rYywxYw)zGenerate all items.N)r"rrr#r$)rr(s rr2z"DeferredGeneratorList.generate_allgsD 1 N %%i0 !  s4 AAN)__name__ __module__ __qualname____doc__rrrr)r-r0rr4r7r8r;r2rrr r sP  ####.  ### ### $1rr patternstringgrouprctj|}|j|}|s td|tj d||j |S)a?Shortcut method to search a string for a given pattern. :param str pattern: A regular expression pattern. :param str string: A target string to search. :param int group: Index of group to return. :rtype: str or tuple :returns: Substring pattern matches. regex_search)callerrBzmatched regex search: %s)recompilesearchr loggerdebugrD)rBrCrDregexresultss rrFrFrsN JJw Ell6"G ^WEE LL+W5 == rs max_lengthctdDcgc] }t|}}gd}dj||z}tj|tj }|j d|}|d|jdddScc}w)atSanitize a string making it safe to use as a filename. This function was based off the limitations outlined here: https://en.wikipedia.org/wiki/Filename. :param str s: A string to make safe for use as a file name. :param int max_length: The maximum filename character length. :rtype: str :returns: A sanitized string. )"z\#z\$z\%'z\*z\,z\.z\/z\:rSz\;z\z\?z\\z\^z\|z\~z\\\\|N r)rangechrjoinrHrIUNICODEsubrsplit)rOrPintfs_characters charactersrBrMfilenames r safe_filenamerbs(-Ry1!s1v1O1J,hh34G JJw +EyyQH KZ ' 'Q / 2252sBlevel log_filenamecfd}d}tj||}tjd}|j|tj}|j ||j ||8tj|}|j ||j |yy)z~Create a configured instance of logger. :param int level: Describe the severity level of the logs to handle. z6[%(asctime)s] %(levelname)s in %(module)s: %(message)sz%H:%M:%S)datefmt pytubefixN)logging Formatter getLoggersetLevel StreamHandler setFormatter addHandler FileHandler)rcrdfmtdate_fmt formatterrKstream_handler file_handlers r setup_loggerrus CCH!!#x8I  { +F OOE**,N * n%**<8 !!),,' r GenericTypefunc.c6tj|S)z1 mypy compatible annotation wrapper for lru_cache) functools lru_cache)rws rcacher{s 9    &&rreasoncfd}|S)z This is a decorator which can be used to mark functions as deprecated. It will result in a warning being emitted when the function is used. cNdtjfd}|S)Nz.Call to deprecated function {name} ({reason}).ctjdttjj j tdtjdt|i|S)Nalways)namer|)category stackleveldefault)warnings simplefilterDeprecationWarningwarnformatr=)argskwargsfunc1messager|s r new_func1z0deprecated..decorator..new_func1s]  ! !(,> ? MMENN6B+   ! !)-? @$)&) )r)rywraps)rrrr|s` @r decoratorzdeprecated..decorators+B   *  *rrA)r|rs` r deprecatedrs r output_pathc|rRtjj|sGtjjtj|}ntj}tj |d|S)a4 Function for determining target directory of a download. Returns an absolute path (if relative one given) or the current path (if none given). Makes directory if it does not exist. :type output_path: str :rtype: str :returns: An absolute directory path as a string. T)exist_ok)ospathisabsrZgetcwdmakedirs)rs rtarget_directoryrsPww}}[)'',,ryy{K@Kiik KK d+ r proxy_handlerctj|}tj|}tj|yN)r ProxyHandler build_openerinstall_opener)r proxy_supportopeners r install_proxyrs0((7M  ! !- 0F 6"r duped_listcDg}|D]}||vr|j||S)zRemove duplicate items from a list, while maintaining list order. :param List duped_list List to remove duplicates from :return List result De-duplicated list )r#)rresultitems r uniqueifyr s5F 6>  d Mrc0gd}|D] }t|y)zRegenerate the video mock json files for all current test videos. This should automatically output to the test/mocks directory. ) 2lAe1cqCOXo 5YceQ8YqYMc irauhITDrsE m8uHb5jIGN8 QRS8MkLhQmM WXxV9g7lsFEN)create_mock_html_json) test_vid_idsvid_ids rgenerate_all_html_json_mocksrs" L&f%&rcddlm}d|d}tjj tjj tjj ttjj}tjj |dd}tjj ||}|d|}|j|j|j|j|jd}tjd |t!j"|d 5}|j%t'j(|j+d d d d |S#1swY|SxYw) zGenerate a json.gz file with sample html responses. :param str vid_id YouTube video id :return dict data Dict used to generate the json.gz file r)YouTubez yt-video-z -html.json.gztestsmocksz https://www.youtube.com/watch?v=)urljs embed_html watch_htmlvid_infozOutputing json.gz file to wbzutf-8N)rgrrrabspathrZdirname__file__pardir watch_urlrrrrrKinfogzipopenwritejsondumpsencode) rr gzip_filenamepytube_dir_pathpytube_mocks_path gzip_filepathyt html_datafs rrr,s$"x}5Mggoo  GGOOH % GGNN O  _gwGGGLL!2MBM 3F8< =B||eemmmmKK I KK,]O<= =$ '71  9%,,W567 7 s 74E55E?cPtjd}|jd|S)z-Remove ANSI color codes from a colored stringz%\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])rV)rHrIr\) input_str ansi_escapes rstrip_color_codesrRs"**EFK ??2y ))rverbosectjjtjjtd}|rt t jtjj|rNtjj|r/tj|tjd|dytjd|dy)a Deletes the `__cache__` directory to reset the cache. This function checks if the `__cache__` directory exists in the same directory as the script. If it exists and is a directory, it deletes it along with its contents. If the directory does not exist, it logs a message indicating that the cache directory is not present. Parameters: verbose (bool): If True, sets up logging at the DEBUG level. Default is False. Behavior: - When `verbose` is True, debug messages are logged, providing information about the existence and status of the cache directory. - If `verbose` is False, no logging configuration is modified, and debug messages may not be shown unless logging is already configured externally. Example: >>> reset_cache(verbose=True) # Logs detailed information about the cache reset process. Raises: None __cache__)rczCache directory 'z' has been reset.z' does not exist.N)rrrZrrrurhDEBUGexistsisdirshutilrmtreerKrL)r cache_dirs r reset_cacherXs4 RWW__X6 DI7==) ww~~i RWW]]9%= i  ( 3DEF ( 3DEFr)r)F))r@ryrrrhrrHrrtypingrrrrrrurllibr pytubefix.exceptionsr rjr=rKr r7rrFrbERRORrurvr{rrrrrrrboolrrArrrsa5   ??0   8 $\1\1~ # s 3 3 0)3S)3c)3C)3X&mm4((8C=(TX(0m$ 'k)*'{' sx4(3-3(#c3h#D# $4"&"#T#s(^#L* #G#Gr