pysftp

https://pysftp.readthedocs.io/en/latest/
Admin
pysftp is a Python library that provides a simple interface for interacting with SFTP servers,...
Tokens:9,257
Snippets:120
Trust Score:9.6
Update:2 months ago
Show doc for...
Tokens:
Raw
### get(remotepath, localpath=None, callback=None, preserve_mtime=False)

Source: https://pysftp.readthedocs.io/en/latest/pysftp.html

Copies a file between the remote host and the local host.

```APIDOC
## get(remotepath, localpath=None, callback=None, preserve_mtime=False)

### Description
Copies a file between the remote host and the local host.

### Parameters
- **remotepath** (str) - Required - The remote path and filename, source.
- **localpath** (str) - Optional - The local path and filename to copy, destination. If not specified, file is copied to local current working directory.
- **callback** (callable) - Optional - Optional callback function (form: func(int, int)) that accepts the bytes transferred so far and the total bytes to be transferred.
- **preserve_mtime** (bool) - Optional - Default: False - make the modification time(st_mtime) on the local file match the time on the remote.
```

--------------------------------

### Retrieve current working directory

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

The pwd property provides a more reliable way to get the current directory compared to getcwd, which may return None if chdir has not been called.

```python
...
>>> print(sftp.getcwd())
None
>>> sftp.pwd
u'/home/test'
```

--------------------------------

### Establish a pysftp Connection

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Demonstrates basic connection patterns using username/password, context managers, and various key-based authentication methods.

```python
import pysftp
sftp = pysftp.Connection('hostname', username='me', password='secret')
#
# ... do sftp operations
#
sftp.close()    # close your connection to hostname
```

```python
import pysftp
with pysftp.Connection('hostname', username='me', password='secret') as sftp:
    #
    # ... do sftp operations
    #
# connection closed automatically at the end of the with-block
```

```python
import pysftp
with pysftp.Connection('hostname', username='me', private_key='/path/to/keyfile') as sftp:
    #
    # ... do sftp operations
    #
```

```python
import pysftp
with pysftp.Connection('hostname', username='me', private_key=my_agentkey) as sftp:
    #
    # ... do sftp operations
    #
```

--------------------------------

### Create a directory with mkdir

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Creates a single directory with a specified integer mode.

```python
... 
sftp.mkdir('show', mode=644)  # user r/w, group and other read-only
```

--------------------------------

### Create directories with makedirs

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Creates all directories in a path as needed, optionally setting the mode.

```python
... 
sftp.makedirs('pub/show/off')  # will happily make all non-existing directories
```

--------------------------------

### pysftp.CnOpts

Source: https://pysftp.readthedocs.io/en/latest/pysftp.html

Initializes connection options for the SFTP session, such as host key verification and logging settings.

```APIDOC
## class pysftp.CnOpts(knownhosts=None)

### Description
Creates a connection options object used for passing extended configuration to the Connection class.

### Parameters
- **knownhosts** (filepath|None) - Optional - File to load hostkeys. Defaults to ~/.ssh/known_hosts.

### Variables
- **log** (bool|str) - Optional - Log connection/handshake details.
- **compression** (bool) - Optional - Enable transport compression.
- **ciphers** (list|None) - Optional - List of ciphers to use.
- **hostkeys** (paramiko.hostkeys.HostKeys|None) - Optional - HostKeys object for verification.
```

--------------------------------

### pysftp.cd

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

A context-aware version of os.chdir for the local file system.

```APIDOC
## pysftp.cd(path)

### Description
A with-context aware version of os.chdir for use on the local file system.

### Example
```python
>>> with pysftp.cd('docs'):
...     print os.getcwd()
```
```

--------------------------------

### pysftp.Connection.mkdir()

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Creates a new directory with the specified mode.

```APIDOC
## pysftp.Connection.mkdir(path, mode)

### Description
Creates a new directory with the specified mode.

### Parameters
- **path** (string) - Required - The directory path to create.
- **mode** (integer) - Required - Integer representation of the octal mode.
```

--------------------------------

### pysftp.Connection.makedirs()

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Creates all directories in a path as needed, setting their mode if created.

