:py:mod:`wfexs_backend.fetchers.sftp`
=====================================

.. py:module:: wfexs_backend.fetchers.sftp

.. autodoc2-docstring:: wfexs_backend.fetchers.sftp
   :allowtitles:

Module Contents
---------------

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`sftpCopy <wfexs_backend.fetchers.sftp.sftpCopy>`
     - .. autodoc2-docstring:: wfexs_backend.fetchers.sftp.sftpCopy
          :summary:
   * - :py:obj:`fetchSSHURL <wfexs_backend.fetchers.sftp.fetchSSHURL>`
     - .. autodoc2-docstring:: wfexs_backend.fetchers.sftp.fetchSSHURL
          :summary:

API
~~~

.. py:function:: sftpCopy(sftp: paramiko.SFTPClient, sshPath: wfexs_backend.common.AbsPath, localPath: wfexs_backend.common.PathLikePath, sshStat: Optional[paramiko.SFTPAttributes] = None) -> Tuple[Union[int, Literal[False]], Optional[ContentKind]]
   :canonical: wfexs_backend.fetchers.sftp.sftpCopy

   .. autodoc2-docstring:: wfexs_backend.fetchers.sftp.sftpCopy

.. py:function:: fetchSSHURL(remote_file: wfexs_backend.common.URIType, cachedFilename: wfexs_backend.common.PathLikePath, secContext: Optional[SecurityContextConfig] = None) -> wfexs_backend.fetchers.ProtocolFetcherReturn
   :canonical: wfexs_backend.fetchers.sftp.fetchSSHURL

   .. autodoc2-docstring:: wfexs_backend.fetchers.sftp.fetchSSHURL