+ BiӨfRt^RIt^RIt^RIt^RIt^RIHt^RIHt^RI H t ^RI t ^t RR] R2/tRRlt!R R 4t!R R 4t!R R4t!RR4tRtRt!RR4t!RR]4t!RR]4t!RR]4tR# ] dRt Lzi;i ] dRt Li;i)z1 The classes that actually handle the downloads. N parse_url) __version__)tqdmz User-Agentpoochz! (https://www.fatiando.org/pooch)c R\R\R\R\R\/p\ V4pVR,V9d+\ RVR, RV R VP 4 R 24hW#R,,!VR 7pV#) aK Choose the appropriate downloader for the given URL based on the protocol. Parameters ---------- url : str A URL (including protocol). progressbar : bool or an arbitrary progress bar object If True, will print a progress bar of the download to standard error (stderr). Requires `tqdm `__ to be installed. Alternatively, an arbitrary progress bar object can be passed. See :ref:`custom-progressbar` for details. Returns ------- downloader A downloader class, like :class:`pooch.HTTPDownloader`, :class:`pooch.FTPDownloader`, or :class: `pooch.SFTPDownloader`. Examples -------- >>> downloader = choose_downloader("http://something.com") >>> print(downloader.__class__.__name__) HTTPDownloader >>> downloader = choose_downloader("https://something.com") >>> print(downloader.__class__.__name__) HTTPDownloader >>> downloader = choose_downloader("ftp://something.com") >>> print(downloader.__class__.__name__) FTPDownloader >>> downloader = choose_downloader("doi:DOI/filename.csv") >>> print(downloader.__class__.__name__) DOIDownloader ftphttpshttpsftpdoiprotocolzUnrecognized URL protocol 'z' in 'z'. Must be one of .) progressbar) FTPDownloaderHTTPDownloaderSFTPDownloader DOIDownloaderr ValueErrorkeys)urlrknown_downloaders parsed_url downloaders&& O/var/www/html/photoedit/myenv/lib/python3.14/site-packages/pooch/downloaders.pychoose_downloaderr-sL } } 3J*%66)*Z*@)AuM/4467q :  #j#9:{SJ c8a]tRt^dtoRtRRltRRltRtVtR#)ra Download manager for fetching files over HTTP/HTTPS. When called, downloads the given file URL into the specified local file. Uses the :mod:`requests` library to manage downloads. Use with :meth:`pooch.Pooch.fetch` or :func:`pooch.retrieve` to customize the download of files (for example, to use authentication or print a progress bar). Parameters ---------- progressbar : bool or an arbitrary progress bar object If True, will print a progress bar of the download to standard error (stderr). Requires `tqdm `__ to be installed. Alternatively, an arbitrary progress bar object can be passed. See :ref:`custom-progressbar` for details. chunk_size : int Files are streamed *chunk_size* bytes at a time instead of loading everything into memory at one. Usually doesn't need to be changed. **kwargs All keyword arguments given when creating an instance of this class will be passed to :func:`requests.get`. Examples -------- Download one of the data files from the Pooch repository: >>> import os >>> from pooch import __version__, check_version >>> url = "https://github.com/fatiando/pooch/raw/{}/data/tiny-data.txt" >>> url = url.format(check_version(__version__, fallback="main")) >>> downloader = HTTPDownloader() >>> # Not using with Pooch.fetch so no need to pass an instance of Pooch >>> downloader(url=url, output_file="tiny-data.txt", pooch=None) >>> os.path.exists("tiny-data.txt") True >>> with open("tiny-data.txt") as f: ... print(f.read().strip()) # A tiny data file for test purposes only 1 2 3 4 5 6 >>> os.remove("tiny-data.txt") Authentication can be handled by passing a user name and password to :func:`requests.get`. All arguments provided when creating an instance of the class are forwarded to :func:`requests.get`. We'll use ``auth=(username, password)`` to use basic HTTPS authentication. The https://httpbin.org website allows us to make a fake a login request using whatever username and password we provide to it: >>> user = "doggo" >>> password = "goodboy" >>> # httpbin will ask for the user and password we provide in the URL >>> url = f"https://httpbin.org/basic-auth/{user}/{password}" >>> # Trying without the login credentials causes an error >>> downloader = HTTPDownloader() >>> try: ... downloader(url=url, output_file="tiny-data.txt", pooch=None) ... except Exception: ... print("There was an error!") There was an error! >>> # Pass in the credentials to HTTPDownloader >>> downloader = HTTPDownloader(auth=(user, password)) >>> downloader(url=url, output_file="tiny-data.txt", pooch=None) >>> with open("tiny-data.txt") as f: ... for line in f: ... print(line.rstrip()) { "authenticated": true, "user": "doggo" } >>> os.remove("tiny-data.txt") c tW0nWnW nVPRJd\f \ R4hR#R#TN2Missing package 'tqdm' required for progress bars.)kwargsr chunk_sizerr)selfrr"r!s&&&,r__init__HTTPDownloader.__init__s8 &$   t # QR R)5 #rc  ^RIpV'dNVPPR\4pVP WRR7p\ VP ^8H4pV#VPP4p V PR\4pV PRR4\VR4'*p V 'd \VR4pVP!V3RV/V BpVP4VPVPR7p \VP PR ^44p VP"RJd/\ \$P&R 8H4p \)V ^OV R RRR 7pM$VP"'dVP"pWnV F]pV'gK VP-V4VP/4VP"'gKBXP1VP4K_ VP"'d2XP34VP1V 4VP54V 'dVP54R# T 'dTP54ii;i) a Download the given URL over HTTP to the given output file. Uses :func:`requests.get`. Parameters ---------- url : str The URL to the file you want to download. output_file : str or file-like object Path (and file name) to which the file will be downloaded. pooch : :class:`~pooch.Pooch` The instance of :class:`~pooch.Pooch` that is calling this method. check_only : bool If True, will only check if a file exists on the server and **without downloading the file**. Will return ``True`` if the file exists and ``False`` otherwise. Returns ------- availability : bool or None If ``check_only==True``, returns a boolean indicating if the file is available on the server. Otherwise, returns ``None``. NtimeoutT)r'allow_redirectsstreamwritew+b)r"zcontent-lengthwin32Btotalncolsasciiunit unit_scaleleave)requestsr!getDEFAULT_TIMEOUTheadbool status_codecopypop setdefaulthasattropenraise_for_status iter_contentr"intheadersrsysplatformrr/r*flushupdateresetclose)r#r output_filer check_onlyr5r'response availabler!ispathcontentr/ use_asciiprogresschunks&&&&& r__call__HTTPDownloader.__call__s:  kkooiAG}}S4}PHX11S89I !!#**Y8(D)['22 {E2K( $||CCCFCH  % % '++t+GG((,,-=qABE4'!!89 ## !!!++!& 5%%e,%%''''!8! & !!#!!#s%B5I 8I 0I 0I ?1I I%)r"r!rN)FF __name__ __module__ __qualname____firstlineno____doc__r$rS__static_attributes____classdictcell__ __classdict__s@rrrdsJXSVVrrc8a]tRtRtoRtRRltRRltRtVtR#) ria Download manager for fetching files over FTP. When called, downloads the given file URL into the specified local file. Uses the :mod:`ftplib` module to manage downloads. Use with :meth:`pooch.Pooch.fetch` or :func:`pooch.retrieve` to customize the download of files (for example, to use authentication or print a progress bar). Parameters ---------- port : int Port used for the FTP connection. username : str User name used to login to the server. Only needed if the server requires authentication (i.e., no anonymous FTP). password : str Password used to login to the server. Only needed if the server requires authentication (i.e., no anonymous FTP). Use the empty string to indicate no password is required. account : str Some servers also require an "account" name for authentication. timeout : int Timeout in seconds for ftp socket operations, use None to mean no timeout. progressbar : bool If True, will print a progress bar of the download to standard error (stderr). Requires `tqdm `__ to be installed. **Custom progress bars are not yet supported.** chunk_size : int Files are streamed *chunk_size* bytes at a time instead of loading everything into memory at one. Usually doesn't need to be changed. NcWnW nW0nW@nWPnW`nWpnVP RJd\f \R4hR#R#r) portusernamepasswordaccountr'rr"rr)r#rcrdrerfr'rr"s&&&&&&&&rr$FTPDownloader.__init__6sN     &$   t # QR R)5 #rc  aa\V4p\P!VPR7pVP VR,VP R7V'd\ PPVR,4wrxVPVPVPVPR7WPV49p VP4V #\SR4'*p V 'd \!SR4oVPVPVPVPR7RVR, 2p VP"'dVP%R 4\'\(P*R 8H4p \-\/VP1VR,44^OV R R R R 7oS;_uu_4VV3Rlp VP3WVP4R7RRR4M(VP3V SP6VP4R7VP94V 'dSP4R# TP4i;i +'giLO;i TP94T 'dSP4ii;i)a Download the given URL over FTP to the given output file. Parameters ---------- url : str The URL to the file you want to download. output_file : str or file-like object Path (and file name) to which the file will be downloaded. pooch : :class:`~pooch.Pooch` The instance of :class:`~pooch.Pooch` that is calling this method. check_only : bool If True, will only check if a file exists on the server and **without downloading the file**. Will return ``True`` if the file exists and ``False`` otherwise. Returns ------- availability : bool or None If ``check_only==True``, returns a boolean indicating if the file is available on the server. Otherwise, returns ``None``. )r'netloc)hostrcpath)userpasswdacctr*r+zRETR zTYPE Ir,r-Tr.c^<SP\V44SPV4R#z+Update the progress bar and write to outputN)rGlenr*)datarJrQs&rcallback(FTPDownloader.__call__..callbacks! D 2#))$/r) blocksizeN)rftplibFTPr'connectrcosrksplitloginrdrerfnlstrIr>r?rvoidcmdr9rDrErrBsize retrbinaryr"r*quit)r#rrJrrKrr directory file_namerMrNcommandrPrsrQs&&f&& @rrSFTPDownloader.__call__Js0s^ jj. H-DII > #%77==F1C#D I  t}}T]] V%))<<   ['22 {E2K $ II4==T\\I Rj012G H% !89 chhz&'9:;## X0 NN7NPXw (9(9T__U HHJ!!#M 0X HHJ!!#s9AH8AI A'I 8%I 1I 8I  I I +J )rfr"rercrr'rd) anonymousrNFrUrVrWr_s@rrrs"HS(HHrrc4a]tRtRtoRtRRltRtRtVtR#)ria: Download manager for fetching files over SFTP. When called, downloads the given file URL into the specified local file. Requires `paramiko `__ to be installed. Use with :meth:`pooch.Pooch.fetch` or :func:`pooch.retrieve` to customize the download of files (for example, to use authentication or print a progress bar). Parameters ---------- port : int Port used for the SFTP connection. username : str User name used to login to the server. Only needed if the server requires authentication (i.e., no anonymous SFTP). password : str Password used to login to the server. Only needed if the server requires authentication (i.e., no anonymous SFTP). Use the empty string to indicate no password is required. timeout : int Timeout in seconds for sftp socket operations, use None to mean no timeout. progressbar : bool or an arbitrary progress bar object If True, will print a progress bar of the download to standard error (stderr). Requires `tqdm `__ to be installed. NcWnW nW0nW@nWPnW`n.pVP 'd\ fVPR4\fVPR4V'd\RPV44hR#)Nr z7Missing package 'paramiko' required for SFTP downloads. ) rcrdrerfr'rrappendparamikorjoin)r#rcrdrerfr'rerrorss&&&&&&& rr$SFTPDownloader.__init__sv     &     MMN O   MMS T SXXf-. . rc  a \V4p\P!VR,VP3R7pRpVP VP VP R7\PPV4pVPVP4n VP'dY\VPVR,4P4p\!\"P$R8H4p\'V^OVRRRR 7o VP'd5S ;_uu_4V 3R lp VP)VR,W)R 7RRR4MVP)VR,V4VP+4VeVP+4R#R# +'giL8;i TP+4TeTP+4ii;i) a Download the given URL over SFTP to the given output file. The output file must be given as a string (file name/path) and not an open file object! Otherwise, paramiko cannot save to that file. Parameters ---------- url : str The URL to the file you want to download. output_file : str Path (and file name) to which the file will be downloaded. **Cannot be a file object**. pooch : :class:`~pooch.Pooch` The instance of :class:`~pooch.Pooch` that is calling this method. ri)sockN)rdrerkr,r-Tr.c~<\V4SnSP\VSP, 44R#rp)rBr/rGn)currentr/rQs&&rrs)SFTPDownloader.__call__..callbacks(),U Ghjj,@(ABr)rs)rr Transportrcrxrdre SFTPClientfrom_transportr' get_channel settimeoutrrBstatst_sizer9rDrErr6rI) r#rrJrr connectionr r~rPrsrQs &&&& @rrSSFTPDownloader.__call__sl"s^ ''j.BDII-NO        N&&55jAD,0LLD    )499Z%78@@A !89 ## XC HHZ/HPXF+[9      X      s1A6F#1A)F# F#%!F"F# F F##'G )rfrercrr'rd)rrrNFrWr_s@rrrs@/411rrc<a]tRtRtoRtRRR]3RltRtRtVt R#) ria Download manager for fetching files from Digital Object Identifiers (DOIs). Open-access data repositories often issue Digital Object Identifiers (DOIs) for data which provide a stable link and citation point. The trick is finding out the download URL for a file given the DOI. When called, this downloader uses the repository's public API to find out the download URL from the DOI and file name. It then uses :class:`pooch.HTTPDownloader` to download the URL into the specified local file. Allowing "URL"s to be specified with the DOI instead of the actual HTTP download link. Uses the :mod:`requests` library to manage downloads and interact with the APIs. The **format of the "URL"** is: ``doi:{DOI}/{file name}``. Notice that there are no ``//`` like in HTTP/FTP and you must specify a file name after the DOI (separated by a ``/``). Use with :meth:`pooch.Pooch.fetch` or :func:`pooch.retrieve` to be able to download files given the DOI instead of an HTTP link. Supported repositories: * `figshare `__ * `Zenodo `__ * `Dataverse `__ instances .. attention:: DOIs from other repositories **will not work** since we need to access their particular APIs to find the download links. We welcome suggestions and contributions adding new repositories. Parameters ---------- progressbar : bool or an arbitrary progress bar object If True, will print a progress bar of the download to standard error (stderr). Requires `tqdm `__ to be installed. Alternatively, an arbitrary progress bar object can be passed. See :ref:`custom-progressbar` for details. chunk_size : int, optional Files are streamed *chunk_size* bytes at a time instead of loading everything into memory at one. Usually doesn't need to be changed. headers : dict or None, optional Headers that will be passed to :func:`requests.get`. If None, default headers containing Pooch's user agent will be used. If no headers should be used, pass an empty dictionary. **kwargs All keyword arguments given when creating an instance of this class will be passed to :func:`requests.get`. Examples -------- Download one of the data files from the figshare archive of Pooch test data: >>> import os >>> downloader = DOIDownloader() >>> url = "doi:10.6084/m9.figshare.14763051.v1/tiny-data.txt" >>> # Not using with Pooch.fetch so no need to pass an instance of Pooch >>> downloader( ... url=url, output_file="tiny-data.txt", pooch=None ... ) # doctest: +SKIP >>> os.path.exists("tiny-data.txt") # doctest: +SKIP True >>> with open("tiny-data.txt") as f: # doctest: +SKIP ... print(f.read().strip()) # A tiny data file for test purposes only 1 2 3 4 5 6 >>> os.remove("tiny-data.txt") # doctest: +SKIP Same thing but for our Zenodo archive: >>> url = "doi:10.5281/zenodo.4924875/tiny-data.txt" >>> downloader( ... url=url, output_file="tiny-data.txt", pooch=None ... ) # doctest: +SKIP >>> os.path.exists("tiny-data.txt") # doctest: +SKIP True >>> with open("tiny-data.txt") as f: # doctest: +SKIP ... print(f.read().strip()) # A tiny data file for test purposes only 1 2 3 4 5 6 >>> os.remove("tiny-data.txt") # doctest: +SKIP FrUNc XWPnVeTM\VnW@nWnW nR#N)r!REQUESTS_HEADERSrCr'rr")r#rr"rCr'r!s&&&&&,rr$DOIDownloader.__init__^s( ")"5w;K  &$rc  \V4p\VR,3RVPRVP/VPBpVR,pV^,R8Xd VR,pVP V4p\ R RVPRVPRVPRVP/VPBpV!WrV4R #) a Download the given DOI URL over HTTP to the given output file. Uses the repository's API to determine the actual HTTP download URL from the given DOI. Uses :func:`requests.get`. Parameters ---------- url : str The URL to the file you want to download. output_file : str or file-like object Path (and file name) to which the file will be downloaded. pooch : :class:`~pooch.Pooch` The instance of :class:`~pooch.Pooch` that is calling this method. rirCr'rk/NNrr"N) rdoi_to_repositoryrCr'r! download_urlrrr") r#rrJrrdata_repositoryrrrs &&&& rrSDOIDownloader.__call__ls(s^ + x  LL LL kk  v& Q<3 !" I&33I> $ ((  LL LL  kk   /ZenodoRepository.api_version..ssH-GT5D=-GfilesFTlegacyc3,"TF pRV9xK R#5i)filenameNrrs& rrrusO4NDZ4'4Nrnewz5Couldn't determine the version of the Zenodo API for  (doi:).)rallrrrr r#s&r api_versionZenodoRepository.api_version^s(    $sHT->->w-GHsssHT->->w-GHHH$,!   OD4E4Eg4NOOD4E4Eg4NOOO$)!    !K''(txxj<   rc  VPR8Xd+VPR,Uu/uF q"R,VbK ppM(VPR,Uu.uF q"R,NK ppW9d*\RV RVP RVP R24hVPR8XdW1,R ,R ,pV#VPR ,pR V R V R2pV#uupiuupi)az Use the repository API to get the download URL for a file given the archive URL. Parameters ---------- file_name : str The name of the file in the archive that will be downloaded. Returns ------- download_url : str The HTTP URL that can be used to download the file. Notes ----- After Zenodo migrated to InvenioRDM on Oct 2023, their API changed. The link to the desired files that appears in the API response leads to 404 errors (by 2023-10-17). The files are available in the following url: ``https://zenodo.org/records/{article_id}/files/{file_name}?download=1``. This method supports both the legacy and the new API. rrrrFile '' not found in data archive rrlinksr#idzhttps://zenodo.org/records/z/files/z ?download=1)rrrrr )r#ritemrrrs&& rrZenodoRepository.download_url~s2   x '373D3DW3MN3M4%[$&3MENE262C2CG2LM2L$*%%2LEM  ! #?##$F488*B8    x ' +G4V+Z55rrcXa]tRtRtoRt]R4tRt]R4t Rt Rt Rt Vt R #) ric 8W nWnRVnW0nR#rrr rr!rs&&&,rr$FigshareRepository.__init__&! rc J\V4pVR,R8wdR#V!W3/VB#)rriz figshare.comNrrs&&&, rrFigshareRepository.initializes/.'{3 h '> 93.v..rc VPPR4wrVPR4R,pV^,R8wdR#\VR,4pV#)zQ Parse version from the doi Return None if version is not available in the doi. rrvNrr)r rzrB)r#_suffix last_partversions& r_parse_version_from_doi*FigshareRepository._parse_version_from_doisMHHNN3' LL%b) Q<3 im$rc VPf^RIpVP!RVP 23/VPBP 4^,pVR,pVP 4pVf0\P!RVP R2\4RV 2pMRV RV 2pVP!V3/VPBpVP4VP 4R,VnVP#) z!Cached API response from FigshareNz)https://api.figshare.com/v2/articles?doi=rzThe Figshare DOI 'zv' doesn't specify which version of the repository should be used. Figshare will point to the latest version available.z%https://api.figshare.com/v2/articles/z /versions/r) rr5r6r r!rr warningswarn UserWarningr@)r#r5articlerr api_urlrLs& rrFigshareRepository.api_responses    % ll;DHH:F++dfQG!J224G ( 3KK B*N <!l*WI7  ||G;t{{;H  % % '!)!9D !!!rc  VPUu/uF q"R,VbK ppW9d*\RV RVP RVP R24hW1,R,pV#uupi)rnamerrrrr)rrrr )r#rrrrs&& rrFigshareRepository.download_url$s150A0AB0Aft#0AB  ! #?@P@P?QQWX\X`X`Waacd '7  CsA#c lVPF#pRVR, 2VPVR,&K% R#)rr computed_md5rN)rrr#rrs&& rr$FigshareRepository.populate_registry;s4))H15h~6N5O/PENN8F+ ,*rrrr r!N)rXrYrZr[r$rrr rrrrr]r^r_s@rrrsI //8 ("("T. Q Qrrca]tRtRtoRt]R4t]R4t]R4t ] PR4t Rt Rt R t VtR #) riIc 8W nWnRVnW0nR#rrrs&&&,rr$DataverseRepository.__init__Jrrc VP!W3/VBpRVPu;8:d R8dR#V!W3/VBpWEnV#)rrrN)_get_api_responser:r)rr rr!rLrs&&&, rrDataverseRepository.initializePsS,((DVD (&& , , -4V4 "*rc v^RIp\V4pVP!VR, RVR, RV 23/VBpV#)z Perform the actual API request This has been separated into a separate ``classmethod``, as it can be used prior and after the initialization. Nr ://riz-/api/datasets/:persistentId?persistentId=doi:)r5rr6)rr rr!r5parsedrLs&&&, rr %DataverseRepository._get_api_responseqsV ;'<<j!"#fX&6%78..1U 4   rc VPf8VP!VPVP3/VPBVnVP#)z-Cached API response from a DataVerse instance)rr r rr!rs&rr DataverseRepository.api_responsesL    %!%!7!7$**".2kk"D !!!rc WnR#)zUpdate the cached API responseN)r)r#rLs&&rrr's &rc  \VP4pVPP4pVR,R,R,Uu/uFpVR,R,VR,bK ppW9d*\ RV RVP RVP R 24hVR , R VR , R WQ,R, 2pV#uupi)rrr latestVersionrdataFilerrrrrr r#riz/api/access/datafile/r)rrrrrr )r#rr$rLrrrs&& rr DataverseRepository.download_urls4++,$$))+!(9'B B  Z ($z*: :B    ! #?##$F488*B8  j!"#fX&6%77L%& (  s !Cc VPP4R,R,R,F1pRVR,R, 2VPVR,R,&K3 R#) rrrr*rrr+md5rN)rrrrs&& rr%DataverseRepository.populate_registrys]))..08I'RRHx +E234 NN8J/ ; <SrrN)rXrYrZr[r$rrr rrsetterrrr]r^r_s@rrrIsq @$""&& B  rrrV)r\ryrDrvrutilsr_versionr tqdm.autor ImportErrorrr7rrrrrrrrrrrrrrrr5s ! E+&GH 4njjZAAHll^T5T5n>7t2"2"jY5~Y5xAQAQHz.ze! D Hs"BB$ B! B!$ B0/B0