```APIDOC
## pysftp.Connection.makedirs(path, mode)

### Description
Creates all directories in a path as needed, setting their mode if created.

### Parameters
- **path** (string) - Required - The directory path to create.
- **mode** (integer) - Optional - Integer representation of the mode to set.
```

--------------------------------

### Establish SFTP Connection and Perform File Operations

Source: https://pysftp.readthedocs.io/en/latest/index.html

Uses a context manager to connect to an SFTP server, change directories, and perform file uploads and downloads.

```python
import pysftp

with pysftp.Connection('hostname', username='me', password='secret') as sftp:
    with sftp.cd('public'):             # temporarily chdir to public
        sftp.put('/my/local/filename')  # upload file to public/ on remote
        sftp.get('remote_file')         # get a remote file
```

--------------------------------

### pysftp.Connection.walktree()

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Recursively walks a remote directory structure.

```APIDOC
## pysftp.Connection.walktree()

### Description
Recursively walks a remote directory structure and executes user-supplied callback functions for each file, directory, or unknown entity encountered.

### Usage
`sftp.walktree(remotepath, fcallback, dcallback, ucallback)`
```

--------------------------------

### Download a directory with pysftp

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Copies all files from a remote directory to a local path, optionally preserving modification times.

```python
# copy all files under public to a local path, preserving modification time
sftp.get_d('public', 'local-backup', preserve_mtime=True)
```

--------------------------------

### Connect Using Dictionary Parameters

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Passes connection credentials stored in a dictionary directly to the Connection object using argument unpacking.

```python
import pysftp
cinfo = {'host':'hostname', 'username':'me', 'password':'secret', 'port':2222}
with pysftp.Connection(**cinfo) as sftp:
    #
    # ... do sftp operations
    #
```

--------------------------------

### pysftp.Connection.put_r()

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Copies all files and directories from a local path to a remote path, creating directories as needed.

```APIDOC
## pysftp.Connection.put_r(localpath, remotepath, preserve_mtime=False)

### Description
Recursively copies files and directories from a local path to a remote path. It creates necessary directories and succeeds if the target directories already exist.

### Parameters
- **localpath** (string) - Required - The local directory path to copy from.
- **remotepath** (string) - Required - The remote directory path to copy to.
- **preserve_mtime** (boolean) - Optional - If True, preserves modification times on the files.
```

--------------------------------

### open(remote_file, mode='r', bufsize=-1)

Source: https://pysftp.readthedocs.io/en/latest/pysftp.html

Opens a file on the remote server.

```APIDOC
## open(remote_file, mode='r', bufsize=-1)

### Description
Open a file on the remote server.

### Parameters
- **remote_file** (str) - Required - Name of the file to open.
- **mode** (str) - Optional - Mode (Python-style) to open file (always assumed binary)
- **bufsize** (int) - Optional - Default: -1 - Desired buffering

### Returns
- (obj) SFTPFile, a handle the remote open file

### Raises
- IOError, if the file could not be opened.
```

--------------------------------

### Recursively download a directory with pysftp

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Recursively copies files and directories from a remote path to a local destination.

```python
# copy all files AND directories under public to a local path
sftp.get_r('public', 'local-backup', preserve_mtime=True)
```

--------------------------------

### pysftp.Connection.get()

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Downloads a file from the remote server to the local system.

```APIDOC
## pysftp.Connection.get()

### Description
Downloads a file from the remote server. Optionally preserves the modification time of the file.

### Parameters
- **remotepath** (string) - Required - The path to the file on the remote server.
- **preserve_mtime** (boolean) - Optional - If True, sets the local file modification time to match the remote file.
```

--------------------------------

### pysftp.Connection.listdir()

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Returns a sorted list of filenames in the current directory.

```APIDOC
## pysftp.Connection.listdir()

### Description
Returns a sorted list of filenames in the current directory.

### Returns
- **list** - A sorted list of filenames.
```

--------------------------------

### Recursively copy files with put_r

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Copies all files and directories from a local path to a remote path, creating directories as needed.

```python
# recursively copy files and directories from local static, to remote static,
# preserving modification times on the files
sftp.put_r('static', 'static', preserve_mtime=True)
```

--------------------------------

### walktree(remotepath, fcallback, dcallback, ucallback, recurse=True)

