Connection abstact abstract classes API

This file describes abstract classes defining the package API.

ssh_utilities.abstract

Template module for all connection classes.

class ssh_utilities.abstract.ConnectionABC

Bases: abc.ABC

Class defining API for connection classes.

static _path2str(path: Optional[_SPATH]) → str

Converts pathlib.Path, SSHPath or plain str to string.

Also remove any rtailing backslashes.

Parameters:path (ssh_utilities.typeshed._SPATH) – path to convert to string, if string is passed, then just returns it
Raises:ValueError – if path is not instance of str, Path or SSHPath
_to_str(connection_name: str, host_name: str, address: Optional[str], user_name: str, ssh_key: Union[pathlib.Path, str, None], thread_safe: bool, allow_agent: bool) → str

Aims to ease persistance, returns string representation of instance.

With this method all data needed to initialize class are saved to sting and connection can be reinitialized with from_str method of conection.Connection class.

Parameters:
  • connection_name (str) – SSHConnection or LocalConnection
  • host_name (str) – name of remote server
  • address (str) – server address in case of remote connection
  • user_name (str) – server login name
  • ssh_key (Optional[Union[Path, str]]) – file with public key, pass none for LocalConnection
  • thread_safe (bool) – make connection object thread safe so it can be safely accessed from any number of threads, it is disabled by default to avoid performance penalty of threading locks
  • allow_agent (bool) – allows use of ssh agent for connection authentication, when this is True key for the host does not have to be available.
Returns:

string representation of the class

Return type:

str

See also

ssh_utilities.conncection.Connection

class ssh_utilities.abstract.OsPathABC

Bases: abc.ABC

os.path module drop-in replacement base.

exists(path: _SPATH) → bool

Check if path exists in filesystem.

Parameters:path (ssh_utilities.typeshed._SPATH) – path to check
Returns:check result
Return type:bool
getsize(path: _SPATH) → int

Return the size of path in bytes.

Parameters:path (ssh_utilities.typeshed._SPATH) – path to file/directory
Returns:size in bytes
Return type:int
Raises:OsError – if the file does not exist or is inaccessible
isdir(path: _SPATH) → bool

Check if path points to directory.

Parameters:path (ssh_utilities.typeshed._SPATH) – path to check
Returns:check result
Return type:bool
Raises:IOError – if dir could not be accessed
isfile(path: _SPATH) → bool

Check if path points to a file.

Parameters:path (ssh_utilities.typeshed._SPATH) – path to check
Returns:check result
Return type:bool
Raises:IOError – if file could not be accessed

Check if path points to symbolic link.

Parameters:path (ssh_utilities.typeshed._SPATH) – path to check
Returns:check result
Return type:bool
Raises:IOError – if dir could not be accessed
join(path: _SPATH, *paths) → str

Join one or more path components intelligently.

The return value is the concatenation of path and any members of *paths with exactly one directory separator following each non-empty part except the last, meaning that the result will only end in a separator if the last part is empty. If a component is an absolute path, all previous components are thrown away and joining continues from the absolute path component. On Windows, the drive letter is not reset when an absolute path component (e.g., ‘foo’) is encountered. If a component contains a drive letter, all previous components are thrown away and the drive letter is reset. Note that since there is a current directory for each drive, os.path.join(“c:”, “foo”) represents a path relative to the current directory on drive C: (c:foo), not c:/foo.

Parameters:
Returns:

joined path parts

Return type:

str

realpath(path: _SPATH) → str

Return the canonical path of the specified filename.

Eliminates any symbolic links encountered in the path.

Parameters:path (ssh_utilities.typeshed._SPATH) – path to resolve
Returns:string representation of the resolved path
Return type:str
class ssh_utilities.abstract.BuiltinsABC

Bases: abc.ABC, typing.Generic

Python builtins drop-in replacement base.

open(filename: _SPATH, mode: str = 'r', buffering: int = -1, encoding: Optional[str] = None, errors: Optional[str] = None, newline: Optional[str] = None) → _Builtins1

Opens remote file, works as python open function.

Can be used both as a function or a decorator.

Parameters:
  • filename (ssh_utilities.typeshed._SPATH) – path to file to be opened
  • mode (str) – select mode to open file. Same as python open modes
  • encoding (Optional[str]) – encoding type to decode file bytes stream
  • buffering (int) – buffer size, 0 turns off buffering, 1 uses line buffering, and any number greater than 1 (>1) uses that specific buffer size
  • errors (Optional[str]) – string that specifies how encoding and decoding errors are to be handled, see builtin function open documentation for more details
  • newline (Optional[str]) – this parameter is not used in ssh implementation
Raises:

FileNotFoundError – when mode is ‘r’ and file does not exist

class ssh_utilities.abstract.OsABC

Bases: abc.ABC, typing.Generic

os module drop-in replacement base.

chdir(path: _SPATH)

Changes working directory.

Parameters:path (_SPATH) – directory to change to

Warning

This is not guaranted to work on all servers. You should avoud this method or check if you are in the correct directory.

Raises:
  • FileNotFoundError – if directory does not exist
  • NotADirectoryError – if path is not a directory
chmod(path: _SPATH, mode: int, *, dir_fd: Optional[int] = None, follow_symlinks: bool = True)

Change the mode of path to the numeric mode.

Parameters:
  • path (ssh_utilities.typeshed._SPATH) – path pointing to the file/directory
  • mode (int) – desired mode to set, check python os documentation to see options
  • dir_fd (Optional[int], optional) – not used by ssh implementation, by default None
  • follow_symlinks (bool, optional) – whether to resolve symlinks on the way, by default True
Raises:

FileNotFoundError – if the path does not exist

lchmod(path: _SPATH, mode: int)

Change the mode of path to the numeric mode.

