FTPS connection¶

`FTPS` ¶

Bases: FTP

FTPS file connection.

Warning

Since onETL v0.7.0 to use FTPS connector you should install package as follows:

pip install "onetl[ftp]"

# or
pip install "onetl[files]"

See File connections install installation instruction for more details.

Added in 0.1.0

Parameters:

host (str) –

Host of FTPS source. For example: ftp.domain.com
port (int, default: 21 ) –

Port of FTPS source
user (str, default: None ) –

User, which have access to the file source. For example: someuser.

None means that the user is anonymous.
password (str, default: None ) –

Password for file source connection.

None means that the user is anonymous.
extra (FTPSExtra, default: FTPSExtra() ) –

Extra options

Examples:

Create and check FTPS connectionCreate and check FTPS connection with extra options

from onetl.connection import FTPS

ftp = FTPS(
    host="ftp.domain.com",
    user="someuser",
    password="*****",
).check()

from onetl.connection import FTPS

ftp = FTPS(
    host="ftp.domain.com",
    user="someuser",
    password="*****",
    extra=FTPS.Extra(use_passive_mode=True),
).check()

`check()` ¶

Check source availability.

If not, an exception will be raised.

Returns:

Self –

Connection itself

Raises:

RuntimeError –

If the connection is not available

Examples:

connection.check()

`path_exists(path)` ¶

Check if specified path exists on remote filesystem. .

Added in 0.8.0

Parameters:

path (str | PathLike) –

Path to check

Returns:

bool –

True if path exists, False otherwise

Examples:

>>> connection.path_exists("/path/to/file.csv")
True
>>> connection.path_exists("/path/to/dir")
True
>>> connection.path_exists("/path/to/missing")
False

`is_file(path)` ¶

Check if specified path is a file.

Added in 0.8.0

Parameters:

path (str | PathLike) –

Path to check

Returns:

bool –

True if path is a file, False otherwise.

Raises:

FileNotFoundError –

Path does not exist

Examples:

>>> connection.is_file("/path/to/dir/file.csv")
True
>>> connection.is_file("/path/to/dir")
False

`is_dir(path)` ¶

Check if specified path is a directory.

Added in 0.8.0

Parameters:

path (str | PathLike) –

Path to check

Returns:

bool –

True if path is a directory, False otherwise.

Raises:

DirectoryNotFoundError –

Path does not exist

Examples:

>>> connection.is_dir("/path/to/dir")
True
>>> connection.is_dir("/path/to/dir/file.csv")
False

`get_stat(path)` ¶

Returns stats for a specific path.

Added in 0.8.0

Parameters:

path (str | PathLike) –

Path to get stats for

Returns:

PathStatProtocol –

Stats object

Raises:

Any underlying client exception –

Examples:

>>> stat = connection.get_stat("/path/to/file.csv")
>>> stat.st_size  # in bytes
1024
>>> stat.st_uid  # owner id or name
12345

`resolve_dir(path)` ¶

Returns directory at specific path, with stats.

Added in 0.8.0

Parameters:

path (str | PathLike) –

Path to resolve

Returns:

PathWithStatsProtocol –

Directory path with stats

Raises:

DirectoryNotFoundError –

Path does not exist
NotADirectoryError –

Path is not a directory

Examples:

>>> dir_path = connection.resolve_dir("/path/to/dir")
>>> os.fspath(dir_path)
'/path/to/dir'
>>> dir_path.stat().st_uid  # owner id
12345

`resolve_file(path)` ¶

Returns file at specific path, with stats.

Added in 0.8.0

Parameters:

path (str | PathLike) –

Path to resolve

Returns:

PathWithStatsProtocol –

File path with stats

Raises:

FileNotFoundError –

Path does not exist
NotAFileError –

Path is not a file

Examples:

>>> file_path = connection.resolve_file("/path/to/dir/file.csv")
>>> os.fspath(file_path)
'/path/to/dir/file.csv'
>>> file_path.stat().st_uid  # owner id
12345