Source: https://pysftp.readthedocs.io/en/latest/pysftp.html

Recursively descends a directory tree.

```APIDOC
## walktree(remotepath, fcallback, dcallback, ucallback, recurse=True)

### Description
Recursively descend, depth first, the directory tree rooted at remotepath, calling discreet callback functions for each regular file, directory and unknown file type.

### Parameters
- **remotepath** (str) - Required - Root of remote directory to descend
- **fcallback** (callable) - Required - Callback function for a regular file
- **dcallback** (callable) - Required - Callback function for a directory
- **ucallback** (callable) - Required - Callback function for an unknown file type
- **recurse** (bool) - Optional - Default: True - Should it recurse

### Returns
- **None**
```

--------------------------------

### Upload a directory with pysftp

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Copies the contents of a local directory to a remote directory via SFTP.

```python
# copy files from images, to remote static/images directory, preserving modification time
sftp.put_d('images', 'static/images', preserve_mtime=True)
```

--------------------------------

### pysftp.Connection.get_r()

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Recursively downloads files and directories from a remote path.

```APIDOC
## pysftp.Connection.get_r()

### Description
Recursively copies files and directories from the remote server to a local path.

### Parameters
- **remotepath** (string) - Required - The remote path to copy.
- **localpath** (string) - Required - The local destination path.
- **preserve_mtime** (boolean) - Optional - If True, preserves modification times.
```

--------------------------------

### pysftp.Connection.cd()

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

A context manager for changing the remote working directory, automatically restoring the original directory upon exit.

```APIDOC
## pysftp.Connection.cd(remotedir=None)

### Description
A with-context capable version of chdir(). It changes the remote directory temporarily and restores the original directory when the with statement goes out of scope.

### Parameters
- **remotedir** (string) - Optional - The remote directory to change to. If omitted, it acts as a bookmark to return to the current directory later.
```

--------------------------------

### pysftp.Connection

Source: https://pysftp.readthedocs.io/en/latest/pysftp.html

Establishes an SFTP connection to a remote host.

```APIDOC
## class pysftp.Connection(host, username=None, private_key=None, password=None, port=22, private_key_pass=None, cnopts=None, default_path=None)

### Description
Connects and logs into the specified remote hostname.

### Parameters
- **host** (str) - Required - The Hostname or IP of the remote machine.
- **username** (str|None) - Optional - Username at the remote machine.
- **private_key** (str|obj|None) - Optional - Path to private key file or paramiko.AgentKey.
- **password** (str|None) - Optional - Password at the remote machine.
- **port** (int) - Optional - SSH port, defaults to 22.
- **cnopts** (CnOpts|None) - Optional - Extra connection options.
```

--------------------------------

### makedirs(remotedir, mode=777)

Source: https://pysftp.readthedocs.io/en/latest/pysftp.html

Creates all directories in the specified remote path as needed, setting their mode if created.

```APIDOC
## makedirs(remotedir, mode=777)

### Description
Creates all directories in remotedir as needed, setting their mode to mode, if created. If remotedir already exists, silently complete. If a regular file is in the way, raise an exception.

### Parameters
- **remotedir** (str) - Required - The directory structure to create
- **mode** (int) - Optional - Default: 777 - int representation of octal mode for directory

### Returns
- None

### Raises
- OSError
```

--------------------------------

### Load Additional Known Host Keys

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Merges additional host keys into the existing known_hosts configuration using the load method.

```python
import pysftp
cnopts = pysftp.CnOpts()
cnopts.hostkeys.load('path/to/your/extra_knownhosts')
with pysftp.Connection('host', username='me', password='pass', cnopts=cnopts):
    # do stuff here
```

--------------------------------

### listdir(remotepath='.')

Source: https://pysftp.readthedocs.io/en/latest/pysftp.html

Returns a sorted list of files/directories for the given remote path.

```APIDOC
## listdir(remotepath='.')

### Description
Return a list of files/directories for the given remote path. Unlike paramiko, the directory listing is sorted.

### Parameters
- **remotepath** (str) - Optional - Path to list on the server.

### Returns
- (list of str) - Directory entries, sorted.
```

--------------------------------

### put_r(localpath, remotepath, confirm=True, preserve_mtime=False)

