U gB&@sbdZddlZddlZddlZddlZddlZddlZddlZddlm Z m Z m Z m Z m Z mZddlmZddlmZeeZGdddZeeeedd d Zd(eeed d dZejdfee eddddZedZe defedddZee dddZd)e eedddZ e eefddddZ!e e d d!d"Z"d#d$Z#e ee fd%d&d'Z$dS)*z/Various helper functions implemented by pytube.N)AnyCallableDictListOptionalTypeVar)request)RegexMatchErrorc@speZdZdZddZddZedddZd d Zedd d Z e dd dZ e dddZ ddZddZdS)DeferredGeneratorLista A wrapper class for deferring list generation. Pytube 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. cCs||_g|_dS)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 generatorr2/tmp/pip-unpacked-wheel-1a9f0fi6/pytube/helpers.py__init__szDeferredGeneratorList.__init__cCs t||kS)z.We want to mimic list behavior for comparison.)list)r otherrrr__eq__'szDeferredGeneratorList.__eq__returncCst|ttfstd|}t|tr4t||dd}t|j|jkrzzt|j}Wnt k rjt Yq4X|j |q4|j|S)z)Only generate items as they're asked for.z"Key must be either a slice or int.) isinstanceintslice TypeErrorlenr stopnextr StopIteration IndexErrorappend)r keyZ key_slice next_itemrrr __getitem__+s  z!DeferredGeneratorList.__getitem__ccs<d}z ||}Wntk r&YdSX|V|d7}qdS)z/Custom iterator for dynamically generated list.rNr)r )r iter_indexZ curr_itemrrr__iter__Bs zDeferredGeneratorList.__iter__cCs:z||j}Wntk r&tYnX|jd7_|S)zFetch next element in iterator.r)r%r r)r Z curr_elementrrr__next__Ns  zDeferredGeneratorList.__next__cCs|t|jS)z#Return length of list of all items.) generate_allrr r rrr__len__WszDeferredGeneratorList.__len__cCs|t|jS)z#String representation of all items.)r(strr r)rrr__repr__\szDeferredGeneratorList.__repr__cCs||jdddS)N)r(r r)rrr __reversed__asz"DeferredGeneratorList.__reversed__cCs:zt|j}Wntk r&Yq6YqX|j|qdS)zGenerate all items.N)rr rr r!)r r#rrrr(es  z"DeferredGeneratorList.generate_allN)__name__ __module__ __qualname____doc__rrrr$r&r'rr*r+r,r.r(rrrrr s    r )patternstringgrouprcCs:t|}||}|s$td|dtd|||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)Zcallerr3zmatched regex search: %s)recompilesearchr loggerdebugr5)r3r4r5regexresultsrrrr6ps     r6)s max_lengthrcCsddtddD}ddddd d d d d dddddddddddg}d||}t|tj}|d|}|d|dddS)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. cSsg|] }t|qSr)chr).0irrr sz!safe_filename..r"z\#z\$z\%'z\*z\,z\.z\/z\:z\;z\z\?z\\z\^z\|z\~z\\\\|N )rangejoinr7r8UNICODEsubrsplit)r?r@Zntfs_characters charactersr3r<filenamerrr safe_filenames4 rR)level log_filenamercCspd}d}tj||d}td}||t}|||||dk rlt|}||||dS)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)datefmtpytubeN)logging Formatter getLoggersetLevel StreamHandler setFormatter addHandler FileHandler)rSrTfmtZdate_fmt formatterr:Zstream_handlerZ file_handlerrrr setup_loggers      ra GenericType.)funcrcCs t|S)z1 mypy compatible annotation wrapper for lru_cache) functools lru_cache)rcrrrcachesrf)reasonrcsfdd}|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. cs"dtfdd}|S)Nz.Call to deprecated function {name} ({reason}).cs>tdttjjjdtddtdt||S)Nalways)namerg)category stackleveldefault)warnings simplefilterDeprecationWarningwarnformatr/)argskwargs)func1messagergrr new_func1s  z0deprecated..decorator..new_func1)rdwraps)rurwrg)rurvr decorators zdeprecated..decoratorr)rgrzrryr deprecateds r{) output_pathrcCs>|r$tj|s,tjt|}nt}tj|dd|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)ospathisabsrLgetcwdmakedirs)r|rrrtarget_directorys  r) proxy_handlerrcCs"t|}t|}t|dS)N)r ProxyHandler build_openerinstall_opener)rZ proxy_supportopenerrrr install_proxys  r) duped_listrcCs2i}g}|D] }||krq d||<||q |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 T)r!)rseenresultitemrrr uniqueifys  rcCs&ddddddg}|D] }t|qdS)zRegenerate the video mock json files for all current test videos. This should automatically output to the test/mocks directory. Z 2lAe1cqCOXoZ 5YceQ8YqYMcZ irauhITDrsEZ m8uHb5jIGN8Z QRS8MkLhQmMZ WXxV9g7lsFEN)create_mock_html_json)Z test_vid_idsvid_idrrrgenerate_all_html_json_mockssrrc Csddlm}d|}tjtjtjttjj}tj|dd}tj||}|d|}|j |j |j |j |j d}td|t|d }|t|d W5QRX|S) 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)YouTubezyt-video-%s-html.json.gztestsZmocksz https://www.youtube.com/watch?v=)urljs embed_html watch_htmlvid_infozOutputing json.gz file to wbzutf-8)rVrr~rabspathrLdirname__file__pardirZ watch_urlrrrrr:infogzipopenwritejsondumpsencode) rrZ gzip_filenameZpytube_dir_pathZpytube_mocks_pathZ gzip_filepathZytZ html_datafrrrr,s*   r)r>)N)%r2rdrrrWr~r7rntypingrrrrrrurllibrZpytube.exceptionsr rYr/r:r r+rr6rRERRORrarbrfr{rrrrrrrrrs.    _,