`create_dir(path)` ¶

Creates directory tree on remote filesystem.

Added in 0.8.0

Parameters:

path (str | PathLike) –

Directory path

Returns:

PathWithStatsProtocol –

Created directory with stats

Raises:

NotAFileError –

Path is not a file

Examples:

>>> dir_path = connection.create_dir("/path/to/dir")
>>> os.fspath(dir_path)
'/path/to/dir'

`remove_file(path)` ¶

Removes file on remote filesystem.

If file does not exist, no exception is raised.

Warning

Supports only one file removal per call. Directory removal is NOT supported, use remove_dir instead.

Added in 0.8.0

Parameters:

path (str | PathLike) –

File path

Returns:

bool –

True if file was removed, False if file does not exist in the first place.

Raises:

NotAFileError –

Path is not a file

Examples:

>>> connection.remove_file("/path/to/file.csv")
True
>>> connection.path_exists("/path/to/dir/file.csv")
False
>>> connection.remove_file("/path/to/file.csv")  # already deleted, no error
False

`remove_dir(path, *, recursive=False)` ¶

Remove directory or directory tree.

If directory does not exist, no exception is raised.

Added in 0.8.0

Parameters:

path (str | PathLike) –

Directory path to remove
recursive (bool, default: False ) –

If True, remove directory tree recursively (including files and subdirectories).

If False, remove only directory itself. Directory should be empty.

Returns:

bool –

True if directory was removed, False if directory does not exist in the first place.

Raises:

NotADirectoryError –

Path is not a directory
DirectoryNotEmptyError –

Directory is not empty, and recursive is False

Examples:

>>> connection.remove_dir("/path/to/dir")
Traceback (most recent call last):
    ...
onetl.exception.DirectoryNotEmptyError: Cannot delete non-empty directory '/path/to/dir'
>>> connection.remove_dir("/path/to/dir", recirsive=True)
True
>>> connection.path_exists("/path/to/dir")
False
>>> connection.path_exists("/path/to/dir/file.csv")
False
>>> connection.remove_dir("/path/to/dir")  # already deleted, no error
False

`rename_dir(source_dir_path, target_dir_path, *, replace=False)` ¶

Rename or move dir on remote filesystem.

Added in 0.8.0

Parameters:

source_dir_path (str | PathLike) –

Old directory path
target_dir_path (str | PathLike) –

New directory path
replace (bool, default: False ) –

If True, existing directory will be replaced.

Returns:

PathWithStatsProtocol –

New directory path with stats.

Raises:

NotADirectoryError –

Path is not a directory
DirectoryNotFoundError –

Path does not exist
DirectoryExistsError –

Directory already exists, and replace=False

Examples:

>>> new_dir = connection.rename_dir("/path/to/dir1", "/path/to/dir2")
>>> os.fspath(new_dir)
'/path/to/dir2'
>>> connection.path_exists("/path/to/dir1")
False
>>> connection.path_exists("/path/to/dir2")
True

`rename_file(source_file_path, target_file_path, *, replace=False)` ¶

Rename or move file on remote filesystem.

Warning

Supports only one file move per call. Directory move/rename is NOT supported.

Added in 0.8.0

Parameters:

source_file_path (str | PathLike) –

Old file path
target_file_path (str | PathLike) –

New file path
replace (bool, default: False ) –

If True, existing file will be replaced.

Returns:

PathWithStatsProtocol –

New file path with stats.

Raises:

NotAFileError –

Source or target path is not a file
FileNotFoundError –

File does not exist
FileExistsError –

File already exists, and replace=False

Examples:

>>> new_file = connection.rename_file("/path/to/file1.csv", "/path/to/file2.csv")
>>> os.fspath(new_file)
'/path/to/file2.csv'
>>> connection.path_exists("/path/to/file2.csv")
True
>>> connection.path_exists("/path/to/file1.csv")
False