If path is a symlink, this affects the symlink rather than the target.

Parameters:
  • path (ssh_utilities.typeshed._SPATH) – path pointing to the file/directory
  • mode (int) – desired mode to set, check python os documentation to see options
Raises:

FileNotFoundError – if the path does not exist

listdir(path: _SPATH) → _Os2

Lists contents of specified directory.

Parameters:

path (ssh_utilities.typeshed._SPATH) – directory path

Returns:

list of files, dirs, symlinks …

Return type:

List[str]

Raises:
  • FileNotFoundError – if directory does not exist
  • NotADirectoryError – if path is not a directory
lstat(path: _SPATH, *, dir_fd=None) → _Os3

Similar to stat only this does not resolve symlinks.

Parameters:
Returns:

stat object similar to one returned by os.lstat

Return type:

SFTPAttributes

Warning

dir_fd parameter has no effect, it is present only so the signature is compatible with os.lstat

makedirs(path: _SPATH, mode: int = 511, exist_ok: bool = True, quiet: bool = True)

Recursively create directory.

If it already exists, show warning and return.

Parameters:
  • path (ssh_utilities.typeshed._SPATH) – path to directory which should be created
  • mode (int) – create directory with mode, default is 511
  • exist_ok (bool) – if true and directory exists, exception is silently passed when dir already exists
  • quiet (bool) – if True informative messages are suppresssed
Raises:
  • OSError – if directory could not be created
  • FileExistsError – when directory already exists and exist_ok=False
mkdir(path: _SPATH, mode: int = 511, quiet: bool = True)

Create single directory.

If it already exists, show warning and return.

Parameters:
  • path (ssh_utilities.typeshed._SPATH) – path to directory which should be created
  • mode (int) – create directory with mode, default is 511
  • quiet (bool) – if True informative messages are suppresssed
Raises:
  • OSError – if directory could not be created
  • FileNotFoundError – when parent directory is missing and parents=False
name

Try to get remote os name same as os.name function.

Warning

Due to the complexity of the check, this method only checks is remote server is windows by trying to run ver command. If that fails the remote is automatically assumed to be POSIX which should hold true in most cases. If absolute certianty is required you should do your own checks.

Note

This methods main purpose is to help choose the right flavour when instantiating ssh_utilities.path.SSHPath. For its use the provided accuracy should be sufficient.

Returns:remote server os name
Return type:Literal[“nt”, “posix”]
Raises:UnknownOsError – if remote server os name could not be determined
remove(path: _SPATH, *, dir_fd: Optional[int] = None)

Remove file.

Parameters:
  • path (ssh_utilities.typeshed._SPATH) – path to remove
  • dir_fd (Optional[int], optional) – file descriptor, not used in ssh implementation, by default None

Warning

dir_fd parameter is not implemented

Raises:
  • FileNotFoundError – if path does not point to a file
  • IsADirectoryError – if path points to a directory
  • IOError – if some other paramiko related error happens and file could not have been removed.
rename(src: _SPATH, dst: _SPATH, *, src_dir_fd: Optional[int] = None, dst_dir_fd: Optional[int] = None)

Rename the file or directory src to dst.

Parameters:
  • src (ssh_utilities.typeshed._SPATH) – source file or directory
  • dst (ssh_utilities.typeshed._SPATH) – destination file or directory
  • src_dir_fd (Optional[int], optional) – file descriptor, not used in ssh implementation, by default None
  • dst_dir_fd (Optional[int], optional) – file descriptor, not used in ssh implementation, by default None

Warning

src_dir_fd parameter is not implemented dst_dir_fd parameter is not implemented

Raises:
  • FileNotFoundError – raised on win if destination path exists
  • IsADirectoryError – raised on posix if src is file and dst is directory
  • NotADirectoryError – raised on posix in src is dir and dst is file
  • IOError – if some other paramiko related error happens and file could not have been removed.
replace(src: _SPATH, dst: _SPATH, *, src_dir_fd: Optional[int] = None, dst_dir_fd: Optional[int] = None)

Rename the file or directory src to dst.

Parameters:
  • src (ssh_utilities.typeshed._SPATH) – source file or directory
  • dst (ssh_utilities.typeshed._SPATH) – destination file or directory
  • src_dir_fd (Optional[int], optional) – file descriptor, not used in ssh implementation, by default None
  • dst_dir_fd (Optional[int], optional) – file descriptor, not used in ssh implementation, by default None

Warning

src_dir_fd parameter is not implemented dst_dir_fd parameter is not implemented If dst exists and is a file, it will be replaced silently if the user has permission.

Raises:
  • FileNotFoundError – raised on win if destination path exists
  • IsADirectoryError – raised on posix if src is file and dst is directory
  • NotADirectoryError – raised on posix in src is dir and dst is file
  • IOError – if some other paramiko related error happens and file could not have been removed.
rmdir(path: _SPATH, *, dir_fd: Optional[int] = None)

Remove directory.

Parameters:
  • path (ssh_utilities.typeshed._SPATH) – path to remove
  • dir_fd (Optional[int], optional) – file descriptor, not used in ssh implementation, by default None

Warning

dir_fd parameter is not implemented

Raises:
  • FileNotFoundError – if path does not point to a directory
  • OSError – if directory is not empty or some other ssh implementation related error occured
scandir(path: _SPATH) → _Os1

Return an iterator of os.DirEntry objects.

These correspond to the entries in the directory given by path.

Parameters:path (ssh_utilities.typeshed._SPATH) – root path directory to scan
Returns:scandir iterator.
Return type:ssh_utilities.abstract._SCANDIR
stat(path: _SPATH, *, dir_fd=None, follow_symlinks: bool = True) → _Os3

Replacement for os.stat function.