Source: https://pysftp.readthedocs.io/en/latest/pysftp.html

Recursively copies a local directory’s contents to a remotepath.

```APIDOC
## put_r(localpath, remotepath, confirm=True, preserve_mtime=False)

### Description
Recursively copies a local directory’s contents to a remotepath.

### Parameters
- **localpath** (str) - Required - The local path to copy (source)
- **remotepath** (str) - Required - The remote path to copy to (target)
- **confirm** (bool) - Optional - Whether to do a stat() on the file afterwards to confirm the file size
- **preserve_mtime** (bool) - Optional - Default: False - Make the modification time(st_mtime) on the remote file match the time on the local.

### Returns
- None

### Raises
- IOError - if remotepath doesn’t exist
- OSError - if localpath doesn’t exist
```

--------------------------------

### Download a file with pysftp

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Downloads a single file from the remote server, optionally preserving the modification time.

```python
# ...
sftp.get('myfile', preserve_mtime=True)
```

--------------------------------

### Manage remote directories with cd

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Uses a context manager to temporarily change the remote directory and automatically restore the original path upon exit.

```python
with sftp.cd('static'):     # now in ./static
    sftp.chdir('here')      # now in ./static/here
    sftp.chdir('there')     # now in ./static/here/there
# now back to the original current working directory
```

```python
with sftp.cd():             # still in .
    sftp.chdir('static')    # now in ./static
    sftp.chdir('here')      # now in ./static/here
# now back to the original current working directory
```

--------------------------------

### Reparent a directory structure

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Prepends a base path to a target path, useful for copying directory structures.

```python
>>> pysftp.reparent('backup', '/home/test/pub')
'backup/./home/test/pub'
```

--------------------------------

### Iterate over file path in reverse with path_retreat

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Generates a sequence of parent directories from a given path.

```python
>>> list(pysftp.path_retreat('./pub/example/example01'))
['./pub/example/example01', './pub/example', './pub', '.']
```

--------------------------------

### pysftp.Connection.listdir_attr()

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Returns a list of SFTPAttribute objects for files in the current directory, sorted by filename.

```APIDOC
## pysftp.Connection.listdir_attr()

### Description
Returns a list of SFTPAttribute objects for files in the current directory, sorted by filename.

### Returns
- **list** - A sorted list of SFTPAttribute objects.
```

--------------------------------

### mkdir(remotepath, mode=777)

Source: https://pysftp.readthedocs.io/en/latest/pysftp.html

Creates a directory named remotepath with the specified mode.

```APIDOC
## mkdir(remotepath, mode=777)

### Description
Create a directory named remotepath with mode. On some systems, mode is ignored. Where it is used, the current umask value is first masked out.

### Parameters
- **remotepath** (str) - Required - Directory to create
- **mode** (int) - Optional - Default: 777 - int representation of octal mode for directory

### Returns
- None
```

--------------------------------

### List directory contents with listdir

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Returns a sorted list of filenames in the current directory.

```python
... 
>>> sftp.listdir()
[u'pub', u'readme.sym', u'readme.txt']
```

--------------------------------

### putfo(flo, remotepath=None, file_size=0, callback=None, confirm=True)

Source: https://pysftp.readthedocs.io/en/latest/pysftp.html

Copies the contents of a file-like object to a remote path.

```APIDOC
## putfo(flo, remotepath=None, file_size=0, callback=None, confirm=True)

### Description
Copies the contents of a file like object to remotepath.

### Parameters
- **flo** (object) - Required - A file-like object that supports .read()
- **remotepath** (str) - Optional - The remote path.
- **file_size** (int) - Optional - The size of flo, if not given the second param passed to the callback function will always be 0.
- **callback** (callable) - Optional - Optional callback function (form: func(int, int)) that accepts the bytes transferred so far and the total bytes to be transferred.
- **confirm** (bool) - Optional - Whether to do a stat() on the file afterwards to confirm the file size
```

--------------------------------

### put(localpath, remotepath=None, callback=None, confirm=True, preserve_mtime=False)

Source: https://pysftp.readthedocs.io/en/latest/pysftp.html

Copies a file between the local host and the remote host.

