46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205 | @support_hooks
class FTP(FileConnection, RenameDirMixin):
"""FTP file connection. |support_hooks|
Based on `FTPUtil library <https://pypi.org/project/ftputil/>`_.
.. warning::
Since onETL v0.7.0 to use FTP connector you should install package as follows:
.. code:: bash
pip install "onetl[ftp]"
# or
pip install "onetl[files]"
See :ref:`install-files` installation instruction for more details.
.. versionadded:: 0.1.0
Parameters
----------
host : str
Host of FTP source. For example: ``ftp.domain.com``
port : int, default: ``21``
Port of FTP 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.
Examples
--------
Create and check FTP connection:
.. code:: python
from onetl.connection import FTP
ftp = FTP(
host="ftp.domain.com",
user="someuser",
password="*****",
).check()
"""
host: Host
port: int = 21
user: Optional[str] = None
password: Optional[SecretStr] = None
@property
def instance_url(self) -> str:
return f"{self.__class__.__name__.lower()}://{self.host}:{self.port}"
def __str__(self):
return f"{self.__class__.__name__}[{self.host}:{self.port}]"
@slot
def path_exists(self, path: os.PathLike | str) -> bool:
return self.client.path.exists(os.fspath(path))
def _get_client(self) -> FTPHost:
"""
Returns a FTP connection object
"""
session_factory = ftp_session.session_factory(
base_class=ftplib.FTP,
port=self.port,
encrypt_data_channel=True,
debug_level=0,
)
return FTPHost(
self.host,
self.user,
self.password.get_secret_value() if self.password else None,
session_factory=session_factory,
)
def _is_client_closed(self, client: FTPHost) -> bool:
return client.closed
def _close_client(self, client: FTPHost) -> None:
client.close()
def _remove_dir(self, path: RemotePath) -> None:
self.client.rmdir(os.fspath(path))
def _upload_file(self, local_file_path: LocalPath, remote_file_path: RemotePath) -> None:
self.client.upload(os.fspath(local_file_path), os.fspath(remote_file_path))
def _rename_file(self, source: RemotePath, target: RemotePath) -> None:
self.client.rename(os.fspath(source), os.fspath(target))
_rename_dir = _rename_file
def _download_file(self, remote_file_path: RemotePath, local_file_path: LocalPath) -> None:
self.client.download(os.fspath(remote_file_path), os.fspath(local_file_path))
def _remove_file(self, remote_file_path: RemotePath) -> None:
self.client.remove(os.fspath(remote_file_path))
def _create_dir(self, path: RemotePath) -> None:
self.client.makedirs(os.fspath(path), exist_ok=True)
def _scan_entries(self, path: RemotePath) -> list[str]:
return self.client.listdir(os.fspath(path))
def _is_dir(self, path: RemotePath) -> bool:
return self.client.path.isdir(os.fspath(path))
def _is_file(self, path: RemotePath) -> bool:
return self.client.path.isfile(os.fspath(path))
def _get_stat(self, path: RemotePath) -> PathStatProtocol:
if path == RemotePath("/"):
# FTP does not allow to call stat on root directory, do nothing
return RemotePathStat()
# underlying FTP client already return `os.stat_result`-like class`
return self.client.stat(os.fspath(path))
def _read_text(self, path: RemotePath, encoding: str, **kwargs) -> str:
with self.client.open(os.fspath(path), mode="r", encoding=encoding, **kwargs) as file:
return file.read()
def _read_bytes(self, path: RemotePath, **kwargs) -> bytes:
with self.client.open(os.fspath(path), mode="rb", **kwargs) as file:
return file.read()
def _write_text(self, path: RemotePath, content: str, encoding: str, **kwargs) -> None:
with self.client.open(os.fspath(path), mode="w", encoding=encoding, **kwargs) as file:
file.write(content)
def _write_bytes(self, path: RemotePath, content: bytes, **kwargs) -> None:
with self.client.open(os.fspath(path), mode="wb", **kwargs) as file:
file.write(content)
def _extract_name_from_entry(self, entry: str) -> str:
return entry
def _is_dir_entry(self, top: RemotePath, entry: str) -> bool:
return self._is_dir(top / entry)
def _is_file_entry(self, top: RemotePath, entry: str) -> bool:
return self._is_file(top / entry)
def _extract_stat_from_entry(self, top: RemotePath, entry: str) -> PathStatProtocol:
return self._get_stat(top / entry)
|