Parameters:
  • path (ssh_utilities.typeshed._SPATH) – path to file whose stats are desired
  • dir_fd (Any) – not implemented
  • follow_symlinks (bool) – whether to resolve symbolic links along the way
Returns:

stat object similar to one returned by os.stat

Return type:

SFTPAttributes

Warning

dir_fd parameter has no effect, it is present only so the signature is compatible with os.stat

static supports_dir_fd()

Check file descriptor support.

Raises:NotImplementedError – if passing file descriptor is unsupported
static supports_fd()

Check file descriptor support.

Raises:NotImplementedError – if passing file descriptor is unsupported

Make this path a symlink pointing to the given path.

Parameters:
  • src (ssh_utilities.typeshed._SPATH) – target path to which symlink will point
  • dst (ssh_utilities.typeshed._SPATH) – symlink path
  • target_is_directory (bool, optional) – this parameter is ignored in ssh implementation
  • dir_fd (Optional[int], optional) – this parameter is ignored in ssh implementation

Warning

target_is_directory parameter is ignored

Remove file.

Parameters:
  • path (ssh_utilities.typeshed._SPATH) – path to remove
  • dir_fd (Optional[int], optional) – file descriptor, not used in ssh implementation, by default None

Warning

dir_fd parameter is not implemented

Raises:
  • FileNotFoundError – if path does not point to a file
  • IsADirectoryError – if path points to a directory
  • IOError – if some other paramiko related error happens and file could not have been removed.
walk(top: _SPATH, topdown: bool = True, onerror: _ONERROR = None, followlinks: bool = False) → _Os6

Recursive directory listing.

Parameters:
  • top (ssh_utilities.typeshed._SPATH) – directory to start from
  • topdown (bool, optional) – if true or not specified, the triple for a directory is generated before the triples for any of its subdirectories (directories are generated top-down). This enables you to modify the subdirectories list in place befor iteration continues. If topdown is False, the triple for a directory is generated after the triples for all of its subdirectories, by default True
  • onerror (ssh_utilities.typeshed._ONERROR, optional) – Callable acception one argument of type exception which decides how to handle that exception, by default None
  • followlinks (bool, optional) – follow symbolic links if true, by default False
Returns:

iterator of 3 tuples containing current dir, subdirs and files

Return type:

ssh_utilities.typeshed._WALK

class ssh_utilities.abstract.ShutilABC

Bases: abc.ABC

shutil module drop-in replacement base.

copy(src: _SPATH, dst: _SPATH, *, direction: _DIRECTION, follow_symlinks: bool = True, callback: _CALLBACK = None, quiet: bool = True)

Send files in the chosen direction local <-> remote.

Parameters:

Warning

Unlike shutil this function cannot preserve file permissions (copy) or file metadata (copy2)

Raises:
  • FileNotFoundError – if src is not file
  • ValueError – if direction is not put or get
copyfile(src: _SPATH, dst: _SPATH, *, direction: _DIRECTION, follow_symlinks: bool = True, callback: _CALLBACK = None, quiet: bool = True)

Send files in the chosen direction local <-> remote.

Parameters:
Raises:
  • FileNotFoundError – if src is not file
  • IsADirectoryError – if dst is a targer directory not full path
  • ValueError – if direction is not put or get
copyfileobj(fsrc: Union[IO, SFTPFile], fdst: Union[IO, SFTPFile], *, direction: _DIRECTION, length: Optional[int] = None)

Copy the contents of one file-like object to another.

Parameters:
  • fsrc (Union[IO, SFTPFile]) – source file-like object must be local/remote based on direction parameter
  • fdst (Union[IO, SFTPFile]) – source file-like object must be local/remote based on direction parameter
  • direction (_DIRECTION) – either ‘put’ or ‘get’
  • length (int, optional) – [description], by default -1
download_tree(remote_path: _SPATH, local_path: _SPATH, include: _GLOBPAT = None, exclude: _GLOBPAT = None, remove_after: bool = True, quiet: bool = False)

Download directory tree from remote.

Remote directory must exist otherwise exception is raised.

Parameters:
  • remote_path (ssh_utilities.typeshed._SPATH) – path to directory which should be downloaded
  • local_path (ssh_utilities.typeshed._SPATH) – directory to copy to, must be full path!
  • remove_after (bool) – remove remote copy after directory is uploaded
  • include (ssh_utilities.typeshed._GLOBPAT) – glob pattern of files to include in copy, can be used simultaneously with exclude, default is None = no filtering
  • exclude (ssh_utilities.typeshed._GLOBPAT) – glob pattern of files to exclude in copy, can be used simultaneously with include, default is None = no filtering
  • quiet (Literal[True, False, "stats", "progress"]) – if True informative messages are suppresssed if False all is printed, if stats all statistics except progressbar are suppressed if progress only progressbar is suppressed

Warning

both paths must be full: <some_remote_path>/my_directory -> <some_local_path>/my_directory

Raises:FileNotFoundError – when remote directory does not exist
ignore_patterns(*paterns) → Callable[[Any, Sequence[str]], Set[str]]

Creates a callable for shutil.copytree function to ignore files.

Parameters:*patterns (Sequence[str]) – a list of glob patterns that will ne used to exclude files
Returns:Callable the filters files, when called with a list of strings returns a subset that matches one oth the exclude patterns
Return type:Callable[[Any, Sequence[str]], Set[str]]
rmtree(path: _SPATH, ignore_errors: bool = False, quiet: bool = True)

Recursively remove directory tree.

Parameters:
  • path (ssh_utilities.typeshed._SPATH) – directory to be recursively removed
  • ignore_errors (bool) – if True only log warnings do not raise exception
  • quiet (bool) – if True informative messages are suppresssed
Raises:

FileNotFoundError – if some part of deleting filed

upload_tree(local_path: _SPATH, remote_path: _SPATH, include: _GLOBPAT = None, exclude: _GLOBPAT = None, remove_after: bool = True, quiet: bool = False)

Upload directory tree to remote.

Local path must exist otherwise, exception is raised.

Parameters:
  • local_path (ssh_utilities.typeshed._SPATH) – path to directory which should be uploaded
  • remote_path (ssh_utilities.typeshed._SPATH) – directory to copy to, must be full path!
  • remove_after (bool) – remove local copy after directory is uploaded
  • include (ssh_utilities.typeshed._GLOBPAT) – glob pattern of files to include in copy, can be used simultaneously with exclude, default is None = no filtering
  • exclude (ssh_utilities.typeshed._GLOBPAT) – glob pattern of files to exclude in copy, can be used simultaneously with include, default is None = no filtering
  • quiet (Literal[True, False, "stats", "progress"]) – if True informative messages are suppresssed if False all is printed, if stats all statistics except progressbar are suppressed if progress only progressbar is suppressed

Warning

both paths must be full: <some_local_path>/my_directory -> <some_remote_path>/my_directory

Raises:FileNotFoundError – when local directory does not exist
class ssh_utilities.abstract.SubprocessABC

Bases: abc.ABC, typing.Generic

subprocess module drop-in replacement base.

run(args: _CMD, *, suppress_out: bool, quiet: bool = True, bufsize: int = -1, executable: _SPATH = None, input: Optional[str] = None, stdin: _FILE = None, stdout: _FILE = None, stderr: _FILE = None, capture_output: bool = False, shell: bool = False, cwd: _SPATH = None, timeout: Optional[float] = None, check: bool = False, encoding: Optional[str] = None, errors: Optional[str] = None, text: Optional[bool] = None, env: _ENV = None, universal_newlines: bool = False) → _Subprocess1

Excecute command on remote, has simillar API to subprocess run.

Parameters:
  • args (ssh_utilities.typeshed._CMD) – string, Path-like object or a list of strings. If it is a list it will be joined to string with whitespace delimiter.
  • suppress_out (bool) – whether to print command output to console, this is required keyword argument
  • quiet (bool, optional) – whether to print other function messages, by default True
  • bufsize (int, optional) – buffer size, 0 turns off buffering, 1 uses line buffering, and any number greater than 1 (>1) uses that specific buffer size. This applies ti underlying paramiko client as well as stdin, stdout and stderr PIPES, by default -1
  • executable (ssh_utilities.typeshed._SPATH, optional) – [description], by default None
  • input (Optional[str], optional) – [description], by default None
  • stdin (_FILE, optional) – [description], by default None
  • stdout (_FILE, optional) – [description], by default None
  • stderr (_FILE, optional) – [description], by default None
  • capture_output (bool, optional) – if true then lightweight result object with same API as subprocess.CompletedProcess is returned. Same as passing PIPE to stdout and stderr. Both options cannot be used at the same time, by default False
  • shell (bool, optional) – requests a pseudo terminal from server, by default False
  • cwd (_SPATH, optional) – execute command in this directory, by default None
  • timeout (Optional[float], optional) – set, by default None
  • check (bool, optional) – checks for command return code if other than 0 raises CalledProcessError, by default False
  • encoding (Optional[str], optional) – encoding to use when decoding remote output, default is utf-8, by default None
  • errors (Optional[str], optional) –

    string that specifies how encoding and decoding errors are to be handled, see builtin function open documentation for more details, by default None

  • text (Optional[bool], optional) – will select default encoding and open stdin, stdout and stderr streams in text mode. The default encoding, contrary to behaviour of subprocess module is not selected by locale.getpreferredencoding(False) but is always set to utf-8. By default None
  • env (ssh_utilities.typeshed._ENV, optional) – optinal environment variables that will be merged into the existing environment. This is different to subprocess behaviour which creates new environment with only specified variables, by default None
  • universal_newlines (bool, optional) – an alias for text keyword argument, by default None

Warning

New environment variables defined by env might get silently rejected by the server.

Currentlly it is only possible to use input agrgument, not stdin and send data to process only once at the begining. It is still under developement

Returns:

if capture_output is true, returns lightweight result object with same API as subprocess.CompletedProcess

Return type:

CompletedProcess

Raises:
  • ValueError – if stdin and input are specified at the same time
  • ValueError – if capture_output and stdout and/or stderr are specified at the same time
  • ValueError – if text or universal_newlines is used simultaneously with” encoding and/or errors arguments
  • NotImplementedError – if stdin or executable is used - work in progress
  • TypeError – if stdin, stdout or stderr arguments are of wrong type
  • TypeError – if args argument is of wrong type
  • CalledProcessError – if check is true and command exited with non-zero status
  • TimeoutExpired – if the command exceeded allowed run time
class ssh_utilities.abstract.PathlibABC

Bases: abc.ABC, typing.Generic

pathlib module drop-in replacement base.

Path(path: _SPATH) → _Pathlib1

Provides API similar to pathlib.Path only for remote host.

Only for Unix to Unix connections

Parameters:path (ssh_utilities.typeshed._SPATH) – provide initial path
Returns:object representing remote path
Return type:SSHPath
class ssh_utilities.abstract.DirEntryABC

Bases: abc.ABC

Object representation of directory or a file yielded by scandir().

Has subset of Path object methods.

inode() → int

Return the inode number of the entry.

Returns:inode number
Return type:int
is_dir(*, follow_symlinks: bool = True) → bool

Return True if this entry is a directory.

Parameters:follow_symlinks (bool, optional) – if we method should follow and resolve symlinks, by default False
Returns:True if path points to a directory.
Return type:bool

Warning