```APIDOC
## put(localpath, remotepath=None, callback=None, confirm=True, preserve_mtime=False)

### Description
Copies a file between the local host and the remote host.

### Parameters
- **localpath** (str) - Required - The local path and filename
- **remotepath** (str) - Optional - The remote path, else the remote pwd and filename is used.
- **callback** (callable) - Optional - Optional callback function (form: func(int, int)) that accepts the bytes transferred so far and the total bytes to be transferred.
- **confirm** (bool) - Optional - Whether to do a stat() on the file afterwards to confirm the file size
- **preserve_mtime** (bool) - Optional - Default: False - Make the modification time(st_mtime) on the remote file match the time on the local.

### Returns
- (obj) SFTPAttributes containing attributes about the given file

### Raises
- IOError - if remotepath doesn’t exist
- OSError - if localpath doesn’t exist
```

--------------------------------

### execute(command)

Source: https://pysftp.readthedocs.io/en/latest/pysftp.html

Executes the given command on a remote machine.

```APIDOC
## execute(command)

### Description
Execute the given commands on a remote machine. The command is executed without regard to the remote pwd.

### Parameters
- **command** (str) - Required - The command to execute.

### Returns
- (list of str) - The results of the command.
```

--------------------------------

### pwd()

Source: https://pysftp.readthedocs.io/en/latest/pysftp.html

Returns the current working directory on the remote server.

```APIDOC
## pwd()

### Description
Returns the current working directory as a string.

### Returns
- **(str)** Current working directory
```

--------------------------------

### put_d(localpath, remotepath, confirm=True, preserve_mtime=False)

Source: https://pysftp.readthedocs.io/en/latest/pysftp.html

Copies a local directory’s contents to a remotepath.

```APIDOC
## put_d(localpath, remotepath, confirm=True, preserve_mtime=False)

### Description
Copies a local directory’s contents to a remotepath.

### Parameters
- **localpath** (str) - Required - The local path to copy (source)
- **remotepath** (str) - Required - The remote path to copy to (target)
- **confirm** (bool) - Optional - Whether to do a stat() on the file afterwards to confirm the file size
- **preserve_mtime** (bool) - Optional - Default: False - Make the modification time(st_mtime) on the remote file match the time on the local.

### Returns
- None

### Raises
- IOError - if remotepath doesn’t exist
- OSError - if localpath doesn’t exist
```

--------------------------------

### Iterate over file path

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Generates a sequence of path components for a given file path.

```python
>>> list(pysftp.path_advance('./pub/example/example01'))
['.', './pub', './pub/example', './pub/example/example01']
```

--------------------------------

### pysftp.Connection.put()

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Uploads a file from the local system to the remote server.

```APIDOC
## pysftp.Connection.put()

### Description
Uploads a file to the remote server. Optionally preserves the modification time.

### Parameters
- **localpath** (string) - Required - The path to the local file.
- **preserve_mtime** (boolean) - Optional - If True, sets the remote file modification time to match the local file.
```

--------------------------------

### pysftp.reparent

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Prepends a new parent path to an existing path, useful for copying directory structures.

```APIDOC
## pysftp.reparent(parent, path)

### Description
Prepends a parent directory to a path, ensuring the full structure is maintained.

### Example
```python
>>> pysftp.reparent('backup', '/home/test/pub')
'backup/./home/test/pub'
```
```

--------------------------------

### pysftp.Connection.get_d()

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Downloads all files from a remote directory to a local path.

```APIDOC
## pysftp.Connection.get_d()

### Description
Copies all files in a remote directory to a local path.

### Parameters
- **remotedir** (string) - Required - The remote directory to copy from.
- **localdir** (string) - Required - The local directory to copy to.
- **preserve_mtime** (boolean) - Optional - If True, preserves modification times.
```

--------------------------------

### pysftp.Connection.chown

Source: https://pysftp.readthedocs.io/en/latest/pysftp.html

Sets the UID and/or GID on a remote path.

```APIDOC
## method chown(remotepath, uid=None, gid=None)

### Description
Sets the user ID and/or group ID on a remote path. Requires appropriate permissions on the remote server.

### Parameters
- **remotepath** (str) - Required - The remote path to modify.
- **uid** (int) - Optional - The user ID to set.
- **gid** (int) - Optional - The group ID to set.
```

