|
| 1 | +fromcollections.abcimportCallable,Collection,Iterable,Iterator,Mapping |
| 2 | +fromfunctoolsimportcached_property |
| 3 | +fromtypesimportTracebackType |
| 4 | +fromtyping_extensionsimportSelf,TypeAlias |
| 5 | +fromurllib.requestimportRequest |
| 6 | + |
| 7 | +fromyt_dlp.cacheimportCache |
| 8 | +fromyt_dlp.cookiesimportYoutubeDLCookieJar |
| 9 | +fromyt_dlp.networkingimportRequestDirector,RequestHandler,Response |
| 10 | +fromyt_dlp.utilsimportNamespace |
| 11 | + |
| 12 | +from .import_Params |
| 13 | +from .extractor.commonimportInfoExtractor,_InfoDict |
| 14 | +from .postprocessor.commonimportPostProcessor |
| 15 | +from .utils._utilsimport_ProgressState |
| 16 | + |
| 17 | +_FormatSelector:TypeAlias=Callable[[Mapping[str,object]],Iterator[object]] |
| 18 | + |
| 19 | +classYoutubeDL: |
| 20 | +params:_Params |
| 21 | +cache:Cache |
| 22 | +format_selector:_FormatSelector |
| 23 | +archive:set[str] |
| 24 | +def__init__(self,params:_Params|None= ...,auto_init:bool= ...)->None: ... |
| 25 | +defwarn_if_short_id(self,argv:list[str])->None: ... |
| 26 | +defadd_info_extractor(self,ie:InfoExtractor)->None: ... |
| 27 | +defget_info_extractor(self,ie_key:str)->InfoExtractor: ... |
| 28 | +defadd_default_info_extractors(self)->None: ... |
| 29 | +defadd_post_processor(self,pp:PostProcessor,when:str="post_process")->None: ... |
| 30 | +defadd_post_hook(self,ph:Callable[...,object])->None: ... |
| 31 | +defadd_close_hook(self,ch:Callable[...,object])->None: ... |
| 32 | +defadd_progress_hook(self,ph:Callable[...,object])->None: ... |
| 33 | +defadd_postprocessor_hook(self,ph:Callable[...,object])->None: ... |
| 34 | +defto_stdout(self,message:str,skip_eol:bool=False,quiet:bool|None=None)->None: ... |
| 35 | +defto_screen(self,message:str,skip_eol:bool=False,quiet:bool|None=None,only_once:bool=False)->None: ... |
| 36 | +defto_stderr(self,message:str,only_once:bool=False)->None: ... |
| 37 | +defto_console_title( |
| 38 | +self,message:str|None=None,progress_state:_ProgressState|None=None,percent:int|None=None |
| 39 | + )->None: ... |
| 40 | +defsave_console_title(self)->None: ... |
| 41 | +defrestore_console_title(self)->None: ... |
| 42 | +def__enter__(self)->Self: ... |
| 43 | +defsave_cookies(self)->None: ... |
| 44 | +def__exit__(self,*args:object)->None: ... |
| 45 | +defclose(self)->None: ... |
| 46 | +deftrouble(self,message:str|None=None,tb:TracebackType|None=None,is_error:bool=True)->None: ... |
| 47 | +Styles:Namespace |
| 48 | +defreport_warning(self,message:str,only_once:bool=False)->None: ... |
| 49 | +defdeprecation_warning(self,message:str,*,stacklevel:int=0)->None: ... |
| 50 | +defdeprecated_feature(self,message:str)->None: ... |
| 51 | +defreport_error(self,message:str,*args:object,**kwargs:object)->None: ... |
| 52 | +defwrite_debug(self,message:str,only_once:bool=False)->None: ... |
| 53 | +defreport_file_already_downloaded(self,file_name:str)->None: ... |
| 54 | +defreport_file_delete(self,file_name:str)->None: ... |
| 55 | +defraise_no_formats(self,info:str,forced:bool=False,*,msg:str|None=None)->None: ... |
| 56 | +defget_output_path(self,dir_type:str="",filename:str|None=None)->str: ... |
| 57 | +@staticmethod |
| 58 | +defescape_outtmpl(outtmpl:str)->str: ... |
| 59 | +@classmethod |
| 60 | +defvalidate_outtmpl(cls,outtmpl:str)->ValueError|None: ... |
| 61 | +defprepare_outtmpl(self,outtmpl:str,info_dict:_InfoDict,sanitize:bool=False)->tuple[str,dict[str,object]]: ... |
| 62 | +defevaluate_outtmpl(self,outtmpl:str,info_dict:_InfoDict,*args:object,**kwargs:object)->str: ... |
| 63 | +defprepare_filename( |
| 64 | +self,info_dict:_InfoDict,dir_type:str="",*,outtmpl:str|None=None,warn:bool=False |
| 65 | + )->str: ... |
| 66 | +@staticmethod |
| 67 | +defadd_extra_info(info_dict:_InfoDict,extra_info:Mapping[str,object])->None: ... |
| 68 | +defextract_info( |
| 69 | +self, |
| 70 | +url:str, |
| 71 | +download:bool=True, |
| 72 | +ie_key:str|None=None, |
| 73 | +extra_info:object|None=None, |
| 74 | +process:bool=True, |
| 75 | +force_generic_extractor:bool=False, |
| 76 | + )->_InfoDict: ... |
| 77 | +defadd_default_extra_info(self,ie_result:_InfoDict,ie:InfoExtractor,url:str)->None: ... |
| 78 | +defprocess_ie_result( |
| 79 | +self,ie_result:_InfoDict,download:bool=True,extra_info:Mapping[str,object]|None=None |
| 80 | + )->_InfoDict: ... |
| 81 | +defbuild_format_selector(self,format_spec:str)->_FormatSelector: ... |
| 82 | +defsort_formats(self,info_dict:_InfoDict)->None: ... |
| 83 | +defprocess_video_result(self,info_dict:_InfoDict,download:bool=True)->_InfoDict: ... |
| 84 | +defprocess_subtitles( |
| 85 | +self,video_id:str,normal_subtitles:Mapping[str,object],automatic_captions:Mapping[str,object] |
| 86 | + )->dict[str,object]|None: ... |
| 87 | +defdl(self,name:str,info:_InfoDict,subtitle:bool=False,test:bool=False)->bool: ... |
| 88 | +defexisting_file(self,filepaths:Iterable[str],*,default_overwrite:bool=True)->object|None: ... |
| 89 | +defprocess_info(self,info_dict:_InfoDict)->None: ... |
| 90 | +defdownload(self,url_list:Collection[str])->None: ... |
| 91 | +defdownload_with_info_file(self,info_filename:str)->int: ... |
| 92 | +@staticmethod |
| 93 | +defsanitize_info(info_dict:_InfoDict,remove_private_keys:bool=False)->_InfoDict|None: ... |
| 94 | +@staticmethod |
| 95 | +deffilter_requested_info(info_dict:_InfoDict,actually_filter:bool=True)->_InfoDict|None: ... |
| 96 | +@staticmethod |
| 97 | +defpost_extract(info_dict:_InfoDict)->None: ... |
| 98 | +defrun_pp(self,pp:PostProcessor,infodict:_InfoDict)->_InfoDict: ... |
| 99 | +defrun_all_pps(self,key:str,info:_InfoDict,*,additional_pps:Collection[PostProcessor]|None=None)->_InfoDict: ... |
| 100 | +defpre_process( |
| 101 | +self,ie_info:_InfoDict,key:str="pre_process",files_to_move:Mapping[str,object]|None=None |
| 102 | + )->tuple[_InfoDict,list[str]|None]: ... |
| 103 | +defpost_process(self,filename:str,info:_InfoDict,files_to_move:Mapping[str,object]|None=None)->_InfoDict: ... |
| 104 | +defin_download_archive(self,info_dict:_InfoDict)->bool: ... |
| 105 | +defrecord_download_archive(self,info_dict:_InfoDict)->None: ... |
| 106 | +@staticmethod |
| 107 | +defformat_resolution(format:Mapping[str,object],default:str="unknown")->str: ... |
| 108 | +defrender_formats_table(self,info_dict:_InfoDict)->str|None: ... |
| 109 | +defrender_thumbnails_table(self,info_dict:_InfoDict)->str|None: ... |
| 110 | +defrender_subtitles_table(self,video_id:str,subtitles:Iterable[Mapping[str,object]])->str|None: ... |
| 111 | +deflist_formats(self,info_dict:_InfoDict)->None: ... |
| 112 | +deflist_thumbnails(self,info_dict:_InfoDict)->None: ... |
| 113 | +deflist_subtitles(self,video_id:str,subtitles:Iterable[Mapping[str,object]],name:str="subtitles")->None: ... |
| 114 | +defprint_debug_header(self)->None: ... |
| 115 | +@cached_property |
| 116 | +defproxies(self)->dict[str,object]: ... |
| 117 | +@cached_property |
| 118 | +defcookiejar(self)->YoutubeDLCookieJar: ... |
| 119 | +defurlopen(self,req:Request|str)->Response: ... |
| 120 | +defbuild_request_director( |
| 121 | +self,handlers:Collection[RequestHandler],preferences:Collection[object]|None=None |
| 122 | + )->RequestDirector: ... |
| 123 | +defencode(self,s:str)->bytes: ... |
| 124 | +defget_encoding(self)->str: ... |