U çZßf´ã@s®dZddlZddlZddlZddlZddlZddlZddlZddl Zddl Zddl Zddl Zddl ZddlZddlZdgZejjr–Gdd„dejƒZnejZGdd„dƒZdS)z] `FTPHost` is the central class of the `ftputil` library. See `__init__.py` for an example. éNÚFTPHostcseZdZ‡fdd„Z‡ZS)Údefault_session_factorycsLd|kr(tjj}||d<tƒj||Žn tƒj||Žtj ||d¡dS)NÚencoding)ÚftputilÚ path_encodingZDEFAULT_ENCODINGÚsuperÚ__init__ÚsessionZ_maybe_send_opts_utf8_on)ÚselfÚargsÚkwargsr©Ú __class__©ú0/tmp/pip-unpacked-wheel-g7w5sq0v/ftputil/host.pyr,s z default_session_factory.__init__)Ú__name__Ú __module__Ú __qualname__rÚ __classcell__rrr rr+src@s|eZdZdZdd„Zdd„Zdd„Zdd „Zd d „ZdUd dœdd„Z dd„Z dd„Z e dd„ƒZ dd„Zdd„Zdd„Zdd„Ze ejjd fdd „ƒZd!d"„ZdVd#d$„ZdWd%d&„Zd'd(„ZdXd)d*„ZdYd+d,„Zd-d.„ZdZd0d1„Zd2d3„Zd4d5„Zd[d6d7„Z d\d8d9„Z!d:d;„Z"dd?„Z%d@dA„Z&dBdC„Z'dDdE„Z(d^dGdH„Z)d_dIdJ„Z*d`dKdL„Z+dMdN„Z,dOdP„Z-dQdR„Z.dSdT„Z/d S)arz FTP host class. c Os²||_||_| ¡|_tj |¡|_tj |¡|_ |j j |_ |j   ¡tj j,|j ¡}|j tjj||jd¡|_W5QRXg|_d|_d|_d\|_|_|_d|_d|_dS)z> Abstract initialization of `FTPHost` object. ©rNF)Ú.z..ú/ç)Ú_argsÚ_kwargsÚ _make_sessionÚ_sessionrÚpathZ_PathÚstatZ_StatÚ_statZ _lstat_cacheÚ stat_cacheÚenableÚerrorÚftplib_error_to_ftp_os_errorÚpwdÚnormpathÚtoolÚ as_str_pathÚ _encodingÚ_cached_current_dirÚ _childrenÚ_fileÚclosedÚcurdirÚpardirÚsepÚ _time_shiftÚuse_list_a_option)r r r Z current_dirrrrr]s$     ÿzFTPHost.__init__c Cs"tjj|j ¡W5QRXdS)aX Try to keep the connection alive in order to avoid server timeouts. Note that this won't help if the connection has already timed out! In this case, `keep_alive` will raise an `TemporaryError`. (Actually, if you get a server timeout, the error - for a specific connection - will be permanent.) N)rr"r#rr$©r rrrÚ keep_alive†s zFTPHost.keep_alivec Csl|jdd…}|j ¡}| dt¡}tjj6|||Ž}t|dƒsVtj  d|›d¡‚|j |_ W5QRX|S)zp Return a new session object according to the current state of this `FTPHost` instance. NZsession_factoryrzsession instance z" must have an `encoding` attribute) rrÚcopyÚpoprrr"r#ÚhasattrZNoEncodingErrorrr()r r r Úfactoryr rrrr˜s      ÿzFTPHost._make_sessioncCs|j|j|jŽS)z9 Return a copy of this `FTPHost` object. )rrrr2rrrÚ_copy­sz FTPHost._copyc CsŽ|jD]‚}|jjrz|j ¡Wn^tjk r:YqYqtjk rRYqYqtk rhYqYqt k r~YqYqX|SqdS)zá Return an available (i. e. one whose `_file` object is closed and doesn't have a timed-out server connection) child (`FTPHost` object) from the pool of children or `None` if there aren't any. N) r*r+r,rr$ÚftplibZ error_replyZ error_tempÚEOFErrorÚOSError©r ÚhostrrrÚ_available_childµs   zFTPHost._available_childÚrN)Úrestc Csêtjj||jd}| ¡}|dkrD| ¡}|j |¡tj  |¡|_ |  ¡} |j   |¡r^|} n|j  | |¡} |j  | ¡\} } z| | ¡Wn*tjjk r´tj d | ¡¡‚YnX|j j| ||||||dd|krä|j | ¡|j S)a Return an open file(-like) object which is associated with this `FTPHost` object. The arguments `path`, `mode`, `buffering`, `encoding`, `errors` and `newlines` have the same meaning as for `open`. If `rest` is given as an integer, - reading will start at the byte (zero-based) `rest` - writing will overwrite the remote file from byte `rest` This method tries to reuse a child but will generate a new one if none is available. rNzEremote directory '{}' doesn't exist or has insufficient access rights)ÚmodeÚ bufferingrÚerrorsÚnewliner@Úw)rr&r'r(r>r8r*ÚappendÚfileZFTPFiler+ÚgetcwdrÚisabsÚjoinÚsplitÚchdirr"ÚPermanentErrorÚ FTPIOErrorÚformatÚ_openr Ú invalidate) r rrArBrrCrDr@r=ÚbasedirZeffective_pathZ effective_dirZeffective_filerrrÚopenäs>  ÿÿ ù  z FTPHost.openc Csh|jr dS|jD]}|j ¡| ¡qz"tjj|j  ¡W5QRXW5|j ¡g|_d|_XdS)z( Close host connection. NT) r,r*r+Úcloser Úclearrr"r#rr<rrrrT%s     z FTPHost.closecCs|j ¡||j_d|j_dS)a, Set the parser for extracting stat results from directory listings. The parser interface is described in the documentation, but here are the most important things: - A parser should derive from `ftputil.stat.Parser`. - The parser has to implement two methods, `parse_line` and `ignores_line`. For the latter, there's a probably useful default in the class `ftputil.stat.Parser`. - `parse_line` should try to parse a line of a directory listing and return a `ftputil.stat.StatResult` instance. If parsing isn't possible, raise `ftputil.error.ParserError` with a useful error message. - `ignores_line` should return a true value if the line isn't assumed to contain stat information. FN)r rUrÚ_parserZ_allow_parser_switching)r ÚparserrrrÚ set_parser?s zFTPHost.set_parsercCsHd}|dkrdSt|ƒ}||}t|d|d|ƒd|}||S)z– Return the given time shift in seconds, but rounded to 15-minute units. The argument is also assumed to be given in seconds. çN@rrg@g.@)ÚabsÚint)Ú time_shiftÚminuteZabsolute_time_shiftÚsignumÚabsolute_rounded_time_shiftrrrZ__rounded_time_shift]sÿþzFTPHost.__rounded_time_shiftcCsrd}d|}t| |¡ƒ}|d|kr8tj d |¡¡‚d|}t|| |¡ƒ|krntj d |t|ƒ¡¡‚dS)z± Perform sanity checks on the time shift value (given in seconds). If the value is invalid, raise a `TimeShiftError`, else simply return `None`. rYéz!time shift abs({0:.2f} s) > 1 dayézFtime shift ({0:.2f} s) deviates more than {1:d} s from 15-minute unitsN)rZÚ_FTPHost__rounded_time_shiftrr"ÚTimeShiftErrorrOr[)r r\r]Úhourr_Zmaximum_deviationrrrZ__assert_valid_time_shiftqs ÿÿÿz!FTPHost.__assert_valid_time_shiftcCs4| |¡| ¡}||kr0|j ¡| |¡|_dS)a\ Set the time shift value. By (my) definition, the time shift value is the difference of the time zone used in server listings and UTC, i. e. time_shift =def= t_server - utc <=> t_server = utc + time_shift <=> utc = t_server - time_shift The time shift is measured in seconds. N)Ú!_FTPHost__assert_valid_time_shiftr\r rUrbr0)r r\Zold_time_shiftrrrÚset_time_shift‰s  zFTPHost.set_time_shiftcCs|jS)zŒ Return the time shift between FTP server and client. See the docstring of `set_time_shift` for more on this value. )r0r2rrrr\ŸszFTPHost.time_shiftc Csäd}z| |d¡}| ¡Wn.tjjk rJtj d | ¡¡¡‚YnXz|j  |¡}|  |¡Wn$tjj k rŠtj d¡‚YnXt   ¡}||}|dkrÖt j j|t jjd}|j|jdd}| ¡|}| |¡d S) ai Synchronize the local times of FTP client and server. This is necessary to let `upload_if_newer` and `download_if_newer` work correctly. If `synchronize_times` isn't applicable (see below), the time shift can still be set explicitly with `set_time_shift`. This implementation of `synchronize_times` requires _all_ of the following: - The connection between server and client is established. - The client has write access to the directory that is current when `synchronize_times` is called. The common usage pattern of `synchronize_times` is to call it directly after the connection is established. (As can be concluded from the points above, this requires write access to the login directory.) If `synchronize_times` fails, it raises a `TimeShiftError`. Z_ftputil_sync_rEz,couldn't write helper file in directory '{}'z)could write helper file but not unlink itid%þ)Útzé)ÚyearN)rSrTrr"rNrcrOrHrÚgetmtimeÚunlinkÚ FTPOSErrorÚtimeÚdatetimeÚ fromtimestampÚtimezoneÚutcÚreplaceriÚ timestamprf)r Zhelper_file_nameÚfile_Z server_timeÚnowr\Zserver_datetimerrrÚsynchronize_times¦s2   ÿ  ÿ ÿ zFTPHost.synchronize_timescCstj ||||¡dS)zX Copy data from file-like object `source` to file-like object `target`. N)rÚ file_transferÚ copyfileobj)ÚsourceÚtargetZmax_chunk_sizeÚcallbackrrrrxîs zFTPHost.copyfileobjcCs&tj |d¡}tj ||d¡}||fS)zõ Return a `LocalFile` and `RemoteFile` as source and target, respectively. The strings `source_path` and `target_path` are the (absolute or relative) paths of the local and the remote file, respectively. ÚrbÚwb)rrwÚ LocalFileÚ RemoteFile©r Ú source_pathÚ target_pathÚ source_fileÚ target_filerrrÚ _upload_filesúszFTPHost._upload_filescCsZ|dkrtdƒ‚tjj|ddtjj||jd}| ||¡\}}tjj||d|ddS) a Upload a file from the local source (name) to the remote target (name). If a callable `callback` is given, it's called after every chunk of transferred data. The chunk size is a constant defined in `file_transfer`. The callback will be called with a single argument, the data chunk that was transferred before the callback was called. ©Úóúpath argument `source` is emptyrz©Zpath_argument_namerF©Z conditionalr{N) ÚIOErrorrr&Úraise_for_empty_pathr'r(r…rwÚ copy_file©r ryrzr{rƒr„rrrÚuploads ÿzFTPHost.uploadcCsVtjj|dd|dkr tdƒ‚tjj||jd}| ||¡\}}tjj||d|dS)a7 Upload a file only if it's newer than the target on the remote host or if the target file does not exist. See the method `upload` for the meaning of the parameters. If an upload was necessary, return `True`, else return `False`. If a callable `callback` is given, it's called after every chunk of transferred data. The chunk size is a constant defined in `file_transfer`. The callback will be called with a single argument, the data chunk that was transferred before the callback was called. ryrŠr†úpath argument `target` is emptyrTr‹) rr&rrŒr'r(r…rwrŽrrrrÚupload_if_newers ÿzFTPHost.upload_if_newercCs&tj ||d¡}tj |d¡}||fS)zõ Return a `RemoteFile` and `LocalFile` as source and target, respectively. The strings `source_path` and `target_path` are the (absolute or relative) paths of the remote and the local file, respectively. r|r})rrwrr~r€rrrÚ_download_files/szFTPHost._download_filescCsZtjj|dd|dkr tdƒ‚tjj||jd}| ||¡\}}tjj||d|ddS) a‹ Download a file from the remote source (name) to the local target (name). If a callable `callback` is given, it's called after every chunk of transferred data. The chunk size is a constant defined in `file_transfer`. The callback will be called with a single argument, the data chunk that was transferred before the callback was called. ryrŠr†r‘rFr‹N) rr&rrŒr'r(r“rwrŽrrrrÚdownload;s ÿzFTPHost.downloadcCsV|dkrtdƒ‚tjj|ddtjj||jd}| ||¡\}}tjj||d|dS)a; Download a file only if it's newer than the target on the local host or if the target file does not exist. See the method `download` for the meaning of the parameters. If a download was necessary, return `True`, else return `False`. If a callable `callback` is given, it's called after every chunk of transferred data. The chunk size is a constant defined in `file_transfer`. The callback will be called with a single argument, the data chunk that was transferred before the callback was called. r†r‰rzrŠrTr‹) rŒrr&rr'r(r“rwrŽrrrrÚdownload_if_newerNs ÿzFTPHost.download_if_newercCsF| ¡}z| |¡Wn*tjjk r@tj d |¡¡‚YnXdS)zÇ Raise an `InaccessibleLoginDirError` exception if we can't change to the login directory. This test is only reliable if the current directory is the login directory. z directory '{}' is not accessibleN)rHrLrr"rMZInaccessibleLoginDirErrorrO)r Zpresumable_login_dirrrrÚ#_check_inaccessible_login_directorygsÿz+FTPHost._check_inaccessible_login_directoryFc Csj| ¡| ¡}zH|r.| |¡||dƒW¢.S|j |¡\}}| |¡|||ƒW¢SW5| |¡XdS)a Run an FTP command on a path. The return value of the method is the return value of the command. If `descend_deeply` is true (the default is false), descend deeply, i. e. change the directory to the end of the path. r‡N)r–rHrLrrK)r ÚcommandrÚdescend_deeplyÚold_dirÚheadÚtailrrrÚ_robust_ftp_commandws   zFTPHost._robust_ftp_commandcCs|jS)z4 Return the current directory path. )r)r2rrrrHžszFTPHost.getcwdc CsPtjj||jd}tjj|j |¡W5QRX|j  |j  |j |¡¡|_ dS)z= Change the directory on the host to `path`. rN) rr&r'r(r"r#rÚcwdrr%rJr)©r rrrrrL¤s  ÿz FTPHost.chdircCs6tj |¡tjj||jd}dd„}| ||¡dS)z™ Make the directory path on the remote host. The argument `mode` is ignored and only "supported" for similarity with `os.mkdir`. rc Ss$tjj|j |¡W5QRXdS©úCallback function.N)rr"r#rZmkdržrrrr—»s zFTPHost.mkdir..commandN)rr&rr'r(rœ©r rrAr—rrrÚmkdir³s z FTPHost.mkdirc Cstj |¡tjj||jd}|j |¡}| |j¡}|  ¡}zÆt dt |ƒƒD]²}|j|jj |d|d…Ž}z|  |¡WnNtjjk rÌz| |¡Wn&tjjk rÆ|j |¡s‚YnXYqNX|t |ƒdkrN|sNtj d |¡¡}tj|_|‚qNW5|  |¡XdS)at Make the directory `path`, but also make not yet existing intermediate directories, like `os.makedirs`. The value of `mode` is only accepted for compatibility with `os.makedirs` but otherwise ignored. If `exist_ok` is `False` (the default) and the leaf directory exists, raise a `PermanentError` with `errno` 17. rrhNzpath {!r} exists)rr&rr'r(rÚabspathrKr/rHrLÚrangeÚlenrJr"rMr¢ÚisdirrOÚerrnoÚEEXIST) r rrAÚexist_okÚ directoriesr™ÚindexZnext_directoryZ ftp_os_errorrrrÚmakedirsÉs.    ÿ zFTPHost.makedirsc Csrtj |¡tjj||jd}|j |¡}| |¡rFtj  d  |¡¡‚dd„}z|  ||¡W5|j   |¡XdS)a  Remove the _empty_ directory `path` on the remote host. Compatibility note: Previous versions of ftputil could possibly delete non-empty directories as well, - if the server allowed it. This is no longer supported. rzdirectory '{}' not emptyc Ss$tjj|j |¡W5QRXdSrŸ)rr"r#rZrmdržrrrr—s zFTPHost.rmdir..commandN)rr&rr'r(rr£Úlistdirr"rMrOr rQrœ©r rr—rrrÚrmdirÿs   z FTPHost.rmdirc Csˆtj |¡tjj||jd}|j |¡}|j |¡sN|j |¡sN|j  |¡sxdd„}z|  ||¡W5|j   |¡Xn tj  d¡‚dS)zÖ Remove the file or link given by `path`. Raise a `PermanentError` if the path doesn't exist, but maybe raise other exceptions depending on the state of the server (e. g. timeout). rc Ss$tjj|j |¡W5QRXdSrŸ)rr"r#rÚdeleteržrrrr—/s zFTPHost.remove..commandz>remove/unlink can only delete files and links, not directoriesN)rr&rr'r(rr£ÚisfileÚislinkÚexistsr rQrœr"rMr®rrrÚremoves    ÿ þ ýÿzFTPHost.removec Cs\tj |¡tjj||jd}|r,dd„}n|dkr>dd„}n|}g}z| |¡}Wn*tjjk r~||j|t  ¡ƒYnX|D]–}|j   ||¡}z|  |¡j }Wntjjk rÂd}YnXt |¡rÞ| |||¡q„z| |¡Wq„tjjk r||j|t  ¡ƒYq„Xq„z| |¡Wn,tjjk rV||j|t  ¡ƒYnXdS)a Remove the given remote, possibly non-empty, directory tree. The interface of this method is rather complex, in favor of compatibility with `shutil.rmtree`. If `ignore_errors` is set to a true value, errors are ignored. If `ignore_errors` is a false value _and_ `onerror` isn't set, all exceptions occurring during the tree iteration and processing are raised. These exceptions are all of type `PermanentError`. To distinguish between error situations, pass in a callable for `onerror`. This callable must accept three arguments: `func`, `path` and `exc_info`. `func` is a bound method object, _for example_ `your_host_object.listdir`. `path` is the path that was the recent argument of the respective method (`listdir`, `remove`, `rmdir`). `exc_info` is the exception info as it's got from `sys.exc_info`. Implementation note: The code is copied from `shutil.rmtree` in Python 2.4 and adapted to ftputil. rcWsdS)z Do nothing.Nr©r rrrÚ new_onerror]sz#FTPHost.rmtree..new_onerrorNcWs‚dS)zRe-raise exception.Nrrµrrrr¶dsr)rr&rr'r(r­r"rMÚsysÚexc_inforrJÚlstatÚst_moderÚS_ISDIRÚrmtreer´r¯rl) r rÚ ignore_errorsÚonerrorr¶ÚnamesÚnameZ full_namerArrrr¼Bs8     zFTPHost.rmtreec sÒtjj|ddtjj|ddtjj|ˆjd}tjj|ˆjd}ˆj |¡\}}ˆj |¡\}}‡fdd„}ˆ ¡d|kp†d|k}|rÄ||krĈ ¡} zˆ  |¡|||ƒW5ˆ  | ¡Xn |||ƒdS) zB Rename the `source` on the FTP host to `target`. ryrŠrzrc s^z&tjjˆj ||¡W5QRXW5ˆj |¡}ˆj |¡}ˆj |¡ˆj |¡XdS©N) rr£r rQrr"r#rÚrename)Z source_argZ target_argZsource_absolute_pathZtarget_absolute_pathr2rrÚrename_with_cleanup’s    z+FTPHost.rename..rename_with_cleanupú N) rr&rr'r(rrKr–rHrL) r ryrzZ source_headZ source_tailZ target_headZ target_tailrÃZpaths_contain_whitespacer™rr2rr‚s    zFTPHost.renamecCsdd„}|j||dd}|S)zj Return a directory listing as made by FTP's `LIST` command as a list of strings. c sPg‰‡‡fdd„}tjj,ˆjr4ˆj d||¡nˆj ||¡W5QRXˆS)r csˆ tjj|ˆjd¡dS)r rN)rFrr&Zas_strr()Úline©Úlinesr rrr{¾sz._FTPHost_dir_command..callbackz-a)rr"r#r1rÚdir)r rr{rrÆrÚ_FTPHost_dir_commandºs z*FTPHost._dir.._FTPHost_dir_commandT)r˜)rœ)r rrÉrÇrrrÚ_dir²sÿz FTPHost._dircsBtj |¡|‰tjj|ˆjd}ˆj |¡}‡‡fdd„|DƒS)zÜ Return a list of directories, files etc. in the directory named `path`. If the directory listing from the server can't be parsed with any of the available parsers raise a `ParserError`. rcsg|]}tj ˆ|ˆj¡‘qSr)rr&Zsame_string_type_asr()Ú.0Úitem©Z original_pathr rrÚ Ýsÿz#FTPHost.listdir..)rr&rr'r(rÚ_listdir)r rÚitemsrrÍrr­Òs   þzFTPHost.listdirTcCs,tj |¡tjj||jd}|j ||¡S)a© Return an object similar to that returned by `os.lstat`. If the directory listing from the server can't be parsed with any of the available parsers, raise a `ParserError`. If the directory _can_ be parsed and the `path` is _not_ found, raise a `PermanentError`. (`_exception_for_missing_path` is an implementation aid and _not_ intended for use by ftputil clients.) r)rr&rr'r(rZ_lstat©r rZ_exception_for_missing_pathrrrr¹âs z FTPHost.lstatcCs,tj |¡tjj||jd}|j ||¡S)aü Return info from a "stat" call on `path`. If the directory containing `path` can't be parsed, raise a `ParserError`. If the directory containing `path` can be parsed but the `path` can't be found, raise a `PermanentError`. Also raise a `PermanentError` if there's an endless (cyclic) chain of symbolic links "behind" the `path`. (`_exception_for_missing_path` is an implementation aid and _not_ intended for use by ftputil clients.) r)rr&rr'r(rrÑrrrrñs z FTPHost.statc cstjj|ddtjj||jd}z| |¡}Wn<tjjk rl}z|dk rV||ƒWY¢dSd}~XYnXgg}}|D]0} |j  |j  || ¡¡r¢|  | ¡q||  | ¡q||r¾|||fV|D]8} |j  || ¡} |sä|j  | ¡sÂ|  | |||¡EdHqÂ|s|||fVdS)zÖ Iterate over directory tree and return a tuple (dirpath, dirnames, filenames) on each iteration, like the `os.walk` function (see https://docs.python.org/library/os.html#os.walk ). ÚtoprŠrN)rr&rr'r(r­r"rlrr¦rJrFr²Úwalk) r rÒÚtopdownr¾Ú followlinksr¿ÚerrÚdirsÚnondirsrÀrrrrrÓs*    z FTPHost.walkcsRtj |¡tjj||jd}|j |¡}‡fdd„}| ||¡|j  |¡dS)a¢ Change the mode of a remote `path` (a string) to the integer `mode`. This integer uses the same bits as the mode value returned by the `stat` and `lstat` commands. If something goes wrong, raise a `TemporaryError` or a `PermanentError`, according to the status code returned by the server. In particular, a non-existent path usually causes a `PermanentError`. rc s,tjj|j d ˆ|¡¡W5QRXdS)r zSITE CHMOD 0{0:o} {1}N)rr"r#rÚvoidcmdrOrž©rArrr—/s zFTPHost.chmod..commandN) rr&rr'r(rr£rœr rQr¡rrÚrÚchmod!s    z FTPHost.chmodcCs tdƒ‚dS)Nzcannot serialize FTPHost object)Ú TypeErrorr2rrrÚ __getstate__7szFTPHost.__getstate__cCs|SrÁrr2rrrÚ __enter__=szFTPHost.__enter__cCs | ¡dS)NF)rT)r Úexc_typeÚexc_valÚexc_tbrrrÚ__exit__BszFTPHost.__exit__)r?NNNN)N)N)N)N)F)N)NF)FN)T)T)TNF)0rrrÚ__doc__rr3rr8r>rSrTrXÚ staticmethodrbrerfr\rvrrwZMAX_COPY_CHUNK_SIZErxr…rr’r“r”r•r–rœrHrLr¢r¬r¯r´rkr¼rÂrÊr­r¹rrÓrÛrÝrÞrârrrrrEsh)2ù ÷ A Hü      '  6$ @0    )rãrnr§r9rr·rmZ ftputil.errorrZ ftputil.fileZftputil.file_transferZ ftputil.pathZftputil.path_encodingZftputil.sessionZ ftputil.statZ ftputil.toolÚ__all__rZRUNNING_UNDER_PY39_AND_UPÚFTPrrrrrrÚs&