--------------------------------

### symlink(remote_src, remote_dest)

Source: https://pysftp.readthedocs.io/en/latest/pysftp.html

Creates a symlink for a remote file.

```APIDOC
## symlink(remote_src, remote_dest)

### Description
Create a symlink for a remote file on the server.

### Parameters
- **remote_src** (str) - Required - Path of original file
- **remote_dest** (str) - Required - Path of the created symlink

### Returns
- **None**

### Raises
- **IOError** if something already exists at remote_dest
```

--------------------------------

### Specify Custom Known Hosts File

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Overrides the default known_hosts file location by providing a path during CnOpts instantiation.

```python
import pysftp
cnopts = pysftp.CnOpts(knownhosts='path/to/your/knownhostsfile')
cnopts.hostkeys = None
with pysftp.Connection('host', username='me', password='pass', cnopts=cnopts):
    # do stuff here
```

--------------------------------

### Read symbolic link with pysftp

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Resolves a symbolic link to its absolute path on the remote server.

```python
>>> sftp.readlink('readme.sym')
u'/home/test/readme.txt'
```

--------------------------------

### List directory attributes with listdir_attr

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Returns a list of SFTPAttribute objects sorted by filename.

```python
... 
>>> for attr in sftp.listdir_attr():
...     print attr.filename, attr
...
pub dr-xrwxr-x   1 501      502             5 19 May 23:22 pub
readme.sym lrwxr-xr-x   1 501      502            10 21 May 23:29 readme.sym
readme.txt -r--r--r--   1 501      502          8192 26 May 23:32 readme.txt
```

--------------------------------

### pysftp.Connection.pwd

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Returns the current working directory on the remote server.

```APIDOC
## pysftp.Connection.pwd

### Description
Returns the current working directory. Unlike getcwd(), this property provides a reliable path string even if chdir() has not been explicitly called.
```

--------------------------------

### pysftp.path_advance()

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Generator to iterate over a file path.

```APIDOC
## pysftp.path_advance()

### Description
A generator that iterates over a file path, yielding each segment of the path.

### Usage
`pysftp.path_advance(path)`
```

--------------------------------

### pysftp.Connection.readlink()

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Returns the absolute path of a symbolic link on the remote server.

```APIDOC
## pysftp.Connection.readlink()

### Description
Returns the absolute path of a symbolic link on the remote server by normalizing the result.

### Usage
`sftp.readlink(remotepath)`
```

--------------------------------

### Change local directory with cd context manager

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Temporarily changes the current working directory within a with-block, reverting automatically afterward.

```python
>>> import os
>>> os.getcwd()
'/home/jlh/Projects/pysftp/src'
>>> with pysftp.cd('docs'):
...     print os.getcwd()
...
/home/jlh/Projects/pysftp/src/docs
>>> os.getcwd()
'/home/jlh/Projects/pysftp/src'
```

--------------------------------

### pysftp.Connection.isfile()

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Checks if the given path is a file.

```APIDOC
## pysftp.Connection.isfile(path)

### Description
Checks if the given path is a file.

### Parameters
- **path** (string) - Required - The path to check.

### Returns
- **boolean** - True if the path is a file, False otherwise.
```

--------------------------------

### Check remote entity existence

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Verifies if a file or directory exists on the remote server.

```python
>>> sftp.exists('readme.txt')   # a file
True
>>> sftp.exists('pub')          # a dir
True
```

--------------------------------

### Upload a file with pysftp

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Uploads a file to the remote server, optionally ensuring the remote modification time matches the local one.

```python
# copy myfile, to the current working directory on the server, preserving modification time
sftp.put('myfile', preserve_mtime=True)
```

--------------------------------

### pysftp.Connection.exists()

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Checks if a remote file or directory exists.

```APIDOC
## pysftp.Connection.exists()

### Description
Returns True if a remote entity exists, False otherwise.

### Usage
`sftp.exists(remotepath)`
```

--------------------------------

### pysftp.Connection.chdir

Source: https://pysftp.readthedocs.io/en/latest/pysftp.html

Changes the current working directory on the remote server.

```APIDOC
## method chdir(remotepath)

### Description
Changes the current working directory on the remote server to the specified path.

### Parameters
- **remotepath** (str) - Required - The remote path to change to.
```