follow_symlinks is False by default in the remote implementation, contrary to the implementation in python os library!

is_file(*, follow_symlinks: bool = True) → bool

Return True if this entry is a file.

Parameters:follow_symlinks (bool, optional) – if we method should follow and resolve symlinks, by default False
Returns:True if path points to a file.
Return type:bool

Warning

follow_symlinks is False by default in the remote implementation, contrary to the implementation in python os library!

Return True if this entry is a symlink.

Returns:true if targer is symlink
Return type:bool
stat(*, follow_symlinks: bool = True) → _ATTRIBUTES

Return SFTPAttributes object similar to os.stat.

Parameters:follow_symlinks (bool, optional) – if we method should follow and resolve symlinks, by default False
Returns:attributes object for the entry.
Return type:SFTPAttributes

Warning

follow_symlinks is False by default in the remote implementation, contrary to the implementation in python os library!

ssh_utilities.abstract._connection

Template module for all connections classes.

class ssh_utilities.abstract._connection.ConnectionABC

Bases: abc.ABC

Class defining API for connection classes.

static _path2str(path: Optional[_SPATH]) → str

Converts pathlib.Path, SSHPath or plain str to string.

Also remove any rtailing backslashes.

Parameters:path (ssh_utilities.typeshed._SPATH) – path to convert to string, if string is passed, then just returns it
Raises:ValueError – if path is not instance of str, Path or SSHPath
_to_str(connection_name: str, host_name: str, address: Optional[str], user_name: str, ssh_key: Union[pathlib.Path, str, None], thread_safe: bool, allow_agent: bool) → str

Aims to ease persistance, returns string representation of instance.

With this method all data needed to initialize class are saved to sting and connection can be reinitialized with from_str method of conection.Connection class.

Parameters:
  • connection_name (str) – SSHConnection or LocalConnection
  • host_name (str) – name of remote server
  • address (str) – server address in case of remote connection
  • user_name (str) – server login name
  • ssh_key (Optional[Union[Path, str]]) – file with public key, pass none for LocalConnection
  • thread_safe (bool) – make connection object thread safe so it can be safely accessed from any number of threads, it is disabled by default to avoid performance penalty of threading locks
  • allow_agent (bool) – allows use of ssh agent for connection authentication, when this is True key for the host does not have to be available.
Returns:

string representation of the class

Return type:

str

See also

ssh_utilities.conncection.Connection

ssh_utilities.abstract._builtins

Template module for all builtins classes.

class ssh_utilities.abstract._builtins.BuiltinsABC

Bases: abc.ABC, typing.Generic

Python builtins drop-in replacement base.

open(filename: _SPATH, mode: str = 'r', buffering: int = -1, encoding: Optional[str] = None, errors: Optional[str] = None, newline: Optional[str] = None) → _Builtins1

Opens remote file, works as python open function.

Can be used both as a function or a decorator.

Parameters:
  • filename (ssh_utilities.typeshed._SPATH) – path to file to be opened
  • mode (str) – select mode to open file. Same as python open modes
  • encoding (Optional[str]) – encoding type to decode file bytes stream
  • buffering (int) – buffer size, 0 turns off buffering, 1 uses line buffering, and any number greater than 1 (>1) uses that specific buffer size
  • errors (Optional[str]) –

    string that specifies how encoding and decoding errors are to be handled, see builtin function open documentation for more details

  • newline (Optional[str]) – this parameter is not used in ssh implementation
Raises:

FileNotFoundError – when mode is ‘r’ and file does not exist

ssh_utilities.abstract._os

Template module for all os classes and methods.

class ssh_utilities.abstract._os.OsABC

Bases: abc.ABC, typing.Generic

os module drop-in replacement base.

chdir(path: _SPATH)

Changes working directory.

Parameters:path (_SPATH) – directory to change to

Warning

This is not guaranted to work on all servers. You should avoud this method or check if you are in the correct directory.

Raises:
  • FileNotFoundError – if directory does not exist
  • NotADirectoryError – if path is not a directory
chmod(path: _SPATH, mode: int, *, dir_fd: Optional[int] = None, follow_symlinks: bool = True)

Change the mode of path to the numeric mode.

Parameters:
  • path (ssh_utilities.typeshed._SPATH) – path pointing to the file/directory
  • mode (int) – desired mode to set, check python os documentation to see options
  • dir_fd (Optional[int], optional) – not used by ssh implementation, by default None
  • follow_symlinks (bool, optional) – whether to resolve symlinks on the way, by default True
Raises:

FileNotFoundError – if the path does not exist

lchmod(path: _SPATH, mode: int)

Change the mode of path to the numeric mode.

If path is a symlink, this affects the symlink rather than the target.

Parameters:
  • path (ssh_utilities.typeshed._SPATH) – path pointing to the file/directory
  • mode (int) – desired mode to set, check python os documentation to see options
Raises:

FileNotFoundError – if the path does not exist

listdir(path: _SPATH) → _Os2

Lists contents of specified directory.

Parameters:

path (ssh_utilities.typeshed._SPATH) – directory path

Returns:

list of files, dirs, symlinks …

Return type:

List[str]

Raises:
  • FileNotFoundError – if directory does not exist
  • NotADirectoryError – if path is not a directory
lstat(path: _SPATH, *, dir_fd=None) → _Os3

Similar to stat only this does not resolve symlinks.

Parameters:
Returns:

stat object similar to one returned by os.lstat

Return type:

SFTPAttributes

Warning

dir_fd parameter has no effect, it is present only so the signature is compatible with os.lstat

makedirs(path: _SPATH, mode: int = 511, exist_ok: bool = True, quiet: bool = True)

Recursively create directory.

If it already exists, show warning and return.