`list_dir(path, filters=None, limits=None)` ¶

Return list of child files/directories in a specific directory.

Added in 0.8.0

Changed in 0.14.0

Method returns full file/directory path instead of just name.

Parameters:

path (str | PathLike) –

Directory path to list contents.
filters (list[BaseFileFilter], default: None ) –

Return only files/directories matching these filters. See File Filters
limits (list[BaseFileLimit], default: None ) –

Apply limits to the list of files/directories, and stop if one of the limits is reached. See File Limits

Returns:

list[PathWithStatsProtocol] –

Directory contents.

Raises:

NotADirectoryError –

Path is not a directory
DirectoryNotFoundError –

Path does not exist

Examples:

>>> dir_content = connection.list_dir("/path/to/dir")
>>> os.fspath(dir_content[0])
'/path/to/dir/file.csv'
>>> connection.path_exists("/path/to/dir/file.csv")
True

`walk(root, *, topdown=True, filters=None, limits=None)` ¶

Walk into directory tree, and iterate over its content in all nesting levels.

Just like os.walk, but with additional filter/limit logic.

Added in 0.8.0

Changed in 0.14.0

Method returns full file/directory path instead of just name.

Parameters:

root (str | PathLike) –

Directory path to walk into.
topdown (bool, default: True ) –

If True, walk in top-down order, otherwise walk in bottom-up order.
filters (list[BaseFileFilter], default: None ) –

Return only files/directories matching these filters. See File Filters.
limits (list[BaseFileLimit], default: None ) –

Apply limits to the list of files/directories, and immediately stop if any of these limits is reached. See File Limits.

Returns:

Iterable[tuple] –

Like os.walk, but all the paths are not strings, instead path classes with embedded stats are returned.

Raises:

NotADirectoryError –

Path is not a directory
DirectoryNotFoundError –

Path does not exist

Examples:

>>> for root, dirs, files in connection.walk("/path/to/dir"):
...    break
>>> os.fspath(root)
'/path/to/dir'
>>> dirs
[]
>>> os.fspath(files[0])
'/path/to/dir/file.csv'
>>> connection.path_exists("/path/to/dir/file.csv")
True

`download_file(remote_file_path, local_file_path, *, replace=True)` ¶

Downloads file from the remote filesystem to a local path.

Warning

Supports only one file download per call. Directory download is NOT supported, use File Downloader instead.

Added in 0.8.0

Parameters:

remote_file_path (str | PathLike) –

Remote file path to read from
local_file_path (str | PathLike) –

Local file path to create
replace (bool, default: False ) –

If True, existing file will be replaced

Returns:

PathWithStatsProtocol –

Local file with stats.

Raises:

NotAFileError –

Remote or local path is not a file
FileNotFoundError –

Remote file does not exist
FileExistsError –

Local file already exists, and replace=False
FileSizeMismatchError –

Target file size after download is different from source file size.

Examples:

>>> local_file = connection.download_file(
...     remote_file_path="/path/to/source.csv",
...     local_file_path="/path/to/target.csv",
... )
>>> os.fspath(local_file)
'/path/to/target.csv'
>>> local_file.exists()
True
>>> local_file.stat().st_size  # in bytes
1024
>>> connection.get_stat("/path/to/source.csv").st_size  # same size
1024

`upload_file(local_file_path, remote_file_path, *, replace=False)` ¶

Uploads local file to a remote filesystem.

Warning

Supports only one file upload per call. Directory upload is NOT supported, use File Uploader instead.

Added in 0.8.0

Parameters:

local_file_path (str | PathLike) –

Local file path to read from
remote_file_path (str | PathLike) –

Remote file path to create
replace (bool, default: False ) –

If True, existing file will be replaced

Returns:

PathWithStatsProtocol –

Remote file with stats.

Raises:

NotAFileError –