--------------------------------

### pysftp.Connection.put_d()

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Uploads the contents of a local directory to a remote directory.

```APIDOC
## pysftp.Connection.put_d()

### Description
Copies the contents of a local directory to a remote directory via SFTP.

### Parameters
- **localdir** (string) - Required - The local directory to copy from.
- **remotedir** (string) - Required - The remote directory to copy to.
- **preserve_mtime** (boolean) - Optional - If True, preserves modification times.
```

--------------------------------

### pysftp.Connection.chown(uid=None, gid=None)

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Changes the owner and group of a remote file or directory.

```APIDOC
## pysftp.Connection.chown(uid=None, gid=None)

### Description
Allows specifying the uid, gid, or both for a remote file. If either parameter is None, the method performs a stat to retrieve current values to ensure both are set as required by the underlying paramiko implementation.

### Parameters
- **uid** (int) - Optional - The user ID to set.
- **gid** (int) - Optional - The group ID to set.
```

--------------------------------

### pysftp.Connection.isdir()

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Checks if the given path is a directory.

```APIDOC
## pysftp.Connection.isdir(path)

### Description
Checks if the given path is a directory.

### Parameters
- **path** (string) - Required - The path to check.

### Returns
- **boolean** - True if the path is a directory, False otherwise.
```

--------------------------------

### stat(remotepath)

Source: https://pysftp.readthedocs.io/en/latest/pysftp.html

Returns information about a file or directory.

```APIDOC
## stat(remotepath)

### Description
Return information about file/directory for the given remote path.

### Parameters
- **remotepath** (str) - Required - Path to stat

### Returns
- **(obj)** SFTPAttributes
```

--------------------------------

### Disable Host Key Checking with CnOpts

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Disables host key verification by setting hostkeys to None. This is not advised for production environments.

```python
import pysftp
cnopts = pysftp.CnOpts()
cnopts.hostkeys = None
with pysftp.Connection('host', username='me', password='pass', cnopts=cnopts):
    # do stuff here
```

--------------------------------

### Change working directory

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

The cwd method acts as a synonym for chdir to facilitate easier migration from command-line sftp usage.

```python
...
sftp.cwd('public')  # is equivalent to sftp.chdir('public')
```

--------------------------------

### Convert file mode to integer

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Use this to convert the st_mode attribute from an SFTPAttribute object into a standard octal-based integer representation.

```python
>>> attr = sftp.stat('readme.txt')
>>> attr.st_mode
33188
>>> pysftp.st_mode_to_int(attr.st_mode)
644
```

--------------------------------

### pysftp.Connection.chmod

Source: https://pysftp.readthedocs.io/en/latest/pysftp.html

Sets the mode of a remote file or directory.

```APIDOC
## method chmod(remotepath, mode=777)

### Description
Sets the mode of a remote path to the specified integer representation of the octal mode.

### Parameters
- **remotepath** (str) - Required - The remote path to modify.
- **mode** (int) - Optional - Integer representation of octal mode, defaults to 777.
```

--------------------------------

### Update file permissions with chmod

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Sets file permissions using an integer representation of the octal mode, similar to the command line chmod utility.

```text
user group other
rwx  rwx   rwx
421  421   421

user  - read/write = 4+2 = 6
group - read       = 4   = 4
other - read       = 4   = 4
```

```python
sftp.chmod('readme.txt', 644)
```

--------------------------------

### pysftp.Connection.truncate()

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Truncates a remote file to a specified size.

```APIDOC
## pysftp.Connection.truncate()

### Description
Truncates the remote file to the specified size and returns the new file size.

### Usage
`sftp.truncate(remotepath, size)`
```

--------------------------------

### pysftp.path_retreat

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

A generator that iterates over a file path in reverse, yielding each parent directory.

```APIDOC
## pysftp.path_retreat(path)

### Description
Generator to iterate over a file path in reverse.

### Example
```python
>>> list(pysftp.path_retreat('./pub/example/example01'))
['./pub/example/example01', './pub/example', './pub', '.']
```
```

--------------------------------

### truncate(remotepath, size)

Source: https://pysftp.readthedocs.io/en/latest/pysftp.html