Parameters:
  • path (ssh_utilities.typeshed._SPATH) – path to directory which should be created
  • mode (int) – create directory with mode, default is 511
  • exist_ok (bool) – if true and directory exists, exception is silently passed when dir already exists
  • quiet (bool) – if True informative messages are suppresssed
Raises:
  • OSError – if directory could not be created
  • FileExistsError – when directory already exists and exist_ok=False
mkdir(path: _SPATH, mode: int = 511, quiet: bool = True)

Create single directory.

If it already exists, show warning and return.

Parameters:
  • path (ssh_utilities.typeshed._SPATH) – path to directory which should be created
  • mode (int) – create directory with mode, default is 511
  • quiet (bool) – if True informative messages are suppresssed
Raises:
  • OSError – if directory could not be created
  • FileNotFoundError – when parent directory is missing and parents=False
name

Try to get remote os name same as os.name function.

Warning

Due to the complexity of the check, this method only checks is remote server is windows by trying to run ver command. If that fails the remote is automatically assumed to be POSIX which should hold true in most cases. If absolute certianty is required you should do your own checks.

Note

This methods main purpose is to help choose the right flavour when instantiating ssh_utilities.path.SSHPath. For its use the provided accuracy should be sufficient.

Returns:remote server os name
Return type:Literal[“nt”, “posix”]
Raises:UnknownOsError – if remote server os name could not be determined
remove(path: _SPATH, *, dir_fd: Optional[int] = None)

Remove file.

Parameters:
  • path (ssh_utilities.typeshed._SPATH) – path to remove
  • dir_fd (Optional[int], optional) – file descriptor, not used in ssh implementation, by default None

Warning

dir_fd parameter is not implemented

Raises:
  • FileNotFoundError – if path does not point to a file
  • IsADirectoryError – if path points to a directory
  • IOError – if some other paramiko related error happens and file could not have been removed.
rename(src: _SPATH, dst: _SPATH, *, src_dir_fd: Optional[int] = None, dst_dir_fd: Optional[int] = None)

Rename the file or directory src to dst.

Parameters:
  • src (ssh_utilities.typeshed._SPATH) – source file or directory
  • dst (ssh_utilities.typeshed._SPATH) – destination file or directory
  • src_dir_fd (Optional[int], optional) – file descriptor, not used in ssh implementation, by default None
  • dst_dir_fd (Optional[int], optional) – file descriptor, not used in ssh implementation, by default None

Warning

src_dir_fd parameter is not implemented dst_dir_fd parameter is not implemented

Raises:
  • FileNotFoundError – raised on win if destination path exists
  • IsADirectoryError – raised on posix if src is file and dst is directory
  • NotADirectoryError – raised on posix in src is dir and dst is file
  • IOError – if some other paramiko related error happens and file could not have been removed.
replace(src: _SPATH, dst: _SPATH, *, src_dir_fd: Optional[int] = None, dst_dir_fd: Optional[int] = None)

Rename the file or directory src to dst.

Parameters:
  • src (ssh_utilities.typeshed._SPATH) – source file or directory
  • dst (ssh_utilities.typeshed._SPATH) – destination file or directory
  • src_dir_fd (Optional[int], optional) – file descriptor, not used in ssh implementation, by default None
  • dst_dir_fd (Optional[int], optional) – file descriptor, not used in ssh implementation, by default None

Warning

src_dir_fd parameter is not implemented dst_dir_fd parameter is not implemented If dst exists and is a file, it will be replaced silently if the user has permission.

Raises:
  • FileNotFoundError – raised on win if destination path exists
  • IsADirectoryError – raised on posix if src is file and dst is directory
  • NotADirectoryError – raised on posix in src is dir and dst is file
  • IOError – if some other paramiko related error happens and file could not have been removed.
rmdir(path: _SPATH, *, dir_fd: Optional[int] = None)

Remove directory.

Parameters:
  • path (ssh_utilities.typeshed._SPATH) – path to remove
  • dir_fd (Optional[int], optional) – file descriptor, not used in ssh implementation, by default None

Warning

dir_fd parameter is not implemented

Raises:
  • FileNotFoundError – if path does not point to a directory
  • OSError – if directory is not empty or some other ssh implementation related error occured
scandir(path: _SPATH) → _Os1

Return an iterator of os.DirEntry objects.

These correspond to the entries in the directory given by path.

Parameters:path (ssh_utilities.typeshed._SPATH) – root path directory to scan
Returns:scandir iterator.
Return type:ssh_utilities.abstract._SCANDIR
stat(path: _SPATH, *, dir_fd=None, follow_symlinks: bool = True) → _Os3

Replacement for os.stat function.

Parameters:
  • path (ssh_utilities.typeshed._SPATH) – path to file whose stats are desired
  • dir_fd (Any) – not implemented
  • follow_symlinks (bool) – whether to resolve symbolic links along the way
Returns:

stat object similar to one returned by os.stat

Return type:

SFTPAttributes

Warning

dir_fd parameter has no effect, it is present only so the signature is compatible with os.stat

static supports_dir_fd()

Check file descriptor support.

Raises:NotImplementedError – if passing file descriptor is unsupported
static supports_fd()

Check file descriptor support.

Raises:NotImplementedError – if passing file descriptor is unsupported

Make this path a symlink pointing to the given path.

Parameters:
  • src (ssh_utilities.typeshed._SPATH) – target path to which symlink will point
  • dst (ssh_utilities.typeshed._SPATH) – symlink path
  • target_is_directory (bool, optional) – this parameter is ignored in ssh implementation
  • dir_fd (Optional[int], optional) – this parameter is ignored in ssh implementation

Warning

target_is_directory parameter is ignored

Remove file.