Remote or local path is not a file
FileNotFoundError –

Local file does not exist
FileExistsError –

Remote file already exists, and replace=False
FileSizeMismatchError –

Target file size after upload is different from source file size.

Examples:

>>> remote_file = connection.upload_file(
...     local_file_path="/path/to/source.csv",
...     remote_file_path="/path/to/target.csv",
... )
>>> os.fspath(remote_file)
'/path/to/target.csv'
>>> connection.path_exists("/path/to/target.csv")
True
>>> remote_file.stat().st_size  # in bytes
1024
>>> os.stat("/path/to/source.csv").st_size  # same as source
1024

`FTPSExtra` ¶

Bases: FTPExtra

Extra options for FTPS connection.

You can pass here any parameters supported by ftputil.session.session_factory.

Parameters:

use_passive_mode (bool) –

Set to True to use passive mode, False to use active mode, None for autodetect
encoding (str, default: utf-8 ) –

File path encoding

FTPS connection¶

`FTPS` ¶

`check()` ¶

`path_exists(path)` ¶

`is_file(path)` ¶

`is_dir(path)` ¶

`get_stat(path)` ¶

`resolve_dir(path)` ¶

`resolve_file(path)` ¶

`create_dir(path)` ¶

`remove_file(path)` ¶

`remove_dir(path, *, recursive=False)` ¶

`rename_dir(source_dir_path, target_dir_path, *, replace=False)` ¶

`rename_file(source_file_path, target_file_path, *, replace=False)` ¶

`list_dir(path, filters=None, limits=None)` ¶

`walk(root, *, topdown=True, filters=None, limits=None)` ¶

`download_file(remote_file_path, local_file_path, *, replace=True)` ¶

`upload_file(local_file_path, remote_file_path, *, replace=False)` ¶

`FTPSExtra` ¶

`use_passive_mode = None` `class-attribute` `instance-attribute` ¶

`encoding = 'utf-8'` `class-attribute` `instance-attribute` ¶

FTPS connection¶

FTPS ¶

check() ¶

path_exists(path) ¶

is_file(path) ¶

is_dir(path) ¶

get_stat(path) ¶

resolve_dir(path) ¶

resolve_file(path) ¶

create_dir(path) ¶

remove_file(path) ¶

remove_dir(path, *, recursive=False) ¶

rename_dir(source_dir_path, target_dir_path, *, replace=False) ¶

rename_file(source_file_path, target_file_path, *, replace=False) ¶

list_dir(path, filters=None, limits=None) ¶

walk(root, *, topdown=True, filters=None, limits=None) ¶

download_file(remote_file_path, local_file_path, *, replace=True) ¶

upload_file(local_file_path, remote_file_path, *, replace=False) ¶

FTPSExtra ¶

use_passive_mode = None class-attribute instance-attribute ¶

encoding = 'utf-8' class-attribute instance-attribute ¶

`FTPS` ¶

`check()` ¶

`path_exists(path)` ¶

`is_file(path)` ¶

`is_dir(path)` ¶

`get_stat(path)` ¶

`resolve_dir(path)` ¶

`resolve_file(path)` ¶

`create_dir(path)` ¶

`remove_file(path)` ¶

`remove_dir(path, *, recursive=False)` ¶

`rename_dir(source_dir_path, target_dir_path, *, replace=False)` ¶

`rename_file(source_file_path, target_file_path, *, replace=False)` ¶

`list_dir(path, filters=None, limits=None)` ¶

`walk(root, *, topdown=True, filters=None, limits=None)` ¶

`download_file(remote_file_path, local_file_path, *, replace=True)` ¶

`upload_file(local_file_path, remote_file_path, *, replace=False)` ¶

`FTPSExtra` ¶

`use_passive_mode = None` `class-attribute` `instance-attribute` ¶

`encoding = 'utf-8'` `class-attribute` `instance-attribute` ¶