Changes the size of a file on the remote server.

```APIDOC
## truncate(remotepath, size)

### Description
Change the size of the file specified by path.

### Parameters
- **remotepath** (str) - Required - Remote file path to modify
- **size** (int|long) - Required - The new file size

### Returns
- **(int)** New size of file

### Raises
- **IOError** if file does not exist
```

--------------------------------

### Check if path is a file with isfile

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Returns True if the path is a file, False otherwise.

```python
... 
>>> sftp.isfile('pub')
False
```

--------------------------------

### pysftp.Connection.cwd(path)

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Changes the current working directory on the remote server.

```APIDOC
## pysftp.Connection.cwd(path)

### Description
A synonym for chdir() designed to make transposing command-line SFTP commands easier.

### Parameters
- **path** (str) - Required - The directory path to change to.
```

--------------------------------

### pysftp.Connection.lexists()

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Checks if a remote entity exists, including broken symbolic links.

```APIDOC
## pysftp.Connection.lexists()

### Description
Similar to exists(), but returns True even for broken symbolic links.

### Usage
`sftp.lexists(remotepath)`
```

--------------------------------

### normalize(remotepath)

Source: https://pysftp.readthedocs.io/en/latest/pysftp.html

Returns the expanded path of a given path on the remote server.

```APIDOC
## normalize(remotepath)

### Description
Return the expanded path, w.r.t the server, of a given path. This can be used to resolve symlinks or determine what the server believes to be the pwd, by passing ‘.’ as remotepath.

### Parameters
- **remotepath** (str) - Required - Path to be normalized

### Returns
- (str) normalized form of the given path

### Raises
- IOError, if remotepath can’t be resolved
```

--------------------------------

### readlink(remotelink)

Source: https://pysftp.readthedocs.io/en/latest/pysftp.html

Returns the target of a symlink on the remote server.

```APIDOC
## readlink(remotelink)

### Description
Return the target of a symlink. The result will be an absolute pathname.

### Parameters
- **remotelink** (str) - Required - Remote path of the symlink

### Returns
- **(str)** Absolute path to target
```

--------------------------------

### Truncate remote file

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Resizes a remote file and returns the new file size.

```python
>>> sftp.truncate('readme.txt', 4096)
4096
```

--------------------------------

### rename(remote_src, remote_dest)

Source: https://pysftp.readthedocs.io/en/latest/pysftp.html

Renames a file or directory on the remote host.

```APIDOC
## rename(remote_src, remote_dest)

### Description
Rename a file or directory on the remote host.

### Parameters
- **remote_src** (str) - Required - The remote file/directory to rename
- **remote_dest** (str) - Required - The remote file/directory to put it

### Returns
- **None**

### Raises
- **IOError**
```

--------------------------------

### Check if path is a directory with isdir

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Returns True if the path is a directory, False otherwise.

```python
... 
>>> sftp.isdir('pub')
True
```

--------------------------------

### pysftp.st_mode_to_int(mode)

Source: https://pysftp.readthedocs.io/en/latest/cookbook.html

Converts an octal mode result from an SFTPAttribute object into a standard integer representation of file mode bits.

```APIDOC
## pysftp.st_mode_to_int(mode)

### Description
Converts an octal mode result back to an integer representation. This function clips extra bits from the .st_mode attribute returned by SFTPAttribute to provide recognizable file mode bits.

### Parameters
- **mode** (int) - Required - The st_mode value from an SFTPAttribute object.
```

--------------------------------

### remove(remotefile)

Source: https://pysftp.readthedocs.io/en/latest/pysftp.html

Removes a file from the remote server.

```APIDOC
## remove(remotefile)

### Description
Remove the file at remotefile. This method only works on files.

### Parameters
- **remotefile** (str) - Required - The remote file to delete

### Returns
- **None**

### Raises
- **IOError**
```

--------------------------------

### rmdir(remotepath)

Source: https://pysftp.readthedocs.io/en/latest/pysftp.html

Removes a remote directory.

```APIDOC
## rmdir(remotepath)

### Description
Remove remote directory.

### Parameters
- **remotepath** (str) - Required - The remote directory to remove

### Returns
- **None**
```
Tokens:
Raw