Parameters:
  • path (ssh_utilities.typeshed._SPATH) – path to remove
  • dir_fd (Optional[int], optional) – file descriptor, not used in ssh implementation, by default None

Warning

dir_fd parameter is not implemented

Raises:
  • FileNotFoundError – if path does not point to a file
  • IsADirectoryError – if path points to a directory
  • IOError – if some other paramiko related error happens and file could not have been removed.
walk(top: _SPATH, topdown: bool = True, onerror: _ONERROR = None, followlinks: bool = False) → _Os6

Recursive directory listing.

Parameters:
  • top (ssh_utilities.typeshed._SPATH) – directory to start from
  • topdown (bool, optional) – if true or not specified, the triple for a directory is generated before the triples for any of its subdirectories (directories are generated top-down). This enables you to modify the subdirectories list in place befor iteration continues. If topdown is False, the triple for a directory is generated after the triples for all of its subdirectories, by default True
  • onerror (ssh_utilities.typeshed._ONERROR, optional) – Callable acception one argument of type exception which decides how to handle that exception, by default None
  • followlinks (bool, optional) – follow symbolic links if true, by default False
Returns:

iterator of 3 tuples containing current dir, subdirs and files

Return type:

ssh_utilities.typeshed._WALK

class ssh_utilities.abstract._os.DirEntryABC

Bases: abc.ABC

Object representation of directory or a file yielded by scandir().

Has subset of Path object methods.

inode() → int

Return the inode number of the entry.

Returns:inode number
Return type:int
is_dir(*, follow_symlinks: bool = True) → bool

Return True if this entry is a directory.

Parameters:follow_symlinks (bool, optional) – if we method should follow and resolve symlinks, by default False
Returns:True if path points to a directory.
Return type:bool

Warning

follow_symlinks is False by default in the remote implementation, contrary to the implementation in python os library!

is_file(*, follow_symlinks: bool = True) → bool

Return True if this entry is a file.

Parameters:follow_symlinks (bool, optional) – if we method should follow and resolve symlinks, by default False
Returns:True if path points to a file.
Return type:bool

Warning

follow_symlinks is False by default in the remote implementation, contrary to the implementation in python os library!

Return True if this entry is a symlink.

Returns:true if targer is symlink
Return type:bool
stat(*, follow_symlinks: bool = True) → _ATTRIBUTES

Return SFTPAttributes object similar to os.stat.

Parameters:follow_symlinks (bool, optional) – if we method should follow and resolve symlinks, by default False
Returns:attributes object for the entry.
Return type:SFTPAttributes

Warning

follow_symlinks is False by default in the remote implementation, contrary to the implementation in python os library!

ssh_utilities.abstract._pathlib

Template module for all pathlib classes.

class ssh_utilities.abstract._pathlib.PathlibABC

Bases: abc.ABC, typing.Generic

pathlib module drop-in replacement base.

Path(path: _SPATH) → _Pathlib1

Provides API similar to pathlib.Path only for remote host.

Only for Unix to Unix connections

Parameters:path (ssh_utilities.typeshed._SPATH) – provide initial path
Returns:object representing remote path
Return type:SSHPath

ssh_utilities.abstract._shutil

Template module for all shutil classes.

class ssh_utilities.abstract._shutil.ShutilABC

Bases: abc.ABC

shutil module drop-in replacement base.

copy(src: _SPATH, dst: _SPATH, *, direction: _DIRECTION, follow_symlinks: bool = True, callback: _CALLBACK = None, quiet: bool = True)

Send files in the chosen direction local <-> remote.

Parameters:

Warning

Unlike shutil this function cannot preserve file permissions (copy) or file metadata (copy2)

Raises:
  • FileNotFoundError – if src is not file
  • ValueError – if direction is not put or get
copyfile(src: _SPATH, dst: _SPATH, *, direction: _DIRECTION, follow_symlinks: bool = True, callback: _CALLBACK = None, quiet: bool = True)

Send files in the chosen direction local <-> remote.

Parameters:
Raises:
  • FileNotFoundError – if src is not file
  • IsADirectoryError – if dst is a targer directory not full path
  • ValueError – if direction is not put or get
copyfileobj(fsrc: Union[IO, SFTPFile], fdst: Union[IO, SFTPFile], *, direction: _DIRECTION, length: Optional[int] = None)

Copy the contents of one file-like object to another.

Parameters:
  • fsrc (Union[IO, SFTPFile]) – source file-like object must be local/remote based on direction parameter
  • fdst (Union[IO, SFTPFile]) – source file-like object must be local/remote based on direction parameter
  • direction (_DIRECTION) – either ‘put’ or ‘get’
  • length (int, optional) – [description], by default -1
download_tree(remote_path: _SPATH, local_path: _SPATH, include: _GLOBPAT = None, exclude: _GLOBPAT = None, remove_after: bool = True, quiet: bool = False)

Download directory tree from remote.

Remote directory must exist otherwise exception is raised.

Parameters:
  • remote_path (ssh_utilities.typeshed._SPATH) – path to directory which should be downloaded
  • local_path (ssh_utilities.typeshed._SPATH) – directory to copy to, must be full path!
  • remove_after (bool) – remove remote copy after directory is uploaded
  • include (ssh_utilities.typeshed._GLOBPAT) – glob pattern of files to include in copy, can be used simultaneously with exclude, default is None = no filtering
  • exclude (ssh_utilities.typeshed._GLOBPAT) – glob pattern of files to exclude in copy, can be used simultaneously with include, default is None = no filtering
  • quiet (Literal[True, False, "stats", "progress"]) – if True informative messages are suppresssed if False all is printed, if stats all statistics except progressbar are suppressed if progress only progressbar is suppressed

Warning

both paths must be full: <some_remote_path>/my_directory -> <some_local_path>/my_directory

Raises:FileNotFoundError – when remote directory does not exist
ignore_patterns(*paterns) → Callable[[Any, Sequence[str]], Set[str]]

Creates a callable for shutil.copytree function to ignore files.

Parameters:*patterns (Sequence[str]) – a list of glob patterns that will ne used to exclude files
Returns:Callable the filters files, when called with a list of strings returns a subset that matches one oth the exclude patterns
Return type:Callable[[Any, Sequence[str]], Set[str]]
rmtree(path: _SPATH, ignore_errors: bool = False, quiet: bool = True)

Recursively remove directory tree.

Parameters:
  • path (ssh_utilities.typeshed._SPATH) – directory to be recursively removed
  • ignore_errors (bool) – if True only log warnings do not raise exception
  • quiet (bool) – if True informative messages are suppresssed
Raises:

FileNotFoundError – if some part of deleting filed

upload_tree(local_path: _SPATH, remote_path: _SPATH, include: _GLOBPAT = None, exclude: _GLOBPAT = None, remove_after: bool = True, quiet: bool = False)

Upload directory tree to remote.

Local path must exist otherwise, exception is raised.

Parameters:
  • local_path (ssh_utilities.typeshed._SPATH) – path to directory which should be uploaded
  • remote_path (ssh_utilities.typeshed._SPATH) – directory to copy to, must be full path!
  • remove_after (bool) – remove local copy after directory is uploaded
  • include (ssh_utilities.typeshed._GLOBPAT) – glob pattern of files to include in copy, can be used simultaneously with exclude, default is None = no filtering
  • exclude (ssh_utilities.typeshed._GLOBPAT) – glob pattern of files to exclude in copy, can be used simultaneously with include, default is None = no filtering
  • quiet (Literal[True, False, "stats", "progress"]) – if True informative messages are suppresssed if False all is printed, if stats all statistics except progressbar are suppressed if progress only progressbar is suppressed

Warning

both paths must be full: <some_local_path>/my_directory -> <some_remote_path>/my_directory

Raises:FileNotFoundError – when local directory does not exist

ssh_utilities.abstract._subprocess

Template module for all subprocess classes.

class ssh_utilities.abstract._subprocess.SubprocessABC

Bases: abc.ABC, typing.Generic

subprocess module drop-in replacement base.

run(args: _CMD, *, suppress_out: bool, quiet: bool = True, bufsize: int = -1, executable: _SPATH = None, input: Optional[str] = None, stdin: _FILE = None, stdout: _FILE = None, stderr: _FILE = None, capture_output: bool = False, shell: bool = False, cwd: _SPATH = None, timeout: Optional[float] = None, check: bool = False, encoding: Optional[str] = None, errors: Optional[str] = None, text: Optional[bool] = None, env: _ENV = None, universal_newlines: bool = False) → _Subprocess1

Excecute command on remote, has simillar API to subprocess run.

Parameters:
  • args (ssh_utilities.typeshed._CMD) – string, Path-like object or a list of strings. If it is a list it will be joined to string with whitespace delimiter.
  • suppress_out (bool) – whether to print command output to console, this is required keyword argument
  • quiet (bool, optional) – whether to print other function messages, by default True
  • bufsize (int, optional) – buffer size, 0 turns off buffering, 1 uses line buffering, and any number greater than 1 (>1) uses that specific buffer size. This applies ti underlying paramiko client as well as stdin, stdout and stderr PIPES, by default -1
  • executable (ssh_utilities.typeshed._SPATH, optional) – [description], by default None
  • input (Optional[str], optional) – [description], by default None
  • stdin (_FILE, optional) – [description], by default None
  • stdout (_FILE, optional) – [description], by default None
  • stderr (_FILE, optional) – [description], by default None
  • capture_output (bool, optional) – if true then lightweight result object with same API as subprocess.CompletedProcess is returned. Same as passing PIPE to stdout and stderr. Both options cannot be used at the same time, by default False
  • shell (bool, optional) – requests a pseudo terminal from server, by default False
  • cwd (_SPATH, optional) – execute command in this directory, by default None
  • timeout (Optional[float], optional) – set, by default None
  • check (bool, optional) – checks for command return code if other than 0 raises CalledProcessError, by default False
  • encoding (Optional[str], optional) – encoding to use when decoding remote output, default is utf-8, by default None
  • errors (Optional[str], optional) –

    string that specifies how encoding and decoding errors are to be handled, see builtin function open documentation for more details, by default None

  • text (Optional[bool], optional) – will select default encoding and open stdin, stdout and stderr streams in text mode. The default encoding, contrary to behaviour of subprocess module is not selected by locale.getpreferredencoding(False) but is always set to utf-8. By default None
  • env (ssh_utilities.typeshed._ENV, optional) – optinal environment variables that will be merged into the existing environment. This is different to subprocess behaviour which creates new environment with only specified variables, by default None
  • universal_newlines (bool, optional) – an alias for text keyword argument, by default None

Warning

New environment variables defined by env might get silently rejected by the server.

Currentlly it is only possible to use input agrgument, not stdin and send data to process only once at the begining. It is still under developement

Returns:

if capture_output is true, returns lightweight result object with same API as subprocess.CompletedProcess

Return type:

CompletedProcess

Raises:
  • ValueError – if stdin and input are specified at the same time
  • ValueError – if capture_output and stdout and/or stderr are specified at the same time
  • ValueError – if text or universal_newlines is used simultaneously with” encoding and/or errors arguments
  • NotImplementedError – if stdin or executable is used - work in progress
  • TypeError – if stdin, stdout or stderr arguments are of wrong type
  • TypeError – if args argument is of wrong type
  • CalledProcessError – if check is true and command exited with non-zero status
  • TimeoutExpired – if the command exceeded allowed run time